1b7d5a9c2SKamil Rytarowski#!/usr/bin/env perl 21ec3f6f9SBlue Swirl# (c) 2001, Dave Jones. (the file handling bit) 31ec3f6f9SBlue Swirl# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) 41ec3f6f9SBlue Swirl# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite) 51ec3f6f9SBlue Swirl# (c) 2008-2010 Andy Whitcroft <apw@canonical.com> 61ec3f6f9SBlue Swirl# Licensed under the terms of the GNU GPL License version 2 71ec3f6f9SBlue Swirl 81ec3f6f9SBlue Swirluse strict; 9b7d5a9c2SKamil Rytarowskiuse warnings; 101db4269fSPaolo Bonziniuse Term::ANSIColor qw(:constants); 111ec3f6f9SBlue Swirl 121ec3f6f9SBlue Swirlmy $P = $0; 131ec3f6f9SBlue Swirl$P =~ s@.*/@@g; 141ec3f6f9SBlue Swirl 1572205289SMatheus Ferstour $SrcFile = qr{\.(?:(h|c)(\.inc)?|cpp|s|S|pl|py|sh)$}; 16777d05baSPaolo Bonzini 171ec3f6f9SBlue Swirlmy $V = '0.31'; 181ec3f6f9SBlue Swirl 191ec3f6f9SBlue Swirluse Getopt::Long qw(:config no_auto_abbrev); 201ec3f6f9SBlue Swirl 211ec3f6f9SBlue Swirlmy $quiet = 0; 221ec3f6f9SBlue Swirlmy $tree = 1; 231ec3f6f9SBlue Swirlmy $chk_signoff = 1; 248e1fe175SDaniel P. Berrangemy $chk_patch = undef; 258e1fe175SDaniel P. Berrangemy $chk_branch = undef; 261ec3f6f9SBlue Swirlmy $tst_only; 271ec3f6f9SBlue Swirlmy $emacs = 0; 281ec3f6f9SBlue Swirlmy $terse = 0; 298e1fe175SDaniel P. Berrangemy $file = undef; 301db4269fSPaolo Bonzinimy $color = "auto"; 31141de886SPaolo Bonzinimy $no_warnings = 0; 321ec3f6f9SBlue Swirlmy $summary = 1; 331ec3f6f9SBlue Swirlmy $mailback = 0; 341ec3f6f9SBlue Swirlmy $summary_file = 0; 351ec3f6f9SBlue Swirlmy $root; 361ec3f6f9SBlue Swirlmy %debug; 371ec3f6f9SBlue Swirlmy $help = 0; 38e072af19SZhao Liumy $codespell = 0; 39e072af19SZhao Liumy $codespellfile = "/usr/share/codespell/dictionary.txt"; 40e072af19SZhao Liumy $user_codespellfile = ""; 411ec3f6f9SBlue Swirl 421ec3f6f9SBlue Swirlsub help { 431ec3f6f9SBlue Swirl my ($exitcode) = @_; 441ec3f6f9SBlue Swirl 451ec3f6f9SBlue Swirl print << "EOM"; 468e1fe175SDaniel P. BerrangeUsage: 478e1fe175SDaniel P. Berrange 488e1fe175SDaniel P. Berrange $P [OPTION]... [FILE]... 498e1fe175SDaniel P. Berrange $P [OPTION]... [GIT-REV-LIST] 508e1fe175SDaniel P. Berrange 511ec3f6f9SBlue SwirlVersion: $V 521ec3f6f9SBlue Swirl 531ec3f6f9SBlue SwirlOptions: 541ec3f6f9SBlue Swirl -q, --quiet quiet 55143a768cSAleksandar Markovic --no-tree run without a qemu tree 561ec3f6f9SBlue Swirl --no-signoff do not check for 'Signed-off-by' line 578e1fe175SDaniel P. Berrange --patch treat FILE as patchfile 588e1fe175SDaniel P. Berrange --branch treat args as GIT revision list 591ec3f6f9SBlue Swirl --emacs emacs compile window format 601ec3f6f9SBlue Swirl --terse one line per report 611ec3f6f9SBlue Swirl -f, --file treat FILE as regular source file 62141de886SPaolo Bonzini --strict fail if only warnings are found 63143a768cSAleksandar Markovic --root=PATH PATH to the qemu tree root 641ec3f6f9SBlue Swirl --no-summary suppress the per-file summary 651ec3f6f9SBlue Swirl --mailback only produce a report in case of warnings/errors 661ec3f6f9SBlue Swirl --summary-file include the filename in summary 671ec3f6f9SBlue Swirl --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 681ec3f6f9SBlue Swirl 'values', 'possible', 'type', and 'attr' (default 691ec3f6f9SBlue Swirl is all off) 701ec3f6f9SBlue Swirl --test-only=WORD report only warnings/errors containing WORD 711ec3f6f9SBlue Swirl literally 72e072af19SZhao Liu --codespell Use the codespell dictionary for spelling/typos 73e072af19SZhao Liu (default: $codespellfile) 74e072af19SZhao Liu --codespellfile Use this codespell dictionary 751db4269fSPaolo Bonzini --color[=WHEN] Use colors 'always', 'never', or only when output 761db4269fSPaolo Bonzini is a terminal ('auto'). Default is 'auto'. 771ec3f6f9SBlue Swirl -h, --help, --version display this help and exit 781ec3f6f9SBlue Swirl 791ec3f6f9SBlue SwirlWhen FILE is - read standard input. 801ec3f6f9SBlue SwirlEOM 811ec3f6f9SBlue Swirl 821ec3f6f9SBlue Swirl exit($exitcode); 831ec3f6f9SBlue Swirl} 841ec3f6f9SBlue Swirl 851db4269fSPaolo Bonzini# Perl's Getopt::Long allows options to take optional arguments after a space. 861db4269fSPaolo Bonzini# Prevent --color by itself from consuming other arguments 871db4269fSPaolo Bonziniforeach (@ARGV) { 881db4269fSPaolo Bonzini if ($_ eq "--color" || $_ eq "-color") { 891db4269fSPaolo Bonzini $_ = "--color=$color"; 901db4269fSPaolo Bonzini } 911db4269fSPaolo Bonzini} 921db4269fSPaolo Bonzini 931ec3f6f9SBlue SwirlGetOptions( 941ec3f6f9SBlue Swirl 'q|quiet+' => \$quiet, 951ec3f6f9SBlue Swirl 'tree!' => \$tree, 961ec3f6f9SBlue Swirl 'signoff!' => \$chk_signoff, 971ec3f6f9SBlue Swirl 'patch!' => \$chk_patch, 988e1fe175SDaniel P. Berrange 'branch!' => \$chk_branch, 991ec3f6f9SBlue Swirl 'emacs!' => \$emacs, 1001ec3f6f9SBlue Swirl 'terse!' => \$terse, 1011ec3f6f9SBlue Swirl 'f|file!' => \$file, 102141de886SPaolo Bonzini 'strict!' => \$no_warnings, 1031ec3f6f9SBlue Swirl 'root=s' => \$root, 1041ec3f6f9SBlue Swirl 'summary!' => \$summary, 1051ec3f6f9SBlue Swirl 'mailback!' => \$mailback, 1061ec3f6f9SBlue Swirl 'summary-file!' => \$summary_file, 1071ec3f6f9SBlue Swirl 'debug=s' => \%debug, 1081ec3f6f9SBlue Swirl 'test-only=s' => \$tst_only, 109e072af19SZhao Liu 'codespell!' => \$codespell, 110e072af19SZhao Liu 'codespellfile=s' => \$user_codespellfile, 1111db4269fSPaolo Bonzini 'color=s' => \$color, 1121db4269fSPaolo Bonzini 'no-color' => sub { $color = 'never'; }, 1131ec3f6f9SBlue Swirl 'h|help' => \$help, 1141ec3f6f9SBlue Swirl 'version' => \$help 1151ec3f6f9SBlue Swirl) or help(1); 1161ec3f6f9SBlue Swirl 117e072af19SZhao Liuif ($user_codespellfile) { 118e072af19SZhao Liu # Use the user provided codespell file unconditionally 119e072af19SZhao Liu $codespellfile = $user_codespellfile; 120e072af19SZhao Liu} elsif (!(-f $codespellfile)) { 121e072af19SZhao Liu # If /usr/share/codespell/dictionary.txt is not present, try to find it 122e072af19SZhao Liu # under codespell's install directory: <codespell_root>/data/dictionary.txt 123e072af19SZhao Liu if (($codespell || $help) && which("python3") ne "") { 124e072af19SZhao Liu my $python_codespell_dict = << "EOF"; 125e072af19SZhao Liu 126e072af19SZhao Liuimport os.path as op 127e072af19SZhao Liuimport codespell_lib 128e072af19SZhao Liucodespell_dir = op.dirname(codespell_lib.__file__) 129e072af19SZhao Liucodespell_file = op.join(codespell_dir, 'data', 'dictionary.txt') 130e072af19SZhao Liuprint(codespell_file, end='') 131e072af19SZhao LiuEOF 132e072af19SZhao Liu 133e072af19SZhao Liu my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`; 134e072af19SZhao Liu $codespellfile = $codespell_dict if (-f $codespell_dict); 135e072af19SZhao Liu } 136e072af19SZhao Liu} 137e072af19SZhao Liu 1381ec3f6f9SBlue Swirlhelp(0) if ($help); 1391ec3f6f9SBlue Swirl 1401ec3f6f9SBlue Swirlmy $exit = 0; 1411ec3f6f9SBlue Swirl 1421ec3f6f9SBlue Swirlif ($#ARGV < 0) { 1431ec3f6f9SBlue Swirl print "$P: no input files\n"; 1441ec3f6f9SBlue Swirl exit(1); 1451ec3f6f9SBlue Swirl} 1461ec3f6f9SBlue Swirl 1478e1fe175SDaniel P. Berrangeif (!defined $chk_branch && !defined $chk_patch && !defined $file) { 148777d05baSPaolo Bonzini $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0; 149777d05baSPaolo Bonzini $file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0; 150777d05baSPaolo Bonzini $chk_patch = $chk_branch || $file ? 0 : 1; 1518e1fe175SDaniel P. Berrange} elsif (!defined $chk_branch && !defined $chk_patch) { 1528e1fe175SDaniel P. Berrange if ($file) { 1538e1fe175SDaniel P. Berrange $chk_branch = $chk_patch = 0; 1548e1fe175SDaniel P. Berrange } else { 155777d05baSPaolo Bonzini $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0; 1568e1fe175SDaniel P. Berrange $chk_patch = $chk_branch ? 0 : 1; 1578e1fe175SDaniel P. Berrange } 1588e1fe175SDaniel P. Berrange} elsif (!defined $chk_branch && !defined $file) { 1598e1fe175SDaniel P. Berrange if ($chk_patch) { 1608e1fe175SDaniel P. Berrange $chk_branch = $file = 0; 1618e1fe175SDaniel P. Berrange } else { 162777d05baSPaolo Bonzini $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0; 1638e1fe175SDaniel P. Berrange $file = $chk_branch ? 0 : 1; 1648e1fe175SDaniel P. Berrange } 1658e1fe175SDaniel P. Berrange} elsif (!defined $chk_patch && !defined $file) { 1668e1fe175SDaniel P. Berrange if ($chk_branch) { 1678e1fe175SDaniel P. Berrange $chk_patch = $file = 0; 1688e1fe175SDaniel P. Berrange } else { 169777d05baSPaolo Bonzini $file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0; 170777d05baSPaolo Bonzini $chk_patch = $file ? 0 : 1; 1718e1fe175SDaniel P. Berrange } 1728e1fe175SDaniel P. Berrange} elsif (!defined $chk_branch) { 1738e1fe175SDaniel P. Berrange $chk_branch = $chk_patch || $file ? 0 : 1; 1748e1fe175SDaniel P. Berrange} elsif (!defined $chk_patch) { 1758e1fe175SDaniel P. Berrange $chk_patch = $chk_branch || $file ? 0 : 1; 1768e1fe175SDaniel P. Berrange} elsif (!defined $file) { 1778e1fe175SDaniel P. Berrange $file = $chk_patch || $chk_branch ? 0 : 1; 1788e1fe175SDaniel P. Berrange} 1798e1fe175SDaniel P. Berrange 1808e1fe175SDaniel P. Berrangeif (($chk_patch && $chk_branch) || 1818e1fe175SDaniel P. Berrange ($chk_patch && $file) || 1828e1fe175SDaniel P. Berrange ($chk_branch && $file)) { 1838e1fe175SDaniel P. Berrange die "Only one of --file, --branch, --patch is permitted\n"; 1848e1fe175SDaniel P. Berrange} 1858e1fe175SDaniel P. Berrangeif (!$chk_patch && !$chk_branch && !$file) { 1868e1fe175SDaniel P. Berrange die "One of --file, --branch, --patch is required\n"; 1878e1fe175SDaniel P. Berrange} 1888e1fe175SDaniel P. Berrange 1891db4269fSPaolo Bonziniif ($color =~ /^always$/i) { 1901db4269fSPaolo Bonzini $color = 1; 1911db4269fSPaolo Bonzini} elsif ($color =~ /^never$/i) { 1921db4269fSPaolo Bonzini $color = 0; 1931db4269fSPaolo Bonzini} elsif ($color =~ /^auto$/i) { 1941db4269fSPaolo Bonzini $color = (-t STDOUT); 1951db4269fSPaolo Bonzini} else { 1961db4269fSPaolo Bonzini die "Invalid color mode: $color\n"; 1971db4269fSPaolo Bonzini} 1981db4269fSPaolo Bonzini 1991ec3f6f9SBlue Swirlmy $dbg_values = 0; 2001ec3f6f9SBlue Swirlmy $dbg_possible = 0; 2011ec3f6f9SBlue Swirlmy $dbg_type = 0; 2021ec3f6f9SBlue Swirlmy $dbg_attr = 0; 203a99ac041SDon Slutzmy $dbg_adv_dcs = 0; 2045424302eSDon Slutzmy $dbg_adv_checking = 0; 20569402a69SDon Slutzmy $dbg_adv_apw = 0; 2061ec3f6f9SBlue Swirlfor my $key (keys %debug) { 2071ec3f6f9SBlue Swirl ## no critic 2081ec3f6f9SBlue Swirl eval "\${dbg_$key} = '$debug{$key}';"; 2091ec3f6f9SBlue Swirl die "$@" if ($@); 2101ec3f6f9SBlue Swirl} 2111ec3f6f9SBlue Swirl 2121ec3f6f9SBlue Swirlmy $rpt_cleaners = 0; 2131ec3f6f9SBlue Swirl 2141ec3f6f9SBlue Swirlif ($terse) { 2151ec3f6f9SBlue Swirl $emacs = 1; 2161ec3f6f9SBlue Swirl $quiet++; 2171ec3f6f9SBlue Swirl} 2181ec3f6f9SBlue Swirl 2191ec3f6f9SBlue Swirlif ($tree) { 2201ec3f6f9SBlue Swirl if (defined $root) { 2211ec3f6f9SBlue Swirl if (!top_of_kernel_tree($root)) { 2221ec3f6f9SBlue Swirl die "$P: $root: --root does not point at a valid tree\n"; 2231ec3f6f9SBlue Swirl } 2241ec3f6f9SBlue Swirl } else { 2251ec3f6f9SBlue Swirl if (top_of_kernel_tree('.')) { 2261ec3f6f9SBlue Swirl $root = '.'; 2271ec3f6f9SBlue Swirl } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2281ec3f6f9SBlue Swirl top_of_kernel_tree($1)) { 2291ec3f6f9SBlue Swirl $root = $1; 2301ec3f6f9SBlue Swirl } 2311ec3f6f9SBlue Swirl } 2321ec3f6f9SBlue Swirl 2331ec3f6f9SBlue Swirl if (!defined $root) { 234143a768cSAleksandar Markovic print "Must be run from the top-level dir. of a qemu tree\n"; 2351ec3f6f9SBlue Swirl exit(2); 2361ec3f6f9SBlue Swirl } 2371ec3f6f9SBlue Swirl} 2381ec3f6f9SBlue Swirl 2391ec3f6f9SBlue Swirlmy $emitted_corrupt = 0; 2401ec3f6f9SBlue Swirl 2411ec3f6f9SBlue Swirlour $Ident = qr{ 2421ec3f6f9SBlue Swirl [A-Za-z_][A-Za-z\d_]* 2431ec3f6f9SBlue Swirl (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2441ec3f6f9SBlue Swirl }x; 2451ec3f6f9SBlue Swirlour $Storage = qr{extern|static|asmlinkage}; 2461ec3f6f9SBlue Swirlour $Sparse = qr{ 247f1e155bbSPaolo Bonzini __force 2481ec3f6f9SBlue Swirl }x; 2491ec3f6f9SBlue Swirl 2501ec3f6f9SBlue Swirl# Notes to $Attribute: 2511ec3f6f9SBlue Swirlour $Attribute = qr{ 2521ec3f6f9SBlue Swirl const| 25371c47b01SPaolo Bonzini volatile| 2548905770bSMarc-André Lureau G_NORETURN| 255c0840179SMarc-André Lureau G_GNUC_WARN_UNUSED_RESULT| 256887ce500SMarc-André Lureau G_GNUC_NULL_TERMINATED| 25771c47b01SPaolo Bonzini QEMU_PACKED| 2589edc6313SMarc-André Lureau G_GNUC_PRINTF 2591ec3f6f9SBlue Swirl }x; 2601ec3f6f9SBlue Swirlour $Modifier; 26171c47b01SPaolo Bonziniour $Inline = qr{inline}; 2621ec3f6f9SBlue Swirlour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2631ec3f6f9SBlue Swirlour $Lval = qr{$Ident(?:$Member)*}; 2641ec3f6f9SBlue Swirl 2651ec3f6f9SBlue Swirlour $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 2661ec3f6f9SBlue Swirlour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 2671ec3f6f9SBlue Swirlour $Compare = qr{<=|>=|==|!=|<|>}; 2681ec3f6f9SBlue Swirlour $Operators = qr{ 2691ec3f6f9SBlue Swirl <=|>=|==|!=| 2701ec3f6f9SBlue Swirl =>|->|<<|>>|<|>|!|~| 2711ec3f6f9SBlue Swirl &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 2721ec3f6f9SBlue Swirl }x; 2731ec3f6f9SBlue Swirl 2741ec3f6f9SBlue Swirlour $NonptrType; 2751ec3f6f9SBlue Swirlour $Type; 2761ec3f6f9SBlue Swirlour $Declare; 2771ec3f6f9SBlue Swirl 278b37c4aacSJoe Perchesour $NON_ASCII_UTF8 = qr{ 279b37c4aacSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 2801ec3f6f9SBlue Swirl | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 2811ec3f6f9SBlue Swirl | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 2821ec3f6f9SBlue Swirl | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 2831ec3f6f9SBlue Swirl | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 2841ec3f6f9SBlue Swirl | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 2851ec3f6f9SBlue Swirl | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 2861ec3f6f9SBlue Swirl}x; 2871ec3f6f9SBlue Swirl 288b37c4aacSJoe Perchesour $UTF8 = qr{ 289b37c4aacSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 290b37c4aacSJoe Perches | $NON_ASCII_UTF8 291b37c4aacSJoe Perches}x; 292b37c4aacSJoe Perches 293874acb6fSPaolo Bonzini# some readers default to ISO-8859-1 when showing email source. detect 294874acb6fSPaolo Bonzini# when UTF-8 is incorrectly interpreted as ISO-8859-1 and reencoded back. 295874acb6fSPaolo Bonzini# False positives are possible but very unlikely. 296874acb6fSPaolo Bonziniour $UTF8_MOJIBAKE = qr{ 297874acb6fSPaolo Bonzini \xC3[\x82-\x9F] \xC2[\x80-\xBF] # c2-df 80-bf 298874acb6fSPaolo Bonzini | \xC3\xA0 \xC2[\xA0-\xBF] \xC2[\x80-\xBF] # e0 a0-bf 80-bf 299874acb6fSPaolo Bonzini | \xC3[\xA1-\xAC\xAE\xAF] (?: \xC2[\x80-\xBF]){2} # e1-ec/ee/ef 80-bf 80-bf 300874acb6fSPaolo Bonzini | \xC3\xAD \xC2[\x80-\x9F] \xC2[\x80-\xBF] # ed 80-9f 80-bf 301874acb6fSPaolo Bonzini | \xC3\xB0 \xC2[\x90-\xBF] (?: \xC2[\x80-\xBF]){2} # f0 90-bf 80-bf 80-bf 302874acb6fSPaolo Bonzini | \xC3[\xB1-\xB3] (?: \xC2[\x80-\xBF]){3} # f1-f3 80-bf 80-bf 80-bf 303874acb6fSPaolo Bonzini | \xC3\xB4 \xC2[\x80-\x8F] (?: \xC2[\x80-\xBF]){2} # f4 80-b8 80-bf 80-bf 304874acb6fSPaolo Bonzini}x; 305874acb6fSPaolo Bonzini 306a6859debSPaolo Bonzini# There are still some false positives, but this catches most 307a6859debSPaolo Bonzini# common cases. 3081ec3f6f9SBlue Swirlour $typeTypedefs = qr{(?x: 3095fa96cadSPhilippe Mathieu-Daudé (?![KMGTPE]iB) # IEC binary prefix (do not match) 310a6859debSPaolo Bonzini [A-Z][A-Z\d_]*[a-z][A-Za-z\d_]* # camelcase 311a6859debSPaolo Bonzini | [A-Z][A-Z\d_]*AIOCB # all uppercase 312a6859debSPaolo Bonzini | [A-Z][A-Z\d_]*CPU # all uppercase 313a6859debSPaolo Bonzini | QEMUBH # all uppercase 3141ec3f6f9SBlue Swirl)}; 3151ec3f6f9SBlue Swirl 3161ec3f6f9SBlue Swirlour @typeList = ( 3171ec3f6f9SBlue Swirl qr{void}, 3181ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?char}, 3191ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?short}, 3201ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?int}, 3211ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?long}, 3221ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?long\s+int}, 3231ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?long\s+long}, 3241ec3f6f9SBlue Swirl qr{(?:unsigned\s+)?long\s+long\s+int}, 3251ec3f6f9SBlue Swirl qr{unsigned}, 3261ec3f6f9SBlue Swirl qr{float}, 3271ec3f6f9SBlue Swirl qr{double}, 3281ec3f6f9SBlue Swirl qr{bool}, 3291ec3f6f9SBlue Swirl qr{struct\s+$Ident}, 3301ec3f6f9SBlue Swirl qr{union\s+$Ident}, 3311ec3f6f9SBlue Swirl qr{enum\s+$Ident}, 3321ec3f6f9SBlue Swirl qr{${Ident}_t}, 3331ec3f6f9SBlue Swirl qr{${Ident}_handler}, 3341ec3f6f9SBlue Swirl qr{${Ident}_handler_fn}, 335f0707d2eSCédric Le Goater qr{target_(?:u)?long}, 336825bfa00SGreg Kurz qr{hwaddr}, 33782870f3cSPeter Xu # external libraries 3388d0f08e9SPaul Durrant qr{xen\w+_handle}, 33982870f3cSPeter Xu # Glib definitions 34082870f3cSPeter Xu qr{gchar}, 34182870f3cSPeter Xu qr{gshort}, 34282870f3cSPeter Xu qr{glong}, 34382870f3cSPeter Xu qr{gint}, 34482870f3cSPeter Xu qr{gboolean}, 34582870f3cSPeter Xu qr{guchar}, 34682870f3cSPeter Xu qr{gushort}, 34782870f3cSPeter Xu qr{gulong}, 34882870f3cSPeter Xu qr{guint}, 34982870f3cSPeter Xu qr{gfloat}, 35082870f3cSPeter Xu qr{gdouble}, 35182870f3cSPeter Xu qr{gpointer}, 35282870f3cSPeter Xu qr{gconstpointer}, 35382870f3cSPeter Xu qr{gint8}, 35482870f3cSPeter Xu qr{guint8}, 35582870f3cSPeter Xu qr{gint16}, 35682870f3cSPeter Xu qr{guint16}, 35782870f3cSPeter Xu qr{gint32}, 35882870f3cSPeter Xu qr{guint32}, 35982870f3cSPeter Xu qr{gint64}, 36082870f3cSPeter Xu qr{guint64}, 36182870f3cSPeter Xu qr{gsize}, 36282870f3cSPeter Xu qr{gssize}, 36382870f3cSPeter Xu qr{goffset}, 36482870f3cSPeter Xu qr{gintptr}, 36582870f3cSPeter Xu qr{guintptr}, 3661ec3f6f9SBlue Swirl); 367f1e155bbSPaolo Bonzini 368e072af19SZhao Liu# Load common spelling mistakes and build regular expression list. 369e072af19SZhao Liumy $misspellings; 370e072af19SZhao Liumy %spelling_fix; 371e072af19SZhao Liu 372e072af19SZhao Liuif ($codespell) { 373e072af19SZhao Liu if (open(my $spelling, '<', $codespellfile)) { 374e072af19SZhao Liu while (<$spelling>) { 375e072af19SZhao Liu my $line = $_; 376e072af19SZhao Liu 377e072af19SZhao Liu $line =~ s/\s*\n?$//g; 378e072af19SZhao Liu $line =~ s/^\s*//g; 379e072af19SZhao Liu 380e072af19SZhao Liu next if ($line =~ m/^\s*#/); 381e072af19SZhao Liu next if ($line =~ m/^\s*$/); 382e072af19SZhao Liu next if ($line =~ m/, disabled/i); 383e072af19SZhao Liu 384e072af19SZhao Liu $line =~ s/,.*$//; 385e072af19SZhao Liu 386e072af19SZhao Liu my ($suspect, $fix) = split(/->/, $line); 387e072af19SZhao Liu 388e072af19SZhao Liu $spelling_fix{$suspect} = $fix; 389e072af19SZhao Liu } 390e072af19SZhao Liu close($spelling); 391e072af19SZhao Liu } else { 392e072af19SZhao Liu warn "No codespell typos will be found - file '$codespellfile': $!\n"; 393e072af19SZhao Liu } 394e072af19SZhao Liu} 395e072af19SZhao Liu 396e072af19SZhao Liu$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 397e072af19SZhao Liu 398f1e155bbSPaolo Bonzini# This can be modified by sub possible. Since it can be empty, be careful 399f1e155bbSPaolo Bonzini# about regexes that always match, because they can cause infinite loops. 4001ec3f6f9SBlue Swirlour @modifierList = ( 4011ec3f6f9SBlue Swirl); 4021ec3f6f9SBlue Swirl 4031ec3f6f9SBlue Swirlsub build_types { 4041ec3f6f9SBlue Swirl my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 405f1e155bbSPaolo Bonzini if (@modifierList > 0) { 406f1e155bbSPaolo Bonzini my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 4071ec3f6f9SBlue Swirl $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 408f1e155bbSPaolo Bonzini } else { 409f1e155bbSPaolo Bonzini $Modifier = qr{(?:$Attribute|$Sparse)}; 410f1e155bbSPaolo Bonzini } 4111ec3f6f9SBlue Swirl $NonptrType = qr{ 4121ec3f6f9SBlue Swirl (?:$Modifier\s+|const\s+)* 4131ec3f6f9SBlue Swirl (?: 4141ec3f6f9SBlue Swirl (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 4151ec3f6f9SBlue Swirl (?:$typeTypedefs\b)| 4161ec3f6f9SBlue Swirl (?:${all}\b) 4171ec3f6f9SBlue Swirl ) 4181ec3f6f9SBlue Swirl (?:\s+$Modifier|\s+const)* 4191ec3f6f9SBlue Swirl }x; 4201ec3f6f9SBlue Swirl $Type = qr{ 4211ec3f6f9SBlue Swirl $NonptrType 4221ec3f6f9SBlue Swirl (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 4231ec3f6f9SBlue Swirl (?:\s+$Inline|\s+$Modifier)* 4241ec3f6f9SBlue Swirl }x; 4251ec3f6f9SBlue Swirl $Declare = qr{(?:$Storage\s+)?$Type}; 4261ec3f6f9SBlue Swirl} 4271ec3f6f9SBlue Swirlbuild_types(); 4281ec3f6f9SBlue Swirl 4291ec3f6f9SBlue Swirl$chk_signoff = 0 if ($file); 4301ec3f6f9SBlue Swirl 4311ec3f6f9SBlue Swirlmy @rawlines = (); 4321ec3f6f9SBlue Swirlmy @lines = (); 4331ec3f6f9SBlue Swirlmy $vname; 4348e1fe175SDaniel P. Berrangeif ($chk_branch) { 4358e1fe175SDaniel P. Berrange my @patches; 436c182b619SPaolo Bonzini my %git_commits = (); 4378e1fe175SDaniel P. Berrange my $HASH; 438c182b619SPaolo Bonzini open($HASH, "-|", "git", "log", "--reverse", "--no-merges", "--format=%H %s", $ARGV[0]) || 439c182b619SPaolo Bonzini die "$P: git log --reverse --no-merges --format='%H %s' $ARGV[0] failed - $!\n"; 4408e1fe175SDaniel P. Berrange 441c182b619SPaolo Bonzini for my $line (<$HASH>) { 442c182b619SPaolo Bonzini $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 443c182b619SPaolo Bonzini next if (!defined($1) || !defined($2)); 444c182b619SPaolo Bonzini my $sha1 = $1; 445c182b619SPaolo Bonzini my $subject = $2; 446c182b619SPaolo Bonzini push(@patches, $sha1); 447c182b619SPaolo Bonzini $git_commits{$sha1} = $subject; 4488e1fe175SDaniel P. Berrange } 4498e1fe175SDaniel P. Berrange 4508e1fe175SDaniel P. Berrange close $HASH; 4518e1fe175SDaniel P. Berrange 4522d4274d6SDaniel P. Berrangé die "$P: no revisions returned for revlist '$ARGV[0]'\n" 4538e1fe175SDaniel P. Berrange unless @patches; 4548e1fe175SDaniel P. Berrange 455c182b619SPaolo Bonzini my $i = 1; 456c182b619SPaolo Bonzini my $num_patches = @patches; 4578e1fe175SDaniel P. Berrange for my $hash (@patches) { 4588e1fe175SDaniel P. Berrange my $FILE; 45966cf7014SAlex Bennée open($FILE, '-|', "git", 46066cf7014SAlex Bennée "-c", "diff.renamelimit=0", 46166cf7014SAlex Bennée "-c", "diff.renames=True", 46266cf7014SAlex Bennée "-c", "diff.algorithm=histogram", 46366cf7014SAlex Bennée "show", 46466cf7014SAlex Bennée "--patch-with-stat", $hash) || 4658e1fe175SDaniel P. Berrange die "$P: git show $hash - $!\n"; 4668e1fe175SDaniel P. Berrange while (<$FILE>) { 4678e1fe175SDaniel P. Berrange chomp; 4688e1fe175SDaniel P. Berrange push(@rawlines, $_); 4698e1fe175SDaniel P. Berrange } 4708e1fe175SDaniel P. Berrange close($FILE); 471c182b619SPaolo Bonzini $vname = substr($hash, 0, 12) . ' (' . $git_commits{$hash} . ')'; 472c182b619SPaolo Bonzini if ($num_patches > 1 && $quiet == 0) { 4731db4269fSPaolo Bonzini my $prefix = "$i/$num_patches"; 4741db4269fSPaolo Bonzini $prefix = BLUE . BOLD . $prefix . RESET if $color; 4751db4269fSPaolo Bonzini print "$prefix Checking commit $vname\n"; 476c182b619SPaolo Bonzini $vname = "Patch $i/$num_patches"; 477c182b619SPaolo Bonzini } else { 478c182b619SPaolo Bonzini $vname = "Commit " . $vname; 479c182b619SPaolo Bonzini } 4808e1fe175SDaniel P. Berrange if (!process($hash)) { 4818e1fe175SDaniel P. Berrange $exit = 1; 482c182b619SPaolo Bonzini print "\n" if ($num_patches > 1 && $quiet == 0); 4838e1fe175SDaniel P. Berrange } 4848e1fe175SDaniel P. Berrange @rawlines = (); 4858e1fe175SDaniel P. Berrange @lines = (); 486c182b619SPaolo Bonzini $i++; 4878e1fe175SDaniel P. Berrange } 4888e1fe175SDaniel P. Berrange} else { 4891ec3f6f9SBlue Swirl for my $filename (@ARGV) { 4901ec3f6f9SBlue Swirl my $FILE; 4911ec3f6f9SBlue Swirl if ($file) { 4921ec3f6f9SBlue Swirl open($FILE, '-|', "diff -u /dev/null $filename") || 4931ec3f6f9SBlue Swirl die "$P: $filename: diff failed - $!\n"; 4941ec3f6f9SBlue Swirl } elsif ($filename eq '-') { 4951ec3f6f9SBlue Swirl open($FILE, '<&STDIN'); 4961ec3f6f9SBlue Swirl } else { 4971ec3f6f9SBlue Swirl open($FILE, '<', "$filename") || 4981ec3f6f9SBlue Swirl die "$P: $filename: open failed - $!\n"; 4991ec3f6f9SBlue Swirl } 5001ec3f6f9SBlue Swirl if ($filename eq '-') { 5011ec3f6f9SBlue Swirl $vname = 'Your patch'; 5021ec3f6f9SBlue Swirl } else { 5031ec3f6f9SBlue Swirl $vname = $filename; 5041ec3f6f9SBlue Swirl } 505c182b619SPaolo Bonzini print "Checking $filename...\n" if @ARGV > 1 && $quiet == 0; 5061ec3f6f9SBlue Swirl while (<$FILE>) { 5071ec3f6f9SBlue Swirl chomp; 5081ec3f6f9SBlue Swirl push(@rawlines, $_); 5091ec3f6f9SBlue Swirl } 5101ec3f6f9SBlue Swirl close($FILE); 5111ec3f6f9SBlue Swirl if (!process($filename)) { 5121ec3f6f9SBlue Swirl $exit = 1; 5131ec3f6f9SBlue Swirl } 5141ec3f6f9SBlue Swirl @rawlines = (); 5151ec3f6f9SBlue Swirl @lines = (); 5161ec3f6f9SBlue Swirl } 5178e1fe175SDaniel P. Berrange} 5181ec3f6f9SBlue Swirl 5191ec3f6f9SBlue Swirlexit($exit); 5201ec3f6f9SBlue Swirl 5211ec3f6f9SBlue Swirlsub top_of_kernel_tree { 5221ec3f6f9SBlue Swirl my ($root) = @_; 5231ec3f6f9SBlue Swirl 5241ec3f6f9SBlue Swirl my @tree_check = ( 525b6469683SBlue Swirl "COPYING", "MAINTAINERS", "Makefile", 526336a7451SDaniel P. Berrangé "README.rst", "docs", "VERSION", 5278d7f2e76SPhilippe Mathieu-Daudé "linux-user", "system" 5281ec3f6f9SBlue Swirl ); 5291ec3f6f9SBlue Swirl 5301ec3f6f9SBlue Swirl foreach my $check (@tree_check) { 5311ec3f6f9SBlue Swirl if (! -e $root . '/' . $check) { 5321ec3f6f9SBlue Swirl return 0; 5331ec3f6f9SBlue Swirl } 5341ec3f6f9SBlue Swirl } 5351ec3f6f9SBlue Swirl return 1; 5361ec3f6f9SBlue Swirl} 5371ec3f6f9SBlue Swirl 538e072af19SZhao Liusub which { 539e072af19SZhao Liu my ($bin) = @_; 540e072af19SZhao Liu 541e072af19SZhao Liu foreach my $path (split(/:/, $ENV{PATH})) { 542e072af19SZhao Liu if (-e "$path/$bin") { 543e072af19SZhao Liu return "$path/$bin"; 544e072af19SZhao Liu } 545e072af19SZhao Liu } 546e072af19SZhao Liu 547e072af19SZhao Liu return ""; 548e072af19SZhao Liu} 549e072af19SZhao Liu 5501ec3f6f9SBlue Swirlsub expand_tabs { 5511ec3f6f9SBlue Swirl my ($str) = @_; 5521ec3f6f9SBlue Swirl 5531ec3f6f9SBlue Swirl my $res = ''; 5541ec3f6f9SBlue Swirl my $n = 0; 5551ec3f6f9SBlue Swirl for my $c (split(//, $str)) { 5561ec3f6f9SBlue Swirl if ($c eq "\t") { 5571ec3f6f9SBlue Swirl $res .= ' '; 5581ec3f6f9SBlue Swirl $n++; 5591ec3f6f9SBlue Swirl for (; ($n % 8) != 0; $n++) { 5601ec3f6f9SBlue Swirl $res .= ' '; 5611ec3f6f9SBlue Swirl } 5621ec3f6f9SBlue Swirl next; 5631ec3f6f9SBlue Swirl } 5641ec3f6f9SBlue Swirl $res .= $c; 5651ec3f6f9SBlue Swirl $n++; 5661ec3f6f9SBlue Swirl } 5671ec3f6f9SBlue Swirl 5681ec3f6f9SBlue Swirl return $res; 5691ec3f6f9SBlue Swirl} 5701ec3f6f9SBlue Swirlsub copy_spacing { 5711ec3f6f9SBlue Swirl (my $res = shift) =~ tr/\t/ /c; 5721ec3f6f9SBlue Swirl return $res; 5731ec3f6f9SBlue Swirl} 5741ec3f6f9SBlue Swirl 5751ec3f6f9SBlue Swirlsub line_stats { 5761ec3f6f9SBlue Swirl my ($line) = @_; 5771ec3f6f9SBlue Swirl 5781ec3f6f9SBlue Swirl # Drop the diff line leader and expand tabs 5791ec3f6f9SBlue Swirl $line =~ s/^.//; 5801ec3f6f9SBlue Swirl $line = expand_tabs($line); 5811ec3f6f9SBlue Swirl 5821ec3f6f9SBlue Swirl # Pick the indent from the front of the line. 5831ec3f6f9SBlue Swirl my ($white) = ($line =~ /^(\s*)/); 5841ec3f6f9SBlue Swirl 5851ec3f6f9SBlue Swirl return (length($line), length($white)); 5861ec3f6f9SBlue Swirl} 5871ec3f6f9SBlue Swirl 5881ec3f6f9SBlue Swirlmy $sanitise_quote = ''; 5891ec3f6f9SBlue Swirl 5901ec3f6f9SBlue Swirlsub sanitise_line_reset { 5911ec3f6f9SBlue Swirl my ($in_comment) = @_; 5921ec3f6f9SBlue Swirl 5931ec3f6f9SBlue Swirl if ($in_comment) { 5941ec3f6f9SBlue Swirl $sanitise_quote = '*/'; 5951ec3f6f9SBlue Swirl } else { 5961ec3f6f9SBlue Swirl $sanitise_quote = ''; 5971ec3f6f9SBlue Swirl } 5981ec3f6f9SBlue Swirl} 5991ec3f6f9SBlue Swirlsub sanitise_line { 6001ec3f6f9SBlue Swirl my ($line) = @_; 6011ec3f6f9SBlue Swirl 6021ec3f6f9SBlue Swirl my $res = ''; 6031ec3f6f9SBlue Swirl my $l = ''; 6041ec3f6f9SBlue Swirl 6051ec3f6f9SBlue Swirl my $qlen = 0; 6061ec3f6f9SBlue Swirl my $off = 0; 6071ec3f6f9SBlue Swirl my $c; 6081ec3f6f9SBlue Swirl 6091ec3f6f9SBlue Swirl # Always copy over the diff marker. 6101ec3f6f9SBlue Swirl $res = substr($line, 0, 1); 6111ec3f6f9SBlue Swirl 6121ec3f6f9SBlue Swirl for ($off = 1; $off < length($line); $off++) { 6131ec3f6f9SBlue Swirl $c = substr($line, $off, 1); 6141ec3f6f9SBlue Swirl 615cb8d4c8fSStefan Weil # Comments we are wacking completely including the begin 6161ec3f6f9SBlue Swirl # and end, all to $;. 6171ec3f6f9SBlue Swirl if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 6181ec3f6f9SBlue Swirl $sanitise_quote = '*/'; 6191ec3f6f9SBlue Swirl 6201ec3f6f9SBlue Swirl substr($res, $off, 2, "$;$;"); 6211ec3f6f9SBlue Swirl $off++; 6221ec3f6f9SBlue Swirl next; 6231ec3f6f9SBlue Swirl } 6241ec3f6f9SBlue Swirl if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 6251ec3f6f9SBlue Swirl $sanitise_quote = ''; 6261ec3f6f9SBlue Swirl substr($res, $off, 2, "$;$;"); 6271ec3f6f9SBlue Swirl $off++; 6281ec3f6f9SBlue Swirl next; 6291ec3f6f9SBlue Swirl } 6301ec3f6f9SBlue Swirl if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 6311ec3f6f9SBlue Swirl $sanitise_quote = '//'; 6321ec3f6f9SBlue Swirl 6331ec3f6f9SBlue Swirl substr($res, $off, 2, $sanitise_quote); 6341ec3f6f9SBlue Swirl $off++; 6351ec3f6f9SBlue Swirl next; 6361ec3f6f9SBlue Swirl } 6371ec3f6f9SBlue Swirl 6381ec3f6f9SBlue Swirl # A \ in a string means ignore the next character. 6391ec3f6f9SBlue Swirl if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 6401ec3f6f9SBlue Swirl $c eq "\\") { 6411ec3f6f9SBlue Swirl substr($res, $off, 2, 'XX'); 6421ec3f6f9SBlue Swirl $off++; 6431ec3f6f9SBlue Swirl next; 6441ec3f6f9SBlue Swirl } 6451ec3f6f9SBlue Swirl # Regular quotes. 6461ec3f6f9SBlue Swirl if ($c eq "'" || $c eq '"') { 6471ec3f6f9SBlue Swirl if ($sanitise_quote eq '') { 6481ec3f6f9SBlue Swirl $sanitise_quote = $c; 6491ec3f6f9SBlue Swirl 6501ec3f6f9SBlue Swirl substr($res, $off, 1, $c); 6511ec3f6f9SBlue Swirl next; 6521ec3f6f9SBlue Swirl } elsif ($sanitise_quote eq $c) { 6531ec3f6f9SBlue Swirl $sanitise_quote = ''; 6541ec3f6f9SBlue Swirl } 6551ec3f6f9SBlue Swirl } 6561ec3f6f9SBlue Swirl 6571ec3f6f9SBlue Swirl #print "c<$c> SQ<$sanitise_quote>\n"; 6581ec3f6f9SBlue Swirl if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 6591ec3f6f9SBlue Swirl substr($res, $off, 1, $;); 6601ec3f6f9SBlue Swirl } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 6611ec3f6f9SBlue Swirl substr($res, $off, 1, $;); 6621ec3f6f9SBlue Swirl } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 6631ec3f6f9SBlue Swirl substr($res, $off, 1, 'X'); 6641ec3f6f9SBlue Swirl } else { 6651ec3f6f9SBlue Swirl substr($res, $off, 1, $c); 6661ec3f6f9SBlue Swirl } 6671ec3f6f9SBlue Swirl } 6681ec3f6f9SBlue Swirl 6691ec3f6f9SBlue Swirl if ($sanitise_quote eq '//') { 6701ec3f6f9SBlue Swirl $sanitise_quote = ''; 6711ec3f6f9SBlue Swirl } 6721ec3f6f9SBlue Swirl 6731ec3f6f9SBlue Swirl # The pathname on a #include may be surrounded by '<' and '>'. 6741ec3f6f9SBlue Swirl if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 6751ec3f6f9SBlue Swirl my $clean = 'X' x length($1); 6761ec3f6f9SBlue Swirl $res =~ s@\<.*\>@<$clean>@; 6771ec3f6f9SBlue Swirl 6781ec3f6f9SBlue Swirl # The whole of a #error is a string. 6791ec3f6f9SBlue Swirl } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 6801ec3f6f9SBlue Swirl my $clean = 'X' x length($1); 6811ec3f6f9SBlue Swirl $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 6821ec3f6f9SBlue Swirl } 6831ec3f6f9SBlue Swirl 6841ec3f6f9SBlue Swirl return $res; 6851ec3f6f9SBlue Swirl} 6861ec3f6f9SBlue Swirl 6871ec3f6f9SBlue Swirlsub ctx_statement_block { 6881ec3f6f9SBlue Swirl my ($linenr, $remain, $off) = @_; 6891ec3f6f9SBlue Swirl my $line = $linenr - 1; 6901ec3f6f9SBlue Swirl my $blk = ''; 6911ec3f6f9SBlue Swirl my $soff = $off; 6921ec3f6f9SBlue Swirl my $coff = $off - 1; 6931ec3f6f9SBlue Swirl my $coff_set = 0; 6941ec3f6f9SBlue Swirl 6951ec3f6f9SBlue Swirl my $loff = 0; 6961ec3f6f9SBlue Swirl 6971ec3f6f9SBlue Swirl my $type = ''; 6981ec3f6f9SBlue Swirl my $level = 0; 6991ec3f6f9SBlue Swirl my @stack = (); 7001ec3f6f9SBlue Swirl my $p; 7011ec3f6f9SBlue Swirl my $c; 7021ec3f6f9SBlue Swirl my $len = 0; 7031ec3f6f9SBlue Swirl 7041ec3f6f9SBlue Swirl my $remainder; 7051ec3f6f9SBlue Swirl while (1) { 7061ec3f6f9SBlue Swirl @stack = (['', 0]) if ($#stack == -1); 7071ec3f6f9SBlue Swirl 7081ec3f6f9SBlue Swirl #warn "CSB: blk<$blk> remain<$remain>\n"; 7091ec3f6f9SBlue Swirl # If we are about to drop off the end, pull in more 7101ec3f6f9SBlue Swirl # context. 7111ec3f6f9SBlue Swirl if ($off >= $len) { 7121ec3f6f9SBlue Swirl for (; $remain > 0; $line++) { 7131ec3f6f9SBlue Swirl last if (!defined $lines[$line]); 7141ec3f6f9SBlue Swirl next if ($lines[$line] =~ /^-/); 7151ec3f6f9SBlue Swirl $remain--; 7161ec3f6f9SBlue Swirl $loff = $len; 7171ec3f6f9SBlue Swirl $blk .= $lines[$line] . "\n"; 7181ec3f6f9SBlue Swirl $len = length($blk); 7191ec3f6f9SBlue Swirl $line++; 7201ec3f6f9SBlue Swirl last; 7211ec3f6f9SBlue Swirl } 7221ec3f6f9SBlue Swirl # Bail if there is no further context. 7231ec3f6f9SBlue Swirl #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 7241ec3f6f9SBlue Swirl if ($off >= $len) { 7251ec3f6f9SBlue Swirl last; 7261ec3f6f9SBlue Swirl } 7271ec3f6f9SBlue Swirl } 7281ec3f6f9SBlue Swirl $p = $c; 7291ec3f6f9SBlue Swirl $c = substr($blk, $off, 1); 7301ec3f6f9SBlue Swirl $remainder = substr($blk, $off); 7311ec3f6f9SBlue Swirl 7321ec3f6f9SBlue Swirl #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 7331ec3f6f9SBlue Swirl 7341ec3f6f9SBlue Swirl # Handle nested #if/#else. 7351ec3f6f9SBlue Swirl if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 7361ec3f6f9SBlue Swirl push(@stack, [ $type, $level ]); 7371ec3f6f9SBlue Swirl } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 7381ec3f6f9SBlue Swirl ($type, $level) = @{$stack[$#stack - 1]}; 7391ec3f6f9SBlue Swirl } elsif ($remainder =~ /^#\s*endif\b/) { 7401ec3f6f9SBlue Swirl ($type, $level) = @{pop(@stack)}; 7411ec3f6f9SBlue Swirl } 7421ec3f6f9SBlue Swirl 7431ec3f6f9SBlue Swirl # Statement ends at the ';' or a close '}' at the 7441ec3f6f9SBlue Swirl # outermost level. 7451ec3f6f9SBlue Swirl if ($level == 0 && $c eq ';') { 7461ec3f6f9SBlue Swirl last; 7471ec3f6f9SBlue Swirl } 7481ec3f6f9SBlue Swirl 7491ec3f6f9SBlue Swirl # An else is really a conditional as long as its not else if 7501ec3f6f9SBlue Swirl if ($level == 0 && $coff_set == 0 && 7511ec3f6f9SBlue Swirl (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 7521ec3f6f9SBlue Swirl $remainder =~ /^(else)(?:\s|{)/ && 7531ec3f6f9SBlue Swirl $remainder !~ /^else\s+if\b/) { 7541ec3f6f9SBlue Swirl $coff = $off + length($1) - 1; 7551ec3f6f9SBlue Swirl $coff_set = 1; 7561ec3f6f9SBlue Swirl #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 7571ec3f6f9SBlue Swirl #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 7581ec3f6f9SBlue Swirl } 7591ec3f6f9SBlue Swirl 7601ec3f6f9SBlue Swirl if (($type eq '' || $type eq '(') && $c eq '(') { 7611ec3f6f9SBlue Swirl $level++; 7621ec3f6f9SBlue Swirl $type = '('; 7631ec3f6f9SBlue Swirl } 7641ec3f6f9SBlue Swirl if ($type eq '(' && $c eq ')') { 7651ec3f6f9SBlue Swirl $level--; 7661ec3f6f9SBlue Swirl $type = ($level != 0)? '(' : ''; 7671ec3f6f9SBlue Swirl 7681ec3f6f9SBlue Swirl if ($level == 0 && $coff < $soff) { 7691ec3f6f9SBlue Swirl $coff = $off; 7701ec3f6f9SBlue Swirl $coff_set = 1; 7711ec3f6f9SBlue Swirl #warn "CSB: mark coff<$coff>\n"; 7721ec3f6f9SBlue Swirl } 7731ec3f6f9SBlue Swirl } 7741ec3f6f9SBlue Swirl if (($type eq '' || $type eq '{') && $c eq '{') { 7751ec3f6f9SBlue Swirl $level++; 7761ec3f6f9SBlue Swirl $type = '{'; 7771ec3f6f9SBlue Swirl } 7781ec3f6f9SBlue Swirl if ($type eq '{' && $c eq '}') { 7791ec3f6f9SBlue Swirl $level--; 7801ec3f6f9SBlue Swirl $type = ($level != 0)? '{' : ''; 7811ec3f6f9SBlue Swirl 7821ec3f6f9SBlue Swirl if ($level == 0) { 7831ec3f6f9SBlue Swirl if (substr($blk, $off + 1, 1) eq ';') { 7841ec3f6f9SBlue Swirl $off++; 7851ec3f6f9SBlue Swirl } 7861ec3f6f9SBlue Swirl last; 7871ec3f6f9SBlue Swirl } 7881ec3f6f9SBlue Swirl } 7891ec3f6f9SBlue Swirl $off++; 7901ec3f6f9SBlue Swirl } 7911ec3f6f9SBlue Swirl # We are truly at the end, so shuffle to the next line. 7921ec3f6f9SBlue Swirl if ($off == $len) { 7931ec3f6f9SBlue Swirl $loff = $len + 1; 7941ec3f6f9SBlue Swirl $line++; 7951ec3f6f9SBlue Swirl $remain--; 7961ec3f6f9SBlue Swirl } 7971ec3f6f9SBlue Swirl 7981ec3f6f9SBlue Swirl my $statement = substr($blk, $soff, $off - $soff + 1); 7991ec3f6f9SBlue Swirl my $condition = substr($blk, $soff, $coff - $soff + 1); 8001ec3f6f9SBlue Swirl 8011ec3f6f9SBlue Swirl #warn "STATEMENT<$statement>\n"; 8021ec3f6f9SBlue Swirl #warn "CONDITION<$condition>\n"; 8031ec3f6f9SBlue Swirl 8041ec3f6f9SBlue Swirl #print "coff<$coff> soff<$off> loff<$loff>\n"; 8051ec3f6f9SBlue Swirl 8061ec3f6f9SBlue Swirl return ($statement, $condition, 8071ec3f6f9SBlue Swirl $line, $remain + 1, $off - $loff + 1, $level); 8081ec3f6f9SBlue Swirl} 8091ec3f6f9SBlue Swirl 8101ec3f6f9SBlue Swirlsub statement_lines { 8111ec3f6f9SBlue Swirl my ($stmt) = @_; 8121ec3f6f9SBlue Swirl 8131ec3f6f9SBlue Swirl # Strip the diff line prefixes and rip blank lines at start and end. 8141ec3f6f9SBlue Swirl $stmt =~ s/(^|\n)./$1/g; 8151ec3f6f9SBlue Swirl $stmt =~ s/^\s*//; 8161ec3f6f9SBlue Swirl $stmt =~ s/\s*$//; 8171ec3f6f9SBlue Swirl 8181ec3f6f9SBlue Swirl my @stmt_lines = ($stmt =~ /\n/g); 8191ec3f6f9SBlue Swirl 8201ec3f6f9SBlue Swirl return $#stmt_lines + 2; 8211ec3f6f9SBlue Swirl} 8221ec3f6f9SBlue Swirl 8231ec3f6f9SBlue Swirlsub statement_rawlines { 8241ec3f6f9SBlue Swirl my ($stmt) = @_; 8251ec3f6f9SBlue Swirl 8261ec3f6f9SBlue Swirl my @stmt_lines = ($stmt =~ /\n/g); 8271ec3f6f9SBlue Swirl 8281ec3f6f9SBlue Swirl return $#stmt_lines + 2; 8291ec3f6f9SBlue Swirl} 8301ec3f6f9SBlue Swirl 8311ec3f6f9SBlue Swirlsub statement_block_size { 8321ec3f6f9SBlue Swirl my ($stmt) = @_; 8331ec3f6f9SBlue Swirl 8341ec3f6f9SBlue Swirl $stmt =~ s/(^|\n)./$1/g; 83504f2562fSFam Zheng $stmt =~ s/^\s*\{//; 8361ec3f6f9SBlue Swirl $stmt =~ s/}\s*$//; 8371ec3f6f9SBlue Swirl $stmt =~ s/^\s*//; 8381ec3f6f9SBlue Swirl $stmt =~ s/\s*$//; 8391ec3f6f9SBlue Swirl 8401ec3f6f9SBlue Swirl my @stmt_lines = ($stmt =~ /\n/g); 8411ec3f6f9SBlue Swirl my @stmt_statements = ($stmt =~ /;/g); 8421ec3f6f9SBlue Swirl 8431ec3f6f9SBlue Swirl my $stmt_lines = $#stmt_lines + 2; 8441ec3f6f9SBlue Swirl my $stmt_statements = $#stmt_statements + 1; 8451ec3f6f9SBlue Swirl 8461ec3f6f9SBlue Swirl if ($stmt_lines > $stmt_statements) { 8471ec3f6f9SBlue Swirl return $stmt_lines; 8481ec3f6f9SBlue Swirl } else { 8491ec3f6f9SBlue Swirl return $stmt_statements; 8501ec3f6f9SBlue Swirl } 8511ec3f6f9SBlue Swirl} 8521ec3f6f9SBlue Swirl 8531ec3f6f9SBlue Swirlsub ctx_statement_full { 8541ec3f6f9SBlue Swirl my ($linenr, $remain, $off) = @_; 8551ec3f6f9SBlue Swirl my ($statement, $condition, $level); 8561ec3f6f9SBlue Swirl 8571ec3f6f9SBlue Swirl my (@chunks); 8581ec3f6f9SBlue Swirl 8591ec3f6f9SBlue Swirl # Grab the first conditional/block pair. 8601ec3f6f9SBlue Swirl ($statement, $condition, $linenr, $remain, $off, $level) = 8611ec3f6f9SBlue Swirl ctx_statement_block($linenr, $remain, $off); 8621ec3f6f9SBlue Swirl #print "F: c<$condition> s<$statement> remain<$remain>\n"; 8631ec3f6f9SBlue Swirl push(@chunks, [ $condition, $statement ]); 8641ec3f6f9SBlue Swirl if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 8651ec3f6f9SBlue Swirl return ($level, $linenr, @chunks); 8661ec3f6f9SBlue Swirl } 8671ec3f6f9SBlue Swirl 8681ec3f6f9SBlue Swirl # Pull in the following conditional/block pairs and see if they 8691ec3f6f9SBlue Swirl # could continue the statement. 8701ec3f6f9SBlue Swirl for (;;) { 8711ec3f6f9SBlue Swirl ($statement, $condition, $linenr, $remain, $off, $level) = 8721ec3f6f9SBlue Swirl ctx_statement_block($linenr, $remain, $off); 8731ec3f6f9SBlue Swirl #print "C: c<$condition> s<$statement> remain<$remain>\n"; 8741ec3f6f9SBlue Swirl last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 8751ec3f6f9SBlue Swirl #print "C: push\n"; 8761ec3f6f9SBlue Swirl push(@chunks, [ $condition, $statement ]); 8771ec3f6f9SBlue Swirl } 8781ec3f6f9SBlue Swirl 8791ec3f6f9SBlue Swirl return ($level, $linenr, @chunks); 8801ec3f6f9SBlue Swirl} 8811ec3f6f9SBlue Swirl 8821ec3f6f9SBlue Swirlsub ctx_block_get { 8831ec3f6f9SBlue Swirl my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8841ec3f6f9SBlue Swirl my $line; 8851ec3f6f9SBlue Swirl my $start = $linenr - 1; 8861ec3f6f9SBlue Swirl my $blk = ''; 8871ec3f6f9SBlue Swirl my @o; 8881ec3f6f9SBlue Swirl my @c; 8891ec3f6f9SBlue Swirl my @res = (); 8901ec3f6f9SBlue Swirl 8911ec3f6f9SBlue Swirl my $level = 0; 8921ec3f6f9SBlue Swirl my @stack = ($level); 8931ec3f6f9SBlue Swirl for ($line = $start; $remain > 0; $line++) { 8941ec3f6f9SBlue Swirl next if ($rawlines[$line] =~ /^-/); 8951ec3f6f9SBlue Swirl $remain--; 8961ec3f6f9SBlue Swirl 8971ec3f6f9SBlue Swirl $blk .= $rawlines[$line]; 8981ec3f6f9SBlue Swirl 8991ec3f6f9SBlue Swirl # Handle nested #if/#else. 9001ec3f6f9SBlue Swirl if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 9011ec3f6f9SBlue Swirl push(@stack, $level); 9021ec3f6f9SBlue Swirl } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 9031ec3f6f9SBlue Swirl $level = $stack[$#stack - 1]; 9041ec3f6f9SBlue Swirl } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 9051ec3f6f9SBlue Swirl $level = pop(@stack); 9061ec3f6f9SBlue Swirl } 9071ec3f6f9SBlue Swirl 9081ec3f6f9SBlue Swirl foreach my $c (split(//, $lines[$line])) { 9091ec3f6f9SBlue Swirl ##print "C<$c>L<$level><$open$close>O<$off>\n"; 9101ec3f6f9SBlue Swirl if ($off > 0) { 9111ec3f6f9SBlue Swirl $off--; 9121ec3f6f9SBlue Swirl next; 9131ec3f6f9SBlue Swirl } 9141ec3f6f9SBlue Swirl 9151ec3f6f9SBlue Swirl if ($c eq $close && $level > 0) { 9161ec3f6f9SBlue Swirl $level--; 9171ec3f6f9SBlue Swirl last if ($level == 0); 9181ec3f6f9SBlue Swirl } elsif ($c eq $open) { 9191ec3f6f9SBlue Swirl $level++; 9201ec3f6f9SBlue Swirl } 9211ec3f6f9SBlue Swirl } 9221ec3f6f9SBlue Swirl 9231ec3f6f9SBlue Swirl if (!$outer || $level <= 1) { 9241ec3f6f9SBlue Swirl push(@res, $rawlines[$line]); 9251ec3f6f9SBlue Swirl } 9261ec3f6f9SBlue Swirl 9271ec3f6f9SBlue Swirl last if ($level == 0); 9281ec3f6f9SBlue Swirl } 9291ec3f6f9SBlue Swirl 9301ec3f6f9SBlue Swirl return ($level, @res); 9311ec3f6f9SBlue Swirl} 9321ec3f6f9SBlue Swirlsub ctx_block_outer { 9331ec3f6f9SBlue Swirl my ($linenr, $remain) = @_; 9341ec3f6f9SBlue Swirl 9351ec3f6f9SBlue Swirl my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 9361ec3f6f9SBlue Swirl return @r; 9371ec3f6f9SBlue Swirl} 9381ec3f6f9SBlue Swirlsub ctx_block { 9391ec3f6f9SBlue Swirl my ($linenr, $remain) = @_; 9401ec3f6f9SBlue Swirl 9411ec3f6f9SBlue Swirl my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9421ec3f6f9SBlue Swirl return @r; 9431ec3f6f9SBlue Swirl} 9441ec3f6f9SBlue Swirlsub ctx_statement { 9451ec3f6f9SBlue Swirl my ($linenr, $remain, $off) = @_; 9461ec3f6f9SBlue Swirl 9471ec3f6f9SBlue Swirl my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9481ec3f6f9SBlue Swirl return @r; 9491ec3f6f9SBlue Swirl} 9501ec3f6f9SBlue Swirlsub ctx_block_level { 9511ec3f6f9SBlue Swirl my ($linenr, $remain) = @_; 9521ec3f6f9SBlue Swirl 9531ec3f6f9SBlue Swirl return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9541ec3f6f9SBlue Swirl} 9551ec3f6f9SBlue Swirlsub ctx_statement_level { 9561ec3f6f9SBlue Swirl my ($linenr, $remain, $off) = @_; 9571ec3f6f9SBlue Swirl 9581ec3f6f9SBlue Swirl return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9591ec3f6f9SBlue Swirl} 9601ec3f6f9SBlue Swirl 9611ec3f6f9SBlue Swirlsub ctx_locate_comment { 9621ec3f6f9SBlue Swirl my ($first_line, $end_line) = @_; 9631ec3f6f9SBlue Swirl 9641ec3f6f9SBlue Swirl # Catch a comment on the end of the line itself. 9651ec3f6f9SBlue Swirl my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9661ec3f6f9SBlue Swirl return $current_comment if (defined $current_comment); 9671ec3f6f9SBlue Swirl 9681ec3f6f9SBlue Swirl # Look through the context and try and figure out if there is a 9691ec3f6f9SBlue Swirl # comment. 9701ec3f6f9SBlue Swirl my $in_comment = 0; 9711ec3f6f9SBlue Swirl $current_comment = ''; 9721ec3f6f9SBlue Swirl for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 9731ec3f6f9SBlue Swirl my $line = $rawlines[$linenr - 1]; 9741ec3f6f9SBlue Swirl #warn " $line\n"; 9751ec3f6f9SBlue Swirl if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9761ec3f6f9SBlue Swirl $in_comment = 1; 9771ec3f6f9SBlue Swirl } 9781ec3f6f9SBlue Swirl if ($line =~ m@/\*@) { 9791ec3f6f9SBlue Swirl $in_comment = 1; 9801ec3f6f9SBlue Swirl } 9811ec3f6f9SBlue Swirl if (!$in_comment && $current_comment ne '') { 9821ec3f6f9SBlue Swirl $current_comment = ''; 9831ec3f6f9SBlue Swirl } 9841ec3f6f9SBlue Swirl $current_comment .= $line . "\n" if ($in_comment); 9851ec3f6f9SBlue Swirl if ($line =~ m@\*/@) { 9861ec3f6f9SBlue Swirl $in_comment = 0; 9871ec3f6f9SBlue Swirl } 9881ec3f6f9SBlue Swirl } 9891ec3f6f9SBlue Swirl 9901ec3f6f9SBlue Swirl chomp($current_comment); 9911ec3f6f9SBlue Swirl return($current_comment); 9921ec3f6f9SBlue Swirl} 9931ec3f6f9SBlue Swirlsub ctx_has_comment { 9941ec3f6f9SBlue Swirl my ($first_line, $end_line) = @_; 9951ec3f6f9SBlue Swirl my $cmt = ctx_locate_comment($first_line, $end_line); 9961ec3f6f9SBlue Swirl 9971ec3f6f9SBlue Swirl ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9981ec3f6f9SBlue Swirl ##print "CMMT: $cmt\n"; 9991ec3f6f9SBlue Swirl 10001ec3f6f9SBlue Swirl return ($cmt ne ''); 10011ec3f6f9SBlue Swirl} 10021ec3f6f9SBlue Swirl 10031ec3f6f9SBlue Swirlsub raw_line { 10041ec3f6f9SBlue Swirl my ($linenr, $cnt) = @_; 10051ec3f6f9SBlue Swirl 10061ec3f6f9SBlue Swirl my $offset = $linenr - 1; 10071ec3f6f9SBlue Swirl $cnt++; 10081ec3f6f9SBlue Swirl 10091ec3f6f9SBlue Swirl my $line; 10101ec3f6f9SBlue Swirl while ($cnt) { 10111ec3f6f9SBlue Swirl $line = $rawlines[$offset++]; 10121ec3f6f9SBlue Swirl next if (defined($line) && $line =~ /^-/); 10131ec3f6f9SBlue Swirl $cnt--; 10141ec3f6f9SBlue Swirl } 10151ec3f6f9SBlue Swirl 10161ec3f6f9SBlue Swirl return $line; 10171ec3f6f9SBlue Swirl} 10181ec3f6f9SBlue Swirl 10191ec3f6f9SBlue Swirlsub cat_vet { 10201ec3f6f9SBlue Swirl my ($vet) = @_; 10211ec3f6f9SBlue Swirl my ($res, $coded); 10221ec3f6f9SBlue Swirl 10231ec3f6f9SBlue Swirl $res = ''; 10241ec3f6f9SBlue Swirl while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 10251ec3f6f9SBlue Swirl $res .= $1; 10261ec3f6f9SBlue Swirl if ($2 ne '') { 10271ec3f6f9SBlue Swirl $coded = sprintf("^%c", unpack('C', $2) + 64); 10281ec3f6f9SBlue Swirl $res .= $coded; 10291ec3f6f9SBlue Swirl } 10301ec3f6f9SBlue Swirl } 10311ec3f6f9SBlue Swirl $res =~ s/$/\$/; 10321ec3f6f9SBlue Swirl 10331ec3f6f9SBlue Swirl return $res; 10341ec3f6f9SBlue Swirl} 10351ec3f6f9SBlue Swirl 10361ec3f6f9SBlue Swirlmy $av_preprocessor = 0; 10371ec3f6f9SBlue Swirlmy $av_pending; 10381ec3f6f9SBlue Swirlmy @av_paren_type; 10391ec3f6f9SBlue Swirlmy $av_pend_colon; 10401ec3f6f9SBlue Swirl 10411ec3f6f9SBlue Swirlsub annotate_reset { 10421ec3f6f9SBlue Swirl $av_preprocessor = 0; 10431ec3f6f9SBlue Swirl $av_pending = '_'; 10441ec3f6f9SBlue Swirl @av_paren_type = ('E'); 10451ec3f6f9SBlue Swirl $av_pend_colon = 'O'; 10461ec3f6f9SBlue Swirl} 10471ec3f6f9SBlue Swirl 10481ec3f6f9SBlue Swirlsub annotate_values { 10491ec3f6f9SBlue Swirl my ($stream, $type) = @_; 10501ec3f6f9SBlue Swirl 10511ec3f6f9SBlue Swirl my $res; 10521ec3f6f9SBlue Swirl my $var = '_' x length($stream); 10531ec3f6f9SBlue Swirl my $cur = $stream; 10541ec3f6f9SBlue Swirl 10551ec3f6f9SBlue Swirl print "$stream\n" if ($dbg_values > 1); 10561ec3f6f9SBlue Swirl 10571ec3f6f9SBlue Swirl while (length($cur)) { 10581ec3f6f9SBlue Swirl @av_paren_type = ('E') if ($#av_paren_type < 0); 10591ec3f6f9SBlue Swirl print " <" . join('', @av_paren_type) . 10601ec3f6f9SBlue Swirl "> <$type> <$av_pending>" if ($dbg_values > 1); 10611ec3f6f9SBlue Swirl if ($cur =~ /^(\s+)/o) { 10621ec3f6f9SBlue Swirl print "WS($1)\n" if ($dbg_values > 1); 10631ec3f6f9SBlue Swirl if ($1 =~ /\n/ && $av_preprocessor) { 10641ec3f6f9SBlue Swirl $type = pop(@av_paren_type); 10651ec3f6f9SBlue Swirl $av_preprocessor = 0; 10661ec3f6f9SBlue Swirl } 10671ec3f6f9SBlue Swirl 106861669f9aSFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10691ec3f6f9SBlue Swirl print "CAST($1)\n" if ($dbg_values > 1); 10701ec3f6f9SBlue Swirl push(@av_paren_type, $type); 10711ec3f6f9SBlue Swirl $type = 'C'; 10721ec3f6f9SBlue Swirl 10731ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 10741ec3f6f9SBlue Swirl print "DECLARE($1)\n" if ($dbg_values > 1); 10751ec3f6f9SBlue Swirl $type = 'T'; 10761ec3f6f9SBlue Swirl 10771ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Modifier)\s*/) { 10781ec3f6f9SBlue Swirl print "MODIFIER($1)\n" if ($dbg_values > 1); 10791ec3f6f9SBlue Swirl $type = 'T'; 10801ec3f6f9SBlue Swirl 10811ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 10821ec3f6f9SBlue Swirl print "DEFINE($1,$2)\n" if ($dbg_values > 1); 10831ec3f6f9SBlue Swirl $av_preprocessor = 1; 10841ec3f6f9SBlue Swirl push(@av_paren_type, $type); 10851ec3f6f9SBlue Swirl if ($2 ne '') { 10861ec3f6f9SBlue Swirl $av_pending = 'N'; 10871ec3f6f9SBlue Swirl } 10881ec3f6f9SBlue Swirl $type = 'E'; 10891ec3f6f9SBlue Swirl 10901ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 10911ec3f6f9SBlue Swirl print "UNDEF($1)\n" if ($dbg_values > 1); 10921ec3f6f9SBlue Swirl $av_preprocessor = 1; 10931ec3f6f9SBlue Swirl push(@av_paren_type, $type); 10941ec3f6f9SBlue Swirl 10951ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 10961ec3f6f9SBlue Swirl print "PRE_START($1)\n" if ($dbg_values > 1); 10971ec3f6f9SBlue Swirl $av_preprocessor = 1; 10981ec3f6f9SBlue Swirl 10991ec3f6f9SBlue Swirl push(@av_paren_type, $type); 11001ec3f6f9SBlue Swirl push(@av_paren_type, $type); 11011ec3f6f9SBlue Swirl $type = 'E'; 11021ec3f6f9SBlue Swirl 11031ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 11041ec3f6f9SBlue Swirl print "PRE_RESTART($1)\n" if ($dbg_values > 1); 11051ec3f6f9SBlue Swirl $av_preprocessor = 1; 11061ec3f6f9SBlue Swirl 11071ec3f6f9SBlue Swirl push(@av_paren_type, $av_paren_type[$#av_paren_type]); 11081ec3f6f9SBlue Swirl 11091ec3f6f9SBlue Swirl $type = 'E'; 11101ec3f6f9SBlue Swirl 11111ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 11121ec3f6f9SBlue Swirl print "PRE_END($1)\n" if ($dbg_values > 1); 11131ec3f6f9SBlue Swirl 11141ec3f6f9SBlue Swirl $av_preprocessor = 1; 11151ec3f6f9SBlue Swirl 11161ec3f6f9SBlue Swirl # Assume all arms of the conditional end as this 11171ec3f6f9SBlue Swirl # one does, and continue as if the #endif was not here. 11181ec3f6f9SBlue Swirl pop(@av_paren_type); 11191ec3f6f9SBlue Swirl push(@av_paren_type, $type); 11201ec3f6f9SBlue Swirl $type = 'E'; 11211ec3f6f9SBlue Swirl 11221ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\\\n)/o) { 11231ec3f6f9SBlue Swirl print "PRECONT($1)\n" if ($dbg_values > 1); 11241ec3f6f9SBlue Swirl 11251ec3f6f9SBlue Swirl } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 11261ec3f6f9SBlue Swirl print "ATTR($1)\n" if ($dbg_values > 1); 11271ec3f6f9SBlue Swirl $av_pending = $type; 11281ec3f6f9SBlue Swirl $type = 'N'; 11291ec3f6f9SBlue Swirl 11301ec3f6f9SBlue Swirl } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 11311ec3f6f9SBlue Swirl print "SIZEOF($1)\n" if ($dbg_values > 1); 11321ec3f6f9SBlue Swirl if (defined $2) { 11331ec3f6f9SBlue Swirl $av_pending = 'V'; 11341ec3f6f9SBlue Swirl } 11351ec3f6f9SBlue Swirl $type = 'N'; 11361ec3f6f9SBlue Swirl 11371ec3f6f9SBlue Swirl } elsif ($cur =~ /^(if|while|for)\b/o) { 11381ec3f6f9SBlue Swirl print "COND($1)\n" if ($dbg_values > 1); 11391ec3f6f9SBlue Swirl $av_pending = 'E'; 11401ec3f6f9SBlue Swirl $type = 'N'; 11411ec3f6f9SBlue Swirl 11421ec3f6f9SBlue Swirl } elsif ($cur =~/^(case)/o) { 11431ec3f6f9SBlue Swirl print "CASE($1)\n" if ($dbg_values > 1); 11441ec3f6f9SBlue Swirl $av_pend_colon = 'C'; 11451ec3f6f9SBlue Swirl $type = 'N'; 11461ec3f6f9SBlue Swirl 11471ec3f6f9SBlue Swirl } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 11481ec3f6f9SBlue Swirl print "KEYWORD($1)\n" if ($dbg_values > 1); 11491ec3f6f9SBlue Swirl $type = 'N'; 11501ec3f6f9SBlue Swirl 11511ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\()/o) { 11521ec3f6f9SBlue Swirl print "PAREN('$1')\n" if ($dbg_values > 1); 11531ec3f6f9SBlue Swirl push(@av_paren_type, $av_pending); 11541ec3f6f9SBlue Swirl $av_pending = '_'; 11551ec3f6f9SBlue Swirl $type = 'N'; 11561ec3f6f9SBlue Swirl 11571ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\))/o) { 11581ec3f6f9SBlue Swirl my $new_type = pop(@av_paren_type); 11591ec3f6f9SBlue Swirl if ($new_type ne '_') { 11601ec3f6f9SBlue Swirl $type = $new_type; 11611ec3f6f9SBlue Swirl print "PAREN('$1') -> $type\n" 11621ec3f6f9SBlue Swirl if ($dbg_values > 1); 11631ec3f6f9SBlue Swirl } else { 11641ec3f6f9SBlue Swirl print "PAREN('$1')\n" if ($dbg_values > 1); 11651ec3f6f9SBlue Swirl } 11661ec3f6f9SBlue Swirl 11671ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Ident)\s*\(/o) { 11681ec3f6f9SBlue Swirl print "FUNC($1)\n" if ($dbg_values > 1); 11691ec3f6f9SBlue Swirl $type = 'V'; 11701ec3f6f9SBlue Swirl $av_pending = 'V'; 11711ec3f6f9SBlue Swirl 11721ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11731ec3f6f9SBlue Swirl if (defined $2 && $type eq 'C' || $type eq 'T') { 11741ec3f6f9SBlue Swirl $av_pend_colon = 'B'; 11751ec3f6f9SBlue Swirl } elsif ($type eq 'E') { 11761ec3f6f9SBlue Swirl $av_pend_colon = 'L'; 11771ec3f6f9SBlue Swirl } 11781ec3f6f9SBlue Swirl print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11791ec3f6f9SBlue Swirl $type = 'V'; 11801ec3f6f9SBlue Swirl 11811ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Ident|$Constant)/o) { 11821ec3f6f9SBlue Swirl print "IDENT($1)\n" if ($dbg_values > 1); 11831ec3f6f9SBlue Swirl $type = 'V'; 11841ec3f6f9SBlue Swirl 11851ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Assignment)/o) { 11861ec3f6f9SBlue Swirl print "ASSIGN($1)\n" if ($dbg_values > 1); 11871ec3f6f9SBlue Swirl $type = 'N'; 11881ec3f6f9SBlue Swirl 11891ec3f6f9SBlue Swirl } elsif ($cur =~/^(;|{|})/) { 11901ec3f6f9SBlue Swirl print "END($1)\n" if ($dbg_values > 1); 11911ec3f6f9SBlue Swirl $type = 'E'; 11921ec3f6f9SBlue Swirl $av_pend_colon = 'O'; 11931ec3f6f9SBlue Swirl 11941ec3f6f9SBlue Swirl } elsif ($cur =~/^(,)/) { 11951ec3f6f9SBlue Swirl print "COMMA($1)\n" if ($dbg_values > 1); 11961ec3f6f9SBlue Swirl $type = 'C'; 11971ec3f6f9SBlue Swirl 11981ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\?)/o) { 11991ec3f6f9SBlue Swirl print "QUESTION($1)\n" if ($dbg_values > 1); 12001ec3f6f9SBlue Swirl $type = 'N'; 12011ec3f6f9SBlue Swirl 12021ec3f6f9SBlue Swirl } elsif ($cur =~ /^(:)/o) { 12031ec3f6f9SBlue Swirl print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 12041ec3f6f9SBlue Swirl 12051ec3f6f9SBlue Swirl substr($var, length($res), 1, $av_pend_colon); 12061ec3f6f9SBlue Swirl if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 12071ec3f6f9SBlue Swirl $type = 'E'; 12081ec3f6f9SBlue Swirl } else { 12091ec3f6f9SBlue Swirl $type = 'N'; 12101ec3f6f9SBlue Swirl } 12111ec3f6f9SBlue Swirl $av_pend_colon = 'O'; 12121ec3f6f9SBlue Swirl 12131ec3f6f9SBlue Swirl } elsif ($cur =~ /^(\[)/o) { 12141ec3f6f9SBlue Swirl print "CLOSE($1)\n" if ($dbg_values > 1); 12151ec3f6f9SBlue Swirl $type = 'N'; 12161ec3f6f9SBlue Swirl 12171ec3f6f9SBlue Swirl } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 12181ec3f6f9SBlue Swirl my $variant; 12191ec3f6f9SBlue Swirl 12201ec3f6f9SBlue Swirl print "OPV($1)\n" if ($dbg_values > 1); 12211ec3f6f9SBlue Swirl if ($type eq 'V') { 12221ec3f6f9SBlue Swirl $variant = 'B'; 12231ec3f6f9SBlue Swirl } else { 12241ec3f6f9SBlue Swirl $variant = 'U'; 12251ec3f6f9SBlue Swirl } 12261ec3f6f9SBlue Swirl 12271ec3f6f9SBlue Swirl substr($var, length($res), 1, $variant); 12281ec3f6f9SBlue Swirl $type = 'N'; 12291ec3f6f9SBlue Swirl 12301ec3f6f9SBlue Swirl } elsif ($cur =~ /^($Operators)/o) { 12311ec3f6f9SBlue Swirl print "OP($1)\n" if ($dbg_values > 1); 12321ec3f6f9SBlue Swirl if ($1 ne '++' && $1 ne '--') { 12331ec3f6f9SBlue Swirl $type = 'N'; 12341ec3f6f9SBlue Swirl } 12351ec3f6f9SBlue Swirl 12361ec3f6f9SBlue Swirl } elsif ($cur =~ /(^.)/o) { 12371ec3f6f9SBlue Swirl print "C($1)\n" if ($dbg_values > 1); 12381ec3f6f9SBlue Swirl } 12391ec3f6f9SBlue Swirl if (defined $1) { 12401ec3f6f9SBlue Swirl $cur = substr($cur, length($1)); 12411ec3f6f9SBlue Swirl $res .= $type x length($1); 12421ec3f6f9SBlue Swirl } 12431ec3f6f9SBlue Swirl } 12441ec3f6f9SBlue Swirl 12451ec3f6f9SBlue Swirl return ($res, $var); 12461ec3f6f9SBlue Swirl} 12471ec3f6f9SBlue Swirl 12481ec3f6f9SBlue Swirlsub possible { 12491ec3f6f9SBlue Swirl my ($possible, $line) = @_; 12501ec3f6f9SBlue Swirl my $notPermitted = qr{(?: 12511ec3f6f9SBlue Swirl ^(?: 12521ec3f6f9SBlue Swirl $Modifier| 12531ec3f6f9SBlue Swirl $Storage| 12541ec3f6f9SBlue Swirl $Type| 12551ec3f6f9SBlue Swirl DEFINE_\S+ 12561ec3f6f9SBlue Swirl )$| 12571ec3f6f9SBlue Swirl ^(?: 12581ec3f6f9SBlue Swirl goto| 12591ec3f6f9SBlue Swirl return| 12601ec3f6f9SBlue Swirl case| 12611ec3f6f9SBlue Swirl else| 12621ec3f6f9SBlue Swirl asm|__asm__| 1263e20122ffSPaolo Bonzini do 12641ec3f6f9SBlue Swirl )(?:\s|$)| 1265e20122ffSPaolo Bonzini ^(?:typedef|struct|enum)\b| 1266e20122ffSPaolo Bonzini ^\# 12671ec3f6f9SBlue Swirl )}x; 12681ec3f6f9SBlue Swirl warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12691ec3f6f9SBlue Swirl if ($possible !~ $notPermitted) { 12701ec3f6f9SBlue Swirl # Check for modifiers. 12711ec3f6f9SBlue Swirl $possible =~ s/\s*$Storage\s*//g; 12721ec3f6f9SBlue Swirl $possible =~ s/\s*$Sparse\s*//g; 12731ec3f6f9SBlue Swirl if ($possible =~ /^\s*$/) { 12741ec3f6f9SBlue Swirl 12751ec3f6f9SBlue Swirl } elsif ($possible =~ /\s/) { 1276e20122ffSPaolo Bonzini $possible =~ s/\s*(?:$Type|\#\#)\s*//g; 12771ec3f6f9SBlue Swirl for my $modifier (split(' ', $possible)) { 12781ec3f6f9SBlue Swirl if ($modifier !~ $notPermitted) { 12791ec3f6f9SBlue Swirl warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 12801ec3f6f9SBlue Swirl push(@modifierList, $modifier); 12811ec3f6f9SBlue Swirl } 12821ec3f6f9SBlue Swirl } 12831ec3f6f9SBlue Swirl 12841ec3f6f9SBlue Swirl } else { 12851ec3f6f9SBlue Swirl warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12861ec3f6f9SBlue Swirl push(@typeList, $possible); 12871ec3f6f9SBlue Swirl } 12881ec3f6f9SBlue Swirl build_types(); 12891ec3f6f9SBlue Swirl } else { 12901ec3f6f9SBlue Swirl warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12911ec3f6f9SBlue Swirl } 12921ec3f6f9SBlue Swirl} 12931ec3f6f9SBlue Swirl 12941ec3f6f9SBlue Swirlmy $prefix = ''; 12951ec3f6f9SBlue Swirl 12961ec3f6f9SBlue Swirlsub report { 12971db4269fSPaolo Bonzini my ($level, $msg) = @_; 12981db4269fSPaolo Bonzini if (defined $tst_only && $msg !~ /\Q$tst_only\E/) { 12991ec3f6f9SBlue Swirl return 0; 13001ec3f6f9SBlue Swirl } 13011ec3f6f9SBlue Swirl 13021db4269fSPaolo Bonzini my $output = ''; 13031db4269fSPaolo Bonzini $output .= BOLD if $color; 13041db4269fSPaolo Bonzini $output .= $prefix; 13051db4269fSPaolo Bonzini $output .= RED if $color && $level eq 'ERROR'; 13061db4269fSPaolo Bonzini $output .= MAGENTA if $color && $level eq 'WARNING'; 13071db4269fSPaolo Bonzini $output .= $level . ':'; 13081db4269fSPaolo Bonzini $output .= RESET if $color; 13091db4269fSPaolo Bonzini $output .= ' ' . $msg . "\n"; 13101ec3f6f9SBlue Swirl 13111db4269fSPaolo Bonzini $output = (split('\n', $output))[0] . "\n" if ($terse); 13121db4269fSPaolo Bonzini 13131db4269fSPaolo Bonzini push(our @report, $output); 13141ec3f6f9SBlue Swirl 13151ec3f6f9SBlue Swirl return 1; 13161ec3f6f9SBlue Swirl} 13171ec3f6f9SBlue Swirlsub report_dump { 13181ec3f6f9SBlue Swirl our @report; 13191ec3f6f9SBlue Swirl} 13201ec3f6f9SBlue Swirlsub ERROR { 13211db4269fSPaolo Bonzini if (report("ERROR", $_[0])) { 13221ec3f6f9SBlue Swirl our $clean = 0; 13231ec3f6f9SBlue Swirl our $cnt_error++; 13241ec3f6f9SBlue Swirl } 13251ec3f6f9SBlue Swirl} 13261ec3f6f9SBlue Swirlsub WARN { 13271db4269fSPaolo Bonzini if (report("WARNING", $_[0])) { 13281ec3f6f9SBlue Swirl our $clean = 0; 13291ec3f6f9SBlue Swirl our $cnt_warn++; 13301ec3f6f9SBlue Swirl } 13311ec3f6f9SBlue Swirl} 13321ec3f6f9SBlue Swirl 13331c3c9a8cSMichael S. Tsirkin# According to tests/qtest/bios-tables-test.c: do not 13341c3c9a8cSMichael S. Tsirkin# change expected file in the same commit with adding test 13351c3c9a8cSMichael S. Tsirkinsub checkfilename { 1336e625ba2aSMichael S. Tsirkin my ($name, $acpi_testexpected, $acpi_nontestexpected) = @_; 1337e625ba2aSMichael S. Tsirkin 1338e11b06a8SMichael S. Tsirkin # Note: shell script that rebuilds the expected files is in the same 1339e11b06a8SMichael S. Tsirkin # directory as files themselves. 1340e11b06a8SMichael S. Tsirkin # Note: allowed diff list can be changed both when changing expected 1341e11b06a8SMichael S. Tsirkin # files and when changing tests. 1342e11b06a8SMichael S. Tsirkin if ($name =~ m#^tests/data/acpi/# and not $name =~ m#^\.sh$#) { 1343e625ba2aSMichael S. Tsirkin $$acpi_testexpected = $name; 13442046811cSMichael S. Tsirkin } elsif ($name !~ m#^tests/qtest/bios-tables-test-allowed-diff.h$#) { 1345e625ba2aSMichael S. Tsirkin $$acpi_nontestexpected = $name; 13461c3c9a8cSMichael S. Tsirkin } 1347e625ba2aSMichael S. Tsirkin if (defined $$acpi_testexpected and defined $$acpi_nontestexpected) { 13481c3c9a8cSMichael S. Tsirkin ERROR("Do not add expected files together with tests, " . 13491c3c9a8cSMichael S. Tsirkin "follow instructions in " . 13501c3c9a8cSMichael S. Tsirkin "tests/qtest/bios-tables-test.c: both " . 1351e625ba2aSMichael S. Tsirkin $$acpi_testexpected . " and " . 1352e625ba2aSMichael S. Tsirkin $$acpi_nontestexpected . " found\n"); 13531c3c9a8cSMichael S. Tsirkin } 13541c3c9a8cSMichael S. Tsirkin} 13551c3c9a8cSMichael S. Tsirkin 13561ec3f6f9SBlue Swirlsub process { 13571ec3f6f9SBlue Swirl my $filename = shift; 13581ec3f6f9SBlue Swirl 13591ec3f6f9SBlue Swirl my $linenr=0; 13601ec3f6f9SBlue Swirl my $prevline=""; 13611ec3f6f9SBlue Swirl my $prevrawline=""; 13621ec3f6f9SBlue Swirl my $stashline=""; 13631ec3f6f9SBlue Swirl my $stashrawline=""; 13641ec3f6f9SBlue Swirl 13651ec3f6f9SBlue Swirl my $length; 13661ec3f6f9SBlue Swirl my $indent; 13671ec3f6f9SBlue Swirl my $previndent=0; 13681ec3f6f9SBlue Swirl my $stashindent=0; 13691ec3f6f9SBlue Swirl 13701ec3f6f9SBlue Swirl our $clean = 1; 13711ec3f6f9SBlue Swirl my $signoff = 0; 13721ec3f6f9SBlue Swirl my $is_patch = 0; 13731ec3f6f9SBlue Swirl 13745fc7e404SJoe Perches my $in_header_lines = $file ? 0 : 1; 1375b37c4aacSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 13764be6131eSJoe Perches my $reported_maintainer_file = 0; 1377bf139a06SPasi Savanainen my $non_utf8_charset = 0; 1378bf139a06SPasi Savanainen 13791ec3f6f9SBlue Swirl our @report = (); 13801ec3f6f9SBlue Swirl our $cnt_lines = 0; 13811ec3f6f9SBlue Swirl our $cnt_error = 0; 13821ec3f6f9SBlue Swirl our $cnt_warn = 0; 13831ec3f6f9SBlue Swirl our $cnt_chk = 0; 13841ec3f6f9SBlue Swirl 13851ec3f6f9SBlue Swirl # Trace the real file/line as we go. 13861ec3f6f9SBlue Swirl my $realfile = ''; 13871ec3f6f9SBlue Swirl my $realline = 0; 13881ec3f6f9SBlue Swirl my $realcnt = 0; 13891ec3f6f9SBlue Swirl my $here = ''; 13901ec3f6f9SBlue Swirl my $in_comment = 0; 13911ec3f6f9SBlue Swirl my $comment_edge = 0; 13921ec3f6f9SBlue Swirl my $first_line = 0; 13931ec3f6f9SBlue Swirl my $p1_prefix = ''; 13941ec3f6f9SBlue Swirl 13951ec3f6f9SBlue Swirl my $prev_values = 'E'; 13961ec3f6f9SBlue Swirl 13971ec3f6f9SBlue Swirl # suppression flags 13981ec3f6f9SBlue Swirl my %suppress_ifbraces; 13991ec3f6f9SBlue Swirl my %suppress_whiletrailers; 14001ec3f6f9SBlue Swirl my %suppress_export; 14011ec3f6f9SBlue Swirl 1402e625ba2aSMichael S. Tsirkin my $acpi_testexpected; 1403e625ba2aSMichael S. Tsirkin my $acpi_nontestexpected; 1404e625ba2aSMichael S. Tsirkin 14051ec3f6f9SBlue Swirl # Pre-scan the patch sanitizing the lines. 14061ec3f6f9SBlue Swirl 14071ec3f6f9SBlue Swirl sanitise_line_reset(); 14081ec3f6f9SBlue Swirl my $line; 14091ec3f6f9SBlue Swirl foreach my $rawline (@rawlines) { 14101ec3f6f9SBlue Swirl $linenr++; 14111ec3f6f9SBlue Swirl $line = $rawline; 14121ec3f6f9SBlue Swirl 14131ec3f6f9SBlue Swirl if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14141ec3f6f9SBlue Swirl $realline=$1-1; 14151ec3f6f9SBlue Swirl if (defined $2) { 14161ec3f6f9SBlue Swirl $realcnt=$3+1; 14171ec3f6f9SBlue Swirl } else { 14181ec3f6f9SBlue Swirl $realcnt=1+1; 14191ec3f6f9SBlue Swirl } 14201ec3f6f9SBlue Swirl $in_comment = 0; 14211ec3f6f9SBlue Swirl 14221ec3f6f9SBlue Swirl # Guestimate if this is a continuing comment. Run 14231ec3f6f9SBlue Swirl # the context looking for a comment "edge". If this 14241ec3f6f9SBlue Swirl # edge is a close comment then we must be in a comment 14251ec3f6f9SBlue Swirl # at context start. 14261ec3f6f9SBlue Swirl my $edge; 14271ec3f6f9SBlue Swirl my $cnt = $realcnt; 14281ec3f6f9SBlue Swirl for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 14291ec3f6f9SBlue Swirl next if (defined $rawlines[$ln - 1] && 14301ec3f6f9SBlue Swirl $rawlines[$ln - 1] =~ /^-/); 14311ec3f6f9SBlue Swirl $cnt--; 14321ec3f6f9SBlue Swirl #print "RAW<$rawlines[$ln - 1]>\n"; 14331ec3f6f9SBlue Swirl last if (!defined $rawlines[$ln - 1]); 14341ec3f6f9SBlue Swirl if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 14351ec3f6f9SBlue Swirl $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 14361ec3f6f9SBlue Swirl ($edge) = $1; 14371ec3f6f9SBlue Swirl last; 14381ec3f6f9SBlue Swirl } 14391ec3f6f9SBlue Swirl } 14401ec3f6f9SBlue Swirl if (defined $edge && $edge eq '*/') { 14411ec3f6f9SBlue Swirl $in_comment = 1; 14421ec3f6f9SBlue Swirl } 14431ec3f6f9SBlue Swirl 14441ec3f6f9SBlue Swirl # Guestimate if this is a continuing comment. If this 14451ec3f6f9SBlue Swirl # is the start of a diff block and this line starts 14461ec3f6f9SBlue Swirl # ' *' then it is very likely a comment. 14471ec3f6f9SBlue Swirl if (!defined $edge && 14481ec3f6f9SBlue Swirl $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 14491ec3f6f9SBlue Swirl { 14501ec3f6f9SBlue Swirl $in_comment = 1; 14511ec3f6f9SBlue Swirl } 14521ec3f6f9SBlue Swirl 14531ec3f6f9SBlue Swirl ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 14541ec3f6f9SBlue Swirl sanitise_line_reset($in_comment); 14551ec3f6f9SBlue Swirl 14561ec3f6f9SBlue Swirl } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 14571ec3f6f9SBlue Swirl # Standardise the strings and chars within the input to 14581ec3f6f9SBlue Swirl # simplify matching -- only bother with positive lines. 14591ec3f6f9SBlue Swirl $line = sanitise_line($rawline); 14601ec3f6f9SBlue Swirl } 14611ec3f6f9SBlue Swirl push(@lines, $line); 14621ec3f6f9SBlue Swirl 14631ec3f6f9SBlue Swirl if ($realcnt > 1) { 14641ec3f6f9SBlue Swirl $realcnt-- if ($line =~ /^(?:\+| |$)/); 14651ec3f6f9SBlue Swirl } else { 14661ec3f6f9SBlue Swirl $realcnt = 0; 14671ec3f6f9SBlue Swirl } 14681ec3f6f9SBlue Swirl 14691ec3f6f9SBlue Swirl #print "==>$rawline\n"; 14701ec3f6f9SBlue Swirl #print "-->$line\n"; 14711ec3f6f9SBlue Swirl } 14721ec3f6f9SBlue Swirl 14731ec3f6f9SBlue Swirl $prefix = ''; 14741ec3f6f9SBlue Swirl 14751ec3f6f9SBlue Swirl $realcnt = 0; 14761ec3f6f9SBlue Swirl $linenr = 0; 14771ec3f6f9SBlue Swirl foreach my $line (@lines) { 14781ec3f6f9SBlue Swirl $linenr++; 14791ec3f6f9SBlue Swirl 14801ec3f6f9SBlue Swirl my $rawline = $rawlines[$linenr - 1]; 14811ec3f6f9SBlue Swirl 14821ec3f6f9SBlue Swirl#extract the line range in the file after the patch is applied 14831ec3f6f9SBlue Swirl if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14841ec3f6f9SBlue Swirl $is_patch = 1; 14851ec3f6f9SBlue Swirl $first_line = $linenr + 1; 14861ec3f6f9SBlue Swirl $realline=$1-1; 14871ec3f6f9SBlue Swirl if (defined $2) { 14881ec3f6f9SBlue Swirl $realcnt=$3+1; 14891ec3f6f9SBlue Swirl } else { 14901ec3f6f9SBlue Swirl $realcnt=1+1; 14911ec3f6f9SBlue Swirl } 14921ec3f6f9SBlue Swirl annotate_reset(); 14931ec3f6f9SBlue Swirl $prev_values = 'E'; 14941ec3f6f9SBlue Swirl 14951ec3f6f9SBlue Swirl %suppress_ifbraces = (); 14961ec3f6f9SBlue Swirl %suppress_whiletrailers = (); 14971ec3f6f9SBlue Swirl %suppress_export = (); 14981ec3f6f9SBlue Swirl next; 14991ec3f6f9SBlue Swirl 15001ec3f6f9SBlue Swirl# track the line number as we move through the hunk, note that 15011ec3f6f9SBlue Swirl# new versions of GNU diff omit the leading space on completely 15021ec3f6f9SBlue Swirl# blank context lines so we need to count that too. 15031ec3f6f9SBlue Swirl } elsif ($line =~ /^( |\+|$)/) { 15041ec3f6f9SBlue Swirl $realline++; 15051ec3f6f9SBlue Swirl $realcnt-- if ($realcnt != 0); 15061ec3f6f9SBlue Swirl 15071ec3f6f9SBlue Swirl # Measure the line length and indent. 15081ec3f6f9SBlue Swirl ($length, $indent) = line_stats($rawline); 15091ec3f6f9SBlue Swirl 15101ec3f6f9SBlue Swirl # Track the previous line. 15111ec3f6f9SBlue Swirl ($prevline, $stashline) = ($stashline, $line); 15121ec3f6f9SBlue Swirl ($previndent, $stashindent) = ($stashindent, $indent); 15131ec3f6f9SBlue Swirl ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 15141ec3f6f9SBlue Swirl 15151ec3f6f9SBlue Swirl #warn "line<$line>\n"; 15161ec3f6f9SBlue Swirl 15171ec3f6f9SBlue Swirl } elsif ($realcnt == 1) { 15181ec3f6f9SBlue Swirl $realcnt--; 15191ec3f6f9SBlue Swirl } 15201ec3f6f9SBlue Swirl 15211ec3f6f9SBlue Swirl my $hunk_line = ($realcnt != 0); 15221ec3f6f9SBlue Swirl 15231ec3f6f9SBlue Swirl#make up the handle for any error we report on this line 15241ec3f6f9SBlue Swirl $prefix = "$filename:$realline: " if ($emacs && $file); 15251ec3f6f9SBlue Swirl $prefix = "$filename:$linenr: " if ($emacs && !$file); 15261ec3f6f9SBlue Swirl 15271ec3f6f9SBlue Swirl $here = "#$linenr: " if (!$file); 15281ec3f6f9SBlue Swirl $here = "#$realline: " if ($file); 15291ec3f6f9SBlue Swirl 15301ec3f6f9SBlue Swirl # extract the filename as it passes 15311ec3f6f9SBlue Swirl if ($line =~ /^diff --git.*?(\S+)$/) { 15321ec3f6f9SBlue Swirl $realfile = $1; 15331a5c63ceSPaolo Bonzini $realfile =~ s@^([^/]*)/@@ if (!$file); 1534e625ba2aSMichael S. Tsirkin checkfilename($realfile, \$acpi_testexpected, \$acpi_nontestexpected); 15351ec3f6f9SBlue Swirl } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 15361ec3f6f9SBlue Swirl $realfile = $1; 15371a5c63ceSPaolo Bonzini $realfile =~ s@^([^/]*)/@@ if (!$file); 1538e625ba2aSMichael S. Tsirkin checkfilename($realfile, \$acpi_testexpected, \$acpi_nontestexpected); 15391ec3f6f9SBlue Swirl 15401ec3f6f9SBlue Swirl $p1_prefix = $1; 15411ec3f6f9SBlue Swirl if (!$file && $tree && $p1_prefix ne '' && 15421ec3f6f9SBlue Swirl -e "$root/$p1_prefix") { 15431ec3f6f9SBlue Swirl WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15441ec3f6f9SBlue Swirl } 15451ec3f6f9SBlue Swirl 15461ec3f6f9SBlue Swirl next; 15471ec3f6f9SBlue Swirl } 15481ec3f6f9SBlue Swirl 15491ec3f6f9SBlue Swirl $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15501ec3f6f9SBlue Swirl 15511ec3f6f9SBlue Swirl my $hereline = "$here\n$rawline\n"; 15521ec3f6f9SBlue Swirl my $herecurr = "$here\n$rawline\n"; 15531ec3f6f9SBlue Swirl my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15541ec3f6f9SBlue Swirl 15551ec3f6f9SBlue Swirl $cnt_lines++ if ($realcnt != 0); 15561ec3f6f9SBlue Swirl 15571ec3f6f9SBlue Swirl# Check for incorrect file permissions 15581ec3f6f9SBlue Swirl if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15591ec3f6f9SBlue Swirl my $permhere = $here . "FILE: $realfile\n"; 156071c47b01SPaolo Bonzini if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) { 15611ec3f6f9SBlue Swirl ERROR("do not set execute permissions for source files\n" . $permhere); 15621ec3f6f9SBlue Swirl } 15631ec3f6f9SBlue Swirl } 15641ec3f6f9SBlue Swirl 1565bc7f3b0bSPhilippe Mathieu-Daudé# Only allow Python 3 interpreter 1566bc7f3b0bSPhilippe Mathieu-Daudé if ($realline == 1 && 1567bc7f3b0bSPhilippe Mathieu-Daudé $line =~ /^\+#!\ *\/usr\/bin\/(?:env )?python$/) { 1568bc7f3b0bSPhilippe Mathieu-Daudé ERROR("please use python3 interpreter\n" . $herecurr); 1569bc7f3b0bSPhilippe Mathieu-Daudé } 1570bc7f3b0bSPhilippe Mathieu-Daudé 1571f8dccbb6SStefan Hajnoczi# Accept git diff extended headers as valid patches 1572f8dccbb6SStefan Hajnoczi if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\.\-]+\s*$/) { 1573f8dccbb6SStefan Hajnoczi $is_patch = 1; 1574f8dccbb6SStefan Hajnoczi } 1575f8dccbb6SStefan Hajnoczi 15767b59d10eSThomas Huth if ($line =~ /^(Author|From): .* via .*<qemu-devel\@nongnu.org>/) { 1577f5177798SDaniel P. Berrangé ERROR("Author email address is mangled by the mailing list\n" . $herecurr); 1578f5177798SDaniel P. Berrangé } 1579f5177798SDaniel P. Berrangé 15801ec3f6f9SBlue Swirl#check the patch for a signoff: 15811ec3f6f9SBlue Swirl if ($line =~ /^\s*signed-off-by:/i) { 15821ec3f6f9SBlue Swirl # This is a signoff, if ugly, so do not double report. 15831ec3f6f9SBlue Swirl $signoff++; 1584b37c4aacSJoe Perches $in_commit_log = 0; 1585b37c4aacSJoe Perches 15861ec3f6f9SBlue Swirl if (!($line =~ /^\s*Signed-off-by:/)) { 1587c2df8783SPaolo Bonzini ERROR("The correct form is \"Signed-off-by\"\n" . 15881ec3f6f9SBlue Swirl $herecurr); 15891ec3f6f9SBlue Swirl } 15901ec3f6f9SBlue Swirl if ($line =~ /^\s*signed-off-by:\S/i) { 1591c2df8783SPaolo Bonzini ERROR("space required after Signed-off-by:\n" . 15921ec3f6f9SBlue Swirl $herecurr); 15931ec3f6f9SBlue Swirl } 15941ec3f6f9SBlue Swirl } 15951ec3f6f9SBlue Swirl 15961a6fad0cSJoe Perches# Check if MAINTAINERS is being updated. If so, there's probably no need to 15971a6fad0cSJoe Perches# emit the "does MAINTAINERS need updating?" message on file add/move/delete 15981a6fad0cSJoe Perches if ($line =~ /^\s*MAINTAINERS\s*\|/) { 15991a6fad0cSJoe Perches $reported_maintainer_file = 1; 16001a6fad0cSJoe Perches } 16011a6fad0cSJoe Perches 16024be6131eSJoe Perches# Check for added, moved or deleted files 16034be6131eSJoe Perches if (!$reported_maintainer_file && !$in_commit_log && 16044be6131eSJoe Perches ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 16054be6131eSJoe Perches $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 16064be6131eSJoe Perches ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 1607d2f1af0eSIsaku Yamahata (defined($1) || defined($2)))) && 1608d2f1af0eSIsaku Yamahata !(($realfile ne '') && 160943bea443SGreg Kurz defined($acpi_testexpected) && 1610d2f1af0eSIsaku Yamahata ($realfile eq $acpi_testexpected))) { 16114be6131eSJoe Perches $reported_maintainer_file = 1; 16124be6131eSJoe Perches WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 16134be6131eSJoe Perches } 16144be6131eSJoe Perches 16151ec3f6f9SBlue Swirl# Check for wrappage within a valid hunk of the file 16161ec3f6f9SBlue Swirl if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 16171ec3f6f9SBlue Swirl ERROR("patch seems to be corrupt (line wrapped?)\n" . 16181ec3f6f9SBlue Swirl $herecurr) if (!$emitted_corrupt++); 16191ec3f6f9SBlue Swirl } 16201ec3f6f9SBlue Swirl 16211ec3f6f9SBlue Swirl# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 16221ec3f6f9SBlue Swirl if (($realfile =~ /^$/ || $line =~ /^\+/) && 16231ec3f6f9SBlue Swirl $rawline !~ m/^$UTF8*$/) { 16241ec3f6f9SBlue Swirl my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 16251ec3f6f9SBlue Swirl 16261ec3f6f9SBlue Swirl my $blank = copy_spacing($rawline); 16271ec3f6f9SBlue Swirl my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 16281ec3f6f9SBlue Swirl my $hereptr = "$hereline$ptr\n"; 16291ec3f6f9SBlue Swirl 16301ec3f6f9SBlue Swirl ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 16311ec3f6f9SBlue Swirl } 16321ec3f6f9SBlue Swirl 1633874acb6fSPaolo Bonzini if ($rawline =~ m/$UTF8_MOJIBAKE/) { 1634874acb6fSPaolo Bonzini ERROR("Doubly-encoded UTF-8\n" . $herecurr); 1635874acb6fSPaolo Bonzini } 1636b37c4aacSJoe Perches# Check if it's the start of a commit log 1637b37c4aacSJoe Perches# (not a header line and we haven't seen the patch filename) 1638b37c4aacSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 16395fc7e404SJoe Perches !($rawline =~ /^\s+\S/ || 16405fc7e404SJoe Perches $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 1641b37c4aacSJoe Perches $in_header_lines = 0; 1642b37c4aacSJoe Perches $in_commit_log = 1; 1643b37c4aacSJoe Perches } 1644b37c4aacSJoe Perches 1645bf139a06SPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1646bf139a06SPasi Savanainen# declined it, i.e defined some charset where it is missing. 1647bf139a06SPasi Savanainen if ($in_header_lines && 1648bf139a06SPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1649bf139a06SPasi Savanainen $1 !~ /utf-8/i) { 1650bf139a06SPasi Savanainen $non_utf8_charset = 1; 1651bf139a06SPasi Savanainen } 1652bf139a06SPasi Savanainen 1653bf139a06SPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 1654b37c4aacSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1655b37c4aacSJoe Perches WARN("8-bit UTF-8 used in possible commit log\n" . $herecurr); 1656b37c4aacSJoe Perches } 1657b37c4aacSJoe Perches 1658e072af19SZhao Liu# Check for various typo / spelling mistakes 1659e072af19SZhao Liu if (defined($misspellings) && 1660e072af19SZhao Liu ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 1661e072af19SZhao Liu while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 1662e072af19SZhao Liu my $typo = $1; 1663e072af19SZhao Liu my $blank = copy_spacing($rawline); 1664e072af19SZhao Liu my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 1665e072af19SZhao Liu my $hereptr = "$hereline$ptr\n"; 1666e072af19SZhao Liu my $typo_fix = $spelling_fix{lc($typo)}; 1667e072af19SZhao Liu $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 1668e072af19SZhao Liu $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 1669e072af19SZhao Liu WARN("'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr); 1670e072af19SZhao Liu } 1671e072af19SZhao Liu } 1672e072af19SZhao Liu 16731ec3f6f9SBlue Swirl# ignore non-hunk lines and lines being removed 16741ec3f6f9SBlue Swirl next if (!$hunk_line || $line =~ /^-/); 16751ec3f6f9SBlue Swirl 167693bf13c6SRadim Krčmář# ignore files that are being periodically imported from Linux 167793bf13c6SRadim Krčmář next if ($realfile =~ /^(linux-headers|include\/standard-headers)\//); 167893bf13c6SRadim Krčmář 16791ec3f6f9SBlue Swirl#trailing whitespace 16801ec3f6f9SBlue Swirl if ($line =~ /^\+.*\015/) { 16811ec3f6f9SBlue Swirl my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 16821ec3f6f9SBlue Swirl ERROR("DOS line endings\n" . $herevet); 16831ec3f6f9SBlue Swirl 16840cebabd5SLluís Vilanova } elsif ($realfile =~ /^docs\/.+\.txt/ || 16850cebabd5SLluís Vilanova $realfile =~ /^docs\/.+\.md/) { 16860cebabd5SLluís Vilanova if ($rawline =~ /^\+\s+$/ && $rawline !~ /^\+ {4}$/) { 16870cebabd5SLluís Vilanova # TODO: properly check we're in a code block 16880cebabd5SLluís Vilanova # (surrounding text is 4-column aligned) 16890cebabd5SLluís Vilanova my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 16900cebabd5SLluís Vilanova ERROR("code blocks in documentation should have " . 16910cebabd5SLluís Vilanova "empty lines with exactly 4 columns of " . 16920cebabd5SLluís Vilanova "whitespace\n" . $herevet); 16930cebabd5SLluís Vilanova } 16941ec3f6f9SBlue Swirl } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 16951ec3f6f9SBlue Swirl my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 16961ec3f6f9SBlue Swirl ERROR("trailing whitespace\n" . $herevet); 16971ec3f6f9SBlue Swirl $rpt_cleaners = 1; 16981ec3f6f9SBlue Swirl } 16991ec3f6f9SBlue Swirl 1700c3e5875aSVladimir Sementsov-Ogievskiy# checks for trace-events files 1701c3e5875aSVladimir Sementsov-Ogievskiy if ($realfile =~ /trace-events$/ && $line =~ /^\+/) { 1702c3e5875aSVladimir Sementsov-Ogievskiy if ($rawline =~ /%[-+ 0]*#/) { 1703c3e5875aSVladimir Sementsov-Ogievskiy ERROR("Don't use '#' flag of printf format ('%#') in " . 1704c3e5875aSVladimir Sementsov-Ogievskiy "trace-events, use '0x' prefix instead\n" . $herecurr); 1705c3e5875aSVladimir Sementsov-Ogievskiy } else { 1706c3e5875aSVladimir Sementsov-Ogievskiy my $hex = 1707c3e5875aSVladimir Sementsov-Ogievskiy qr/%[-+ *.0-9]*([hljztL]|ll|hh)?(x|X|"\s*PRI[xX][^"]*"?)/; 1708c3e5875aSVladimir Sementsov-Ogievskiy 1709d30b5bc9SMichael Tokarev # don't consider groups split by [.:/ ], like 2A.20:12ab 171045042732SVladimir Sementsov-Ogievskiy my $tmpline = $rawline; 171145042732SVladimir Sementsov-Ogievskiy $tmpline =~ s/($hex[.:\/ ])+$hex//g; 1712c3e5875aSVladimir Sementsov-Ogievskiy 1713c3e5875aSVladimir Sementsov-Ogievskiy if ($tmpline =~ /(?<!0x)$hex/) { 1714c3e5875aSVladimir Sementsov-Ogievskiy ERROR("Hex numbers must be prefixed with '0x'\n" . 1715c3e5875aSVladimir Sementsov-Ogievskiy $herecurr); 1716c3e5875aSVladimir Sementsov-Ogievskiy } 1717c3e5875aSVladimir Sementsov-Ogievskiy } 1718c3e5875aSVladimir Sementsov-Ogievskiy } 1719c3e5875aSVladimir Sementsov-Ogievskiy 17201ec3f6f9SBlue Swirl# check we are in a valid source file if not then ignore this hunk 1721777d05baSPaolo Bonzini next if ($realfile !~ /$SrcFile/); 17221ec3f6f9SBlue Swirl 1723205f31a8SEric Blake#90 column limit; exempt URLs, if no other words on line 1724f1e155bbSPaolo Bonzini if ($line =~ /^\+/ && 1725f1e155bbSPaolo Bonzini !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1726205f31a8SEric Blake !($rawline =~ /^[^[:alnum:]]*https?:\S*$/) && 17271ec3f6f9SBlue Swirl $length > 80) 17281ec3f6f9SBlue Swirl { 17298fbe3d1fSPaolo Bonzini if ($length > 90) { 17308fbe3d1fSPaolo Bonzini ERROR("line over 90 characters\n" . $herecurr); 17318fbe3d1fSPaolo Bonzini } else { 17321ec3f6f9SBlue Swirl WARN("line over 80 characters\n" . $herecurr); 17331ec3f6f9SBlue Swirl } 17348fbe3d1fSPaolo Bonzini } 17351ec3f6f9SBlue Swirl 17361ec3f6f9SBlue Swirl# check for spaces before a quoted newline 17371ec3f6f9SBlue Swirl if ($rawline =~ /^.*\".*\s\\n/) { 1738c2df8783SPaolo Bonzini ERROR("unnecessary whitespace before a quoted newline\n" . $herecurr); 17391ec3f6f9SBlue Swirl } 17401ec3f6f9SBlue Swirl 17411ec3f6f9SBlue Swirl# check for adding lines without a newline. 17421ec3f6f9SBlue Swirl if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1743c2df8783SPaolo Bonzini ERROR("adding a line without newline at end of file\n" . $herecurr); 17441ec3f6f9SBlue Swirl } 17451ec3f6f9SBlue Swirl 174693eb8e31SPaolo Bonzini# check for RCS/CVS revision markers 174793eb8e31SPaolo Bonzini if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) { 1748c2df8783SPaolo Bonzini ERROR("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 174993eb8e31SPaolo Bonzini } 175093eb8e31SPaolo Bonzini 1751906fb135SPaolo Bonzini# tabs are only allowed in assembly source code, and in 1752906fb135SPaolo Bonzini# some scripts we imported from other projects. 1753906fb135SPaolo Bonzini next if ($realfile =~ /\.(s|S)$/); 17547a470a37SPeter Maydell next if ($realfile =~ /(checkpatch|get_maintainer)\.pl$/); 1755321b0ca3SMatheus Tavares Bernardino next if ($realfile =~ /^target\/hexagon\/imported\/*/); 17561ec3f6f9SBlue Swirl 1757ad36ce8bSBlue Swirl if ($rawline =~ /^\+.*\t/) { 17581ec3f6f9SBlue Swirl my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1759b6469683SBlue Swirl ERROR("code indent should never use tabs\n" . $herevet); 17601ec3f6f9SBlue Swirl $rpt_cleaners = 1; 17611ec3f6f9SBlue Swirl } 17621ec3f6f9SBlue Swirl 17631ec3f6f9SBlue Swirl# check we are in a valid C source file if not then ignore this hunk 176472205289SMatheus Ferst next if ($realfile !~ /\.((h|c)(\.inc)?|cpp)$/); 17651ec3f6f9SBlue Swirl 17668c06fbdfSPeter Maydell# Block comment styles 17678c06fbdfSPeter Maydell 17688c06fbdfSPeter Maydell # Block comments use /* on a line of its own 17691ef47f40SMichael S. Tsirkin my $commentline = $rawline; 177053a3b832SMichael S. Tsirkin while ($commentline =~ s@^(\+.*)/\*.*\*/@$1@o) { # remove inline /*...*/ 17711ef47f40SMichael S. Tsirkin } 17721ef47f40SMichael S. Tsirkin if ($commentline =~ m@^\+.*/\*\*?+[ \t]*[^ \t]@) { # /* or /** non-blank 17738c06fbdfSPeter Maydell WARN("Block comments use a leading /* on a separate line\n" . $herecurr); 17748c06fbdfSPeter Maydell } 17758c06fbdfSPeter Maydell 17768c06fbdfSPeter Maydell# Block comments use * on subsequent lines 17778c06fbdfSPeter Maydell if ($prevline =~ /$;[ \t]*$/ && #ends in comment 17788c06fbdfSPeter Maydell $prevrawline =~ /^\+.*?\/\*/ && #starting /* 17798c06fbdfSPeter Maydell $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 17808c06fbdfSPeter Maydell $rawline =~ /^\+/ && #line is new 17818c06fbdfSPeter Maydell $rawline !~ /^\+[ \t]*\*/) { #no leading * 17828c06fbdfSPeter Maydell WARN("Block comments use * on subsequent lines\n" . $hereprev); 17838c06fbdfSPeter Maydell } 17848c06fbdfSPeter Maydell 17858c06fbdfSPeter Maydell# Block comments use */ on trailing lines 17868c06fbdfSPeter Maydell if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 17878c06fbdfSPeter Maydell $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 17888c06fbdfSPeter Maydell $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 17898c06fbdfSPeter Maydell $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 17908c06fbdfSPeter Maydell WARN("Block comments use a trailing */ on a separate line\n" . $herecurr); 17918c06fbdfSPeter Maydell } 17928c06fbdfSPeter Maydell 17938c06fbdfSPeter Maydell# Block comment * alignment 17948c06fbdfSPeter Maydell if ($prevline =~ /$;[ \t]*$/ && #ends in comment 17958c06fbdfSPeter Maydell $line =~ /^\+[ \t]*$;/ && #leading comment 17968c06fbdfSPeter Maydell $rawline =~ /^\+[ \t]*\*/ && #leading * 17978c06fbdfSPeter Maydell (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 17988c06fbdfSPeter Maydell $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 17998c06fbdfSPeter Maydell $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 18008c06fbdfSPeter Maydell my $oldindent; 18018c06fbdfSPeter Maydell $prevrawline =~ m@^\+([ \t]*/?)\*@; 18028c06fbdfSPeter Maydell if (defined($1)) { 18038c06fbdfSPeter Maydell $oldindent = expand_tabs($1); 18048c06fbdfSPeter Maydell } else { 18058c06fbdfSPeter Maydell $prevrawline =~ m@^\+(.*/?)\*@; 18068c06fbdfSPeter Maydell $oldindent = expand_tabs($1); 18078c06fbdfSPeter Maydell } 18088c06fbdfSPeter Maydell $rawline =~ m@^\+([ \t]*)\*@; 18098c06fbdfSPeter Maydell my $newindent = $1; 18108c06fbdfSPeter Maydell $newindent = expand_tabs($newindent); 18118c06fbdfSPeter Maydell if (length($oldindent) ne length($newindent)) { 18128c06fbdfSPeter Maydell WARN("Block comments should align the * on each line\n" . $hereprev); 18138c06fbdfSPeter Maydell } 18148c06fbdfSPeter Maydell } 18158c06fbdfSPeter Maydell 18161ec3f6f9SBlue Swirl# Check for potential 'bare' types 18171ec3f6f9SBlue Swirl my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 18181ec3f6f9SBlue Swirl $realline_next); 18191ec3f6f9SBlue Swirl if ($realcnt && $line =~ /.\s*\S/) { 18201ec3f6f9SBlue Swirl ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 18211ec3f6f9SBlue Swirl ctx_statement_block($linenr, $realcnt, 0); 18221ec3f6f9SBlue Swirl $stat =~ s/\n./\n /g; 18231ec3f6f9SBlue Swirl $cond =~ s/\n./\n /g; 18241ec3f6f9SBlue Swirl 18251ec3f6f9SBlue Swirl # Find the real next line. 18261ec3f6f9SBlue Swirl $realline_next = $line_nr_next; 18271ec3f6f9SBlue Swirl if (defined $realline_next && 18281ec3f6f9SBlue Swirl (!defined $lines[$realline_next - 1] || 18291ec3f6f9SBlue Swirl substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 18301ec3f6f9SBlue Swirl $realline_next++; 18311ec3f6f9SBlue Swirl } 18321ec3f6f9SBlue Swirl 18331ec3f6f9SBlue Swirl my $s = $stat; 18341ec3f6f9SBlue Swirl $s =~ s/{.*$//s; 18351ec3f6f9SBlue Swirl 18361ec3f6f9SBlue Swirl # Ignore goto labels. 18371ec3f6f9SBlue Swirl if ($s =~ /$Ident:\*$/s) { 18381ec3f6f9SBlue Swirl 18391ec3f6f9SBlue Swirl # Ignore functions being called 18401ec3f6f9SBlue Swirl } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 18411ec3f6f9SBlue Swirl 18421ec3f6f9SBlue Swirl } elsif ($s =~ /^.\s*else\b/s) { 18431ec3f6f9SBlue Swirl 18441ec3f6f9SBlue Swirl # declarations always start with types 18451ec3f6f9SBlue Swirl } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) { 18461ec3f6f9SBlue Swirl my $type = $1; 18471ec3f6f9SBlue Swirl $type =~ s/\s+/ /g; 18481ec3f6f9SBlue Swirl possible($type, "A:" . $s); 18491ec3f6f9SBlue Swirl 18501ec3f6f9SBlue Swirl # definitions in global scope can only start with types 18511ec3f6f9SBlue Swirl } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 18521ec3f6f9SBlue Swirl possible($1, "B:" . $s); 18531ec3f6f9SBlue Swirl } 18541ec3f6f9SBlue Swirl 18551ec3f6f9SBlue Swirl # any (foo ... *) is a pointer cast, and foo is a type 18561ec3f6f9SBlue Swirl while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 18571ec3f6f9SBlue Swirl possible($1, "C:" . $s); 18581ec3f6f9SBlue Swirl } 18591ec3f6f9SBlue Swirl 18601ec3f6f9SBlue Swirl # Check for any sort of function declaration. 18611ec3f6f9SBlue Swirl # int foo(something bar, other baz); 18621ec3f6f9SBlue Swirl # void (*store_gdt)(x86_descr_ptr *); 18631ec3f6f9SBlue Swirl if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 18641ec3f6f9SBlue Swirl my ($name_len) = length($1); 18651ec3f6f9SBlue Swirl 18661ec3f6f9SBlue Swirl my $ctx = $s; 18671ec3f6f9SBlue Swirl substr($ctx, 0, $name_len + 1, ''); 18681ec3f6f9SBlue Swirl $ctx =~ s/\)[^\)]*$//; 18691ec3f6f9SBlue Swirl 18701ec3f6f9SBlue Swirl for my $arg (split(/\s*,\s*/, $ctx)) { 18711ec3f6f9SBlue Swirl if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 18721ec3f6f9SBlue Swirl 18731ec3f6f9SBlue Swirl possible($1, "D:" . $s); 18741ec3f6f9SBlue Swirl } 18751ec3f6f9SBlue Swirl } 18761ec3f6f9SBlue Swirl } 18771ec3f6f9SBlue Swirl 18781ec3f6f9SBlue Swirl } 18791ec3f6f9SBlue Swirl 18801ec3f6f9SBlue Swirl# 18811ec3f6f9SBlue Swirl# Checks which may be anchored in the context. 18821ec3f6f9SBlue Swirl# 18831ec3f6f9SBlue Swirl 18841ec3f6f9SBlue Swirl# Check for switch () and associated case and default 18851ec3f6f9SBlue Swirl# statements should be at the same indent. 18861ec3f6f9SBlue Swirl if ($line=~/\bswitch\s*\(.*\)/) { 18871ec3f6f9SBlue Swirl my $err = ''; 18881ec3f6f9SBlue Swirl my $sep = ''; 18891ec3f6f9SBlue Swirl my @ctx = ctx_block_outer($linenr, $realcnt); 18901ec3f6f9SBlue Swirl shift(@ctx); 18911ec3f6f9SBlue Swirl for my $ctx (@ctx) { 18921ec3f6f9SBlue Swirl my ($clen, $cindent) = line_stats($ctx); 18931ec3f6f9SBlue Swirl if ($ctx =~ /^\+\s*(case\s+|default:)/ && 18941ec3f6f9SBlue Swirl $indent != $cindent) { 18951ec3f6f9SBlue Swirl $err .= "$sep$ctx\n"; 18961ec3f6f9SBlue Swirl $sep = ''; 18971ec3f6f9SBlue Swirl } else { 18981ec3f6f9SBlue Swirl $sep = "[...]\n"; 18991ec3f6f9SBlue Swirl } 19001ec3f6f9SBlue Swirl } 19011ec3f6f9SBlue Swirl if ($err ne '') { 19021ec3f6f9SBlue Swirl ERROR("switch and case should be at the same indent\n$hereline$err"); 19031ec3f6f9SBlue Swirl } 19041ec3f6f9SBlue Swirl } 19051ec3f6f9SBlue Swirl 19061ec3f6f9SBlue Swirl# if/while/etc brace do not go on next line, unless defining a do while loop, 19071ec3f6f9SBlue Swirl# or if that brace on the next line is for something else 19081ec3f6f9SBlue Swirl if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 19091ec3f6f9SBlue Swirl my $pre_ctx = "$1$2"; 19101ec3f6f9SBlue Swirl 19111ec3f6f9SBlue Swirl my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 19121ec3f6f9SBlue Swirl my $ctx_cnt = $realcnt - $#ctx - 1; 19131ec3f6f9SBlue Swirl my $ctx = join("\n", @ctx); 19141ec3f6f9SBlue Swirl 19151ec3f6f9SBlue Swirl my $ctx_ln = $linenr; 19161ec3f6f9SBlue Swirl my $ctx_skip = $realcnt; 19171ec3f6f9SBlue Swirl 19181ec3f6f9SBlue Swirl while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 19191ec3f6f9SBlue Swirl defined $lines[$ctx_ln - 1] && 19201ec3f6f9SBlue Swirl $lines[$ctx_ln - 1] =~ /^-/)) { 19211ec3f6f9SBlue Swirl ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 19221ec3f6f9SBlue Swirl $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 19231ec3f6f9SBlue Swirl $ctx_ln++; 19241ec3f6f9SBlue Swirl } 19251ec3f6f9SBlue Swirl 19261ec3f6f9SBlue Swirl #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 19271ec3f6f9SBlue Swirl #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 19281ec3f6f9SBlue Swirl 1929a97ceca5SMax Reitz # The length of the "previous line" is checked against 80 because it 1930a97ceca5SMax Reitz # includes the + at the beginning of the line (if the actual line has 1931a97ceca5SMax Reitz # 79 or 80 characters, it is no longer possible to add a space and an 1932a97ceca5SMax Reitz # opening brace there) 1933a97ceca5SMax Reitz if ($#ctx == 0 && $ctx !~ /{\s*/ && 193404f2562fSFam Zheng defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ && 1935a97ceca5SMax Reitz defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) { 19361ec3f6f9SBlue Swirl ERROR("that open brace { should be on the previous line\n" . 19371ec3f6f9SBlue Swirl "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 19381ec3f6f9SBlue Swirl } 19391ec3f6f9SBlue Swirl if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 19401ec3f6f9SBlue Swirl $ctx =~ /\)\s*\;\s*$/ && 19411ec3f6f9SBlue Swirl defined $lines[$ctx_ln - 1]) 19421ec3f6f9SBlue Swirl { 19431ec3f6f9SBlue Swirl my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 19441ec3f6f9SBlue Swirl if ($nindent > $indent) { 1945c2df8783SPaolo Bonzini ERROR("trailing semicolon indicates no statements, indent implies otherwise\n" . 19461ec3f6f9SBlue Swirl "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 19471ec3f6f9SBlue Swirl } 19481ec3f6f9SBlue Swirl } 19491ec3f6f9SBlue Swirl } 19501ec3f6f9SBlue Swirl 1951f4bdc13eSEric Blake# 'do ... while (0/false)' only makes sense in macros, without trailing ';' 1952f4bdc13eSEric Blake if ($line =~ /while\s*\((0|false)\);/) { 1953f4bdc13eSEric Blake ERROR("suspicious ; after while (0)\n" . $herecurr); 1954f4bdc13eSEric Blake } 1955f4bdc13eSEric Blake 1956ee0f3c09SPhilippe Mathieu-Daudé# Check superfluous trailing ';' 1957ee0f3c09SPhilippe Mathieu-Daudé if ($line =~ /;;$/) { 1958ee0f3c09SPhilippe Mathieu-Daudé ERROR("superfluous trailing semicolon\n" . $herecurr); 1959ee0f3c09SPhilippe Mathieu-Daudé } 1960ee0f3c09SPhilippe Mathieu-Daudé 19611ec3f6f9SBlue Swirl# Check relative indent for conditionals and blocks. 19621ec3f6f9SBlue Swirl if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 19631ec3f6f9SBlue Swirl my ($s, $c) = ($stat, $cond); 19641ec3f6f9SBlue Swirl 19651ec3f6f9SBlue Swirl substr($s, 0, length($c), ''); 19661ec3f6f9SBlue Swirl 19671ec3f6f9SBlue Swirl # Make sure we remove the line prefixes as we have 196865fdb3ccSzhaolichang # none on the first line, and are going to re-add them 19691ec3f6f9SBlue Swirl # where necessary. 19701ec3f6f9SBlue Swirl $s =~ s/\n./\n/gs; 19711ec3f6f9SBlue Swirl 19721ec3f6f9SBlue Swirl # Find out how long the conditional actually is. 19731ec3f6f9SBlue Swirl my @newlines = ($c =~ /\n/gs); 19741ec3f6f9SBlue Swirl my $cond_lines = 1 + $#newlines; 19751ec3f6f9SBlue Swirl 19761ec3f6f9SBlue Swirl # We want to check the first line inside the block 19771ec3f6f9SBlue Swirl # starting at the end of the conditional, so remove: 19781ec3f6f9SBlue Swirl # 1) any blank line termination 19791ec3f6f9SBlue Swirl # 2) any opening brace { on end of the line 19801ec3f6f9SBlue Swirl # 3) any do (...) { 19811ec3f6f9SBlue Swirl my $continuation = 0; 19821ec3f6f9SBlue Swirl my $check = 0; 19831ec3f6f9SBlue Swirl $s =~ s/^.*\bdo\b//; 198404f2562fSFam Zheng $s =~ s/^\s*\{//; 19851ec3f6f9SBlue Swirl if ($s =~ s/^\s*\\//) { 19861ec3f6f9SBlue Swirl $continuation = 1; 19871ec3f6f9SBlue Swirl } 19881ec3f6f9SBlue Swirl if ($s =~ s/^\s*?\n//) { 19891ec3f6f9SBlue Swirl $check = 1; 19901ec3f6f9SBlue Swirl $cond_lines++; 19911ec3f6f9SBlue Swirl } 19921ec3f6f9SBlue Swirl 19931ec3f6f9SBlue Swirl # Also ignore a loop construct at the end of a 19941ec3f6f9SBlue Swirl # preprocessor statement. 19951ec3f6f9SBlue Swirl if (($prevline =~ /^.\s*#\s*define\s/ || 19961ec3f6f9SBlue Swirl $prevline =~ /\\\s*$/) && $continuation == 0) { 19971ec3f6f9SBlue Swirl $check = 0; 19981ec3f6f9SBlue Swirl } 19991ec3f6f9SBlue Swirl 20001ec3f6f9SBlue Swirl my $cond_ptr = -1; 20011ec3f6f9SBlue Swirl $continuation = 0; 20021ec3f6f9SBlue Swirl while ($cond_ptr != $cond_lines) { 20031ec3f6f9SBlue Swirl $cond_ptr = $cond_lines; 20041ec3f6f9SBlue Swirl 20051ec3f6f9SBlue Swirl # If we see an #else/#elif then the code 20061ec3f6f9SBlue Swirl # is not linear. 20071ec3f6f9SBlue Swirl if ($s =~ /^\s*\#\s*(?:else|elif)/) { 20081ec3f6f9SBlue Swirl $check = 0; 20091ec3f6f9SBlue Swirl } 20101ec3f6f9SBlue Swirl 20111ec3f6f9SBlue Swirl # Ignore: 20121ec3f6f9SBlue Swirl # 1) blank lines, they should be at 0, 20131ec3f6f9SBlue Swirl # 2) preprocessor lines, and 20141ec3f6f9SBlue Swirl # 3) labels. 20151ec3f6f9SBlue Swirl if ($continuation || 20161ec3f6f9SBlue Swirl $s =~ /^\s*?\n/ || 20171ec3f6f9SBlue Swirl $s =~ /^\s*#\s*?/ || 20181ec3f6f9SBlue Swirl $s =~ /^\s*$Ident\s*:/) { 20191ec3f6f9SBlue Swirl $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 20201ec3f6f9SBlue Swirl if ($s =~ s/^.*?\n//) { 20211ec3f6f9SBlue Swirl $cond_lines++; 20221ec3f6f9SBlue Swirl } 20231ec3f6f9SBlue Swirl } 20241ec3f6f9SBlue Swirl } 20251ec3f6f9SBlue Swirl 20261ec3f6f9SBlue Swirl my (undef, $sindent) = line_stats("+" . $s); 20271ec3f6f9SBlue Swirl my $stat_real = raw_line($linenr, $cond_lines); 20281ec3f6f9SBlue Swirl 20291ec3f6f9SBlue Swirl # Check if either of these lines are modified, else 20301ec3f6f9SBlue Swirl # this is not this patch's fault. 20311ec3f6f9SBlue Swirl if (!defined($stat_real) || 20321ec3f6f9SBlue Swirl $stat !~ /^\+/ && $stat_real !~ /^\+/) { 20331ec3f6f9SBlue Swirl $check = 0; 20341ec3f6f9SBlue Swirl } 20351ec3f6f9SBlue Swirl if (defined($stat_real) && $cond_lines > 1) { 20361ec3f6f9SBlue Swirl $stat_real = "[...]\n$stat_real"; 20371ec3f6f9SBlue Swirl } 20381ec3f6f9SBlue Swirl 20391ec3f6f9SBlue Swirl #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n"; 20401ec3f6f9SBlue Swirl 2041b6469683SBlue Swirl if ($check && (($sindent % 4) != 0 || 20421ec3f6f9SBlue Swirl ($sindent <= $indent && $s ne ''))) { 2043c2df8783SPaolo Bonzini ERROR("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 20441ec3f6f9SBlue Swirl } 20451ec3f6f9SBlue Swirl } 20461ec3f6f9SBlue Swirl 20471ec3f6f9SBlue Swirl # Track the 'values' across context and added lines. 20481ec3f6f9SBlue Swirl my $opline = $line; $opline =~ s/^./ /; 20491ec3f6f9SBlue Swirl my ($curr_values, $curr_vars) = 20501ec3f6f9SBlue Swirl annotate_values($opline . "\n", $prev_values); 20511ec3f6f9SBlue Swirl $curr_values = $prev_values . $curr_values; 20521ec3f6f9SBlue Swirl if ($dbg_values) { 20531ec3f6f9SBlue Swirl my $outline = $opline; $outline =~ s/\t/ /g; 20541ec3f6f9SBlue Swirl print "$linenr > .$outline\n"; 20551ec3f6f9SBlue Swirl print "$linenr > $curr_values\n"; 20561ec3f6f9SBlue Swirl print "$linenr > $curr_vars\n"; 20571ec3f6f9SBlue Swirl } 20581ec3f6f9SBlue Swirl $prev_values = substr($curr_values, -1); 20591ec3f6f9SBlue Swirl 20601ec3f6f9SBlue Swirl#ignore lines not being added 20611ec3f6f9SBlue Swirl if ($line=~/^[^\+]/) {next;} 20621ec3f6f9SBlue Swirl 20631ec3f6f9SBlue Swirl# TEST: allow direct testing of the type matcher. 20641ec3f6f9SBlue Swirl if ($dbg_type) { 20651ec3f6f9SBlue Swirl if ($line =~ /^.\s*$Declare\s*$/) { 20661ec3f6f9SBlue Swirl ERROR("TEST: is type\n" . $herecurr); 20671ec3f6f9SBlue Swirl } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 20681ec3f6f9SBlue Swirl ERROR("TEST: is not type ($1 is)\n". $herecurr); 20691ec3f6f9SBlue Swirl } 20701ec3f6f9SBlue Swirl next; 20711ec3f6f9SBlue Swirl } 20721ec3f6f9SBlue Swirl# TEST: allow direct testing of the attribute matcher. 20731ec3f6f9SBlue Swirl if ($dbg_attr) { 20741ec3f6f9SBlue Swirl if ($line =~ /^.\s*$Modifier\s*$/) { 20751ec3f6f9SBlue Swirl ERROR("TEST: is attr\n" . $herecurr); 20761ec3f6f9SBlue Swirl } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 20771ec3f6f9SBlue Swirl ERROR("TEST: is not attr ($1 is)\n". $herecurr); 20781ec3f6f9SBlue Swirl } 20791ec3f6f9SBlue Swirl next; 20801ec3f6f9SBlue Swirl } 20811ec3f6f9SBlue Swirl 20821ec3f6f9SBlue Swirl# check for initialisation to aggregates open brace on the next line 208304f2562fSFam Zheng if ($line =~ /^.\s*\{/ && 20841ec3f6f9SBlue Swirl $prevline =~ /(?:^|[^=])=\s*$/) { 20851ec3f6f9SBlue Swirl ERROR("that open brace { should be on the previous line\n" . $hereprev); 20861ec3f6f9SBlue Swirl } 20871ec3f6f9SBlue Swirl 20881ec3f6f9SBlue Swirl# 20891ec3f6f9SBlue Swirl# Checks which are anchored on the added line. 20901ec3f6f9SBlue Swirl# 20911ec3f6f9SBlue Swirl 20921ec3f6f9SBlue Swirl# check for malformed paths in #include statements (uses RAW line) 20931ec3f6f9SBlue Swirl if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 20941ec3f6f9SBlue Swirl my $path = $1; 20951ec3f6f9SBlue Swirl if ($path =~ m{//}) { 20961ec3f6f9SBlue Swirl ERROR("malformed #include filename\n" . 20971ec3f6f9SBlue Swirl $herecurr); 20981ec3f6f9SBlue Swirl } 20991ec3f6f9SBlue Swirl } 21001ec3f6f9SBlue Swirl 21011ec3f6f9SBlue Swirl# no C99 // comments 21028d061278SPeter Xu if ($line =~ m{//} && 21038d061278SPeter Xu $rawline !~ m{// SPDX-License-Identifier: }) { 21041ec3f6f9SBlue Swirl ERROR("do not use C99 // comments\n" . $herecurr); 21051ec3f6f9SBlue Swirl } 21061ec3f6f9SBlue Swirl # Remove C99 comments. 21071ec3f6f9SBlue Swirl $line =~ s@//.*@@; 21081ec3f6f9SBlue Swirl $opline =~ s@//.*@@; 21091ec3f6f9SBlue Swirl 21101ec3f6f9SBlue Swirl# check for global initialisers. 21111ec3f6f9SBlue Swirl if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 21121ec3f6f9SBlue Swirl ERROR("do not initialise globals to 0 or NULL\n" . 21131ec3f6f9SBlue Swirl $herecurr); 21141ec3f6f9SBlue Swirl } 21151ec3f6f9SBlue Swirl# check for static initialisers. 21161ec3f6f9SBlue Swirl if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 21171ec3f6f9SBlue Swirl ERROR("do not initialise statics to 0 or NULL\n" . 21181ec3f6f9SBlue Swirl $herecurr); 21191ec3f6f9SBlue Swirl } 21201ec3f6f9SBlue Swirl 21211ec3f6f9SBlue Swirl# * goes on variable not on type 21221ec3f6f9SBlue Swirl # (char*[ const]) 21231ec3f6f9SBlue Swirl if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { 21241ec3f6f9SBlue Swirl my ($from, $to) = ($1, $1); 21251ec3f6f9SBlue Swirl 21261ec3f6f9SBlue Swirl # Should start with a space. 21271ec3f6f9SBlue Swirl $to =~ s/^(\S)/ $1/; 21281ec3f6f9SBlue Swirl # Should not end with a space. 21291ec3f6f9SBlue Swirl $to =~ s/\s+$//; 21301ec3f6f9SBlue Swirl # '*'s should not have spaces between. 21311ec3f6f9SBlue Swirl while ($to =~ s/\*\s+\*/\*\*/) { 21321ec3f6f9SBlue Swirl } 21331ec3f6f9SBlue Swirl 21341ec3f6f9SBlue Swirl #print "from<$from> to<$to>\n"; 21351ec3f6f9SBlue Swirl if ($from ne $to) { 21361ec3f6f9SBlue Swirl ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 21371ec3f6f9SBlue Swirl } 21381ec3f6f9SBlue Swirl } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { 21391ec3f6f9SBlue Swirl my ($from, $to, $ident) = ($1, $1, $2); 21401ec3f6f9SBlue Swirl 21411ec3f6f9SBlue Swirl # Should start with a space. 21421ec3f6f9SBlue Swirl $to =~ s/^(\S)/ $1/; 21431ec3f6f9SBlue Swirl # Should not end with a space. 21441ec3f6f9SBlue Swirl $to =~ s/\s+$//; 21451ec3f6f9SBlue Swirl # '*'s should not have spaces between. 21461ec3f6f9SBlue Swirl while ($to =~ s/\*\s+\*/\*\*/) { 21471ec3f6f9SBlue Swirl } 21481ec3f6f9SBlue Swirl # Modifiers should have spaces. 21491ec3f6f9SBlue Swirl $to =~ s/(\b$Modifier$)/$1 /; 21501ec3f6f9SBlue Swirl 21511ec3f6f9SBlue Swirl #print "from<$from> to<$to> ident<$ident>\n"; 21521ec3f6f9SBlue Swirl if ($from ne $to && $ident !~ /^$Modifier$/) { 21531ec3f6f9SBlue Swirl ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 21541ec3f6f9SBlue Swirl } 21551ec3f6f9SBlue Swirl } 21561ec3f6f9SBlue Swirl 21571ec3f6f9SBlue Swirl# function brace can't be on same line, except for #defines of do while, 21581ec3f6f9SBlue Swirl# or if closed on same line 215904f2562fSFam Zheng if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and 216004f2562fSFam Zheng !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 21611ec3f6f9SBlue Swirl ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 21621ec3f6f9SBlue Swirl } 21631ec3f6f9SBlue Swirl 21641ec3f6f9SBlue Swirl# open braces for enum, union and struct go on the same line. 216504f2562fSFam Zheng if ($line =~ /^.\s*\{/ && 21661ec3f6f9SBlue Swirl $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 21671ec3f6f9SBlue Swirl ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 21681ec3f6f9SBlue Swirl } 21691ec3f6f9SBlue Swirl 21701ec3f6f9SBlue Swirl# missing space after union, struct or enum definition 21711ec3f6f9SBlue Swirl if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 217271c47b01SPaolo Bonzini ERROR("missing space after $1 definition\n" . $herecurr); 21731ec3f6f9SBlue Swirl } 21741ec3f6f9SBlue Swirl 21751ec3f6f9SBlue Swirl# check for spacing round square brackets; allowed: 21761ec3f6f9SBlue Swirl# 1. with a type on the left -- int [] a; 21771ec3f6f9SBlue Swirl# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 21781ec3f6f9SBlue Swirl# 3. inside a curly brace -- = { [0...10] = 5 } 2179409db6ebSLeonid Bloch# 4. after a comma -- [1] = 5, [2] = 6 21808800cf0aSLeonid Bloch# 5. in a macro definition -- #define abc(x) [x] = y 21811ec3f6f9SBlue Swirl while ($line =~ /(.*?\s)\[/g) { 21821ec3f6f9SBlue Swirl my ($where, $prefix) = ($-[1], $1); 21831ec3f6f9SBlue Swirl if ($prefix !~ /$Type\s+$/ && 21841ec3f6f9SBlue Swirl ($where != 0 || $prefix !~ /^.\s+$/) && 21858800cf0aSLeonid Bloch $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ && 218666e9d20eSHeinrich Schuchardt $prefix !~ /[,{:]\s+$/) { 21871ec3f6f9SBlue Swirl ERROR("space prohibited before open square bracket '['\n" . $herecurr); 21881ec3f6f9SBlue Swirl } 21891ec3f6f9SBlue Swirl } 21901ec3f6f9SBlue Swirl 21911ec3f6f9SBlue Swirl# check for spaces between functions and their parentheses. 21921ec3f6f9SBlue Swirl while ($line =~ /($Ident)\s+\(/g) { 21931ec3f6f9SBlue Swirl my $name = $1; 21941ec3f6f9SBlue Swirl my $ctx_before = substr($line, 0, $-[1]); 21951ec3f6f9SBlue Swirl my $ctx = "$ctx_before$name"; 21961ec3f6f9SBlue Swirl 21971ec3f6f9SBlue Swirl # Ignore those directives where spaces _are_ permitted. 21981ec3f6f9SBlue Swirl if ($name =~ /^(?: 21991ec3f6f9SBlue Swirl if|for|while|switch|return|case| 2200000980cbSJeff Cody volatile|__volatile__|coroutine_fn| 22011ec3f6f9SBlue Swirl __attribute__|format|__extension__| 22021ec3f6f9SBlue Swirl asm|__asm__)$/x) 22031ec3f6f9SBlue Swirl { 22041ec3f6f9SBlue Swirl 220569d5d21fSTomoki Sekiyama # Ignore 'catch (...)' in C++ 220669d5d21fSTomoki Sekiyama } elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) { 220769d5d21fSTomoki Sekiyama 22081ec3f6f9SBlue Swirl # cpp #define statements have non-optional spaces, ie 22091ec3f6f9SBlue Swirl # if there is a space between the name and the open 22101ec3f6f9SBlue Swirl # parenthesis it is simply not a parameter group. 22111ec3f6f9SBlue Swirl } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 22121ec3f6f9SBlue Swirl 22131ec3f6f9SBlue Swirl # cpp #elif statement condition may start with a ( 22141ec3f6f9SBlue Swirl } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 22151ec3f6f9SBlue Swirl 22161ec3f6f9SBlue Swirl # If this whole things ends with a type its most 22171ec3f6f9SBlue Swirl # likely a typedef for a function. 22181ec3f6f9SBlue Swirl } elsif ($ctx =~ /$Type$/) { 22191ec3f6f9SBlue Swirl 22201ec3f6f9SBlue Swirl } else { 2221c2df8783SPaolo Bonzini ERROR("space prohibited between function name and open parenthesis '('\n" . $herecurr); 22221ec3f6f9SBlue Swirl } 22231ec3f6f9SBlue Swirl } 22241ec3f6f9SBlue Swirl# Check operator spacing. 22251ec3f6f9SBlue Swirl if (!($line=~/\#\s*include/)) { 22261ec3f6f9SBlue Swirl my $ops = qr{ 22271ec3f6f9SBlue Swirl <<=|>>=|<=|>=|==|!=| 22281ec3f6f9SBlue Swirl \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 22291ec3f6f9SBlue Swirl =>|->|<<|>>|<|>|=|!|~| 22301ec3f6f9SBlue Swirl &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 223169d5d21fSTomoki Sekiyama \?|::|: 22321ec3f6f9SBlue Swirl }x; 22331ec3f6f9SBlue Swirl my @elements = split(/($ops|;)/, $opline); 22341ec3f6f9SBlue Swirl my $off = 0; 22351ec3f6f9SBlue Swirl 22361ec3f6f9SBlue Swirl my $blank = copy_spacing($opline); 22371ec3f6f9SBlue Swirl 22381ec3f6f9SBlue Swirl for (my $n = 0; $n < $#elements; $n += 2) { 22391ec3f6f9SBlue Swirl $off += length($elements[$n]); 22401ec3f6f9SBlue Swirl 2241e7d81004SStefan Weil # Pick up the preceding and succeeding characters. 22421ec3f6f9SBlue Swirl my $ca = substr($opline, 0, $off); 22431ec3f6f9SBlue Swirl my $cc = ''; 22441ec3f6f9SBlue Swirl if (length($opline) >= ($off + length($elements[$n + 1]))) { 22451ec3f6f9SBlue Swirl $cc = substr($opline, $off + length($elements[$n + 1])); 22461ec3f6f9SBlue Swirl } 22471ec3f6f9SBlue Swirl my $cb = "$ca$;$cc"; 22481ec3f6f9SBlue Swirl 22491ec3f6f9SBlue Swirl my $a = ''; 22501ec3f6f9SBlue Swirl $a = 'V' if ($elements[$n] ne ''); 22511ec3f6f9SBlue Swirl $a = 'W' if ($elements[$n] =~ /\s$/); 22521ec3f6f9SBlue Swirl $a = 'C' if ($elements[$n] =~ /$;$/); 22531ec3f6f9SBlue Swirl $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 22541ec3f6f9SBlue Swirl $a = 'O' if ($elements[$n] eq ''); 22551ec3f6f9SBlue Swirl $a = 'E' if ($ca =~ /^\s*$/); 22561ec3f6f9SBlue Swirl 22571ec3f6f9SBlue Swirl my $op = $elements[$n + 1]; 22581ec3f6f9SBlue Swirl 22591ec3f6f9SBlue Swirl my $c = ''; 22601ec3f6f9SBlue Swirl if (defined $elements[$n + 2]) { 22611ec3f6f9SBlue Swirl $c = 'V' if ($elements[$n + 2] ne ''); 22621ec3f6f9SBlue Swirl $c = 'W' if ($elements[$n + 2] =~ /^\s/); 22631ec3f6f9SBlue Swirl $c = 'C' if ($elements[$n + 2] =~ /^$;/); 22641ec3f6f9SBlue Swirl $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 22651ec3f6f9SBlue Swirl $c = 'O' if ($elements[$n + 2] eq ''); 22661ec3f6f9SBlue Swirl $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 22671ec3f6f9SBlue Swirl } else { 22681ec3f6f9SBlue Swirl $c = 'E'; 22691ec3f6f9SBlue Swirl } 22701ec3f6f9SBlue Swirl 22711ec3f6f9SBlue Swirl my $ctx = "${a}x${c}"; 22721ec3f6f9SBlue Swirl 22731ec3f6f9SBlue Swirl my $at = "(ctx:$ctx)"; 22741ec3f6f9SBlue Swirl 22751ec3f6f9SBlue Swirl my $ptr = substr($blank, 0, $off) . "^"; 22761ec3f6f9SBlue Swirl my $hereptr = "$hereline$ptr\n"; 22771ec3f6f9SBlue Swirl 22781ec3f6f9SBlue Swirl # Pull out the value of this operator. 22791ec3f6f9SBlue Swirl my $op_type = substr($curr_values, $off + 1, 1); 22801ec3f6f9SBlue Swirl 22811ec3f6f9SBlue Swirl # Get the full operator variant. 22821ec3f6f9SBlue Swirl my $opv = $op . substr($curr_vars, $off, 1); 22831ec3f6f9SBlue Swirl 22841ec3f6f9SBlue Swirl # Ignore operators passed as parameters. 22851ec3f6f9SBlue Swirl if ($op_type ne 'V' && 22861ec3f6f9SBlue Swirl $ca =~ /\s$/ && $cc =~ /^\s*,/) { 22871ec3f6f9SBlue Swirl 22881ec3f6f9SBlue Swirl# # Ignore comments 22891ec3f6f9SBlue Swirl# } elsif ($op =~ /^$;+$/) { 22901ec3f6f9SBlue Swirl 22911ec3f6f9SBlue Swirl # ; should have either the end of line or a space or \ after it 22921ec3f6f9SBlue Swirl } elsif ($op eq ';') { 22931ec3f6f9SBlue Swirl if ($ctx !~ /.x[WEBC]/ && 22941ec3f6f9SBlue Swirl $cc !~ /^\\/ && $cc !~ /^;/) { 22951ec3f6f9SBlue Swirl ERROR("space required after that '$op' $at\n" . $hereptr); 22961ec3f6f9SBlue Swirl } 22971ec3f6f9SBlue Swirl 22981ec3f6f9SBlue Swirl # // is a comment 22991ec3f6f9SBlue Swirl } elsif ($op eq '//') { 23001ec3f6f9SBlue Swirl 230169d5d21fSTomoki Sekiyama # Ignore : used in class declaration in C++ 230269d5d21fSTomoki Sekiyama } elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ && 230369d5d21fSTomoki Sekiyama $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) { 230469d5d21fSTomoki Sekiyama 23051ec3f6f9SBlue Swirl # No spaces for: 23061ec3f6f9SBlue Swirl # -> 23071ec3f6f9SBlue Swirl # : when part of a bitfield 23081ec3f6f9SBlue Swirl } elsif ($op eq '->' || $opv eq ':B') { 23091ec3f6f9SBlue Swirl if ($ctx =~ /Wx.|.xW/) { 23101ec3f6f9SBlue Swirl ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 23111ec3f6f9SBlue Swirl } 23121ec3f6f9SBlue Swirl 23131ec3f6f9SBlue Swirl # , must have a space on the right. 23149fbe4784SAlexander Graf # not required when having a single },{ on one line 23151ec3f6f9SBlue Swirl } elsif ($op eq ',') { 23169fbe4784SAlexander Graf if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ && 231704f2562fSFam Zheng ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") { 23181ec3f6f9SBlue Swirl ERROR("space required after that '$op' $at\n" . $hereptr); 23191ec3f6f9SBlue Swirl } 23201ec3f6f9SBlue Swirl 23211ec3f6f9SBlue Swirl # '*' as part of a type definition -- reported already. 23221ec3f6f9SBlue Swirl } elsif ($opv eq '*_') { 23231ec3f6f9SBlue Swirl #warn "'*' is part of type\n"; 23241ec3f6f9SBlue Swirl 23251ec3f6f9SBlue Swirl # unary operators should have a space before and 23261ec3f6f9SBlue Swirl # none after. May be left adjacent to another 23271ec3f6f9SBlue Swirl # unary operator, or a cast 23281ec3f6f9SBlue Swirl } elsif ($op eq '!' || $op eq '~' || 23291ec3f6f9SBlue Swirl $opv eq '*U' || $opv eq '-U' || 23301ec3f6f9SBlue Swirl $opv eq '&U' || $opv eq '&&U') { 233169d5d21fSTomoki Sekiyama if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) { 233269d5d21fSTomoki Sekiyama # '~' used as a name of Destructor 233369d5d21fSTomoki Sekiyama 233469d5d21fSTomoki Sekiyama } elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 23351ec3f6f9SBlue Swirl ERROR("space required before that '$op' $at\n" . $hereptr); 23361ec3f6f9SBlue Swirl } 23371ec3f6f9SBlue Swirl if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 23381ec3f6f9SBlue Swirl # A unary '*' may be const 23391ec3f6f9SBlue Swirl 23401ec3f6f9SBlue Swirl } elsif ($ctx =~ /.xW/) { 23411ec3f6f9SBlue Swirl ERROR("space prohibited after that '$op' $at\n" . $hereptr); 23421ec3f6f9SBlue Swirl } 23431ec3f6f9SBlue Swirl 23441ec3f6f9SBlue Swirl # unary ++ and unary -- are allowed no space on one side. 23451ec3f6f9SBlue Swirl } elsif ($op eq '++' or $op eq '--') { 23461ec3f6f9SBlue Swirl if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 23471ec3f6f9SBlue Swirl ERROR("space required one side of that '$op' $at\n" . $hereptr); 23481ec3f6f9SBlue Swirl } 23491ec3f6f9SBlue Swirl if ($ctx =~ /Wx[BE]/ || 23501ec3f6f9SBlue Swirl ($ctx =~ /Wx./ && $cc =~ /^;/)) { 23511ec3f6f9SBlue Swirl ERROR("space prohibited before that '$op' $at\n" . $hereptr); 23521ec3f6f9SBlue Swirl } 23531ec3f6f9SBlue Swirl if ($ctx =~ /ExW/) { 23541ec3f6f9SBlue Swirl ERROR("space prohibited after that '$op' $at\n" . $hereptr); 23551ec3f6f9SBlue Swirl } 23561ec3f6f9SBlue Swirl 23571ec3f6f9SBlue Swirl # A colon needs no spaces before when it is 23581ec3f6f9SBlue Swirl # terminating a case value or a label. 23591ec3f6f9SBlue Swirl } elsif ($opv eq ':C' || $opv eq ':L') { 23601ec3f6f9SBlue Swirl if ($ctx =~ /Wx./) { 23611ec3f6f9SBlue Swirl ERROR("space prohibited before that '$op' $at\n" . $hereptr); 23621ec3f6f9SBlue Swirl } 23631ec3f6f9SBlue Swirl 23641ec3f6f9SBlue Swirl # All the others need spaces both sides. 23651ec3f6f9SBlue Swirl } elsif ($ctx !~ /[EWC]x[CWE]/) { 23661ec3f6f9SBlue Swirl my $ok = 0; 23671ec3f6f9SBlue Swirl 236869d5d21fSTomoki Sekiyama if ($realfile =~ /\.cpp|\.h$/) { 236969d5d21fSTomoki Sekiyama # Ignore template arguments <...> in C++ 237069d5d21fSTomoki Sekiyama if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) { 237169d5d21fSTomoki Sekiyama $ok = 1; 237269d5d21fSTomoki Sekiyama } 237369d5d21fSTomoki Sekiyama 237469d5d21fSTomoki Sekiyama # Ignore :: in C++ 237569d5d21fSTomoki Sekiyama if ($op eq '::') { 237669d5d21fSTomoki Sekiyama $ok = 1; 237769d5d21fSTomoki Sekiyama } 237869d5d21fSTomoki Sekiyama } 237969d5d21fSTomoki Sekiyama 23801ec3f6f9SBlue Swirl # Ignore email addresses <foo@bar> 23811ec3f6f9SBlue Swirl if (($op eq '<' && 23821ec3f6f9SBlue Swirl $cc =~ /^\S+\@\S+>/) || 23831ec3f6f9SBlue Swirl ($op eq '>' && 23841ec3f6f9SBlue Swirl $ca =~ /<\S+\@\S+$/)) 23851ec3f6f9SBlue Swirl { 23861ec3f6f9SBlue Swirl $ok = 1; 23871ec3f6f9SBlue Swirl } 23881ec3f6f9SBlue Swirl 23891ec3f6f9SBlue Swirl # Ignore ?: 23901ec3f6f9SBlue Swirl if (($opv eq ':O' && $ca =~ /\?$/) || 23911ec3f6f9SBlue Swirl ($op eq '?' && $cc =~ /^:/)) { 23921ec3f6f9SBlue Swirl $ok = 1; 23931ec3f6f9SBlue Swirl } 23941ec3f6f9SBlue Swirl 23951ec3f6f9SBlue Swirl if ($ok == 0) { 23961ec3f6f9SBlue Swirl ERROR("spaces required around that '$op' $at\n" . $hereptr); 23971ec3f6f9SBlue Swirl } 23981ec3f6f9SBlue Swirl } 23991ec3f6f9SBlue Swirl $off += length($elements[$n + 1]); 24001ec3f6f9SBlue Swirl } 24011ec3f6f9SBlue Swirl } 24021ec3f6f9SBlue Swirl 24031ec3f6f9SBlue Swirl#need space before brace following if, while, etc 240404f2562fSFam Zheng if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 240504f2562fSFam Zheng $line =~ /do\{/) { 24061ec3f6f9SBlue Swirl ERROR("space required before the open brace '{'\n" . $herecurr); 24071ec3f6f9SBlue Swirl } 24081ec3f6f9SBlue Swirl 24091ec3f6f9SBlue Swirl# closing brace should have a space following it when it has anything 24101ec3f6f9SBlue Swirl# on the line 24111ec3f6f9SBlue Swirl if ($line =~ /}(?!(?:,|;|\)))\S/) { 24121ec3f6f9SBlue Swirl ERROR("space required after that close brace '}'\n" . $herecurr); 24131ec3f6f9SBlue Swirl } 24141ec3f6f9SBlue Swirl 24151ec3f6f9SBlue Swirl# check spacing on square brackets 24161ec3f6f9SBlue Swirl if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 24171ec3f6f9SBlue Swirl ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 24181ec3f6f9SBlue Swirl } 24191ec3f6f9SBlue Swirl if ($line =~ /\s\]/) { 24201ec3f6f9SBlue Swirl ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 24211ec3f6f9SBlue Swirl } 24221ec3f6f9SBlue Swirl 24231ec3f6f9SBlue Swirl# check spacing on parentheses 24241ec3f6f9SBlue Swirl if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 24251ec3f6f9SBlue Swirl $line !~ /for\s*\(\s+;/) { 24261ec3f6f9SBlue Swirl ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 24271ec3f6f9SBlue Swirl } 24281ec3f6f9SBlue Swirl if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 24291ec3f6f9SBlue Swirl $line !~ /for\s*\(.*;\s+\)/ && 24301ec3f6f9SBlue Swirl $line !~ /:\s+\)/) { 24311ec3f6f9SBlue Swirl ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 24321ec3f6f9SBlue Swirl } 24331ec3f6f9SBlue Swirl 24341ec3f6f9SBlue Swirl# Return is not a function. 24351ec3f6f9SBlue Swirl if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 24361ec3f6f9SBlue Swirl my $spacing = $1; 24371ec3f6f9SBlue Swirl my $value = $2; 24381ec3f6f9SBlue Swirl 24391ec3f6f9SBlue Swirl # Flatten any parentheses 24401ec3f6f9SBlue Swirl $value =~ s/\(/ \(/g; 24411ec3f6f9SBlue Swirl $value =~ s/\)/\) /g; 24421ec3f6f9SBlue Swirl while ($value =~ s/\[[^\{\}]*\]/1/ || 24431ec3f6f9SBlue Swirl $value !~ /(?:$Ident|-?$Constant)\s* 24441ec3f6f9SBlue Swirl $Compare\s* 24451ec3f6f9SBlue Swirl (?:$Ident|-?$Constant)/x && 24461ec3f6f9SBlue Swirl $value =~ s/\([^\(\)]*\)/1/) { 24471ec3f6f9SBlue Swirl } 24481ec3f6f9SBlue Swirl#print "value<$value>\n"; 2449c20b1396SPaolo Bonzini if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/ && 2450c20b1396SPaolo Bonzini $line =~ /;$/) { 24511ec3f6f9SBlue Swirl ERROR("return is not a function, parentheses are not required\n" . $herecurr); 24521ec3f6f9SBlue Swirl 24531ec3f6f9SBlue Swirl } elsif ($spacing !~ /\s+/) { 24541ec3f6f9SBlue Swirl ERROR("space required before the open parenthesis '('\n" . $herecurr); 24551ec3f6f9SBlue Swirl } 24561ec3f6f9SBlue Swirl } 24571ec3f6f9SBlue Swirl# Return of what appears to be an errno should normally be -'ve 24581ec3f6f9SBlue Swirl if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 24591ec3f6f9SBlue Swirl my $name = $1; 24601ec3f6f9SBlue Swirl if ($name ne 'EOF' && $name ne 'ERROR') { 2461c2df8783SPaolo Bonzini ERROR("return of an errno should typically be -ve (return -$1)\n" . $herecurr); 24621ec3f6f9SBlue Swirl } 24631ec3f6f9SBlue Swirl } 24641ec3f6f9SBlue Swirl 246550db69a1SPaolo Bonzini if ($line =~ /^.\s*(Q(?:S?LIST|SIMPLEQ|TAILQ)_HEAD)\s*\(\s*[^,]/ && 246650db69a1SPaolo Bonzini $line !~ /^.typedef/) { 246750db69a1SPaolo Bonzini ERROR("named $1 should be typedefed separately\n" . $herecurr); 246850db69a1SPaolo Bonzini } 246950db69a1SPaolo Bonzini 24701ec3f6f9SBlue Swirl# Need a space before open parenthesis after if, while etc 24711ec3f6f9SBlue Swirl if ($line=~/\b(if|while|for|switch)\(/) { 24721ec3f6f9SBlue Swirl ERROR("space required before the open parenthesis '('\n" . $herecurr); 24731ec3f6f9SBlue Swirl } 24741ec3f6f9SBlue Swirl 24751ec3f6f9SBlue Swirl# Check for illegal assignment in if conditional -- and check for trailing 24761ec3f6f9SBlue Swirl# statements after the conditional. 24771ec3f6f9SBlue Swirl if ($line =~ /do\s*(?!{)/) { 24781ec3f6f9SBlue Swirl my ($stat_next) = ctx_statement_block($line_nr_next, 24791ec3f6f9SBlue Swirl $remain_next, $off_next); 24801ec3f6f9SBlue Swirl $stat_next =~ s/\n./\n /g; 24811ec3f6f9SBlue Swirl ##print "stat<$stat> stat_next<$stat_next>\n"; 24821ec3f6f9SBlue Swirl 24831ec3f6f9SBlue Swirl if ($stat_next =~ /^\s*while\b/) { 24841ec3f6f9SBlue Swirl # If the statement carries leading newlines, 24851ec3f6f9SBlue Swirl # then count those as offsets. 24861ec3f6f9SBlue Swirl my ($whitespace) = 24871ec3f6f9SBlue Swirl ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 24881ec3f6f9SBlue Swirl my $offset = 24891ec3f6f9SBlue Swirl statement_rawlines($whitespace) - 1; 24901ec3f6f9SBlue Swirl 24911ec3f6f9SBlue Swirl $suppress_whiletrailers{$line_nr_next + 24921ec3f6f9SBlue Swirl $offset} = 1; 24931ec3f6f9SBlue Swirl } 24941ec3f6f9SBlue Swirl } 24951ec3f6f9SBlue Swirl if (!defined $suppress_whiletrailers{$linenr} && 24961ec3f6f9SBlue Swirl $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 24971ec3f6f9SBlue Swirl my ($s, $c) = ($stat, $cond); 24981ec3f6f9SBlue Swirl 24991ec3f6f9SBlue Swirl if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 25001ec3f6f9SBlue Swirl ERROR("do not use assignment in if condition\n" . $herecurr); 25011ec3f6f9SBlue Swirl } 25021ec3f6f9SBlue Swirl 25031ec3f6f9SBlue Swirl # Find out what is on the end of the line after the 25041ec3f6f9SBlue Swirl # conditional. 25051ec3f6f9SBlue Swirl substr($s, 0, length($c), ''); 25061ec3f6f9SBlue Swirl $s =~ s/\n.*//g; 25071ec3f6f9SBlue Swirl $s =~ s/$;//g; # Remove any comments 25081ec3f6f9SBlue Swirl if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 25091ec3f6f9SBlue Swirl $c !~ /}\s*while\s*/) 25101ec3f6f9SBlue Swirl { 25111ec3f6f9SBlue Swirl # Find out how long the conditional actually is. 25121ec3f6f9SBlue Swirl my @newlines = ($c =~ /\n/gs); 25131ec3f6f9SBlue Swirl my $cond_lines = 1 + $#newlines; 25141ec3f6f9SBlue Swirl my $stat_real = ''; 25151ec3f6f9SBlue Swirl 25161ec3f6f9SBlue Swirl $stat_real = raw_line($linenr, $cond_lines) 25171ec3f6f9SBlue Swirl . "\n" if ($cond_lines); 25181ec3f6f9SBlue Swirl if (defined($stat_real) && $cond_lines > 1) { 25191ec3f6f9SBlue Swirl $stat_real = "[...]\n$stat_real"; 25201ec3f6f9SBlue Swirl } 25211ec3f6f9SBlue Swirl 25221ec3f6f9SBlue Swirl ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); 25231ec3f6f9SBlue Swirl } 25241ec3f6f9SBlue Swirl } 25251ec3f6f9SBlue Swirl 25261ec3f6f9SBlue Swirl# Check for bitwise tests written as boolean 25271ec3f6f9SBlue Swirl if ($line =~ / 25281ec3f6f9SBlue Swirl (?: 25291ec3f6f9SBlue Swirl (?:\[|\(|\&\&|\|\|) 25301ec3f6f9SBlue Swirl \s*0[xX][0-9]+\s* 25311ec3f6f9SBlue Swirl (?:\&\&|\|\|) 25321ec3f6f9SBlue Swirl | 25331ec3f6f9SBlue Swirl (?:\&\&|\|\|) 25341ec3f6f9SBlue Swirl \s*0[xX][0-9]+\s* 25351ec3f6f9SBlue Swirl (?:\&\&|\|\||\)|\]) 25361ec3f6f9SBlue Swirl )/x) 25371ec3f6f9SBlue Swirl { 2538c2df8783SPaolo Bonzini ERROR("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 25391ec3f6f9SBlue Swirl } 25401ec3f6f9SBlue Swirl 25411ec3f6f9SBlue Swirl# if and else should not have general statements after it 25421ec3f6f9SBlue Swirl if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 25431ec3f6f9SBlue Swirl my $s = $1; 25441ec3f6f9SBlue Swirl $s =~ s/$;//g; # Remove any comments 25451ec3f6f9SBlue Swirl if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 25461ec3f6f9SBlue Swirl ERROR("trailing statements should be on next line\n" . $herecurr); 25471ec3f6f9SBlue Swirl } 25481ec3f6f9SBlue Swirl } 25491ec3f6f9SBlue Swirl# if should not continue a brace 25501ec3f6f9SBlue Swirl if ($line =~ /}\s*if\b/) { 25511ec3f6f9SBlue Swirl ERROR("trailing statements should be on next line\n" . 25521ec3f6f9SBlue Swirl $herecurr); 25531ec3f6f9SBlue Swirl } 25541ec3f6f9SBlue Swirl# case and default should not have general statements after them 25551ec3f6f9SBlue Swirl if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 25561ec3f6f9SBlue Swirl $line !~ /\G(?: 25571ec3f6f9SBlue Swirl (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 25581ec3f6f9SBlue Swirl \s*return\s+ 25591ec3f6f9SBlue Swirl )/xg) 25601ec3f6f9SBlue Swirl { 25611ec3f6f9SBlue Swirl ERROR("trailing statements should be on next line\n" . $herecurr); 25621ec3f6f9SBlue Swirl } 25631ec3f6f9SBlue Swirl 25641ec3f6f9SBlue Swirl # Check for }<nl>else {, these must be at the same 25651ec3f6f9SBlue Swirl # indent level to be relevant to each other. 25661ec3f6f9SBlue Swirl if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 25671ec3f6f9SBlue Swirl $previndent == $indent) { 25681ec3f6f9SBlue Swirl ERROR("else should follow close brace '}'\n" . $hereprev); 25691ec3f6f9SBlue Swirl } 25701ec3f6f9SBlue Swirl 25711ec3f6f9SBlue Swirl if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 25721ec3f6f9SBlue Swirl $previndent == $indent) { 25731ec3f6f9SBlue Swirl my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 25741ec3f6f9SBlue Swirl 25751ec3f6f9SBlue Swirl # Find out what is on the end of the line after the 25761ec3f6f9SBlue Swirl # conditional. 25771ec3f6f9SBlue Swirl substr($s, 0, length($c), ''); 25781ec3f6f9SBlue Swirl $s =~ s/\n.*//g; 25791ec3f6f9SBlue Swirl 25801ec3f6f9SBlue Swirl if ($s =~ /^\s*;/) { 25811ec3f6f9SBlue Swirl ERROR("while should follow close brace '}'\n" . $hereprev); 25821ec3f6f9SBlue Swirl } 25831ec3f6f9SBlue Swirl } 25841ec3f6f9SBlue Swirl 25851ec3f6f9SBlue Swirl#studly caps, commented out until figure out how to distinguish between use of existing and adding new 25861ec3f6f9SBlue Swirl# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 25871ec3f6f9SBlue Swirl# print "No studly caps, use _\n"; 25881ec3f6f9SBlue Swirl# print "$herecurr"; 25891ec3f6f9SBlue Swirl# $clean = 0; 25901ec3f6f9SBlue Swirl# } 25911ec3f6f9SBlue Swirl 25921ec3f6f9SBlue Swirl#no spaces allowed after \ in define 25931ec3f6f9SBlue Swirl if ($line=~/\#\s*define.*\\\s$/) { 2594c2df8783SPaolo Bonzini ERROR("Whitespace after \\ makes next lines useless\n" . $herecurr); 25951ec3f6f9SBlue Swirl } 25961ec3f6f9SBlue Swirl 25971ec3f6f9SBlue Swirl# multi-statement macros should be enclosed in a do while loop, grab the 25981ec3f6f9SBlue Swirl# first statement and ensure its the whole macro if its not enclosed 25991ec3f6f9SBlue Swirl# in a known good container 26001ec3f6f9SBlue Swirl if ($realfile !~ m@/vmlinux.lds.h$@ && 26011ec3f6f9SBlue Swirl $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 26021ec3f6f9SBlue Swirl my $ln = $linenr; 26031ec3f6f9SBlue Swirl my $cnt = $realcnt; 26041ec3f6f9SBlue Swirl my ($off, $dstat, $dcond, $rest); 26051ec3f6f9SBlue Swirl my $ctx = ''; 26061ec3f6f9SBlue Swirl 26071ec3f6f9SBlue Swirl my $args = defined($1); 26081ec3f6f9SBlue Swirl 26091ec3f6f9SBlue Swirl # Find the end of the macro and limit our statement 26101ec3f6f9SBlue Swirl # search to that. 26111ec3f6f9SBlue Swirl while ($cnt > 0 && defined $lines[$ln - 1] && 26121ec3f6f9SBlue Swirl $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 26131ec3f6f9SBlue Swirl { 26141ec3f6f9SBlue Swirl $ctx .= $rawlines[$ln - 1] . "\n"; 26151ec3f6f9SBlue Swirl $cnt-- if ($lines[$ln - 1] !~ /^-/); 26161ec3f6f9SBlue Swirl $ln++; 26171ec3f6f9SBlue Swirl } 26181ec3f6f9SBlue Swirl $ctx .= $rawlines[$ln - 1]; 26191ec3f6f9SBlue Swirl 26201ec3f6f9SBlue Swirl ($dstat, $dcond, $ln, $cnt, $off) = 26211ec3f6f9SBlue Swirl ctx_statement_block($linenr, $ln - $linenr + 1, 0); 26221ec3f6f9SBlue Swirl #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 26231ec3f6f9SBlue Swirl #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 26241ec3f6f9SBlue Swirl 26251ec3f6f9SBlue Swirl # Extract the remainder of the define (if any) and 26261ec3f6f9SBlue Swirl # rip off surrounding spaces, and trailing \'s. 26271ec3f6f9SBlue Swirl $rest = ''; 26281ec3f6f9SBlue Swirl while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 26291ec3f6f9SBlue Swirl #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 26301ec3f6f9SBlue Swirl if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 26311ec3f6f9SBlue Swirl $rest .= substr($lines[$ln - 1], $off) . "\n"; 26321ec3f6f9SBlue Swirl $cnt--; 26331ec3f6f9SBlue Swirl } 26341ec3f6f9SBlue Swirl $ln++; 26351ec3f6f9SBlue Swirl $off = 0; 26361ec3f6f9SBlue Swirl } 26371ec3f6f9SBlue Swirl $rest =~ s/\\\n.//g; 26381ec3f6f9SBlue Swirl $rest =~ s/^\s*//s; 26391ec3f6f9SBlue Swirl $rest =~ s/\s*$//s; 26401ec3f6f9SBlue Swirl 26411ec3f6f9SBlue Swirl # Clean up the original statement. 26421ec3f6f9SBlue Swirl if ($args) { 26431ec3f6f9SBlue Swirl substr($dstat, 0, length($dcond), ''); 26441ec3f6f9SBlue Swirl } else { 26451ec3f6f9SBlue Swirl $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 26461ec3f6f9SBlue Swirl } 26471ec3f6f9SBlue Swirl $dstat =~ s/$;//g; 26481ec3f6f9SBlue Swirl $dstat =~ s/\\\n.//g; 26491ec3f6f9SBlue Swirl $dstat =~ s/^\s*//s; 26501ec3f6f9SBlue Swirl $dstat =~ s/\s*$//s; 26511ec3f6f9SBlue Swirl 26521ec3f6f9SBlue Swirl # Flatten any parentheses and braces 26531ec3f6f9SBlue Swirl while ($dstat =~ s/\([^\(\)]*\)/1/ || 26541ec3f6f9SBlue Swirl $dstat =~ s/\{[^\{\}]*\}/1/ || 26551ec3f6f9SBlue Swirl $dstat =~ s/\[[^\{\}]*\]/1/) 26561ec3f6f9SBlue Swirl { 26571ec3f6f9SBlue Swirl } 26581ec3f6f9SBlue Swirl 26591ec3f6f9SBlue Swirl my $exceptions = qr{ 26601ec3f6f9SBlue Swirl $Declare| 26611ec3f6f9SBlue Swirl module_param_named| 26621ec3f6f9SBlue Swirl MODULE_PARAM_DESC| 26631ec3f6f9SBlue Swirl DECLARE_PER_CPU| 26641ec3f6f9SBlue Swirl DEFINE_PER_CPU| 26651ec3f6f9SBlue Swirl __typeof__\(| 26661ec3f6f9SBlue Swirl union| 26671ec3f6f9SBlue Swirl struct| 26681ec3f6f9SBlue Swirl \.$Ident\s*=\s*| 26691ec3f6f9SBlue Swirl ^\"|\"$ 26701ec3f6f9SBlue Swirl }x; 26711ec3f6f9SBlue Swirl #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 26721ec3f6f9SBlue Swirl if ($rest ne '' && $rest ne ',') { 26731ec3f6f9SBlue Swirl if ($rest !~ /while\s*\(/ && 26741ec3f6f9SBlue Swirl $dstat !~ /$exceptions/) 26751ec3f6f9SBlue Swirl { 26761ec3f6f9SBlue Swirl ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 26771ec3f6f9SBlue Swirl } 26781ec3f6f9SBlue Swirl 26791ec3f6f9SBlue Swirl } elsif ($ctx !~ /;/) { 26801ec3f6f9SBlue Swirl if ($dstat ne '' && 26811ec3f6f9SBlue Swirl $dstat !~ /^(?:$Ident|-?$Constant)$/ && 26821ec3f6f9SBlue Swirl $dstat !~ /$exceptions/ && 26831ec3f6f9SBlue Swirl $dstat !~ /^\.$Ident\s*=/ && 26841ec3f6f9SBlue Swirl $dstat =~ /$Operators/) 26851ec3f6f9SBlue Swirl { 26861ec3f6f9SBlue Swirl ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 26871ec3f6f9SBlue Swirl } 26881ec3f6f9SBlue Swirl } 26891ec3f6f9SBlue Swirl } 26901ec3f6f9SBlue Swirl 26912b9aef6fSSu Hang# check for missing bracing around if etc 26922b9aef6fSSu Hang if ($line =~ /(^.*)\b(?:if|while|for)\b/ && 26932b9aef6fSSu Hang $line !~ /\#\s*if/) { 2694053e45d2SSu Hang my $allowed = 0; 2695053e45d2SSu Hang 2696053e45d2SSu Hang # Check the pre-context. 2697053e45d2SSu Hang if ($line =~ /(\}.*?)$/) { 2698053e45d2SSu Hang my $pre = $1; 2699053e45d2SSu Hang 2700053e45d2SSu Hang if ($line !~ /else/) { 2701053e45d2SSu Hang print "APW: ALLOWED: pre<$pre> line<$line>\n" 2702053e45d2SSu Hang if $dbg_adv_apw; 2703053e45d2SSu Hang $allowed = 1; 2704053e45d2SSu Hang } 2705053e45d2SSu Hang } 27061ec3f6f9SBlue Swirl my ($level, $endln, @chunks) = 27071ec3f6f9SBlue Swirl ctx_statement_full($linenr, $realcnt, 1); 270869402a69SDon Slutz if ($dbg_adv_apw) { 270969402a69SDon Slutz print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 271069402a69SDon Slutz print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n" 271169402a69SDon Slutz if $#chunks >= 1; 271269402a69SDon Slutz } 2713b6469683SBlue Swirl if ($#chunks >= 0 && $level == 0) { 27141ec3f6f9SBlue Swirl my $seen = 0; 27151ec3f6f9SBlue Swirl my $herectx = $here . "\n"; 27161ec3f6f9SBlue Swirl my $ln = $linenr - 1; 27171ec3f6f9SBlue Swirl for my $chunk (@chunks) { 27181ec3f6f9SBlue Swirl my ($cond, $block) = @{$chunk}; 27191ec3f6f9SBlue Swirl 27201ec3f6f9SBlue Swirl # If the condition carries leading newlines, then count those as offsets. 27211ec3f6f9SBlue Swirl my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 27221ec3f6f9SBlue Swirl my $offset = statement_rawlines($whitespace) - 1; 27231ec3f6f9SBlue Swirl 27241ec3f6f9SBlue Swirl #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 27251ec3f6f9SBlue Swirl 27261ec3f6f9SBlue Swirl # We have looked at and allowed this specific line. 27271ec3f6f9SBlue Swirl $suppress_ifbraces{$ln + $offset} = 1; 27281ec3f6f9SBlue Swirl 27291ec3f6f9SBlue Swirl $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 27301ec3f6f9SBlue Swirl $ln += statement_rawlines($block) - 1; 27311ec3f6f9SBlue Swirl 27321ec3f6f9SBlue Swirl substr($block, 0, length($cond), ''); 27331ec3f6f9SBlue Swirl 2734a97ceca5SMax Reitz my $spaced_block = $block; 2735a97ceca5SMax Reitz $spaced_block =~ s/\n\+/ /g; 2736a97ceca5SMax Reitz 273704f2562fSFam Zheng $seen++ if ($spaced_block =~ /^\s*\{/); 27381ec3f6f9SBlue Swirl 273969402a69SDon Slutz print "APW: cond<$cond> block<$block> allowed<$allowed>\n" 274069402a69SDon Slutz if $dbg_adv_apw; 27411ec3f6f9SBlue Swirl if (statement_lines($cond) > 1) { 274269402a69SDon Slutz print "APW: ALLOWED: cond<$cond>\n" 274369402a69SDon Slutz if $dbg_adv_apw; 27441ec3f6f9SBlue Swirl $allowed = 1; 27451ec3f6f9SBlue Swirl } 27461ec3f6f9SBlue Swirl if ($block =~/\b(?:if|for|while)\b/) { 274769402a69SDon Slutz print "APW: ALLOWED: block<$block>\n" 274869402a69SDon Slutz if $dbg_adv_apw; 27491ec3f6f9SBlue Swirl $allowed = 1; 27501ec3f6f9SBlue Swirl } 27511ec3f6f9SBlue Swirl if (statement_block_size($block) > 1) { 275269402a69SDon Slutz print "APW: ALLOWED: lines block<$block>\n" 275369402a69SDon Slutz if $dbg_adv_apw; 27541ec3f6f9SBlue Swirl $allowed = 1; 27551ec3f6f9SBlue Swirl } 27561ec3f6f9SBlue Swirl } 2757053e45d2SSu Hang if ($seen != ($#chunks + 1) && !$allowed) { 2758c2df8783SPaolo Bonzini ERROR("braces {} are necessary for all arms of this statement\n" . $herectx); 27591ec3f6f9SBlue Swirl } 27601ec3f6f9SBlue Swirl } 27611ec3f6f9SBlue Swirl } 27621ec3f6f9SBlue Swirl if (!defined $suppress_ifbraces{$linenr - 1} && 2763789f88d0SJan Kiszka $line =~ /\b(if|while|for|else)\b/ && 2764d0510af2SBlue Swirl $line !~ /\#\s*if/ && 2765789f88d0SJan Kiszka $line !~ /\#\s*else/) { 27661ec3f6f9SBlue Swirl my $allowed = 0; 27671ec3f6f9SBlue Swirl 27681ec3f6f9SBlue Swirl # Check the pre-context. 27691ec3f6f9SBlue Swirl if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2770dfe7053aSDon Slutz my $pre = $1; 2771dfe7053aSDon Slutz 2772dfe7053aSDon Slutz if ($line !~ /else/) { 277369402a69SDon Slutz print "APW: ALLOWED: pre<$pre> line<$line>\n" 277469402a69SDon Slutz if $dbg_adv_apw; 27751ec3f6f9SBlue Swirl $allowed = 1; 27761ec3f6f9SBlue Swirl } 2777dfe7053aSDon Slutz } 27781ec3f6f9SBlue Swirl 27791ec3f6f9SBlue Swirl my ($level, $endln, @chunks) = 27801ec3f6f9SBlue Swirl ctx_statement_full($linenr, $realcnt, $-[0]); 27811ec3f6f9SBlue Swirl 27821ec3f6f9SBlue Swirl # Check the condition. 27831ec3f6f9SBlue Swirl my ($cond, $block) = @{$chunks[0]}; 27845424302eSDon Slutz print "CHECKING<$linenr> cond<$cond> block<$block>\n" 27855424302eSDon Slutz if $dbg_adv_checking; 27861ec3f6f9SBlue Swirl if (defined $cond) { 27871ec3f6f9SBlue Swirl substr($block, 0, length($cond), ''); 27881ec3f6f9SBlue Swirl } 27891ec3f6f9SBlue Swirl if (statement_lines($cond) > 1) { 279069402a69SDon Slutz print "APW: ALLOWED: cond<$cond>\n" 279169402a69SDon Slutz if $dbg_adv_apw; 27921ec3f6f9SBlue Swirl $allowed = 1; 27931ec3f6f9SBlue Swirl } 27941ec3f6f9SBlue Swirl if ($block =~/\b(?:if|for|while)\b/) { 279569402a69SDon Slutz print "APW: ALLOWED: block<$block>\n" 279669402a69SDon Slutz if $dbg_adv_apw; 27971ec3f6f9SBlue Swirl $allowed = 1; 27981ec3f6f9SBlue Swirl } 27991ec3f6f9SBlue Swirl if (statement_block_size($block) > 1) { 280069402a69SDon Slutz print "APW: ALLOWED: lines block<$block>\n" 280169402a69SDon Slutz if $dbg_adv_apw; 28021ec3f6f9SBlue Swirl $allowed = 1; 28031ec3f6f9SBlue Swirl } 28041ec3f6f9SBlue Swirl # Check the post-context. 28051ec3f6f9SBlue Swirl if (defined $chunks[1]) { 28061ec3f6f9SBlue Swirl my ($cond, $block) = @{$chunks[1]}; 28071ec3f6f9SBlue Swirl if (defined $cond) { 28081ec3f6f9SBlue Swirl substr($block, 0, length($cond), ''); 28091ec3f6f9SBlue Swirl } 28101ec3f6f9SBlue Swirl if ($block =~ /^\s*\{/) { 281169402a69SDon Slutz print "APW: ALLOWED: chunk-1 block<$block>\n" 281269402a69SDon Slutz if $dbg_adv_apw; 28131ec3f6f9SBlue Swirl $allowed = 1; 28141ec3f6f9SBlue Swirl } 28151ec3f6f9SBlue Swirl } 2816a99ac041SDon Slutz print "DCS: level=$level block<$block> allowed=$allowed\n" 2817a99ac041SDon Slutz if $dbg_adv_dcs; 2818b6469683SBlue Swirl if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) { 28191ec3f6f9SBlue Swirl my $herectx = $here . "\n";; 28201ec3f6f9SBlue Swirl my $cnt = statement_rawlines($block); 28211ec3f6f9SBlue Swirl 28221ec3f6f9SBlue Swirl for (my $n = 0; $n < $cnt; $n++) { 28231ec3f6f9SBlue Swirl $herectx .= raw_line($linenr, $n) . "\n";; 28241ec3f6f9SBlue Swirl } 28251ec3f6f9SBlue Swirl 2826c2df8783SPaolo Bonzini ERROR("braces {} are necessary even for single statement blocks\n" . $herectx); 28271ec3f6f9SBlue Swirl } 28281ec3f6f9SBlue Swirl } 28291ec3f6f9SBlue Swirl 28301ec3f6f9SBlue Swirl# no volatiles please 28311ec3f6f9SBlue Swirl my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 28326b012d23SMarc-André Lureau if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/ && 28336b012d23SMarc-André Lureau $line !~ /sig_atomic_t/ && 28346b012d23SMarc-André Lureau !ctx_has_comment($first_line, $linenr)) { 28356b012d23SMarc-André Lureau my $msg = "Use of volatile is usually wrong, please add a comment\n" . $herecurr; 28366b012d23SMarc-André Lureau ERROR($msg); 28371ec3f6f9SBlue Swirl } 28381ec3f6f9SBlue Swirl 28391ec3f6f9SBlue Swirl# warn about #if 0 28401ec3f6f9SBlue Swirl if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2841c2df8783SPaolo Bonzini ERROR("if this code is redundant consider removing it\n" . 28421ec3f6f9SBlue Swirl $herecurr); 28431ec3f6f9SBlue Swirl } 28441ec3f6f9SBlue Swirl 284571c47b01SPaolo Bonzini# check for needless g_free() checks 28461ec3f6f9SBlue Swirl if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 28471ec3f6f9SBlue Swirl my $expr = $1; 284871c47b01SPaolo Bonzini if ($line =~ /\bg_free\(\Q$expr\E\);/) { 2849c2df8783SPaolo Bonzini ERROR("g_free(NULL) is safe this check is probably not required\n" . $hereprev); 28501ec3f6f9SBlue Swirl } 28511ec3f6f9SBlue Swirl } 28521ec3f6f9SBlue Swirl 28531ec3f6f9SBlue Swirl# warn about #ifdefs in C files 28541ec3f6f9SBlue Swirl# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 28551ec3f6f9SBlue Swirl# print "#ifdef in C files should be avoided\n"; 28561ec3f6f9SBlue Swirl# print "$herecurr"; 28571ec3f6f9SBlue Swirl# $clean = 0; 28581ec3f6f9SBlue Swirl# } 28591ec3f6f9SBlue Swirl 28601ec3f6f9SBlue Swirl# warn about spacing in #ifdefs 28611ec3f6f9SBlue Swirl if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 28621ec3f6f9SBlue Swirl ERROR("exactly one space required after that #$1\n" . $herecurr); 28631ec3f6f9SBlue Swirl } 28641ec3f6f9SBlue Swirl# check for memory barriers without a comment. 286571c47b01SPaolo Bonzini if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 28661ec3f6f9SBlue Swirl if (!ctx_has_comment($first_line, $linenr)) { 2867c2df8783SPaolo Bonzini ERROR("memory barrier without comment\n" . $herecurr); 28681ec3f6f9SBlue Swirl } 28691ec3f6f9SBlue Swirl } 28701ec3f6f9SBlue Swirl# check of hardware specific defines 287171c47b01SPaolo Bonzini# we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases 287271c47b01SPaolo Bonzini# where they might be necessary. 287371c47b01SPaolo Bonzini if ($line =~ m@^.\s*\#\s*if.*\b__@) { 287463ae8b94SPaolo Bonzini WARN("architecture specific defines should be avoided\n" . $herecurr); 28751ec3f6f9SBlue Swirl } 28761ec3f6f9SBlue Swirl 28771ec3f6f9SBlue Swirl# Check that the storage class is at the beginning of a declaration 28781ec3f6f9SBlue Swirl if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 2879c2df8783SPaolo Bonzini ERROR("storage class should be at the beginning of the declaration\n" . $herecurr) 28801ec3f6f9SBlue Swirl } 28811ec3f6f9SBlue Swirl 28821ec3f6f9SBlue Swirl# check the location of the inline attribute, that it is between 28831ec3f6f9SBlue Swirl# storage class and type. 28841ec3f6f9SBlue Swirl if ($line =~ /\b$Type\s+$Inline\b/ || 28851ec3f6f9SBlue Swirl $line =~ /\b$Inline\s+$Storage\b/) { 28861ec3f6f9SBlue Swirl ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 28871ec3f6f9SBlue Swirl } 28881ec3f6f9SBlue Swirl 28891ec3f6f9SBlue Swirl# check for sizeof(&) 28901ec3f6f9SBlue Swirl if ($line =~ /\bsizeof\s*\(\s*\&/) { 2891c2df8783SPaolo Bonzini ERROR("sizeof(& should be avoided\n" . $herecurr); 28921ec3f6f9SBlue Swirl } 28931ec3f6f9SBlue Swirl 28941ec3f6f9SBlue Swirl# check for new externs in .c files. 28951ec3f6f9SBlue Swirl if ($realfile =~ /\.c$/ && defined $stat && 28961ec3f6f9SBlue Swirl $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 28971ec3f6f9SBlue Swirl { 28981ec3f6f9SBlue Swirl my $function_name = $1; 28991ec3f6f9SBlue Swirl my $paren_space = $2; 29001ec3f6f9SBlue Swirl 29011ec3f6f9SBlue Swirl my $s = $stat; 29021ec3f6f9SBlue Swirl if (defined $cond) { 29031ec3f6f9SBlue Swirl substr($s, 0, length($cond), ''); 29041ec3f6f9SBlue Swirl } 29051ec3f6f9SBlue Swirl if ($s =~ /^\s*;/ && 29061ec3f6f9SBlue Swirl $function_name ne 'uninitialized_var') 29071ec3f6f9SBlue Swirl { 2908c2df8783SPaolo Bonzini ERROR("externs should be avoided in .c files\n" . $herecurr); 29091ec3f6f9SBlue Swirl } 29101ec3f6f9SBlue Swirl 29111ec3f6f9SBlue Swirl if ($paren_space =~ /\n/) { 2912c2df8783SPaolo Bonzini ERROR("arguments for function declarations should follow identifier\n" . $herecurr); 29131ec3f6f9SBlue Swirl } 29141ec3f6f9SBlue Swirl 29151ec3f6f9SBlue Swirl } elsif ($realfile =~ /\.c$/ && defined $stat && 29161ec3f6f9SBlue Swirl $stat =~ /^.\s*extern\s+/) 29171ec3f6f9SBlue Swirl { 2918c2df8783SPaolo Bonzini ERROR("externs should be avoided in .c files\n" . $herecurr); 29191ec3f6f9SBlue Swirl } 29201ec3f6f9SBlue Swirl 292171c47b01SPaolo Bonzini# check for pointless casting of g_malloc return 2922dfdb4f3cSPaolo Bonzini if ($line =~ /\*\s*\)\s*g_(try|)(m|re)alloc(0?)(_n)?\b/) { 2923dfdb4f3cSPaolo Bonzini if ($2 eq 'm') { 2924c2df8783SPaolo Bonzini ERROR("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr); 292571c47b01SPaolo Bonzini } else { 2926c2df8783SPaolo Bonzini ERROR("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr); 292771c47b01SPaolo Bonzini } 29281ec3f6f9SBlue Swirl } 29291ec3f6f9SBlue Swirl 29301ec3f6f9SBlue Swirl# check for gcc specific __FUNCTION__ 29311ec3f6f9SBlue Swirl if ($line =~ /__FUNCTION__/) { 2932c2df8783SPaolo Bonzini ERROR("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 29331ec3f6f9SBlue Swirl } 29341ec3f6f9SBlue Swirl 2935fb8446d9SJulia Suvorova# recommend g_path_get_* over g_strdup(basename/dirname(...)) 2936fb8446d9SJulia Suvorova if ($line =~ /\bg_strdup\s*\(\s*(basename|dirname)\s*\(/) { 2937fb8446d9SJulia Suvorova WARN("consider using g_path_get_$1() in preference to g_strdup($1())\n" . $herecurr); 2938fb8446d9SJulia Suvorova } 2939fb8446d9SJulia Suvorova 2940ce2ff9ccSPhilippe Mathieu-Daudé# enforce g_memdup2() over g_memdup() 2941ce2ff9ccSPhilippe Mathieu-Daudé if ($line =~ /\bg_memdup\s*\(/) { 2942ce2ff9ccSPhilippe Mathieu-Daudé ERROR("use g_memdup2() instead of unsafe g_memdup()\n" . $herecurr); 2943ce2ff9ccSPhilippe Mathieu-Daudé } 2944ce2ff9ccSPhilippe Mathieu-Daudé 29455e43efb2SPaolo Bonzini# recommend qemu_strto* over strto* for numeric conversions 294601fb8e19SEric Blake if ($line =~ /\b(strto[^kd].*?)\s*\(/) { 2947c2df8783SPaolo Bonzini ERROR("consider using qemu_$1 in preference to $1\n" . $herecurr); 29481ec3f6f9SBlue Swirl } 2949e8c2091dSPaolo Bonzini# recommend sigaction over signal for portability, when establishing a handler 2950e8c2091dSPaolo Bonzini if ($line =~ /\bsignal\s*\(/ && !($line =~ /SIG_(?:IGN|DFL)/)) { 2951e8c2091dSPaolo Bonzini ERROR("use sigaction to establish signal handlers; signal is not portable\n" . $herecurr); 2952e8c2091dSPaolo Bonzini } 2953ef56ffbdSAlexander Bulekov# recommend qemu_bh_new_guarded instead of qemu_bh_new 2954ef56ffbdSAlexander Bulekov if ($realfile =~ /.*\/hw\/.*/ && $line =~ /\bqemu_bh_new\s*\(/) { 2955ef56ffbdSAlexander Bulekov ERROR("use qemu_bh_new_guarded() instead of qemu_bh_new() to avoid reentrancy problems\n" . $herecurr); 2956ef56ffbdSAlexander Bulekov } 2957ef56ffbdSAlexander Bulekov# recommend aio_bh_new_guarded instead of aio_bh_new 2958ef56ffbdSAlexander Bulekov if ($realfile =~ /.*\/hw\/.*/ && $line =~ /\baio_bh_new\s*\(/) { 2959ef56ffbdSAlexander Bulekov ERROR("use aio_bh_new_guarded() instead of aio_bh_new() to avoid reentrancy problems\n" . $herecurr); 2960ef56ffbdSAlexander Bulekov } 296171c47b01SPaolo Bonzini# check for module_init(), use category-specific init macros explicitly please 296271c47b01SPaolo Bonzini if ($line =~ /^module_init\s*\(/) { 2963c2df8783SPaolo Bonzini ERROR("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr); 29641ec3f6f9SBlue Swirl } 29651ec3f6f9SBlue Swirl# check for various ops structs, ensure they are const. 296671c47b01SPaolo Bonzini my $struct_ops = qr{AIOCBInfo| 296771c47b01SPaolo Bonzini BdrvActionOps| 296871c47b01SPaolo Bonzini BlockDevOps| 296971c47b01SPaolo Bonzini BlockJobDriver| 297071c47b01SPaolo Bonzini DisplayChangeListenerOps| 297171c47b01SPaolo Bonzini GraphicHwOps| 297271c47b01SPaolo Bonzini IDEDMAOps| 297371c47b01SPaolo Bonzini KVMCapabilityInfo| 297471c47b01SPaolo Bonzini MemoryRegionIOMMUOps| 297571c47b01SPaolo Bonzini MemoryRegionOps| 297671c47b01SPaolo Bonzini MemoryRegionPortio| 297771c47b01SPaolo Bonzini QEMUFileOps| 297871c47b01SPaolo Bonzini SCSIBusInfo| 297971c47b01SPaolo Bonzini SCSIReqOps| 298071c47b01SPaolo Bonzini Spice[A-Z][a-zA-Z0-9]*Interface| 29819a86e023SBernhard Beschow TypeInfo| 298271c47b01SPaolo Bonzini USBDesc[A-Z][a-zA-Z0-9]*| 298371c47b01SPaolo Bonzini VhostOps| 298471c47b01SPaolo Bonzini VMStateDescription| 298571c47b01SPaolo Bonzini VMStateInfo}x; 29861ec3f6f9SBlue Swirl if ($line !~ /\bconst\b/ && 2987e20e718cSPaolo Bonzini $line =~ /\b($struct_ops)\b.*=/) { 2988e20e718cSPaolo Bonzini ERROR("initializer for struct $1 should normally be const\n" . 29891ec3f6f9SBlue Swirl $herecurr); 29901ec3f6f9SBlue Swirl } 29911ec3f6f9SBlue Swirl 2992bfac6d19SDov Murik# format strings checks 29931ec3f6f9SBlue Swirl my $string; 29941ec3f6f9SBlue Swirl while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 29951ec3f6f9SBlue Swirl $string = substr($rawline, $-[1], $+[1] - $-[1]); 29961ec3f6f9SBlue Swirl $string =~ s/%%/__/g; 2997bfac6d19SDov Murik # check for %L{u,d,i} in strings 29981ec3f6f9SBlue Swirl if ($string =~ /(?<!%)%L[udi]/) { 2999c2df8783SPaolo Bonzini ERROR("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 3000bfac6d19SDov Murik } 3001bfac6d19SDov Murik # check for %# or %0# in printf-style format strings 3002bfac6d19SDov Murik if ($string =~ /(?<!%)%0?#/) { 3003bfac6d19SDov Murik ERROR("Don't use '#' flag of printf format " . 3004bfac6d19SDov Murik "('%#') in format strings, use '0x' " . 3005bfac6d19SDov Murik "prefix instead\n" . $herecurr); 30061ec3f6f9SBlue Swirl } 30071ec3f6f9SBlue Swirl } 30081ec3f6f9SBlue Swirl 30099964d8f9SStefan Weil# QEMU specific tests 30109964d8f9SStefan Weil if ($rawline =~ /\b(?:Qemu|QEmu)\b/) { 3011c2df8783SPaolo Bonzini ERROR("use QEMU instead of Qemu or QEmu\n" . $herecurr); 30129964d8f9SStefan Weil } 30138b6ee9aeSStefan Hajnoczi 30145d596c24SJason J. Herne# Qemu error function tests 30155d596c24SJason J. Herne 30165d596c24SJason J. Herne # Find newlines in error messages 30175d596c24SJason J. Herne my $qemu_error_funcs = qr{error_setg| 30185d596c24SJason J. Herne error_setg_errno| 30195d596c24SJason J. Herne error_setg_win32| 3020a47eb010SMarkus Armbruster error_setg_file_open| 30215d596c24SJason J. Herne error_set| 3022a47eb010SMarkus Armbruster error_prepend| 3023e43ead1dSAlistair Francis warn_reportf_err| 3024a47eb010SMarkus Armbruster error_reportf_err| 30255d596c24SJason J. Herne error_vreport| 302697f40301SAlistair Francis warn_vreport| 302797f40301SAlistair Francis info_vreport| 302897f40301SAlistair Francis error_report| 302997f40301SAlistair Francis warn_report| 3030f1e35acfSPaolo Bonzini info_report| 3031f1e35acfSPaolo Bonzini g_test_message}x; 30325d596c24SJason J. Herne 3033a47eb010SMarkus Armbruster if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) { 3034c2df8783SPaolo Bonzini ERROR("Error messages should not contain newlines\n" . $herecurr); 30355d596c24SJason J. Herne } 30365d596c24SJason J. Herne 30375d596c24SJason J. Herne # Continue checking for error messages that contains newlines. This 30385d596c24SJason J. Herne # check handles cases where string literals are spread over multiple lines. 30395d596c24SJason J. Herne # Example: 30405d596c24SJason J. Herne # error_report("Error msg line #1" 30415d596c24SJason J. Herne # "Error msg line #2\n"); 30425d596c24SJason J. Herne my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"}; 30435d596c24SJason J. Herne my $continued_str_literal = qr{\+\s*\".*\"}; 30445d596c24SJason J. Herne 30455d596c24SJason J. Herne if ($rawline =~ /$quoted_newline_regex/) { 30465d596c24SJason J. Herne # Backtrack to first line that does not contain only a quoted literal 30475d596c24SJason J. Herne # and assume that it is the start of the statement. 30485d596c24SJason J. Herne my $i = $linenr - 2; 30495d596c24SJason J. Herne 30505d596c24SJason J. Herne while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) { 30515d596c24SJason J. Herne $i--; 30525d596c24SJason J. Herne } 30535d596c24SJason J. Herne 30545d596c24SJason J. Herne if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) { 3055c2df8783SPaolo Bonzini ERROR("Error messages should not contain newlines\n" . $herecurr); 30565d596c24SJason J. Herne } 30575d596c24SJason J. Herne } 30585d596c24SJason J. Herne 30593f822cffSPaolo Bonzini# check for non-portable libc calls that have portable alternatives in QEMU 30608b6ee9aeSStefan Hajnoczi if ($line =~ /\bffs\(/) { 30618b6ee9aeSStefan Hajnoczi ERROR("use ctz32() instead of ffs()\n" . $herecurr); 30628b6ee9aeSStefan Hajnoczi } 30638b6ee9aeSStefan Hajnoczi if ($line =~ /\bffsl\(/) { 30648b6ee9aeSStefan Hajnoczi ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr); 30658b6ee9aeSStefan Hajnoczi } 30668b6ee9aeSStefan Hajnoczi if ($line =~ /\bffsll\(/) { 30678b6ee9aeSStefan Hajnoczi ERROR("use ctz64() instead of ffsll()\n" . $herecurr); 30688b6ee9aeSStefan Hajnoczi } 30693f822cffSPaolo Bonzini if ($line =~ /\bbzero\(/) { 30703f822cffSPaolo Bonzini ERROR("use memset() instead of bzero()\n" . $herecurr); 30713f822cffSPaolo Bonzini } 3072e31db8aaSWei Yang if ($line =~ /\bgetpagesize\(\)/) { 30738e3b0cbbSMarc-André Lureau ERROR("use qemu_real_host_page_size() instead of getpagesize()\n" . $herecurr); 3074e31db8aaSWei Yang } 3075e31db8aaSWei Yang if ($line =~ /\bsysconf\(_SC_PAGESIZE\)/) { 30768e3b0cbbSMarc-André Lureau ERROR("use qemu_real_host_page_size() instead of sysconf(_SC_PAGESIZE)\n" . $herecurr); 3077e31db8aaSWei Yang } 3078837cd584SPhilippe Mathieu-Daudé if ($line =~ /\b(g_)?assert\(0\)/) { 3079837cd584SPhilippe Mathieu-Daudé ERROR("use g_assert_not_reached() instead of assert(0)\n" . $herecurr); 3080837cd584SPhilippe Mathieu-Daudé } 30816e938956SDr. David Alan Gilbert my $non_exit_glib_asserts = qr{g_assert_cmpstr| 30826e938956SDr. David Alan Gilbert g_assert_cmpint| 30836e938956SDr. David Alan Gilbert g_assert_cmpuint| 30846e938956SDr. David Alan Gilbert g_assert_cmphex| 30856e938956SDr. David Alan Gilbert g_assert_cmpfloat| 30866e938956SDr. David Alan Gilbert g_assert_true| 30876e938956SDr. David Alan Gilbert g_assert_false| 30886e938956SDr. David Alan Gilbert g_assert_nonnull| 30896e938956SDr. David Alan Gilbert g_assert_null| 30906e938956SDr. David Alan Gilbert g_assert_no_error| 30916e938956SDr. David Alan Gilbert g_assert_error| 30926e938956SDr. David Alan Gilbert g_test_assert_expected_messages| 30936e938956SDr. David Alan Gilbert g_test_trap_assert_passed| 30946e938956SDr. David Alan Gilbert g_test_trap_assert_stdout| 30956e938956SDr. David Alan Gilbert g_test_trap_assert_stdout_unmatched| 30966e938956SDr. David Alan Gilbert g_test_trap_assert_stderr| 30976e938956SDr. David Alan Gilbert g_test_trap_assert_stderr_unmatched}x; 30986e938956SDr. David Alan Gilbert if ($realfile !~ /^tests\// && 30996e938956SDr. David Alan Gilbert $line =~ /\b(?:$non_exit_glib_asserts)\(/) { 31006e938956SDr. David Alan Gilbert ERROR("Use g_assert or g_assert_not_reached\n". $herecurr); 31016e938956SDr. David Alan Gilbert } 31021ec3f6f9SBlue Swirl } 31031ec3f6f9SBlue Swirl 3104fd9c0cfeSPaolo Bonzini if ($is_patch && $chk_signoff && $signoff == 0) { 3105fd9c0cfeSPaolo Bonzini ERROR("Missing Signed-off-by: line(s)\n"); 3106fd9c0cfeSPaolo Bonzini } 3107fd9c0cfeSPaolo Bonzini 31081ec3f6f9SBlue Swirl # If we have no input at all, then there is nothing to report on 31091ec3f6f9SBlue Swirl # so just keep quiet. 31101ec3f6f9SBlue Swirl if ($#rawlines == -1) { 31111ff7ebf3SPaolo Bonzini return 1; 31121ec3f6f9SBlue Swirl } 31131ec3f6f9SBlue Swirl 31141ec3f6f9SBlue Swirl # In mailback mode only produce a report in the negative, for 31151ec3f6f9SBlue Swirl # things that appear to be patches. 31161ec3f6f9SBlue Swirl if ($mailback && ($clean == 1 || !$is_patch)) { 31171ff7ebf3SPaolo Bonzini return 1; 31181ec3f6f9SBlue Swirl } 31191ec3f6f9SBlue Swirl 31201ec3f6f9SBlue Swirl # This is not a patch, and we are are in 'no-patch' mode so 31211ec3f6f9SBlue Swirl # just keep quiet. 31221ec3f6f9SBlue Swirl if (!$chk_patch && !$is_patch) { 31231ff7ebf3SPaolo Bonzini return 1; 31241ec3f6f9SBlue Swirl } 31251ec3f6f9SBlue Swirl 3126fb4176d0SStefano Garzarella if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 31271ec3f6f9SBlue Swirl ERROR("Does not appear to be a unified-diff format patch\n"); 31281ec3f6f9SBlue Swirl } 31291ec3f6f9SBlue Swirl 31301ec3f6f9SBlue Swirl print report_dump(); 31311ec3f6f9SBlue Swirl if ($summary && !($clean == 1 && $quiet == 1)) { 31321ec3f6f9SBlue Swirl print "$filename " if ($summary_file); 31331ec3f6f9SBlue Swirl print "total: $cnt_error errors, $cnt_warn warnings, " . 31341ec3f6f9SBlue Swirl "$cnt_lines lines checked\n"; 31351ec3f6f9SBlue Swirl print "\n" if ($quiet == 0); 31361ec3f6f9SBlue Swirl } 31371ec3f6f9SBlue Swirl 31381ec3f6f9SBlue Swirl if ($quiet == 0) { 31391ec3f6f9SBlue Swirl # If there were whitespace errors which cleanpatch can fix 31401ec3f6f9SBlue Swirl # then suggest that. 3141b6469683SBlue Swirl# if ($rpt_cleaners) { 3142b6469683SBlue Swirl# print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3143b6469683SBlue Swirl# print " scripts/cleanfile\n\n"; 3144b6469683SBlue Swirl# } 31451ec3f6f9SBlue Swirl } 31461ec3f6f9SBlue Swirl 31471ec3f6f9SBlue Swirl if ($clean == 1 && $quiet == 0) { 31481ec3f6f9SBlue Swirl print "$vname has no obvious style problems and is ready for submission.\n" 31491ec3f6f9SBlue Swirl } 31501ec3f6f9SBlue Swirl if ($clean == 0 && $quiet == 0) { 31511ec3f6f9SBlue Swirl print "$vname has style problems, please review. If any of these errors\n"; 31521ec3f6f9SBlue Swirl print "are false positives report them to the maintainer, see\n"; 31531ec3f6f9SBlue Swirl print "CHECKPATCH in MAINTAINERS.\n"; 31541ec3f6f9SBlue Swirl } 31551ec3f6f9SBlue Swirl 3156141de886SPaolo Bonzini return ($no_warnings ? $clean : $cnt_error == 0); 31571ec3f6f9SBlue Swirl} 3158