Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1 | #!/usr/bin/perl -w |
Dave Jones | dbf004d | 2010-01-12 16:59:52 -0500 | [diff] [blame] | 2 | # (c) 2001, Dave Jones. (the file handling bit) |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 3 | # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) |
Andy Whitcroft | 2a5a2c2 | 2009-01-06 14:41:23 -0800 | [diff] [blame] | 4 | # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite) |
Andy Whitcroft | 015830b | 2010-10-26 14:23:17 -0700 | [diff] [blame] | 5 | # (c) 2008-2010 Andy Whitcroft <apw@canonical.com> |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 6 | # Licensed under the terms of the GNU GPL License version 2 |
| 7 | |
| 8 | use strict; |
| 9 | |
| 10 | my $P = $0; |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 11 | $P =~ s@.*/@@g; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 12 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 13 | my $V = '0.32'; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 14 | |
| 15 | use Getopt::Long qw(:config no_auto_abbrev); |
| 16 | |
| 17 | my $quiet = 0; |
| 18 | my $tree = 1; |
| 19 | my $chk_signoff = 1; |
| 20 | my $chk_patch = 1; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 21 | my $tst_only; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 22 | my $emacs = 0; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 23 | my $terse = 0; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 24 | my $file = 0; |
| 25 | my $check = 0; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 26 | my $summary = 1; |
| 27 | my $mailback = 0; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 28 | my $summary_file = 0; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 29 | my $show_types = 0; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 30 | my $root; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 31 | my %debug; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 32 | my %ignore_type = (); |
| 33 | my @ignore = (); |
Hannes Eder | 77f5b10 | 2009-09-21 17:04:37 -0700 | [diff] [blame] | 34 | my $help = 0; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 35 | my $configuration_file = ".checkpatch.conf"; |
Joe Perches | 6cd7f38 | 2012-12-17 16:01:54 -0800 | [diff] [blame] | 36 | my $max_line_length = 80; |
Hannes Eder | 77f5b10 | 2009-09-21 17:04:37 -0700 | [diff] [blame] | 37 | |
| 38 | sub help { |
| 39 | my ($exitcode) = @_; |
| 40 | |
| 41 | print << "EOM"; |
| 42 | Usage: $P [OPTION]... [FILE]... |
| 43 | Version: $V |
| 44 | |
| 45 | Options: |
| 46 | -q, --quiet quiet |
| 47 | --no-tree run without a kernel tree |
| 48 | --no-signoff do not check for 'Signed-off-by' line |
| 49 | --patch treat FILE as patchfile (default) |
| 50 | --emacs emacs compile window format |
| 51 | --terse one line per report |
| 52 | -f, --file treat FILE as regular source file |
| 53 | --subjective, --strict enable more subjective tests |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 54 | --ignore TYPE(,TYPE2...) ignore various comma separated message types |
Joe Perches | 6cd7f38 | 2012-12-17 16:01:54 -0800 | [diff] [blame] | 55 | --max-line-length=n set the maximum line length, if exceeded, warn |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 56 | --show-types show the message "types" in the output |
Hannes Eder | 77f5b10 | 2009-09-21 17:04:37 -0700 | [diff] [blame] | 57 | --root=PATH PATH to the kernel tree root |
| 58 | --no-summary suppress the per-file summary |
| 59 | --mailback only produce a report in case of warnings/errors |
| 60 | --summary-file include the filename in summary |
| 61 | --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of |
| 62 | 'values', 'possible', 'type', and 'attr' (default |
| 63 | is all off) |
| 64 | --test-only=WORD report only warnings/errors containing WORD |
| 65 | literally |
| 66 | -h, --help, --version display this help and exit |
| 67 | |
| 68 | When FILE is - read standard input. |
| 69 | EOM |
| 70 | |
| 71 | exit($exitcode); |
| 72 | } |
| 73 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 74 | my $conf = which_conf($configuration_file); |
| 75 | if (-f $conf) { |
| 76 | my @conf_args; |
| 77 | open(my $conffile, '<', "$conf") |
| 78 | or warn "$P: Can't find a readable $configuration_file file $!\n"; |
| 79 | |
| 80 | while (<$conffile>) { |
| 81 | my $line = $_; |
| 82 | |
| 83 | $line =~ s/\s*\n?$//g; |
| 84 | $line =~ s/^\s*//g; |
| 85 | $line =~ s/\s+/ /g; |
| 86 | |
| 87 | next if ($line =~ m/^\s*#/); |
| 88 | next if ($line =~ m/^\s*$/); |
| 89 | |
| 90 | my @words = split(" ", $line); |
| 91 | foreach my $word (@words) { |
| 92 | last if ($word =~ m/^#/); |
| 93 | push (@conf_args, $word); |
| 94 | } |
| 95 | } |
| 96 | close($conffile); |
| 97 | unshift(@ARGV, @conf_args) if @conf_args; |
| 98 | } |
| 99 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 100 | GetOptions( |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 101 | 'q|quiet+' => \$quiet, |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 102 | 'tree!' => \$tree, |
| 103 | 'signoff!' => \$chk_signoff, |
| 104 | 'patch!' => \$chk_patch, |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 105 | 'emacs!' => \$emacs, |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 106 | 'terse!' => \$terse, |
Hannes Eder | 77f5b10 | 2009-09-21 17:04:37 -0700 | [diff] [blame] | 107 | 'f|file!' => \$file, |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 108 | 'subjective!' => \$check, |
| 109 | 'strict!' => \$check, |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 110 | 'ignore=s' => \@ignore, |
| 111 | 'show-types!' => \$show_types, |
Joe Perches | 6cd7f38 | 2012-12-17 16:01:54 -0800 | [diff] [blame] | 112 | 'max-line-length=i' => \$max_line_length, |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 113 | 'root=s' => \$root, |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 114 | 'summary!' => \$summary, |
| 115 | 'mailback!' => \$mailback, |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 116 | 'summary-file!' => \$summary_file, |
| 117 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 118 | 'debug=s' => \%debug, |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 119 | 'test-only=s' => \$tst_only, |
Hannes Eder | 77f5b10 | 2009-09-21 17:04:37 -0700 | [diff] [blame] | 120 | 'h|help' => \$help, |
| 121 | 'version' => \$help |
| 122 | ) or help(1); |
| 123 | |
| 124 | help(0) if ($help); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 125 | |
| 126 | my $exit = 0; |
| 127 | |
| 128 | if ($#ARGV < 0) { |
Hannes Eder | 77f5b10 | 2009-09-21 17:04:37 -0700 | [diff] [blame] | 129 | print "$P: no input files\n"; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 130 | exit(1); |
| 131 | } |
| 132 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 133 | @ignore = split(/,/, join(',',@ignore)); |
| 134 | foreach my $word (@ignore) { |
| 135 | $word =~ s/\s*\n?$//g; |
| 136 | $word =~ s/^\s*//g; |
| 137 | $word =~ s/\s+/ /g; |
| 138 | $word =~ tr/[a-z]/[A-Z]/; |
| 139 | |
| 140 | next if ($word =~ m/^\s*#/); |
| 141 | next if ($word =~ m/^\s*$/); |
| 142 | |
| 143 | $ignore_type{$word}++; |
| 144 | } |
| 145 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 146 | my $dbg_values = 0; |
| 147 | my $dbg_possible = 0; |
Andy Whitcroft | 7429c69 | 2008-07-23 21:29:06 -0700 | [diff] [blame] | 148 | my $dbg_type = 0; |
Andy Whitcroft | a1ef277 | 2008-10-15 22:02:17 -0700 | [diff] [blame] | 149 | my $dbg_attr = 0; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 150 | for my $key (keys %debug) { |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 151 | ## no critic |
| 152 | eval "\${dbg_$key} = '$debug{$key}';"; |
| 153 | die "$@" if ($@); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 154 | } |
| 155 | |
Andy Whitcroft | d2c0a23 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 156 | my $rpt_cleaners = 0; |
| 157 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 158 | if ($terse) { |
| 159 | $emacs = 1; |
| 160 | $quiet++; |
| 161 | } |
| 162 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 163 | if ($tree) { |
| 164 | if (defined $root) { |
| 165 | if (!top_of_kernel_tree($root)) { |
| 166 | die "$P: $root: --root does not point at a valid tree\n"; |
| 167 | } |
| 168 | } else { |
| 169 | if (top_of_kernel_tree('.')) { |
| 170 | $root = '.'; |
| 171 | } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && |
| 172 | top_of_kernel_tree($1)) { |
| 173 | $root = $1; |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | if (!defined $root) { |
| 178 | print "Must be run from the top-level dir. of a kernel tree\n"; |
| 179 | exit(2); |
| 180 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 181 | } |
| 182 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 183 | my $emitted_corrupt = 0; |
| 184 | |
Andy Whitcroft | 2ceb532 | 2009-10-26 16:50:14 -0700 | [diff] [blame] | 185 | our $Ident = qr{ |
| 186 | [A-Za-z_][A-Za-z\d_]* |
| 187 | (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* |
| 188 | }x; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 189 | our $Storage = qr{extern|static|asmlinkage}; |
| 190 | our $Sparse = qr{ |
| 191 | __user| |
| 192 | __kernel| |
| 193 | __force| |
| 194 | __iomem| |
| 195 | __must_check| |
| 196 | __init_refok| |
Andy Whitcroft | 417495e | 2009-02-27 14:03:08 -0800 | [diff] [blame] | 197 | __kprobes| |
Sven Eckelmann | 165e72a | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 198 | __ref| |
| 199 | __rcu |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 200 | }x; |
Wolfram Sang | 5213129 | 2010-03-05 13:43:51 -0800 | [diff] [blame] | 201 | |
| 202 | # Notes to $Attribute: |
| 203 | # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 204 | our $Attribute = qr{ |
| 205 | const| |
Joe Perches | 03f1df7 | 2010-10-26 14:23:16 -0700 | [diff] [blame] | 206 | __percpu| |
| 207 | __nocast| |
| 208 | __safe| |
| 209 | __bitwise__| |
| 210 | __packed__| |
| 211 | __packed2__| |
| 212 | __naked| |
| 213 | __maybe_unused| |
| 214 | __always_unused| |
| 215 | __noreturn| |
| 216 | __used| |
| 217 | __cold| |
| 218 | __noclone| |
| 219 | __deprecated| |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 220 | __read_mostly| |
| 221 | __kprobes| |
Wolfram Sang | 5213129 | 2010-03-05 13:43:51 -0800 | [diff] [blame] | 222 | __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| |
Andy Whitcroft | 24e1d81 | 2008-10-15 22:02:18 -0700 | [diff] [blame] | 223 | ____cacheline_aligned| |
| 224 | ____cacheline_aligned_in_smp| |
Andy Whitcroft | 5fe3af1 | 2009-01-06 14:41:18 -0800 | [diff] [blame] | 225 | ____cacheline_internodealigned_in_smp| |
| 226 | __weak |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 227 | }x; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 228 | our $Modifier; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 229 | our $Inline = qr{inline|__always_inline|noinline}; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 230 | our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; |
| 231 | our $Lval = qr{$Ident(?:$Member)*}; |
| 232 | |
Joe Perches | 326b1ff | 2013-02-04 14:28:51 -0800 | [diff] [blame] | 233 | our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; |
| 234 | our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; |
| 235 | our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; |
Joe Perches | 74349bc | 2012-12-17 16:02:05 -0800 | [diff] [blame] | 236 | our $Float = qr{$Float_hex|$Float_dec|$Float_int}; |
Joe Perches | 326b1ff | 2013-02-04 14:28:51 -0800 | [diff] [blame] | 237 | our $Constant = qr{$Float|(?i)(?:0x[0-9a-f]+|[0-9]+)[ul]*}; |
| 238 | our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; |
Andy Whitcroft | 86f9d05 | 2009-01-06 14:41:24 -0800 | [diff] [blame] | 239 | our $Compare = qr{<=|>=|==|!=|<|>}; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 240 | our $Operators = qr{ |
| 241 | <=|>=|==|!=| |
| 242 | =>|->|<<|>>|<|>|!|~| |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 243 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 244 | }x; |
| 245 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 246 | our $NonptrType; |
| 247 | our $Type; |
| 248 | our $Declare; |
| 249 | |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 250 | our $NON_ASCII_UTF8 = qr{ |
| 251 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 252 | | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs |
| 253 | | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte |
| 254 | | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates |
| 255 | | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 |
| 256 | | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 |
| 257 | | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 |
| 258 | }x; |
| 259 | |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 260 | our $UTF8 = qr{ |
| 261 | [\x09\x0A\x0D\x20-\x7E] # ASCII |
| 262 | | $NON_ASCII_UTF8 |
| 263 | }x; |
| 264 | |
Andy Whitcroft | 8ed22ca | 2008-10-15 22:02:32 -0700 | [diff] [blame] | 265 | our $typeTypedefs = qr{(?x: |
Andy Whitcroft | fb9e909 | 2009-09-21 17:04:38 -0700 | [diff] [blame] | 266 | (?:__)?(?:u|s|be|le)(?:8|16|32|64)| |
Andy Whitcroft | 8ed22ca | 2008-10-15 22:02:32 -0700 | [diff] [blame] | 267 | atomic_t |
| 268 | )}; |
| 269 | |
Joe Perches | 691e669 | 2010-03-05 13:43:51 -0800 | [diff] [blame] | 270 | our $logFunctions = qr{(?x: |
Joe Perches | 6e60c02 | 2011-07-25 17:13:27 -0700 | [diff] [blame] | 271 | printk(?:_ratelimited|_once|)| |
| 272 | [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| |
| 273 | WARN(?:_RATELIMIT|_ONCE|)| |
Joe Perches | b053172 | 2011-05-24 17:13:40 -0700 | [diff] [blame] | 274 | panic| |
| 275 | MODULE_[A-Z_]+ |
Joe Perches | 691e669 | 2010-03-05 13:43:51 -0800 | [diff] [blame] | 276 | )}; |
| 277 | |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 278 | our $signature_tags = qr{(?xi: |
| 279 | Signed-off-by:| |
| 280 | Acked-by:| |
| 281 | Tested-by:| |
| 282 | Reviewed-by:| |
| 283 | Reported-by:| |
Mugunthan V N | 8543ae1 | 2013-04-29 16:18:17 -0700 | [diff] [blame] | 284 | Suggested-by:| |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 285 | To:| |
| 286 | Cc: |
| 287 | )}; |
| 288 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 289 | our @typeList = ( |
| 290 | qr{void}, |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 291 | qr{(?:unsigned\s+)?char}, |
| 292 | qr{(?:unsigned\s+)?short}, |
| 293 | qr{(?:unsigned\s+)?int}, |
| 294 | qr{(?:unsigned\s+)?long}, |
| 295 | qr{(?:unsigned\s+)?long\s+int}, |
| 296 | qr{(?:unsigned\s+)?long\s+long}, |
| 297 | qr{(?:unsigned\s+)?long\s+long\s+int}, |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 298 | qr{unsigned}, |
| 299 | qr{float}, |
| 300 | qr{double}, |
| 301 | qr{bool}, |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 302 | qr{struct\s+$Ident}, |
| 303 | qr{union\s+$Ident}, |
| 304 | qr{enum\s+$Ident}, |
| 305 | qr{${Ident}_t}, |
| 306 | qr{${Ident}_handler}, |
| 307 | qr{${Ident}_handler_fn}, |
| 308 | ); |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 309 | our @modifierList = ( |
| 310 | qr{fastcall}, |
| 311 | ); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 312 | |
Wolfram Sang | 7840a94 | 2010-08-09 17:20:57 -0700 | [diff] [blame] | 313 | our $allowed_asm_includes = qr{(?x: |
| 314 | irq| |
| 315 | memory |
| 316 | )}; |
| 317 | # memory.h: ARM has a custom one |
| 318 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 319 | sub build_types { |
Andy Whitcroft | d2172eb | 2008-07-23 21:29:07 -0700 | [diff] [blame] | 320 | my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; |
| 321 | my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; |
Andy Whitcroft | c8cb2ca | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 322 | $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 323 | $NonptrType = qr{ |
Andy Whitcroft | d2172eb | 2008-07-23 21:29:07 -0700 | [diff] [blame] | 324 | (?:$Modifier\s+|const\s+)* |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 325 | (?: |
Andy Whitcroft | 6b48db2 | 2012-01-10 15:10:13 -0800 | [diff] [blame] | 326 | (?:typeof|__typeof__)\s*\([^\)]*\)| |
Andy Whitcroft | 8ed22ca | 2008-10-15 22:02:32 -0700 | [diff] [blame] | 327 | (?:$typeTypedefs\b)| |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 328 | (?:${all}\b) |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 329 | ) |
Andy Whitcroft | c8cb2ca | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 330 | (?:\s+$Modifier|\s+const)* |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 331 | }x; |
| 332 | $Type = qr{ |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 333 | $NonptrType |
Andy Whitcroft | b337d8b | 2012-03-23 15:02:18 -0700 | [diff] [blame] | 334 | (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? |
Andy Whitcroft | c8cb2ca | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 335 | (?:\s+$Inline|\s+$Modifier)* |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 336 | }x; |
| 337 | $Declare = qr{(?:$Storage\s+)?$Type}; |
| 338 | } |
| 339 | build_types(); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 340 | |
Joe Perches | 7d2367a | 2011-07-25 17:13:22 -0700 | [diff] [blame] | 341 | |
| 342 | our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 343 | |
| 344 | # Using $balanced_parens, $LvalOrFunc, or $FuncArg |
| 345 | # requires at least perl version v5.10.0 |
| 346 | # Any use must be runtime checked with $^V |
| 347 | |
| 348 | our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; |
| 349 | our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 350 | our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; |
Joe Perches | 7d2367a | 2011-07-25 17:13:22 -0700 | [diff] [blame] | 351 | |
| 352 | sub deparenthesize { |
| 353 | my ($string) = @_; |
| 354 | return "" if (!defined($string)); |
| 355 | $string =~ s@^\s*\(\s*@@g; |
| 356 | $string =~ s@\s*\)\s*$@@g; |
| 357 | $string =~ s@\s+@ @g; |
| 358 | return $string; |
| 359 | } |
| 360 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 361 | $chk_signoff = 0 if ($file); |
| 362 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 363 | my @rawlines = (); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 364 | my @lines = (); |
| 365 | my $vname; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 366 | for my $filename (@ARGV) { |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 367 | my $FILE; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 368 | if ($file) { |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 369 | open($FILE, '-|', "diff -u /dev/null $filename") || |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 370 | die "$P: $filename: diff failed - $!\n"; |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 371 | } elsif ($filename eq '-') { |
| 372 | open($FILE, '<&STDIN'); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 373 | } else { |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 374 | open($FILE, '<', "$filename") || |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 375 | die "$P: $filename: open failed - $!\n"; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 376 | } |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 377 | if ($filename eq '-') { |
| 378 | $vname = 'Your patch'; |
| 379 | } else { |
| 380 | $vname = $filename; |
| 381 | } |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 382 | while (<$FILE>) { |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 383 | chomp; |
| 384 | push(@rawlines, $_); |
| 385 | } |
Andy Whitcroft | 21caa13 | 2009-01-06 14:41:30 -0800 | [diff] [blame] | 386 | close($FILE); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 387 | if (!process($filename)) { |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 388 | $exit = 1; |
| 389 | } |
| 390 | @rawlines = (); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 391 | @lines = (); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | exit($exit); |
| 395 | |
| 396 | sub top_of_kernel_tree { |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 397 | my ($root) = @_; |
| 398 | |
| 399 | my @tree_check = ( |
| 400 | "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", |
| 401 | "README", "Documentation", "arch", "include", "drivers", |
| 402 | "fs", "init", "ipc", "kernel", "lib", "scripts", |
| 403 | ); |
| 404 | |
| 405 | foreach my $check (@tree_check) { |
| 406 | if (! -e $root . '/' . $check) { |
| 407 | return 0; |
| 408 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 409 | } |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 410 | return 1; |
Joe Perches | 8f26b83 | 2012-10-04 17:13:32 -0700 | [diff] [blame] | 411 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 412 | |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 413 | sub parse_email { |
| 414 | my ($formatted_email) = @_; |
| 415 | |
| 416 | my $name = ""; |
| 417 | my $address = ""; |
| 418 | my $comment = ""; |
| 419 | |
| 420 | if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { |
| 421 | $name = $1; |
| 422 | $address = $2; |
| 423 | $comment = $3 if defined $3; |
| 424 | } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { |
| 425 | $address = $1; |
| 426 | $comment = $2 if defined $2; |
| 427 | } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { |
| 428 | $address = $1; |
| 429 | $comment = $2 if defined $2; |
| 430 | $formatted_email =~ s/$address.*$//; |
| 431 | $name = $formatted_email; |
| 432 | $name =~ s/^\s+|\s+$//g; |
| 433 | $name =~ s/^\"|\"$//g; |
| 434 | # If there's a name left after stripping spaces and |
| 435 | # leading quotes, and the address doesn't have both |
| 436 | # leading and trailing angle brackets, the address |
| 437 | # is invalid. ie: |
| 438 | # "joe smith joe@smith.com" bad |
| 439 | # "joe smith <joe@smith.com" bad |
| 440 | if ($name ne "" && $address !~ /^<[^>]+>$/) { |
| 441 | $name = ""; |
| 442 | $address = ""; |
| 443 | $comment = ""; |
| 444 | } |
| 445 | } |
| 446 | |
| 447 | $name =~ s/^\s+|\s+$//g; |
| 448 | $name =~ s/^\"|\"$//g; |
| 449 | $address =~ s/^\s+|\s+$//g; |
| 450 | $address =~ s/^\<|\>$//g; |
| 451 | |
| 452 | if ($name =~ /[^\w \-]/i) { ##has "must quote" chars |
| 453 | $name =~ s/(?<!\\)"/\\"/g; ##escape quotes |
| 454 | $name = "\"$name\""; |
| 455 | } |
| 456 | |
| 457 | return ($name, $address, $comment); |
| 458 | } |
| 459 | |
| 460 | sub format_email { |
| 461 | my ($name, $address) = @_; |
| 462 | |
| 463 | my $formatted_email; |
| 464 | |
| 465 | $name =~ s/^\s+|\s+$//g; |
| 466 | $name =~ s/^\"|\"$//g; |
| 467 | $address =~ s/^\s+|\s+$//g; |
| 468 | |
| 469 | if ($name =~ /[^\w \-]/i) { ##has "must quote" chars |
| 470 | $name =~ s/(?<!\\)"/\\"/g; ##escape quotes |
| 471 | $name = "\"$name\""; |
| 472 | } |
| 473 | |
| 474 | if ("$name" eq "") { |
| 475 | $formatted_email = "$address"; |
| 476 | } else { |
| 477 | $formatted_email = "$name <$address>"; |
| 478 | } |
| 479 | |
| 480 | return $formatted_email; |
| 481 | } |
| 482 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 483 | sub which_conf { |
| 484 | my ($conf) = @_; |
| 485 | |
| 486 | foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { |
| 487 | if (-e "$path/$conf") { |
| 488 | return "$path/$conf"; |
| 489 | } |
| 490 | } |
| 491 | |
| 492 | return ""; |
| 493 | } |
| 494 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 495 | sub expand_tabs { |
| 496 | my ($str) = @_; |
| 497 | |
| 498 | my $res = ''; |
| 499 | my $n = 0; |
| 500 | for my $c (split(//, $str)) { |
| 501 | if ($c eq "\t") { |
| 502 | $res .= ' '; |
| 503 | $n++; |
| 504 | for (; ($n % 8) != 0; $n++) { |
| 505 | $res .= ' '; |
| 506 | } |
| 507 | next; |
| 508 | } |
| 509 | $res .= $c; |
| 510 | $n++; |
| 511 | } |
| 512 | |
| 513 | return $res; |
| 514 | } |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 515 | sub copy_spacing { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 516 | (my $res = shift) =~ tr/\t/ /c; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 517 | return $res; |
| 518 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 519 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 520 | sub line_stats { |
| 521 | my ($line) = @_; |
| 522 | |
| 523 | # Drop the diff line leader and expand tabs |
| 524 | $line =~ s/^.//; |
| 525 | $line = expand_tabs($line); |
| 526 | |
| 527 | # Pick the indent from the front of the line. |
| 528 | my ($white) = ($line =~ /^(\s*)/); |
| 529 | |
| 530 | return (length($line), length($white)); |
| 531 | } |
| 532 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 533 | my $sanitise_quote = ''; |
| 534 | |
| 535 | sub sanitise_line_reset { |
| 536 | my ($in_comment) = @_; |
| 537 | |
| 538 | if ($in_comment) { |
| 539 | $sanitise_quote = '*/'; |
| 540 | } else { |
| 541 | $sanitise_quote = ''; |
| 542 | } |
| 543 | } |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 544 | sub sanitise_line { |
| 545 | my ($line) = @_; |
| 546 | |
| 547 | my $res = ''; |
| 548 | my $l = ''; |
| 549 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 550 | my $qlen = 0; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 551 | my $off = 0; |
| 552 | my $c; |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 553 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 554 | # Always copy over the diff marker. |
| 555 | $res = substr($line, 0, 1); |
| 556 | |
| 557 | for ($off = 1; $off < length($line); $off++) { |
| 558 | $c = substr($line, $off, 1); |
| 559 | |
| 560 | # Comments we are wacking completly including the begin |
| 561 | # and end, all to $;. |
| 562 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { |
| 563 | $sanitise_quote = '*/'; |
| 564 | |
| 565 | substr($res, $off, 2, "$;$;"); |
| 566 | $off++; |
| 567 | next; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 568 | } |
Andy Whitcroft | 81bc0e0 | 2008-10-15 22:02:26 -0700 | [diff] [blame] | 569 | if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 570 | $sanitise_quote = ''; |
| 571 | substr($res, $off, 2, "$;$;"); |
| 572 | $off++; |
| 573 | next; |
| 574 | } |
Daniel Walker | 113f04a | 2009-09-21 17:04:35 -0700 | [diff] [blame] | 575 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { |
| 576 | $sanitise_quote = '//'; |
| 577 | |
| 578 | substr($res, $off, 2, $sanitise_quote); |
| 579 | $off++; |
| 580 | next; |
| 581 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 582 | |
| 583 | # A \ in a string means ignore the next character. |
| 584 | if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && |
| 585 | $c eq "\\") { |
| 586 | substr($res, $off, 2, 'XX'); |
| 587 | $off++; |
| 588 | next; |
| 589 | } |
| 590 | # Regular quotes. |
| 591 | if ($c eq "'" || $c eq '"') { |
| 592 | if ($sanitise_quote eq '') { |
| 593 | $sanitise_quote = $c; |
| 594 | |
| 595 | substr($res, $off, 1, $c); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 596 | next; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 597 | } elsif ($sanitise_quote eq $c) { |
| 598 | $sanitise_quote = ''; |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 599 | } |
| 600 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 601 | |
Andy Whitcroft | fae17da | 2009-01-06 14:41:20 -0800 | [diff] [blame] | 602 | #print "c<$c> SQ<$sanitise_quote>\n"; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 603 | if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { |
| 604 | substr($res, $off, 1, $;); |
Daniel Walker | 113f04a | 2009-09-21 17:04:35 -0700 | [diff] [blame] | 605 | } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { |
| 606 | substr($res, $off, 1, $;); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 607 | } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { |
| 608 | substr($res, $off, 1, 'X'); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 609 | } else { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 610 | substr($res, $off, 1, $c); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 611 | } |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 612 | } |
| 613 | |
Daniel Walker | 113f04a | 2009-09-21 17:04:35 -0700 | [diff] [blame] | 614 | if ($sanitise_quote eq '//') { |
| 615 | $sanitise_quote = ''; |
| 616 | } |
| 617 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 618 | # The pathname on a #include may be surrounded by '<' and '>'. |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 619 | if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 620 | my $clean = 'X' x length($1); |
| 621 | $res =~ s@\<.*\>@<$clean>@; |
| 622 | |
| 623 | # The whole of a #error is a string. |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 624 | } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 625 | my $clean = 'X' x length($1); |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 626 | $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 627 | } |
| 628 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 629 | return $res; |
| 630 | } |
| 631 | |
Joe Perches | a6962d7 | 2013-04-29 16:18:13 -0700 | [diff] [blame] | 632 | sub get_quoted_string { |
| 633 | my ($line, $rawline) = @_; |
| 634 | |
| 635 | return "" if ($line !~ m/(\"[X]+\")/g); |
| 636 | return substr($rawline, $-[0], $+[0] - $-[0]); |
| 637 | } |
| 638 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 639 | sub ctx_statement_block { |
| 640 | my ($linenr, $remain, $off) = @_; |
| 641 | my $line = $linenr - 1; |
| 642 | my $blk = ''; |
| 643 | my $soff = $off; |
| 644 | my $coff = $off - 1; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 645 | my $coff_set = 0; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 646 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 647 | my $loff = 0; |
| 648 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 649 | my $type = ''; |
| 650 | my $level = 0; |
Andy Whitcroft | a275064 | 2009-01-15 13:51:04 -0800 | [diff] [blame] | 651 | my @stack = (); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 652 | my $p; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 653 | my $c; |
| 654 | my $len = 0; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 655 | |
| 656 | my $remainder; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 657 | while (1) { |
Andy Whitcroft | a275064 | 2009-01-15 13:51:04 -0800 | [diff] [blame] | 658 | @stack = (['', 0]) if ($#stack == -1); |
| 659 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 660 | #warn "CSB: blk<$blk> remain<$remain>\n"; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 661 | # If we are about to drop off the end, pull in more |
| 662 | # context. |
| 663 | if ($off >= $len) { |
| 664 | for (; $remain > 0; $line++) { |
Andy Whitcroft | dea3349 | 2008-10-15 22:02:25 -0700 | [diff] [blame] | 665 | last if (!defined $lines[$line]); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 666 | next if ($lines[$line] =~ /^-/); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 667 | $remain--; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 668 | $loff = $len; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 669 | $blk .= $lines[$line] . "\n"; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 670 | $len = length($blk); |
| 671 | $line++; |
| 672 | last; |
| 673 | } |
| 674 | # Bail if there is no further context. |
| 675 | #warn "CSB: blk<$blk> off<$off> len<$len>\n"; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 676 | if ($off >= $len) { |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 677 | last; |
| 678 | } |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 679 | if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { |
| 680 | $level++; |
| 681 | $type = '#'; |
| 682 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 683 | } |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 684 | $p = $c; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 685 | $c = substr($blk, $off, 1); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 686 | $remainder = substr($blk, $off); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 687 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 688 | #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; |
Andy Whitcroft | 4635f4f | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 689 | |
| 690 | # Handle nested #if/#else. |
| 691 | if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { |
| 692 | push(@stack, [ $type, $level ]); |
| 693 | } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { |
| 694 | ($type, $level) = @{$stack[$#stack - 1]}; |
| 695 | } elsif ($remainder =~ /^#\s*endif\b/) { |
| 696 | ($type, $level) = @{pop(@stack)}; |
| 697 | } |
| 698 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 699 | # Statement ends at the ';' or a close '}' at the |
| 700 | # outermost level. |
| 701 | if ($level == 0 && $c eq ';') { |
| 702 | last; |
| 703 | } |
| 704 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 705 | # An else is really a conditional as long as its not else if |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 706 | if ($level == 0 && $coff_set == 0 && |
| 707 | (!defined($p) || $p =~ /(?:\s|\}|\+)/) && |
| 708 | $remainder =~ /^(else)(?:\s|{)/ && |
| 709 | $remainder !~ /^else\s+if\b/) { |
| 710 | $coff = $off + length($1) - 1; |
| 711 | $coff_set = 1; |
| 712 | #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; |
| 713 | #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 714 | } |
| 715 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 716 | if (($type eq '' || $type eq '(') && $c eq '(') { |
| 717 | $level++; |
| 718 | $type = '('; |
| 719 | } |
| 720 | if ($type eq '(' && $c eq ')') { |
| 721 | $level--; |
| 722 | $type = ($level != 0)? '(' : ''; |
| 723 | |
| 724 | if ($level == 0 && $coff < $soff) { |
| 725 | $coff = $off; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 726 | $coff_set = 1; |
| 727 | #warn "CSB: mark coff<$coff>\n"; |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 728 | } |
| 729 | } |
| 730 | if (($type eq '' || $type eq '{') && $c eq '{') { |
| 731 | $level++; |
| 732 | $type = '{'; |
| 733 | } |
| 734 | if ($type eq '{' && $c eq '}') { |
| 735 | $level--; |
| 736 | $type = ($level != 0)? '{' : ''; |
| 737 | |
| 738 | if ($level == 0) { |
Patrick Pannuto | b998e00 | 2010-08-09 17:21:03 -0700 | [diff] [blame] | 739 | if (substr($blk, $off + 1, 1) eq ';') { |
| 740 | $off++; |
| 741 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 742 | last; |
| 743 | } |
| 744 | } |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 745 | # Preprocessor commands end at the newline unless escaped. |
| 746 | if ($type eq '#' && $c eq "\n" && $p ne "\\") { |
| 747 | $level--; |
| 748 | $type = ''; |
| 749 | $off++; |
| 750 | last; |
| 751 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 752 | $off++; |
| 753 | } |
Andy Whitcroft | a3bb97a | 2008-07-23 21:29:00 -0700 | [diff] [blame] | 754 | # We are truly at the end, so shuffle to the next line. |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 755 | if ($off == $len) { |
Andy Whitcroft | a3bb97a | 2008-07-23 21:29:00 -0700 | [diff] [blame] | 756 | $loff = $len + 1; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 757 | $line++; |
| 758 | $remain--; |
| 759 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 760 | |
| 761 | my $statement = substr($blk, $soff, $off - $soff + 1); |
| 762 | my $condition = substr($blk, $soff, $coff - $soff + 1); |
| 763 | |
| 764 | #warn "STATEMENT<$statement>\n"; |
| 765 | #warn "CONDITION<$condition>\n"; |
| 766 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 767 | #print "coff<$coff> soff<$off> loff<$loff>\n"; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 768 | |
| 769 | return ($statement, $condition, |
| 770 | $line, $remain + 1, $off - $loff + 1, $level); |
| 771 | } |
| 772 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 773 | sub statement_lines { |
| 774 | my ($stmt) = @_; |
| 775 | |
| 776 | # Strip the diff line prefixes and rip blank lines at start and end. |
| 777 | $stmt =~ s/(^|\n)./$1/g; |
| 778 | $stmt =~ s/^\s*//; |
| 779 | $stmt =~ s/\s*$//; |
| 780 | |
| 781 | my @stmt_lines = ($stmt =~ /\n/g); |
| 782 | |
| 783 | return $#stmt_lines + 2; |
| 784 | } |
| 785 | |
| 786 | sub statement_rawlines { |
| 787 | my ($stmt) = @_; |
| 788 | |
| 789 | my @stmt_lines = ($stmt =~ /\n/g); |
| 790 | |
| 791 | return $#stmt_lines + 2; |
| 792 | } |
| 793 | |
| 794 | sub statement_block_size { |
| 795 | my ($stmt) = @_; |
| 796 | |
| 797 | $stmt =~ s/(^|\n)./$1/g; |
| 798 | $stmt =~ s/^\s*{//; |
| 799 | $stmt =~ s/}\s*$//; |
| 800 | $stmt =~ s/^\s*//; |
| 801 | $stmt =~ s/\s*$//; |
| 802 | |
| 803 | my @stmt_lines = ($stmt =~ /\n/g); |
| 804 | my @stmt_statements = ($stmt =~ /;/g); |
| 805 | |
| 806 | my $stmt_lines = $#stmt_lines + 2; |
| 807 | my $stmt_statements = $#stmt_statements + 1; |
| 808 | |
| 809 | if ($stmt_lines > $stmt_statements) { |
| 810 | return $stmt_lines; |
| 811 | } else { |
| 812 | return $stmt_statements; |
| 813 | } |
| 814 | } |
| 815 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 816 | sub ctx_statement_full { |
| 817 | my ($linenr, $remain, $off) = @_; |
| 818 | my ($statement, $condition, $level); |
| 819 | |
| 820 | my (@chunks); |
| 821 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 822 | # Grab the first conditional/block pair. |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 823 | ($statement, $condition, $linenr, $remain, $off, $level) = |
| 824 | ctx_statement_block($linenr, $remain, $off); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 825 | #print "F: c<$condition> s<$statement> remain<$remain>\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 826 | push(@chunks, [ $condition, $statement ]); |
| 827 | if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { |
| 828 | return ($level, $linenr, @chunks); |
| 829 | } |
| 830 | |
| 831 | # Pull in the following conditional/block pairs and see if they |
| 832 | # could continue the statement. |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 833 | for (;;) { |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 834 | ($statement, $condition, $linenr, $remain, $off, $level) = |
| 835 | ctx_statement_block($linenr, $remain, $off); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 836 | #print "C: c<$condition> s<$statement> remain<$remain>\n"; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 837 | last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 838 | #print "C: push\n"; |
| 839 | push(@chunks, [ $condition, $statement ]); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 840 | } |
| 841 | |
| 842 | return ($level, $linenr, @chunks); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 843 | } |
| 844 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 845 | sub ctx_block_get { |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 846 | my ($linenr, $remain, $outer, $open, $close, $off) = @_; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 847 | my $line; |
| 848 | my $start = $linenr - 1; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 849 | my $blk = ''; |
| 850 | my @o; |
| 851 | my @c; |
| 852 | my @res = (); |
| 853 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 854 | my $level = 0; |
Andy Whitcroft | 4635f4f | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 855 | my @stack = ($level); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 856 | for ($line = $start; $remain > 0; $line++) { |
| 857 | next if ($rawlines[$line] =~ /^-/); |
| 858 | $remain--; |
| 859 | |
| 860 | $blk .= $rawlines[$line]; |
Andy Whitcroft | 4635f4f | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 861 | |
| 862 | # Handle nested #if/#else. |
Andy Whitcroft | 01464f3 | 2010-10-26 14:23:19 -0700 | [diff] [blame] | 863 | if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { |
Andy Whitcroft | 4635f4f | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 864 | push(@stack, $level); |
Andy Whitcroft | 01464f3 | 2010-10-26 14:23:19 -0700 | [diff] [blame] | 865 | } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { |
Andy Whitcroft | 4635f4f | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 866 | $level = $stack[$#stack - 1]; |
Andy Whitcroft | 01464f3 | 2010-10-26 14:23:19 -0700 | [diff] [blame] | 867 | } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { |
Andy Whitcroft | 4635f4f | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 868 | $level = pop(@stack); |
| 869 | } |
| 870 | |
Andy Whitcroft | 01464f3 | 2010-10-26 14:23:19 -0700 | [diff] [blame] | 871 | foreach my $c (split(//, $lines[$line])) { |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 872 | ##print "C<$c>L<$level><$open$close>O<$off>\n"; |
| 873 | if ($off > 0) { |
| 874 | $off--; |
| 875 | next; |
| 876 | } |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 877 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 878 | if ($c eq $close && $level > 0) { |
| 879 | $level--; |
| 880 | last if ($level == 0); |
| 881 | } elsif ($c eq $open) { |
| 882 | $level++; |
| 883 | } |
| 884 | } |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 885 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 886 | if (!$outer || $level <= 1) { |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 887 | push(@res, $rawlines[$line]); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 888 | } |
| 889 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 890 | last if ($level == 0); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 891 | } |
| 892 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 893 | return ($level, @res); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 894 | } |
| 895 | sub ctx_block_outer { |
| 896 | my ($linenr, $remain) = @_; |
| 897 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 898 | my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); |
| 899 | return @r; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 900 | } |
| 901 | sub ctx_block { |
| 902 | my ($linenr, $remain) = @_; |
| 903 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 904 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
| 905 | return @r; |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 906 | } |
| 907 | sub ctx_statement { |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 908 | my ($linenr, $remain, $off) = @_; |
| 909 | |
| 910 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); |
| 911 | return @r; |
| 912 | } |
| 913 | sub ctx_block_level { |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 914 | my ($linenr, $remain) = @_; |
| 915 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 916 | return ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 917 | } |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 918 | sub ctx_statement_level { |
| 919 | my ($linenr, $remain, $off) = @_; |
| 920 | |
| 921 | return ctx_block_get($linenr, $remain, 0, '(', ')', $off); |
| 922 | } |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 923 | |
| 924 | sub ctx_locate_comment { |
| 925 | my ($first_line, $end_line) = @_; |
| 926 | |
| 927 | # Catch a comment on the end of the line itself. |
Andy Whitcroft | beae633 | 2008-07-23 21:28:59 -0700 | [diff] [blame] | 928 | my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 929 | return $current_comment if (defined $current_comment); |
| 930 | |
| 931 | # Look through the context and try and figure out if there is a |
| 932 | # comment. |
| 933 | my $in_comment = 0; |
| 934 | $current_comment = ''; |
| 935 | for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 936 | my $line = $rawlines[$linenr - 1]; |
| 937 | #warn " $line\n"; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 938 | if ($linenr == $first_line and $line =~ m@^.\s*\*@) { |
| 939 | $in_comment = 1; |
| 940 | } |
| 941 | if ($line =~ m@/\*@) { |
| 942 | $in_comment = 1; |
| 943 | } |
| 944 | if (!$in_comment && $current_comment ne '') { |
| 945 | $current_comment = ''; |
| 946 | } |
| 947 | $current_comment .= $line . "\n" if ($in_comment); |
| 948 | if ($line =~ m@\*/@) { |
| 949 | $in_comment = 0; |
| 950 | } |
| 951 | } |
| 952 | |
| 953 | chomp($current_comment); |
| 954 | return($current_comment); |
| 955 | } |
| 956 | sub ctx_has_comment { |
| 957 | my ($first_line, $end_line) = @_; |
| 958 | my $cmt = ctx_locate_comment($first_line, $end_line); |
| 959 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 960 | ##print "LINE: $rawlines[$end_line - 1 ]\n"; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 961 | ##print "CMMT: $cmt\n"; |
| 962 | |
| 963 | return ($cmt ne ''); |
| 964 | } |
| 965 | |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 966 | sub raw_line { |
| 967 | my ($linenr, $cnt) = @_; |
| 968 | |
| 969 | my $offset = $linenr - 1; |
| 970 | $cnt++; |
| 971 | |
| 972 | my $line; |
| 973 | while ($cnt) { |
| 974 | $line = $rawlines[$offset++]; |
| 975 | next if (defined($line) && $line =~ /^-/); |
| 976 | $cnt--; |
| 977 | } |
| 978 | |
| 979 | return $line; |
| 980 | } |
| 981 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 982 | sub cat_vet { |
| 983 | my ($vet) = @_; |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 984 | my ($res, $coded); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 985 | |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 986 | $res = ''; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 987 | while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { |
| 988 | $res .= $1; |
| 989 | if ($2 ne '') { |
| 990 | $coded = sprintf("^%c", unpack('C', $2) + 64); |
| 991 | $res .= $coded; |
| 992 | } |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 993 | } |
| 994 | $res =~ s/$/\$/; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 995 | |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 996 | return $res; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 997 | } |
| 998 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 999 | my $av_preprocessor = 0; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1000 | my $av_pending; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1001 | my @av_paren_type; |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1002 | my $av_pend_colon; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1003 | |
| 1004 | sub annotate_reset { |
| 1005 | $av_preprocessor = 0; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1006 | $av_pending = '_'; |
| 1007 | @av_paren_type = ('E'); |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1008 | $av_pend_colon = 'O'; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1009 | } |
| 1010 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1011 | sub annotate_values { |
| 1012 | my ($stream, $type) = @_; |
| 1013 | |
| 1014 | my $res; |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1015 | my $var = '_' x length($stream); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1016 | my $cur = $stream; |
| 1017 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1018 | print "$stream\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1019 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1020 | while (length($cur)) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1021 | @av_paren_type = ('E') if ($#av_paren_type < 0); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1022 | print " <" . join('', @av_paren_type) . |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1023 | "> <$type> <$av_pending>" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1024 | if ($cur =~ /^(\s+)/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1025 | print "WS($1)\n" if ($dbg_values > 1); |
| 1026 | if ($1 =~ /\n/ && $av_preprocessor) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1027 | $type = pop(@av_paren_type); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1028 | $av_preprocessor = 0; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1029 | } |
| 1030 | |
Florian Mickler | c023e473 | 2011-01-12 16:59:58 -0800 | [diff] [blame] | 1031 | } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { |
Andy Whitcroft | 9446ef5 | 2010-10-26 14:23:13 -0700 | [diff] [blame] | 1032 | print "CAST($1)\n" if ($dbg_values > 1); |
| 1033 | push(@av_paren_type, $type); |
Andy Whitcroft | addcdce | 2012-01-10 15:10:11 -0800 | [diff] [blame] | 1034 | $type = 'c'; |
Andy Whitcroft | 9446ef5 | 2010-10-26 14:23:13 -0700 | [diff] [blame] | 1035 | |
Andy Whitcroft | e91b6e2 | 2010-10-26 14:23:11 -0700 | [diff] [blame] | 1036 | } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1037 | print "DECLARE($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1038 | $type = 'T'; |
| 1039 | |
Andy Whitcroft | 389a2fe | 2008-07-23 21:29:05 -0700 | [diff] [blame] | 1040 | } elsif ($cur =~ /^($Modifier)\s*/) { |
| 1041 | print "MODIFIER($1)\n" if ($dbg_values > 1); |
| 1042 | $type = 'T'; |
| 1043 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1044 | } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1045 | print "DEFINE($1,$2)\n" if ($dbg_values > 1); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1046 | $av_preprocessor = 1; |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1047 | push(@av_paren_type, $type); |
| 1048 | if ($2 ne '') { |
| 1049 | $av_pending = 'N'; |
| 1050 | } |
| 1051 | $type = 'E'; |
| 1052 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1053 | } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1054 | print "UNDEF($1)\n" if ($dbg_values > 1); |
| 1055 | $av_preprocessor = 1; |
| 1056 | push(@av_paren_type, $type); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1057 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1058 | } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1059 | print "PRE_START($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1060 | $av_preprocessor = 1; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1061 | |
| 1062 | push(@av_paren_type, $type); |
| 1063 | push(@av_paren_type, $type); |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1064 | $type = 'E'; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1065 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1066 | } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1067 | print "PRE_RESTART($1)\n" if ($dbg_values > 1); |
| 1068 | $av_preprocessor = 1; |
| 1069 | |
| 1070 | push(@av_paren_type, $av_paren_type[$#av_paren_type]); |
| 1071 | |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1072 | $type = 'E'; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1073 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1074 | } elsif ($cur =~ /^(\#\s*(?:endif))/o) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1075 | print "PRE_END($1)\n" if ($dbg_values > 1); |
| 1076 | |
| 1077 | $av_preprocessor = 1; |
| 1078 | |
| 1079 | # Assume all arms of the conditional end as this |
| 1080 | # one does, and continue as if the #endif was not here. |
| 1081 | pop(@av_paren_type); |
| 1082 | push(@av_paren_type, $type); |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1083 | $type = 'E'; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1084 | |
| 1085 | } elsif ($cur =~ /^(\\\n)/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1086 | print "PRECONT($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1087 | |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1088 | } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { |
| 1089 | print "ATTR($1)\n" if ($dbg_values > 1); |
| 1090 | $av_pending = $type; |
| 1091 | $type = 'N'; |
| 1092 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1093 | } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1094 | print "SIZEOF($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1095 | if (defined $2) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1096 | $av_pending = 'V'; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1097 | } |
| 1098 | $type = 'N'; |
| 1099 | |
Andy Whitcroft | 14b111c | 2008-10-15 22:02:16 -0700 | [diff] [blame] | 1100 | } elsif ($cur =~ /^(if|while|for)\b/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1101 | print "COND($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 14b111c | 2008-10-15 22:02:16 -0700 | [diff] [blame] | 1102 | $av_pending = 'E'; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1103 | $type = 'N'; |
| 1104 | |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1105 | } elsif ($cur =~/^(case)/o) { |
| 1106 | print "CASE($1)\n" if ($dbg_values > 1); |
| 1107 | $av_pend_colon = 'C'; |
| 1108 | $type = 'N'; |
| 1109 | |
Andy Whitcroft | 14b111c | 2008-10-15 22:02:16 -0700 | [diff] [blame] | 1110 | } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1111 | print "KEYWORD($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1112 | $type = 'N'; |
| 1113 | |
| 1114 | } elsif ($cur =~ /^(\()/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1115 | print "PAREN('$1')\n" if ($dbg_values > 1); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1116 | push(@av_paren_type, $av_pending); |
| 1117 | $av_pending = '_'; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1118 | $type = 'N'; |
| 1119 | |
| 1120 | } elsif ($cur =~ /^(\))/o) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1121 | my $new_type = pop(@av_paren_type); |
| 1122 | if ($new_type ne '_') { |
| 1123 | $type = $new_type; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1124 | print "PAREN('$1') -> $type\n" |
| 1125 | if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1126 | } else { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1127 | print "PAREN('$1')\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1128 | } |
| 1129 | |
Andy Whitcroft | c8cb2ca | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 1130 | } elsif ($cur =~ /^($Ident)\s*\(/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1131 | print "FUNC($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | c8cb2ca | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 1132 | $type = 'V'; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1133 | $av_pending = 'V'; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1134 | |
Andy Whitcroft | 8e761b0 | 2009-01-06 14:41:19 -0800 | [diff] [blame] | 1135 | } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { |
| 1136 | if (defined $2 && $type eq 'C' || $type eq 'T') { |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1137 | $av_pend_colon = 'B'; |
Andy Whitcroft | 8e761b0 | 2009-01-06 14:41:19 -0800 | [diff] [blame] | 1138 | } elsif ($type eq 'E') { |
| 1139 | $av_pend_colon = 'L'; |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1140 | } |
| 1141 | print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); |
| 1142 | $type = 'V'; |
| 1143 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1144 | } elsif ($cur =~ /^($Ident|$Constant)/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1145 | print "IDENT($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1146 | $type = 'V'; |
| 1147 | |
| 1148 | } elsif ($cur =~ /^($Assignment)/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1149 | print "ASSIGN($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1150 | $type = 'N'; |
| 1151 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1152 | } elsif ($cur =~/^(;|{|})/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1153 | print "END($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1154 | $type = 'E'; |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1155 | $av_pend_colon = 'O'; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1156 | |
Andy Whitcroft | 8e761b0 | 2009-01-06 14:41:19 -0800 | [diff] [blame] | 1157 | } elsif ($cur =~/^(,)/) { |
| 1158 | print "COMMA($1)\n" if ($dbg_values > 1); |
| 1159 | $type = 'C'; |
| 1160 | |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1161 | } elsif ($cur =~ /^(\?)/o) { |
| 1162 | print "QUESTION($1)\n" if ($dbg_values > 1); |
| 1163 | $type = 'N'; |
| 1164 | |
| 1165 | } elsif ($cur =~ /^(:)/o) { |
| 1166 | print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); |
| 1167 | |
| 1168 | substr($var, length($res), 1, $av_pend_colon); |
| 1169 | if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { |
| 1170 | $type = 'E'; |
| 1171 | } else { |
| 1172 | $type = 'N'; |
| 1173 | } |
| 1174 | $av_pend_colon = 'O'; |
| 1175 | |
Andy Whitcroft | 8e761b0 | 2009-01-06 14:41:19 -0800 | [diff] [blame] | 1176 | } elsif ($cur =~ /^(\[)/o) { |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1177 | print "CLOSE($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1178 | $type = 'N'; |
| 1179 | |
Andy Whitcroft | 0d41386 | 2008-10-15 22:02:16 -0700 | [diff] [blame] | 1180 | } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { |
Andy Whitcroft | 74048ed | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1181 | my $variant; |
| 1182 | |
| 1183 | print "OPV($1)\n" if ($dbg_values > 1); |
| 1184 | if ($type eq 'V') { |
| 1185 | $variant = 'B'; |
| 1186 | } else { |
| 1187 | $variant = 'U'; |
| 1188 | } |
| 1189 | |
| 1190 | substr($var, length($res), 1, $variant); |
| 1191 | $type = 'N'; |
| 1192 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1193 | } elsif ($cur =~ /^($Operators)/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1194 | print "OP($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1195 | if ($1 ne '++' && $1 ne '--') { |
| 1196 | $type = 'N'; |
| 1197 | } |
| 1198 | |
| 1199 | } elsif ($cur =~ /(^.)/o) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1200 | print "C($1)\n" if ($dbg_values > 1); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1201 | } |
| 1202 | if (defined $1) { |
| 1203 | $cur = substr($cur, length($1)); |
| 1204 | $res .= $type x length($1); |
| 1205 | } |
| 1206 | } |
| 1207 | |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 1208 | return ($res, $var); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1209 | } |
| 1210 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1211 | sub possible { |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1212 | my ($possible, $line) = @_; |
Andy Whitcroft | 9a974fd | 2009-10-26 16:50:12 -0700 | [diff] [blame] | 1213 | my $notPermitted = qr{(?: |
Andy Whitcroft | 0776e59 | 2008-10-15 22:02:29 -0700 | [diff] [blame] | 1214 | ^(?: |
| 1215 | $Modifier| |
| 1216 | $Storage| |
| 1217 | $Type| |
Andy Whitcroft | 9a974fd | 2009-10-26 16:50:12 -0700 | [diff] [blame] | 1218 | DEFINE_\S+ |
| 1219 | )$| |
| 1220 | ^(?: |
Andy Whitcroft | 0776e59 | 2008-10-15 22:02:29 -0700 | [diff] [blame] | 1221 | goto| |
| 1222 | return| |
| 1223 | case| |
| 1224 | else| |
| 1225 | asm|__asm__| |
Andy Whitcroft | 89a8835 | 2012-01-10 15:10:00 -0800 | [diff] [blame] | 1226 | do| |
| 1227 | \#| |
| 1228 | \#\#| |
Andy Whitcroft | 9a974fd | 2009-10-26 16:50:12 -0700 | [diff] [blame] | 1229 | )(?:\s|$)| |
Andy Whitcroft | 0776e59 | 2008-10-15 22:02:29 -0700 | [diff] [blame] | 1230 | ^(?:typedef|struct|enum)\b |
Andy Whitcroft | 9a974fd | 2009-10-26 16:50:12 -0700 | [diff] [blame] | 1231 | )}x; |
| 1232 | warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); |
| 1233 | if ($possible !~ $notPermitted) { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1234 | # Check for modifiers. |
| 1235 | $possible =~ s/\s*$Storage\s*//g; |
| 1236 | $possible =~ s/\s*$Sparse\s*//g; |
| 1237 | if ($possible =~ /^\s*$/) { |
| 1238 | |
| 1239 | } elsif ($possible =~ /\s/) { |
| 1240 | $possible =~ s/\s*$Type\s*//g; |
Andy Whitcroft | d250658 | 2008-07-23 21:29:09 -0700 | [diff] [blame] | 1241 | for my $modifier (split(' ', $possible)) { |
Andy Whitcroft | 9a974fd | 2009-10-26 16:50:12 -0700 | [diff] [blame] | 1242 | if ($modifier !~ $notPermitted) { |
| 1243 | warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); |
| 1244 | push(@modifierList, $modifier); |
| 1245 | } |
Andy Whitcroft | d250658 | 2008-07-23 21:29:09 -0700 | [diff] [blame] | 1246 | } |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1247 | |
| 1248 | } else { |
| 1249 | warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); |
| 1250 | push(@typeList, $possible); |
| 1251 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1252 | build_types(); |
Andy Whitcroft | 0776e59 | 2008-10-15 22:02:29 -0700 | [diff] [blame] | 1253 | } else { |
| 1254 | warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1255 | } |
| 1256 | } |
| 1257 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1258 | my $prefix = ''; |
| 1259 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1260 | sub show_type { |
| 1261 | return !defined $ignore_type{$_[0]}; |
| 1262 | } |
| 1263 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 1264 | sub report { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1265 | if (!show_type($_[1]) || |
| 1266 | (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1267 | return 0; |
| 1268 | } |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1269 | my $line; |
| 1270 | if ($show_types) { |
| 1271 | $line = "$prefix$_[0]:$_[1]: $_[2]\n"; |
| 1272 | } else { |
| 1273 | $line = "$prefix$_[0]: $_[2]\n"; |
| 1274 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1275 | $line = (split('\n', $line))[0] . "\n" if ($terse); |
| 1276 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1277 | push(our @report, $line); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1278 | |
| 1279 | return 1; |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 1280 | } |
| 1281 | sub report_dump { |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1282 | our @report; |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 1283 | } |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1284 | |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1285 | sub ERROR { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1286 | if (report("ERROR", $_[0], $_[1])) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1287 | our $clean = 0; |
| 1288 | our $cnt_error++; |
| 1289 | } |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1290 | } |
| 1291 | sub WARN { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1292 | if (report("WARNING", $_[0], $_[1])) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1293 | our $clean = 0; |
| 1294 | our $cnt_warn++; |
| 1295 | } |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1296 | } |
| 1297 | sub CHK { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1298 | if ($check && report("CHECK", $_[0], $_[1])) { |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1299 | our $clean = 0; |
| 1300 | our $cnt_chk++; |
| 1301 | } |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1302 | } |
| 1303 | |
Andy Whitcroft | 6ecd967 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 1304 | sub check_absolute_file { |
| 1305 | my ($absolute, $herecurr) = @_; |
| 1306 | my $file = $absolute; |
| 1307 | |
| 1308 | ##print "absolute<$absolute>\n"; |
| 1309 | |
| 1310 | # See if any suffix of this path is a path within the tree. |
| 1311 | while ($file =~ s@^[^/]*/@@) { |
| 1312 | if (-f "$root/$file") { |
| 1313 | ##print "file<$file>\n"; |
| 1314 | last; |
| 1315 | } |
| 1316 | } |
| 1317 | if (! -f _) { |
| 1318 | return 0; |
| 1319 | } |
| 1320 | |
| 1321 | # It is, so see if the prefix is acceptable. |
| 1322 | my $prefix = $absolute; |
| 1323 | substr($prefix, -length($file)) = ''; |
| 1324 | |
| 1325 | ##print "prefix<$prefix>\n"; |
| 1326 | if ($prefix ne ".../") { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1327 | WARN("USE_RELATIVE_PATH", |
| 1328 | "use relative pathname instead of absolute in changelog text\n" . $herecurr); |
Andy Whitcroft | 6ecd967 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 1329 | } |
| 1330 | } |
| 1331 | |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 1332 | sub pos_last_openparen { |
| 1333 | my ($line) = @_; |
| 1334 | |
| 1335 | my $pos = 0; |
| 1336 | |
| 1337 | my $opens = $line =~ tr/\(/\(/; |
| 1338 | my $closes = $line =~ tr/\)/\)/; |
| 1339 | |
| 1340 | my $last_openparen = 0; |
| 1341 | |
| 1342 | if (($opens == 0) || ($closes >= $opens)) { |
| 1343 | return -1; |
| 1344 | } |
| 1345 | |
| 1346 | my $len = length($line); |
| 1347 | |
| 1348 | for ($pos = 0; $pos < $len; $pos++) { |
| 1349 | my $string = substr($line, $pos); |
| 1350 | if ($string =~ /^($FuncArg|$balanced_parens)/) { |
| 1351 | $pos += length($1) - 1; |
| 1352 | } elsif (substr($line, $pos, 1) eq '(') { |
| 1353 | $last_openparen = $pos; |
| 1354 | } elsif (index($string, '(') == -1) { |
| 1355 | last; |
| 1356 | } |
| 1357 | } |
| 1358 | |
| 1359 | return $last_openparen + 1; |
| 1360 | } |
| 1361 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1362 | sub process { |
| 1363 | my $filename = shift; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1364 | |
| 1365 | my $linenr=0; |
| 1366 | my $prevline=""; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1367 | my $prevrawline=""; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1368 | my $stashline=""; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1369 | my $stashrawline=""; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1370 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 1371 | my $length; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1372 | my $indent; |
| 1373 | my $previndent=0; |
| 1374 | my $stashindent=0; |
| 1375 | |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1376 | our $clean = 1; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1377 | my $signoff = 0; |
| 1378 | my $is_patch = 0; |
| 1379 | |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 1380 | my $in_header_lines = 1; |
| 1381 | my $in_commit_log = 0; #Scanning lines before patch |
| 1382 | |
Pasi Savanainen | fa64205d | 2012-10-04 17:13:29 -0700 | [diff] [blame] | 1383 | my $non_utf8_charset = 0; |
| 1384 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1385 | our @report = (); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1386 | our $cnt_lines = 0; |
| 1387 | our $cnt_error = 0; |
| 1388 | our $cnt_warn = 0; |
| 1389 | our $cnt_chk = 0; |
| 1390 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1391 | # Trace the real file/line as we go. |
| 1392 | my $realfile = ''; |
| 1393 | my $realline = 0; |
| 1394 | my $realcnt = 0; |
| 1395 | my $here = ''; |
| 1396 | my $in_comment = 0; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1397 | my $comment_edge = 0; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1398 | my $first_line = 0; |
Wolfram Sang | 1e85572 | 2009-01-06 14:41:24 -0800 | [diff] [blame] | 1399 | my $p1_prefix = ''; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1400 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1401 | my $prev_values = 'E'; |
| 1402 | |
| 1403 | # suppression flags |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1404 | my %suppress_ifbraces; |
Andy Whitcroft | 170d3a2 | 2008-10-15 22:02:30 -0700 | [diff] [blame] | 1405 | my %suppress_whiletrailers; |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 1406 | my %suppress_export; |
Andy Whitcroft | 3e469cd | 2012-01-10 15:10:01 -0800 | [diff] [blame] | 1407 | my $suppress_statement = 0; |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 1408 | |
Joe Perches | 323c126 | 2012-12-17 16:02:07 -0800 | [diff] [blame] | 1409 | my %camelcase = (); |
| 1410 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1411 | # Pre-scan the patch sanitizing the lines. |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1412 | # Pre-scan the patch looking for any __setup documentation. |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1413 | # |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1414 | my @setup_docs = (); |
| 1415 | my $setup_docs = 0; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1416 | |
| 1417 | sanitise_line_reset(); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1418 | my $line; |
| 1419 | foreach my $rawline (@rawlines) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1420 | $linenr++; |
| 1421 | $line = $rawline; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1422 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1423 | if ($rawline=~/^\+\+\+\s+(\S+)/) { |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1424 | $setup_docs = 0; |
| 1425 | if ($1 =~ m@Documentation/kernel-parameters.txt$@) { |
| 1426 | $setup_docs = 1; |
| 1427 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1428 | #next; |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1429 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1430 | if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
| 1431 | $realline=$1-1; |
| 1432 | if (defined $2) { |
| 1433 | $realcnt=$3+1; |
| 1434 | } else { |
| 1435 | $realcnt=1+1; |
| 1436 | } |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1437 | $in_comment = 0; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1438 | |
| 1439 | # Guestimate if this is a continuing comment. Run |
| 1440 | # the context looking for a comment "edge". If this |
| 1441 | # edge is a close comment then we must be in a comment |
| 1442 | # at context start. |
| 1443 | my $edge; |
Andy Whitcroft | 01fa914 | 2008-10-15 22:02:19 -0700 | [diff] [blame] | 1444 | my $cnt = $realcnt; |
| 1445 | for (my $ln = $linenr + 1; $cnt > 0; $ln++) { |
| 1446 | next if (defined $rawlines[$ln - 1] && |
| 1447 | $rawlines[$ln - 1] =~ /^-/); |
| 1448 | $cnt--; |
| 1449 | #print "RAW<$rawlines[$ln - 1]>\n"; |
Andy Whitcroft | 721c1cb | 2009-01-06 14:41:16 -0800 | [diff] [blame] | 1450 | last if (!defined $rawlines[$ln - 1]); |
Andy Whitcroft | fae17da | 2009-01-06 14:41:20 -0800 | [diff] [blame] | 1451 | if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && |
| 1452 | $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { |
| 1453 | ($edge) = $1; |
| 1454 | last; |
| 1455 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1456 | } |
| 1457 | if (defined $edge && $edge eq '*/') { |
| 1458 | $in_comment = 1; |
| 1459 | } |
| 1460 | |
| 1461 | # Guestimate if this is a continuing comment. If this |
| 1462 | # is the start of a diff block and this line starts |
| 1463 | # ' *' then it is very likely a comment. |
| 1464 | if (!defined $edge && |
Andy Whitcroft | 83242e0 | 2009-01-06 14:41:17 -0800 | [diff] [blame] | 1465 | $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1466 | { |
| 1467 | $in_comment = 1; |
| 1468 | } |
| 1469 | |
| 1470 | ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; |
| 1471 | sanitise_line_reset($in_comment); |
| 1472 | |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1473 | } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1474 | # Standardise the strings and chars within the input to |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1475 | # simplify matching -- only bother with positive lines. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1476 | $line = sanitise_line($rawline); |
| 1477 | } |
| 1478 | push(@lines, $line); |
| 1479 | |
| 1480 | if ($realcnt > 1) { |
| 1481 | $realcnt-- if ($line =~ /^(?:\+| |$)/); |
| 1482 | } else { |
| 1483 | $realcnt = 0; |
| 1484 | } |
| 1485 | |
| 1486 | #print "==>$rawline\n"; |
| 1487 | #print "-->$line\n"; |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1488 | |
| 1489 | if ($setup_docs && $line =~ /^\+/) { |
| 1490 | push(@setup_docs, $line); |
| 1491 | } |
| 1492 | } |
| 1493 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1494 | $prefix = ''; |
| 1495 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1496 | $realcnt = 0; |
| 1497 | $linenr = 0; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1498 | foreach my $line (@lines) { |
| 1499 | $linenr++; |
| 1500 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1501 | my $rawline = $rawlines[$linenr - 1]; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1502 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1503 | #extract the line range in the file after the patch is applied |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1504 | if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1505 | $is_patch = 1; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 1506 | $first_line = $linenr + 1; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1507 | $realline=$1-1; |
| 1508 | if (defined $2) { |
| 1509 | $realcnt=$3+1; |
| 1510 | } else { |
| 1511 | $realcnt=1+1; |
| 1512 | } |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1513 | annotate_reset(); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 1514 | $prev_values = 'E'; |
| 1515 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1516 | %suppress_ifbraces = (); |
Andy Whitcroft | 170d3a2 | 2008-10-15 22:02:30 -0700 | [diff] [blame] | 1517 | %suppress_whiletrailers = (); |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 1518 | %suppress_export = (); |
Andy Whitcroft | 3e469cd | 2012-01-10 15:10:01 -0800 | [diff] [blame] | 1519 | $suppress_statement = 0; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1520 | next; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1521 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 1522 | # track the line number as we move through the hunk, note that |
| 1523 | # new versions of GNU diff omit the leading space on completely |
| 1524 | # blank context lines so we need to count that too. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1525 | } elsif ($line =~ /^( |\+|$)/) { |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1526 | $realline++; |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 1527 | $realcnt-- if ($realcnt != 0); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1528 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 1529 | # Measure the line length and indent. |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1530 | ($length, $indent) = line_stats($rawline); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1531 | |
| 1532 | # Track the previous line. |
| 1533 | ($prevline, $stashline) = ($stashline, $line); |
| 1534 | ($previndent, $stashindent) = ($stashindent, $indent); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1535 | ($prevrawline, $stashrawline) = ($stashrawline, $rawline); |
| 1536 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1537 | #warn "line<$line>\n"; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1538 | |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 1539 | } elsif ($realcnt == 1) { |
| 1540 | $realcnt--; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1541 | } |
| 1542 | |
Andy Whitcroft | cc77cdc | 2009-10-26 16:50:13 -0700 | [diff] [blame] | 1543 | my $hunk_line = ($realcnt != 0); |
| 1544 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1545 | #make up the handle for any error we report on this line |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1546 | $prefix = "$filename:$realline: " if ($emacs && $file); |
| 1547 | $prefix = "$filename:$linenr: " if ($emacs && !$file); |
| 1548 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1549 | $here = "#$linenr: " if (!$file); |
| 1550 | $here = "#$realline: " if ($file); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1551 | |
| 1552 | # extract the filename as it passes |
Rabin Vincent | 3bf9a00 | 2010-10-26 14:23:16 -0700 | [diff] [blame] | 1553 | if ($line =~ /^diff --git.*?(\S+)$/) { |
| 1554 | $realfile = $1; |
| 1555 | $realfile =~ s@^([^/]*)/@@; |
Joe Perches | 270c49a | 2012-01-10 15:09:50 -0800 | [diff] [blame] | 1556 | $in_commit_log = 0; |
Rabin Vincent | 3bf9a00 | 2010-10-26 14:23:16 -0700 | [diff] [blame] | 1557 | } elsif ($line =~ /^\+\+\+\s+(\S+)/) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1558 | $realfile = $1; |
Wolfram Sang | 1e85572 | 2009-01-06 14:41:24 -0800 | [diff] [blame] | 1559 | $realfile =~ s@^([^/]*)/@@; |
Joe Perches | 270c49a | 2012-01-10 15:09:50 -0800 | [diff] [blame] | 1560 | $in_commit_log = 0; |
Wolfram Sang | 1e85572 | 2009-01-06 14:41:24 -0800 | [diff] [blame] | 1561 | |
| 1562 | $p1_prefix = $1; |
Andy Whitcroft | e2f7aa4 | 2009-02-27 14:03:06 -0800 | [diff] [blame] | 1563 | if (!$file && $tree && $p1_prefix ne '' && |
| 1564 | -e "$root/$p1_prefix") { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1565 | WARN("PATCH_PREFIX", |
| 1566 | "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); |
Wolfram Sang | 1e85572 | 2009-01-06 14:41:24 -0800 | [diff] [blame] | 1567 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1568 | |
Andy Whitcroft | c1ab332 | 2008-10-15 22:02:20 -0700 | [diff] [blame] | 1569 | if ($realfile =~ m@^include/asm/@) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1570 | ERROR("MODIFIED_INCLUDE_ASM", |
| 1571 | "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 1572 | } |
| 1573 | next; |
| 1574 | } |
| 1575 | |
Randy Dunlap | 389834b | 2007-06-08 13:47:03 -0700 | [diff] [blame] | 1576 | $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1577 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1578 | my $hereline = "$here\n$rawline\n"; |
| 1579 | my $herecurr = "$here\n$rawline\n"; |
| 1580 | my $hereprev = "$here\n$prevrawline\n$rawline\n"; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1581 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1582 | $cnt_lines++ if ($realcnt != 0); |
| 1583 | |
Rabin Vincent | 3bf9a00 | 2010-10-26 14:23:16 -0700 | [diff] [blame] | 1584 | # Check for incorrect file permissions |
| 1585 | if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { |
| 1586 | my $permhere = $here . "FILE: $realfile\n"; |
Joe Perches | 04db4d2 | 2013-04-29 16:18:14 -0700 | [diff] [blame] | 1587 | if ($realfile !~ m@scripts/@ && |
| 1588 | $realfile !~ /\.(py|pl|awk|sh)$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1589 | ERROR("EXECUTE_PERMISSIONS", |
| 1590 | "do not set execute permissions for source files\n" . $permhere); |
Rabin Vincent | 3bf9a00 | 2010-10-26 14:23:16 -0700 | [diff] [blame] | 1591 | } |
| 1592 | } |
| 1593 | |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1594 | # Check the patch for a signoff: |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 1595 | if ($line =~ /^\s*signed-off-by:/i) { |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 1596 | $signoff++; |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 1597 | $in_commit_log = 0; |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1598 | } |
| 1599 | |
| 1600 | # Check signature styles |
Joe Perches | 270c49a | 2012-01-10 15:09:50 -0800 | [diff] [blame] | 1601 | if (!$in_header_lines && |
Joe Perches | ce0338df3c | 2012-07-30 14:41:18 -0700 | [diff] [blame] | 1602 | $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1603 | my $space_before = $1; |
| 1604 | my $sign_off = $2; |
| 1605 | my $space_after = $3; |
| 1606 | my $email = $4; |
| 1607 | my $ucfirst_sign_off = ucfirst(lc($sign_off)); |
| 1608 | |
Joe Perches | ce0338df3c | 2012-07-30 14:41:18 -0700 | [diff] [blame] | 1609 | if ($sign_off !~ /$signature_tags/) { |
| 1610 | WARN("BAD_SIGN_OFF", |
| 1611 | "Non-standard signature: $sign_off\n" . $herecurr); |
| 1612 | } |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1613 | if (defined $space_before && $space_before ne "") { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1614 | WARN("BAD_SIGN_OFF", |
| 1615 | "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1616 | } |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1617 | if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1618 | WARN("BAD_SIGN_OFF", |
| 1619 | "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1620 | } |
| 1621 | if (!defined $space_after || $space_after ne " ") { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1622 | WARN("BAD_SIGN_OFF", |
| 1623 | "Use a single space after $ucfirst_sign_off\n" . $herecurr); |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1624 | } |
| 1625 | |
| 1626 | my ($email_name, $email_address, $comment) = parse_email($email); |
| 1627 | my $suggested_email = format_email(($email_name, $email_address)); |
| 1628 | if ($suggested_email eq "") { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1629 | ERROR("BAD_SIGN_OFF", |
| 1630 | "Unrecognized email address: '$email'\n" . $herecurr); |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1631 | } else { |
| 1632 | my $dequoted = $suggested_email; |
| 1633 | $dequoted =~ s/^"//; |
| 1634 | $dequoted =~ s/" </ </; |
| 1635 | # Don't force email to have quotes |
| 1636 | # Allow just an angle bracketed address |
| 1637 | if ("$dequoted$comment" ne $email && |
| 1638 | "<$email_address>$comment" ne $email && |
| 1639 | "$suggested_email$comment" ne $email) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1640 | WARN("BAD_SIGN_OFF", |
| 1641 | "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); |
Joe Perches | 2011247 | 2011-07-25 17:13:23 -0700 | [diff] [blame] | 1642 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1643 | } |
| 1644 | } |
| 1645 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 1646 | # Check for wrappage within a valid hunk of the file |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1647 | if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1648 | ERROR("CORRUPTED_PATCH", |
| 1649 | "patch seems to be corrupt (line wrapped?)\n" . |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 1650 | $herecurr) if (!$emitted_corrupt++); |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1651 | } |
| 1652 | |
Andy Whitcroft | 6ecd967 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 1653 | # Check for absolute kernel paths. |
| 1654 | if ($tree) { |
| 1655 | while ($line =~ m{(?:^|\s)(/\S*)}g) { |
| 1656 | my $file = $1; |
| 1657 | |
| 1658 | if ($file =~ m{^(.*?)(?::\d+)+:?$} && |
| 1659 | check_absolute_file($1, $herecurr)) { |
| 1660 | # |
| 1661 | } else { |
| 1662 | check_absolute_file($file, $herecurr); |
| 1663 | } |
| 1664 | } |
| 1665 | } |
| 1666 | |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 1667 | # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php |
| 1668 | if (($realfile =~ /^$/ || $line =~ /^\+/) && |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1669 | $rawline !~ m/^$UTF8*$/) { |
| 1670 | my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); |
| 1671 | |
| 1672 | my $blank = copy_spacing($rawline); |
| 1673 | my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; |
| 1674 | my $hereptr = "$hereline$ptr\n"; |
| 1675 | |
Joe Perches | 34d9921 | 2011-07-25 17:13:26 -0700 | [diff] [blame] | 1676 | CHK("INVALID_UTF8", |
| 1677 | "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 1678 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1679 | |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 1680 | # Check if it's the start of a commit log |
| 1681 | # (not a header line and we haven't seen the patch filename) |
| 1682 | if ($in_header_lines && $realfile =~ /^$/ && |
Joe Perches | 270c49a | 2012-01-10 15:09:50 -0800 | [diff] [blame] | 1683 | $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 1684 | $in_header_lines = 0; |
| 1685 | $in_commit_log = 1; |
| 1686 | } |
| 1687 | |
Pasi Savanainen | fa64205d | 2012-10-04 17:13:29 -0700 | [diff] [blame] | 1688 | # Check if there is UTF-8 in a commit log when a mail header has explicitly |
| 1689 | # declined it, i.e defined some charset where it is missing. |
| 1690 | if ($in_header_lines && |
| 1691 | $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && |
| 1692 | $1 !~ /utf-8/i) { |
| 1693 | $non_utf8_charset = 1; |
| 1694 | } |
| 1695 | |
| 1696 | if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 1697 | $rawline =~ /$NON_ASCII_UTF8/) { |
Pasi Savanainen | fa64205d | 2012-10-04 17:13:29 -0700 | [diff] [blame] | 1698 | WARN("UTF8_BEFORE_PATCH", |
Joe Perches | 15662b3 | 2011-10-31 17:13:12 -0700 | [diff] [blame] | 1699 | "8-bit UTF-8 used in possible commit log\n" . $herecurr); |
| 1700 | } |
| 1701 | |
Andy Whitcroft | 30670854 | 2008-10-15 22:02:28 -0700 | [diff] [blame] | 1702 | # ignore non-hunk lines and lines being removed |
| 1703 | next if (!$hunk_line || $line =~ /^-/); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 1704 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1705 | #trailing whitespace |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 1706 | if ($line =~ /^\+.*\015/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1707 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1708 | ERROR("DOS_LINE_ENDINGS", |
| 1709 | "DOS line endings\n" . $herevet); |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 1710 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1711 | } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { |
| 1712 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1713 | ERROR("TRAILING_WHITESPACE", |
| 1714 | "trailing whitespace\n" . $herevet); |
Andy Whitcroft | d2c0a23 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 1715 | $rpt_cleaners = 1; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1716 | } |
Andy Whitcroft | 5368df2 | 2008-10-15 22:02:27 -0700 | [diff] [blame] | 1717 | |
Andi Kleen | 3354957 | 2010-05-24 14:33:29 -0700 | [diff] [blame] | 1718 | # check for Kconfig help text having a real description |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1719 | # Only applies when adding the entry originally, after that we do not have |
| 1720 | # sufficient context to determine whether it is indeed long enough. |
Andi Kleen | 3354957 | 2010-05-24 14:33:29 -0700 | [diff] [blame] | 1721 | if ($realfile =~ /Kconfig/ && |
Andy Whitcroft | a138580 | 2012-01-10 15:10:03 -0800 | [diff] [blame] | 1722 | $line =~ /.\s*config\s+/) { |
Andi Kleen | 3354957 | 2010-05-24 14:33:29 -0700 | [diff] [blame] | 1723 | my $length = 0; |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1724 | my $cnt = $realcnt; |
| 1725 | my $ln = $linenr + 1; |
| 1726 | my $f; |
Andy Whitcroft | a138580 | 2012-01-10 15:10:03 -0800 | [diff] [blame] | 1727 | my $is_start = 0; |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1728 | my $is_end = 0; |
Andy Whitcroft | a138580 | 2012-01-10 15:10:03 -0800 | [diff] [blame] | 1729 | for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1730 | $f = $lines[$ln - 1]; |
| 1731 | $cnt-- if ($lines[$ln - 1] !~ /^-/); |
| 1732 | $is_end = $lines[$ln - 1] =~ /^\+/; |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1733 | |
| 1734 | next if ($f =~ /^-/); |
Andy Whitcroft | a138580 | 2012-01-10 15:10:03 -0800 | [diff] [blame] | 1735 | |
| 1736 | if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { |
| 1737 | $is_start = 1; |
| 1738 | } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { |
| 1739 | $length = -1; |
| 1740 | } |
| 1741 | |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1742 | $f =~ s/^.//; |
Andi Kleen | 3354957 | 2010-05-24 14:33:29 -0700 | [diff] [blame] | 1743 | $f =~ s/#.*//; |
| 1744 | $f =~ s/^\s+//; |
| 1745 | next if ($f =~ /^$/); |
Andy Whitcroft | 9fe287d7 | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 1746 | if ($f =~ /^\s*config\s/) { |
| 1747 | $is_end = 1; |
| 1748 | last; |
| 1749 | } |
Andi Kleen | 3354957 | 2010-05-24 14:33:29 -0700 | [diff] [blame] | 1750 | $length++; |
| 1751 | } |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1752 | WARN("CONFIG_DESCRIPTION", |
Andy Whitcroft | a138580 | 2012-01-10 15:10:03 -0800 | [diff] [blame] | 1753 | "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); |
| 1754 | #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; |
Andi Kleen | 3354957 | 2010-05-24 14:33:29 -0700 | [diff] [blame] | 1755 | } |
| 1756 | |
Kees Cook | 1ba8dfd | 2012-12-17 16:01:48 -0800 | [diff] [blame] | 1757 | # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. |
| 1758 | if ($realfile =~ /Kconfig/ && |
| 1759 | $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { |
| 1760 | WARN("CONFIG_EXPERIMENTAL", |
| 1761 | "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); |
| 1762 | } |
| 1763 | |
Arnaud Lacombe | c68e587 | 2011-08-15 01:07:14 -0400 | [diff] [blame] | 1764 | if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && |
| 1765 | ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { |
| 1766 | my $flag = $1; |
| 1767 | my $replacement = { |
| 1768 | 'EXTRA_AFLAGS' => 'asflags-y', |
| 1769 | 'EXTRA_CFLAGS' => 'ccflags-y', |
| 1770 | 'EXTRA_CPPFLAGS' => 'cppflags-y', |
| 1771 | 'EXTRA_LDFLAGS' => 'ldflags-y', |
| 1772 | }; |
| 1773 | |
| 1774 | WARN("DEPRECATED_VARIABLE", |
| 1775 | "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); |
| 1776 | } |
| 1777 | |
Andy Whitcroft | 5368df2 | 2008-10-15 22:02:27 -0700 | [diff] [blame] | 1778 | # check we are in a valid source file if not then ignore this hunk |
| 1779 | next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); |
| 1780 | |
Joe Perches | 6cd7f38 | 2012-12-17 16:01:54 -0800 | [diff] [blame] | 1781 | #line length limit |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1782 | if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && |
Andy Whitcroft | f4c014c | 2008-07-23 21:29:01 -0700 | [diff] [blame] | 1783 | $rawline !~ /^.\s*\*\s*\@$Ident\s/ && |
Joe Perches | 0fccc62 | 2011-05-24 17:13:41 -0700 | [diff] [blame] | 1784 | !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || |
Joe Perches | 8bbea96 | 2010-08-09 17:21:01 -0700 | [diff] [blame] | 1785 | $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && |
Joe Perches | 6cd7f38 | 2012-12-17 16:01:54 -0800 | [diff] [blame] | 1786 | $length > $max_line_length) |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1787 | { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1788 | WARN("LONG_LINE", |
Joe Perches | 6cd7f38 | 2012-12-17 16:01:54 -0800 | [diff] [blame] | 1789 | "line over $max_line_length characters\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1790 | } |
| 1791 | |
Josh Triplett | ca56dc0 | 2012-03-23 15:02:21 -0700 | [diff] [blame] | 1792 | # Check for user-visible strings broken across lines, which breaks the ability |
| 1793 | # to grep for the string. Limited to strings used as parameters (those |
| 1794 | # following an open parenthesis), which almost completely eliminates false |
| 1795 | # positives, as well as warning only once per parameter rather than once per |
| 1796 | # line of the string. Make an exception when the previous string ends in a |
| 1797 | # newline (multiple lines in one string constant) or \n\t (common in inline |
| 1798 | # assembly to indent the instruction on the following line). |
| 1799 | if ($line =~ /^\+\s*"/ && |
| 1800 | $prevline =~ /"\s*$/ && |
| 1801 | $prevline =~ /\(/ && |
| 1802 | $prevrawline !~ /\\n(?:\\t)*"\s*$/) { |
| 1803 | WARN("SPLIT_STRING", |
| 1804 | "quoted string split across lines\n" . $hereprev); |
| 1805 | } |
| 1806 | |
Joe Perches | 5e79d96 | 2010-03-05 13:43:55 -0800 | [diff] [blame] | 1807 | # check for spaces before a quoted newline |
| 1808 | if ($rawline =~ /^.*\".*\s\\n/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1809 | WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", |
| 1810 | "unnecessary whitespace before a quoted newline\n" . $herecurr); |
Joe Perches | 5e79d96 | 2010-03-05 13:43:55 -0800 | [diff] [blame] | 1811 | } |
| 1812 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1813 | # check for adding lines without a newline. |
| 1814 | if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1815 | WARN("MISSING_EOF_NEWLINE", |
| 1816 | "adding a line without newline at end of file\n" . $herecurr); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1817 | } |
| 1818 | |
Mike Frysinger | 42e41c5 | 2009-09-21 17:04:40 -0700 | [diff] [blame] | 1819 | # Blackfin: use hi/lo macros |
| 1820 | if ($realfile =~ m@arch/blackfin/.*\.S$@) { |
| 1821 | if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { |
| 1822 | my $herevet = "$here\n" . cat_vet($line) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1823 | ERROR("LO_MACRO", |
| 1824 | "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); |
Mike Frysinger | 42e41c5 | 2009-09-21 17:04:40 -0700 | [diff] [blame] | 1825 | } |
| 1826 | if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { |
| 1827 | my $herevet = "$here\n" . cat_vet($line) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1828 | ERROR("HI_MACRO", |
| 1829 | "use the HI() macro, not (... >> 16)\n" . $herevet); |
Mike Frysinger | 42e41c5 | 2009-09-21 17:04:40 -0700 | [diff] [blame] | 1830 | } |
| 1831 | } |
| 1832 | |
Andy Whitcroft | b9ea10d | 2008-10-15 22:02:24 -0700 | [diff] [blame] | 1833 | # check we are in a valid source file C or perl if not then ignore this hunk |
| 1834 | next if ($realfile !~ /\.(h|c|pl)$/); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1835 | |
| 1836 | # at the beginning of a line any tabs must come first and anything |
| 1837 | # more than 8 must use tabs. |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1838 | if ($rawline =~ /^\+\s* \t\s*\S/ || |
| 1839 | $rawline =~ /^\+\s* \s*/) { |
| 1840 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1841 | ERROR("CODE_INDENT", |
| 1842 | "code indent should use tabs where possible\n" . $herevet); |
Andy Whitcroft | d2c0a23 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 1843 | $rpt_cleaners = 1; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 1844 | } |
| 1845 | |
Alberto Panizzo | 08e4436 | 2010-03-05 13:43:54 -0800 | [diff] [blame] | 1846 | # check for space before tabs. |
| 1847 | if ($rawline =~ /^\+/ && $rawline =~ / \t/) { |
| 1848 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1849 | WARN("SPACE_BEFORE_TAB", |
| 1850 | "please, no space before tabs\n" . $herevet); |
Alberto Panizzo | 08e4436 | 2010-03-05 13:43:54 -0800 | [diff] [blame] | 1851 | } |
| 1852 | |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 1853 | # check for && or || at the start of a line |
| 1854 | if ($rawline =~ /^\+\s*(&&|\|\|)/) { |
| 1855 | CHK("LOGICAL_CONTINUATIONS", |
| 1856 | "Logical continuations should be on the previous line\n" . $hereprev); |
| 1857 | } |
| 1858 | |
| 1859 | # check multi-line statement indentation matches previous line |
| 1860 | if ($^V && $^V ge 5.10.0 && |
| 1861 | $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { |
| 1862 | $prevline =~ /^\+(\t*)(.*)$/; |
| 1863 | my $oldindent = $1; |
| 1864 | my $rest = $2; |
| 1865 | |
| 1866 | my $pos = pos_last_openparen($rest); |
| 1867 | if ($pos >= 0) { |
Joe Perches | b34a26f | 2012-07-30 14:41:16 -0700 | [diff] [blame] | 1868 | $line =~ /^(\+| )([ \t]*)/; |
| 1869 | my $newindent = $2; |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 1870 | |
| 1871 | my $goodtabindent = $oldindent . |
| 1872 | "\t" x ($pos / 8) . |
| 1873 | " " x ($pos % 8); |
| 1874 | my $goodspaceindent = $oldindent . " " x $pos; |
| 1875 | |
| 1876 | if ($newindent ne $goodtabindent && |
| 1877 | $newindent ne $goodspaceindent) { |
| 1878 | CHK("PARENTHESIS_ALIGNMENT", |
| 1879 | "Alignment should match open parenthesis\n" . $hereprev); |
| 1880 | } |
| 1881 | } |
| 1882 | } |
| 1883 | |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 1884 | if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) { |
| 1885 | CHK("SPACING", |
| 1886 | "No space is necessary after a cast\n" . $hereprev); |
| 1887 | } |
| 1888 | |
Joe Perches | 0588060 | 2012-10-04 17:13:35 -0700 | [diff] [blame] | 1889 | if ($realfile =~ m@^(drivers/net/|net/)@ && |
| 1890 | $rawline =~ /^\+[ \t]*\/\*[ \t]*$/ && |
| 1891 | $prevrawline =~ /^\+[ \t]*$/) { |
| 1892 | WARN("NETWORKING_BLOCK_COMMENT_STYLE", |
| 1893 | "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); |
| 1894 | } |
| 1895 | |
| 1896 | if ($realfile =~ m@^(drivers/net/|net/)@ && |
Joe Perches | c24f9f1 | 2012-11-08 15:53:29 -0800 | [diff] [blame] | 1897 | $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ |
| 1898 | $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ |
| 1899 | $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ |
| 1900 | $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ |
Joe Perches | 0588060 | 2012-10-04 17:13:35 -0700 | [diff] [blame] | 1901 | WARN("NETWORKING_BLOCK_COMMENT_STYLE", |
| 1902 | "networking block comments put the trailing */ on a separate line\n" . $herecurr); |
| 1903 | } |
| 1904 | |
Raffaele Recalcati | 5f7ddae | 2010-08-09 17:20:59 -0700 | [diff] [blame] | 1905 | # check for spaces at the beginning of a line. |
Andy Whitcroft | 6b4c5be | 2010-10-26 14:23:11 -0700 | [diff] [blame] | 1906 | # Exceptions: |
| 1907 | # 1) within comments |
| 1908 | # 2) indented preprocessor commands |
| 1909 | # 3) hanging labels |
| 1910 | if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { |
Raffaele Recalcati | 5f7ddae | 2010-08-09 17:20:59 -0700 | [diff] [blame] | 1911 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1912 | WARN("LEADING_SPACE", |
| 1913 | "please, no spaces at the start of a line\n" . $herevet); |
Raffaele Recalcati | 5f7ddae | 2010-08-09 17:20:59 -0700 | [diff] [blame] | 1914 | } |
| 1915 | |
Andy Whitcroft | b9ea10d | 2008-10-15 22:02:24 -0700 | [diff] [blame] | 1916 | # check we are in a valid C source file if not then ignore this hunk |
| 1917 | next if ($realfile !~ /\.(h|c)$/); |
| 1918 | |
Kees Cook | 1ba8dfd | 2012-12-17 16:01:48 -0800 | [diff] [blame] | 1919 | # discourage the addition of CONFIG_EXPERIMENTAL in #if(def). |
| 1920 | if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { |
| 1921 | WARN("CONFIG_EXPERIMENTAL", |
| 1922 | "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); |
| 1923 | } |
| 1924 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1925 | # check for RCS/CVS revision markers |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1926 | if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1927 | WARN("CVS_KEYWORD", |
| 1928 | "CVS style keyword markers, these will _not_ be updated\n". $herecurr); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1929 | } |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 1930 | |
Mike Frysinger | 42e41c5 | 2009-09-21 17:04:40 -0700 | [diff] [blame] | 1931 | # Blackfin: don't use __builtin_bfin_[cs]sync |
| 1932 | if ($line =~ /__builtin_bfin_csync/) { |
| 1933 | my $herevet = "$here\n" . cat_vet($line) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1934 | ERROR("CSYNC", |
| 1935 | "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); |
Mike Frysinger | 42e41c5 | 2009-09-21 17:04:40 -0700 | [diff] [blame] | 1936 | } |
| 1937 | if ($line =~ /__builtin_bfin_ssync/) { |
| 1938 | my $herevet = "$here\n" . cat_vet($line) . "\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 1939 | ERROR("SSYNC", |
| 1940 | "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); |
Mike Frysinger | 42e41c5 | 2009-09-21 17:04:40 -0700 | [diff] [blame] | 1941 | } |
| 1942 | |
Joe Perches | 56e77d7 | 2013-02-21 16:44:14 -0800 | [diff] [blame] | 1943 | # check for old HOTPLUG __dev<foo> section markings |
| 1944 | if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { |
| 1945 | WARN("HOTPLUG_SECTION", |
| 1946 | "Using $1 is unnecessary\n" . $herecurr); |
| 1947 | } |
| 1948 | |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 1949 | # Check for potential 'bare' types |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 1950 | my ($stat, $cond, $line_nr_next, $remain_next, $off_next, |
| 1951 | $realline_next); |
Andy Whitcroft | 3e469cd | 2012-01-10 15:10:01 -0800 | [diff] [blame] | 1952 | #print "LINE<$line>\n"; |
| 1953 | if ($linenr >= $suppress_statement && |
| 1954 | $realcnt && $line =~ /.\s*\S/) { |
Andy Whitcroft | 170d3a2 | 2008-10-15 22:02:30 -0700 | [diff] [blame] | 1955 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
Andy Whitcroft | f5fe35d | 2008-07-23 21:29:03 -0700 | [diff] [blame] | 1956 | ctx_statement_block($linenr, $realcnt, 0); |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1957 | $stat =~ s/\n./\n /g; |
| 1958 | $cond =~ s/\n./\n /g; |
| 1959 | |
Andy Whitcroft | 3e469cd | 2012-01-10 15:10:01 -0800 | [diff] [blame] | 1960 | #print "linenr<$linenr> <$stat>\n"; |
| 1961 | # If this statement has no statement boundaries within |
| 1962 | # it there is no point in retrying a statement scan |
| 1963 | # until we hit end of it. |
| 1964 | my $frag = $stat; $frag =~ s/;+\s*$//; |
| 1965 | if ($frag !~ /(?:{|;)/) { |
| 1966 | #print "skip<$line_nr_next>\n"; |
| 1967 | $suppress_statement = $line_nr_next; |
| 1968 | } |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 1969 | |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 1970 | # Find the real next line. |
| 1971 | $realline_next = $line_nr_next; |
| 1972 | if (defined $realline_next && |
| 1973 | (!defined $lines[$realline_next - 1] || |
| 1974 | substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { |
| 1975 | $realline_next++; |
| 1976 | } |
| 1977 | |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1978 | my $s = $stat; |
| 1979 | $s =~ s/{.*$//s; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 1980 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1981 | # Ignore goto labels. |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1982 | if ($s =~ /$Ident:\*$/s) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1983 | |
| 1984 | # Ignore functions being called |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 1985 | } elsif ($s =~ /^.\s*$Ident\s*\(/s) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1986 | |
Andy Whitcroft | 463f286 | 2009-09-21 17:04:34 -0700 | [diff] [blame] | 1987 | } elsif ($s =~ /^.\s*else\b/s) { |
| 1988 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1989 | # declarations always start with types |
Andy Whitcroft | d250658 | 2008-07-23 21:29:09 -0700 | [diff] [blame] | 1990 | } 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) { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1991 | my $type = $1; |
| 1992 | $type =~ s/\s+/ /g; |
| 1993 | possible($type, "A:" . $s); |
| 1994 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1995 | # definitions in global scope can only start with types |
Andy Whitcroft | a6a84062 | 2008-10-15 22:02:30 -0700 | [diff] [blame] | 1996 | } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 1997 | possible($1, "B:" . $s); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 1998 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 1999 | |
| 2000 | # any (foo ... *) is a pointer cast, and foo is a type |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2001 | while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2002 | possible($1, "C:" . $s); |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2003 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2004 | |
| 2005 | # Check for any sort of function declaration. |
| 2006 | # int foo(something bar, other baz); |
| 2007 | # void (*store_gdt)(x86_descr_ptr *); |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 2008 | if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2009 | my ($name_len) = length($1); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2010 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2011 | my $ctx = $s; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2012 | substr($ctx, 0, $name_len + 1, ''); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2013 | $ctx =~ s/\)[^\)]*$//; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2014 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2015 | for my $arg (split(/\s*,\s*/, $ctx)) { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2016 | if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2017 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2018 | possible($1, "D:" . $s); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2019 | } |
| 2020 | } |
| 2021 | } |
| 2022 | |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2023 | } |
| 2024 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2025 | # |
| 2026 | # Checks which may be anchored in the context. |
| 2027 | # |
| 2028 | |
| 2029 | # Check for switch () and associated case and default |
| 2030 | # statements should be at the same indent. |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2031 | if ($line=~/\bswitch\s*\(.*\)/) { |
| 2032 | my $err = ''; |
| 2033 | my $sep = ''; |
| 2034 | my @ctx = ctx_block_outer($linenr, $realcnt); |
| 2035 | shift(@ctx); |
| 2036 | for my $ctx (@ctx) { |
| 2037 | my ($clen, $cindent) = line_stats($ctx); |
| 2038 | if ($ctx =~ /^\+\s*(case\s+|default:)/ && |
| 2039 | $indent != $cindent) { |
| 2040 | $err .= "$sep$ctx\n"; |
| 2041 | $sep = ''; |
| 2042 | } else { |
| 2043 | $sep = "[...]\n"; |
| 2044 | } |
| 2045 | } |
| 2046 | if ($err ne '') { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2047 | ERROR("SWITCH_CASE_INDENT_LEVEL", |
| 2048 | "switch and case should be at the same indent\n$hereline$err"); |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2049 | } |
| 2050 | } |
| 2051 | |
| 2052 | # if/while/etc brace do not go on next line, unless defining a do while loop, |
| 2053 | # or if that brace on the next line is for something else |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2054 | if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2055 | my $pre_ctx = "$1$2"; |
| 2056 | |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2057 | my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
Joe Perches | 8eef05d | 2012-02-03 15:20:39 -0800 | [diff] [blame] | 2058 | |
| 2059 | if ($line =~ /^\+\t{6,}/) { |
| 2060 | WARN("DEEP_INDENTATION", |
| 2061 | "Too many leading tabs - consider code refactoring\n" . $herecurr); |
| 2062 | } |
| 2063 | |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2064 | my $ctx_cnt = $realcnt - $#ctx - 1; |
| 2065 | my $ctx = join("\n", @ctx); |
| 2066 | |
Andy Whitcroft | 548596d | 2008-07-23 21:29:01 -0700 | [diff] [blame] | 2067 | my $ctx_ln = $linenr; |
| 2068 | my $ctx_skip = $realcnt; |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2069 | |
Andy Whitcroft | 548596d | 2008-07-23 21:29:01 -0700 | [diff] [blame] | 2070 | while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && |
| 2071 | defined $lines[$ctx_ln - 1] && |
| 2072 | $lines[$ctx_ln - 1] =~ /^-/)) { |
| 2073 | ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; |
| 2074 | $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2075 | $ctx_ln++; |
| 2076 | } |
Andy Whitcroft | 548596d | 2008-07-23 21:29:01 -0700 | [diff] [blame] | 2077 | |
Andy Whitcroft | 5321016 | 2008-07-23 21:29:03 -0700 | [diff] [blame] | 2078 | #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; |
| 2079 | #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2080 | |
| 2081 | if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2082 | ERROR("OPEN_BRACE", |
| 2083 | "that open brace { should be on the previous line\n" . |
Andy Whitcroft | 01464f3 | 2010-10-26 14:23:19 -0700 | [diff] [blame] | 2084 | "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2085 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2086 | if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && |
| 2087 | $ctx =~ /\)\s*\;\s*$/ && |
| 2088 | defined $lines[$ctx_ln - 1]) |
| 2089 | { |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2090 | my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); |
| 2091 | if ($nindent > $indent) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2092 | WARN("TRAILING_SEMICOLON", |
| 2093 | "trailing semicolon indicates no statements, indent implies otherwise\n" . |
Andy Whitcroft | 01464f3 | 2010-10-26 14:23:19 -0700 | [diff] [blame] | 2094 | "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2095 | } |
| 2096 | } |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2097 | } |
| 2098 | |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2099 | # Check relative indent for conditionals and blocks. |
| 2100 | if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { |
Andy Whitcroft | 3e469cd | 2012-01-10 15:10:01 -0800 | [diff] [blame] | 2101 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
| 2102 | ctx_statement_block($linenr, $realcnt, 0) |
| 2103 | if (!defined $stat); |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2104 | my ($s, $c) = ($stat, $cond); |
| 2105 | |
| 2106 | substr($s, 0, length($c), ''); |
| 2107 | |
| 2108 | # Make sure we remove the line prefixes as we have |
| 2109 | # none on the first line, and are going to readd them |
| 2110 | # where necessary. |
| 2111 | $s =~ s/\n./\n/gs; |
| 2112 | |
| 2113 | # Find out how long the conditional actually is. |
Andy Whitcroft | 6f779c1 | 2008-10-15 22:02:27 -0700 | [diff] [blame] | 2114 | my @newlines = ($c =~ /\n/gs); |
| 2115 | my $cond_lines = 1 + $#newlines; |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2116 | |
| 2117 | # We want to check the first line inside the block |
| 2118 | # starting at the end of the conditional, so remove: |
| 2119 | # 1) any blank line termination |
| 2120 | # 2) any opening brace { on end of the line |
| 2121 | # 3) any do (...) { |
| 2122 | my $continuation = 0; |
| 2123 | my $check = 0; |
| 2124 | $s =~ s/^.*\bdo\b//; |
| 2125 | $s =~ s/^\s*{//; |
| 2126 | if ($s =~ s/^\s*\\//) { |
| 2127 | $continuation = 1; |
| 2128 | } |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2129 | if ($s =~ s/^\s*?\n//) { |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2130 | $check = 1; |
| 2131 | $cond_lines++; |
| 2132 | } |
| 2133 | |
| 2134 | # Also ignore a loop construct at the end of a |
| 2135 | # preprocessor statement. |
| 2136 | if (($prevline =~ /^.\s*#\s*define\s/ || |
| 2137 | $prevline =~ /\\\s*$/) && $continuation == 0) { |
| 2138 | $check = 0; |
| 2139 | } |
| 2140 | |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2141 | my $cond_ptr = -1; |
Andy Whitcroft | 740504c | 2008-10-15 22:02:35 -0700 | [diff] [blame] | 2142 | $continuation = 0; |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2143 | while ($cond_ptr != $cond_lines) { |
| 2144 | $cond_ptr = $cond_lines; |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2145 | |
Andy Whitcroft | f16fa28 | 2008-10-15 22:02:32 -0700 | [diff] [blame] | 2146 | # If we see an #else/#elif then the code |
| 2147 | # is not linear. |
| 2148 | if ($s =~ /^\s*\#\s*(?:else|elif)/) { |
| 2149 | $check = 0; |
| 2150 | } |
| 2151 | |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2152 | # Ignore: |
| 2153 | # 1) blank lines, they should be at 0, |
| 2154 | # 2) preprocessor lines, and |
| 2155 | # 3) labels. |
Andy Whitcroft | 740504c | 2008-10-15 22:02:35 -0700 | [diff] [blame] | 2156 | if ($continuation || |
| 2157 | $s =~ /^\s*?\n/ || |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2158 | $s =~ /^\s*#\s*?/ || |
| 2159 | $s =~ /^\s*$Ident\s*:/) { |
Andy Whitcroft | 740504c | 2008-10-15 22:02:35 -0700 | [diff] [blame] | 2160 | $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; |
Andy Whitcroft | 30dad6e | 2009-09-21 17:04:36 -0700 | [diff] [blame] | 2161 | if ($s =~ s/^.*?\n//) { |
| 2162 | $cond_lines++; |
| 2163 | } |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2164 | } |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2165 | } |
| 2166 | |
| 2167 | my (undef, $sindent) = line_stats("+" . $s); |
| 2168 | my $stat_real = raw_line($linenr, $cond_lines); |
| 2169 | |
| 2170 | # Check if either of these lines are modified, else |
| 2171 | # this is not this patch's fault. |
| 2172 | if (!defined($stat_real) || |
| 2173 | $stat !~ /^\+/ && $stat_real !~ /^\+/) { |
| 2174 | $check = 0; |
| 2175 | } |
| 2176 | if (defined($stat_real) && $cond_lines > 1) { |
| 2177 | $stat_real = "[...]\n$stat_real"; |
| 2178 | } |
| 2179 | |
Andy Whitcroft | 9bd49ef | 2008-10-15 22:02:22 -0700 | [diff] [blame] | 2180 | #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"; |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2181 | |
| 2182 | if ($check && (($sindent % 8) != 0 || |
| 2183 | ($sindent <= $indent && $s ne ''))) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2184 | WARN("SUSPECT_CODE_INDENT", |
| 2185 | "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); |
Andy Whitcroft | 4d001e4 | 2008-10-15 22:02:21 -0700 | [diff] [blame] | 2186 | } |
| 2187 | } |
| 2188 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2189 | # Track the 'values' across context and added lines. |
| 2190 | my $opline = $line; $opline =~ s/^./ /; |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2191 | my ($curr_values, $curr_vars) = |
| 2192 | annotate_values($opline . "\n", $prev_values); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2193 | $curr_values = $prev_values . $curr_values; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2194 | if ($dbg_values) { |
| 2195 | my $outline = $opline; $outline =~ s/\t/ /g; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2196 | print "$linenr > .$outline\n"; |
| 2197 | print "$linenr > $curr_values\n"; |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2198 | print "$linenr > $curr_vars\n"; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2199 | } |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2200 | $prev_values = substr($curr_values, -1); |
| 2201 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2202 | #ignore lines not being added |
| 2203 | if ($line=~/^[^\+]/) {next;} |
| 2204 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2205 | # TEST: allow direct testing of the type matcher. |
Andy Whitcroft | 7429c69 | 2008-07-23 21:29:06 -0700 | [diff] [blame] | 2206 | if ($dbg_type) { |
| 2207 | if ($line =~ /^.\s*$Declare\s*$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2208 | ERROR("TEST_TYPE", |
| 2209 | "TEST: is type\n" . $herecurr); |
Andy Whitcroft | 7429c69 | 2008-07-23 21:29:06 -0700 | [diff] [blame] | 2210 | } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2211 | ERROR("TEST_NOT_TYPE", |
| 2212 | "TEST: is not type ($1 is)\n". $herecurr); |
Andy Whitcroft | 7429c69 | 2008-07-23 21:29:06 -0700 | [diff] [blame] | 2213 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2214 | next; |
| 2215 | } |
Andy Whitcroft | a1ef277 | 2008-10-15 22:02:17 -0700 | [diff] [blame] | 2216 | # TEST: allow direct testing of the attribute matcher. |
| 2217 | if ($dbg_attr) { |
Andy Whitcroft | 9360b0e | 2009-02-27 14:03:08 -0800 | [diff] [blame] | 2218 | if ($line =~ /^.\s*$Modifier\s*$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2219 | ERROR("TEST_ATTR", |
| 2220 | "TEST: is attr\n" . $herecurr); |
Andy Whitcroft | 9360b0e | 2009-02-27 14:03:08 -0800 | [diff] [blame] | 2221 | } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2222 | ERROR("TEST_NOT_ATTR", |
| 2223 | "TEST: is not attr ($1 is)\n". $herecurr); |
Andy Whitcroft | a1ef277 | 2008-10-15 22:02:17 -0700 | [diff] [blame] | 2224 | } |
| 2225 | next; |
| 2226 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2227 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2228 | # check for initialisation to aggregates open brace on the next line |
Andy Whitcroft | 99423c2 | 2009-10-26 16:50:15 -0700 | [diff] [blame] | 2229 | if ($line =~ /^.\s*{/ && |
| 2230 | $prevline =~ /(?:^|[^=])=\s*$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2231 | ERROR("OPEN_BRACE", |
| 2232 | "that open brace { should be on the previous line\n" . $hereprev); |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2233 | } |
| 2234 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2235 | # |
| 2236 | # Checks which are anchored on the added line. |
| 2237 | # |
| 2238 | |
| 2239 | # check for malformed paths in #include statements (uses RAW line) |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2240 | if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2241 | my $path = $1; |
| 2242 | if ($path =~ m{//}) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2243 | ERROR("MALFORMED_INCLUDE", |
Joe Perches | 495e9d8 | 2012-12-20 15:05:37 -0800 | [diff] [blame] | 2244 | "malformed #include filename\n" . $herecurr); |
| 2245 | } |
| 2246 | if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { |
| 2247 | ERROR("UAPI_INCLUDE", |
| 2248 | "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2249 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2250 | } |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2251 | |
| 2252 | # no C99 // comments |
| 2253 | if ($line =~ m{//}) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2254 | ERROR("C99_COMMENTS", |
| 2255 | "do not use C99 // comments\n" . $herecurr); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2256 | } |
| 2257 | # Remove C99 comments. |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2258 | $line =~ s@//.*@@; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2259 | $opline =~ s@//.*@@; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2260 | |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 2261 | # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider |
| 2262 | # the whole statement. |
| 2263 | #print "APW <$lines[$realline_next - 1]>\n"; |
| 2264 | if (defined $realline_next && |
| 2265 | exists $lines[$realline_next - 1] && |
| 2266 | !defined $suppress_export{$realline_next} && |
| 2267 | ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || |
| 2268 | $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { |
Andy Whitcroft | 3cbf62d | 2010-10-26 14:23:18 -0700 | [diff] [blame] | 2269 | # Handle definitions which produce identifiers with |
| 2270 | # a prefix: |
| 2271 | # XXX(foo); |
| 2272 | # EXPORT_SYMBOL(something_foo); |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2273 | my $name = $1; |
Andy Whitcroft | 87a5387 | 2012-01-10 15:10:04 -0800 | [diff] [blame] | 2274 | if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && |
Andy Whitcroft | 3cbf62d | 2010-10-26 14:23:18 -0700 | [diff] [blame] | 2275 | $name =~ /^${Ident}_$2/) { |
| 2276 | #print "FOO C name<$name>\n"; |
| 2277 | $suppress_export{$realline_next} = 1; |
| 2278 | |
| 2279 | } elsif ($stat !~ /(?: |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 2280 | \n.}\s*$| |
Andy Whitcroft | 4801205 | 2008-10-15 22:02:34 -0700 | [diff] [blame] | 2281 | ^.DEFINE_$Ident\(\Q$name\E\)| |
| 2282 | ^.DECLARE_$Ident\(\Q$name\E\)| |
| 2283 | ^.LIST_HEAD\(\Q$name\E\)| |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 2284 | ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| |
| 2285 | \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() |
Andy Whitcroft | 4801205 | 2008-10-15 22:02:34 -0700 | [diff] [blame] | 2286 | )/x) { |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 2287 | #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; |
| 2288 | $suppress_export{$realline_next} = 2; |
| 2289 | } else { |
| 2290 | $suppress_export{$realline_next} = 1; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2291 | } |
| 2292 | } |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 2293 | if (!defined $suppress_export{$linenr} && |
| 2294 | $prevline =~ /^.\s*$/ && |
| 2295 | ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || |
| 2296 | $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { |
| 2297 | #print "FOO B <$lines[$linenr - 1]>\n"; |
| 2298 | $suppress_export{$linenr} = 2; |
| 2299 | } |
| 2300 | if (defined $suppress_export{$linenr} && |
| 2301 | $suppress_export{$linenr} == 2) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2302 | WARN("EXPORT_SYMBOL", |
| 2303 | "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); |
Andy Whitcroft | 2b474a1 | 2009-10-26 16:50:16 -0700 | [diff] [blame] | 2304 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2305 | |
Joe Eloff | 5150bda | 2010-08-09 17:21:00 -0700 | [diff] [blame] | 2306 | # check for global initialisers. |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2307 | if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2308 | ERROR("GLOBAL_INITIALISERS", |
| 2309 | "do not initialise globals to 0 or NULL\n" . |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2310 | $herecurr); |
| 2311 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2312 | # check for static initialisers. |
Andy Whitcroft | 2d1bafd7 | 2009-01-06 14:41:28 -0800 | [diff] [blame] | 2313 | if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2314 | ERROR("INITIALISED_STATIC", |
| 2315 | "do not initialise statics to 0 or NULL\n" . |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2316 | $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2317 | } |
| 2318 | |
Joe Perches | cb710ec | 2010-10-26 14:23:20 -0700 | [diff] [blame] | 2319 | # check for static const char * arrays. |
| 2320 | if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2321 | WARN("STATIC_CONST_CHAR_ARRAY", |
| 2322 | "static const char * array should probably be static const char * const\n" . |
Joe Perches | cb710ec | 2010-10-26 14:23:20 -0700 | [diff] [blame] | 2323 | $herecurr); |
| 2324 | } |
| 2325 | |
| 2326 | # check for static char foo[] = "bar" declarations. |
| 2327 | if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2328 | WARN("STATIC_CONST_CHAR_ARRAY", |
| 2329 | "static char array declaration should probably be static const char\n" . |
Joe Perches | cb710ec | 2010-10-26 14:23:20 -0700 | [diff] [blame] | 2330 | $herecurr); |
| 2331 | } |
| 2332 | |
Joe Perches | 93ed0e2 | 2010-10-26 14:23:21 -0700 | [diff] [blame] | 2333 | # check for declarations of struct pci_device_id |
| 2334 | if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2335 | WARN("DEFINE_PCI_DEVICE_TABLE", |
| 2336 | "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); |
Joe Perches | 93ed0e2 | 2010-10-26 14:23:21 -0700 | [diff] [blame] | 2337 | } |
| 2338 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2339 | # check for new typedefs, only function parameters and sparse annotations |
| 2340 | # make sense. |
| 2341 | if ($line =~ /\btypedef\s/ && |
Andy Whitcroft | 8054576 | 2009-01-06 14:41:26 -0800 | [diff] [blame] | 2342 | $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2343 | $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && |
Andy Whitcroft | 8ed22ca | 2008-10-15 22:02:32 -0700 | [diff] [blame] | 2344 | $line !~ /\b$typeTypedefs\b/ && |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2345 | $line !~ /\b__bitwise(?:__|)\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2346 | WARN("NEW_TYPEDEFS", |
| 2347 | "do not add new typedefs\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2348 | } |
| 2349 | |
| 2350 | # * goes on variable not on type |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2351 | # (char*[ const]) |
Andy Whitcroft | bfcb2cc | 2012-01-10 15:10:15 -0800 | [diff] [blame] | 2352 | while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { |
| 2353 | #print "AA<$1>\n"; |
| 2354 | my ($from, $to) = ($2, $2); |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 2355 | |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2356 | # Should start with a space. |
| 2357 | $to =~ s/^(\S)/ $1/; |
| 2358 | # Should not end with a space. |
| 2359 | $to =~ s/\s+$//; |
| 2360 | # '*'s should not have spaces between. |
Andy Whitcroft | f9a0b3d | 2009-01-15 13:51:05 -0800 | [diff] [blame] | 2361 | while ($to =~ s/\*\s+\*/\*\*/) { |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2362 | } |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 2363 | |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2364 | #print "from<$from> to<$to>\n"; |
| 2365 | if ($from ne $to) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2366 | ERROR("POINTER_LOCATION", |
| 2367 | "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2368 | } |
Andy Whitcroft | bfcb2cc | 2012-01-10 15:10:15 -0800 | [diff] [blame] | 2369 | } |
| 2370 | while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { |
| 2371 | #print "BB<$1>\n"; |
| 2372 | my ($from, $to, $ident) = ($2, $2, $3); |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 2373 | |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2374 | # Should start with a space. |
| 2375 | $to =~ s/^(\S)/ $1/; |
| 2376 | # Should not end with a space. |
| 2377 | $to =~ s/\s+$//; |
| 2378 | # '*'s should not have spaces between. |
Andy Whitcroft | f9a0b3d | 2009-01-15 13:51:05 -0800 | [diff] [blame] | 2379 | while ($to =~ s/\*\s+\*/\*\*/) { |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2380 | } |
| 2381 | # Modifiers should have spaces. |
| 2382 | $to =~ s/(\b$Modifier$)/$1 /; |
| 2383 | |
Andy Whitcroft | 667026e | 2009-02-27 14:03:08 -0800 | [diff] [blame] | 2384 | #print "from<$from> to<$to> ident<$ident>\n"; |
| 2385 | if ($from ne $to && $ident !~ /^$Modifier$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2386 | ERROR("POINTER_LOCATION", |
| 2387 | "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); |
Andy Whitcroft | 6586386 | 2009-01-06 14:41:21 -0800 | [diff] [blame] | 2388 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2389 | } |
| 2390 | |
| 2391 | # # no BUG() or BUG_ON() |
| 2392 | # if ($line =~ /\b(BUG|BUG_ON)\b/) { |
| 2393 | # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; |
| 2394 | # print "$herecurr"; |
| 2395 | # $clean = 0; |
| 2396 | # } |
| 2397 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2398 | if ($line =~ /\bLINUX_VERSION_CODE\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2399 | WARN("LINUX_VERSION_CODE", |
| 2400 | "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2401 | } |
| 2402 | |
Joe Perches | 1744122 | 2011-06-15 15:08:17 -0700 | [diff] [blame] | 2403 | # check for uses of printk_ratelimit |
| 2404 | if ($line =~ /\bprintk_ratelimit\s*\(/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2405 | WARN("PRINTK_RATELIMITED", |
| 2406 | "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); |
Joe Perches | 1744122 | 2011-06-15 15:08:17 -0700 | [diff] [blame] | 2407 | } |
| 2408 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2409 | # printk should use KERN_* levels. Note that follow on printk's on the |
| 2410 | # same line do not need a level, so we use the current block context |
| 2411 | # to try and find and validate the current printk. In summary the current |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 2412 | # printk includes all preceding printk's which have no newline on the end. |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2413 | # we assume the first bad printk is the one to report. |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2414 | if ($line =~ /\bprintk\((?!KERN_)\s*"/) { |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2415 | my $ok = 0; |
| 2416 | for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { |
| 2417 | #print "CHECK<$lines[$ln - 1]\n"; |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 2418 | # we have a preceding printk if it ends |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2419 | # with "\n" ignore it, else it is to blame |
| 2420 | if ($lines[$ln - 1] =~ m{\bprintk\(}) { |
| 2421 | if ($rawlines[$ln - 1] !~ m{\\n"}) { |
| 2422 | $ok = 1; |
| 2423 | } |
| 2424 | last; |
| 2425 | } |
| 2426 | } |
| 2427 | if ($ok == 0) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2428 | WARN("PRINTK_WITHOUT_KERN_LEVEL", |
| 2429 | "printk() should include KERN_ facility level\n" . $herecurr); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2430 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2431 | } |
| 2432 | |
Joe Perches | 243f380 | 2012-05-31 16:26:09 -0700 | [diff] [blame] | 2433 | if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { |
| 2434 | my $orig = $1; |
| 2435 | my $level = lc($orig); |
| 2436 | $level = "warn" if ($level eq "warning"); |
Joe Perches | 8f26b83 | 2012-10-04 17:13:32 -0700 | [diff] [blame] | 2437 | my $level2 = $level; |
| 2438 | $level2 = "dbg" if ($level eq "debug"); |
Joe Perches | 243f380 | 2012-05-31 16:26:09 -0700 | [diff] [blame] | 2439 | WARN("PREFER_PR_LEVEL", |
Joe Perches | 8f26b83 | 2012-10-04 17:13:32 -0700 | [diff] [blame] | 2440 | "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); |
Joe Perches | 243f380 | 2012-05-31 16:26:09 -0700 | [diff] [blame] | 2441 | } |
| 2442 | |
| 2443 | if ($line =~ /\bpr_warning\s*\(/) { |
| 2444 | WARN("PREFER_PR_LEVEL", |
| 2445 | "Prefer pr_warn(... to pr_warning(...\n" . $herecurr); |
| 2446 | } |
| 2447 | |
Joe Perches | dc13931 | 2013-02-21 16:44:13 -0800 | [diff] [blame] | 2448 | if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { |
| 2449 | my $orig = $1; |
| 2450 | my $level = lc($orig); |
| 2451 | $level = "warn" if ($level eq "warning"); |
| 2452 | $level = "dbg" if ($level eq "debug"); |
| 2453 | WARN("PREFER_DEV_LEVEL", |
| 2454 | "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); |
| 2455 | } |
| 2456 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2457 | # function brace can't be on same line, except for #defines of do while, |
| 2458 | # or if closed on same line |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2459 | if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and |
| 2460 | !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2461 | ERROR("OPEN_BRACE", |
| 2462 | "open brace '{' following function declarations go on the next line\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2463 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2464 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2465 | # open braces for enum, union and struct go on the same line. |
| 2466 | if ($line =~ /^.\s*{/ && |
| 2467 | $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2468 | ERROR("OPEN_BRACE", |
| 2469 | "open brace '{' following $1 go on the same line\n" . $hereprev); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2470 | } |
| 2471 | |
Andy Whitcroft | 0c73b4e | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 2472 | # missing space after union, struct or enum definition |
| 2473 | if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2474 | WARN("SPACING", |
| 2475 | "missing space after $1 definition\n" . $herecurr); |
Andy Whitcroft | 0c73b4e | 2010-10-26 14:23:15 -0700 | [diff] [blame] | 2476 | } |
| 2477 | |
Andy Whitcroft | 8d31cfc | 2008-07-23 21:29:02 -0700 | [diff] [blame] | 2478 | # check for spacing round square brackets; allowed: |
| 2479 | # 1. with a type on the left -- int [] a; |
Andy Whitcroft | fe2a7db | 2008-10-15 22:02:15 -0700 | [diff] [blame] | 2480 | # 2. at the beginning of a line for slice initialisers -- [0...10] = 5, |
| 2481 | # 3. inside a curly brace -- = { [0...10] = 5 } |
Andy Whitcroft | 8d31cfc | 2008-07-23 21:29:02 -0700 | [diff] [blame] | 2482 | while ($line =~ /(.*?\s)\[/g) { |
| 2483 | my ($where, $prefix) = ($-[1], $1); |
| 2484 | if ($prefix !~ /$Type\s+$/ && |
Andy Whitcroft | fe2a7db | 2008-10-15 22:02:15 -0700 | [diff] [blame] | 2485 | ($where != 0 || $prefix !~ /^.\s+$/) && |
Andy Whitcroft | daebc53 | 2012-03-23 15:02:17 -0700 | [diff] [blame] | 2486 | $prefix !~ /[{,]\s+$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2487 | ERROR("BRACKET_SPACE", |
| 2488 | "space prohibited before open square bracket '['\n" . $herecurr); |
Andy Whitcroft | 8d31cfc | 2008-07-23 21:29:02 -0700 | [diff] [blame] | 2489 | } |
| 2490 | } |
| 2491 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2492 | # check for spaces between functions and their parentheses. |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2493 | while ($line =~ /($Ident)\s+\(/g) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2494 | my $name = $1; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2495 | my $ctx_before = substr($line, 0, $-[1]); |
| 2496 | my $ctx = "$ctx_before$name"; |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2497 | |
| 2498 | # Ignore those directives where spaces _are_ permitted. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2499 | if ($name =~ /^(?: |
| 2500 | if|for|while|switch|return|case| |
| 2501 | volatile|__volatile__| |
| 2502 | __attribute__|format|__extension__| |
| 2503 | asm|__asm__)$/x) |
| 2504 | { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2505 | |
| 2506 | # cpp #define statements have non-optional spaces, ie |
| 2507 | # if there is a space between the name and the open |
| 2508 | # parenthesis it is simply not a parameter group. |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2509 | } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2510 | |
| 2511 | # cpp #elif statement condition may start with a ( |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2512 | } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2513 | |
| 2514 | # If this whole things ends with a type its most |
| 2515 | # likely a typedef for a function. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2516 | } elsif ($ctx =~ /$Type$/) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2517 | |
| 2518 | } else { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2519 | WARN("SPACING", |
| 2520 | "space prohibited between function name and open parenthesis '('\n" . $herecurr); |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2521 | } |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2522 | } |
Eric Nelson | 9a4cad4 | 2012-05-31 16:26:09 -0700 | [diff] [blame] | 2523 | |
| 2524 | # check for whitespace before a non-naked semicolon |
| 2525 | if ($line =~ /^\+.*\S\s+;/) { |
Joe Perches | 5646bc7 | 2013-04-29 16:18:15 -0700 | [diff] [blame] | 2526 | WARN("SPACING", |
| 2527 | "space prohibited before semicolon\n" . $herecurr); |
Eric Nelson | 9a4cad4 | 2012-05-31 16:26:09 -0700 | [diff] [blame] | 2528 | } |
| 2529 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2530 | # Check operator spacing. |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2531 | if (!($line=~/\#\s*include/)) { |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2532 | my $ops = qr{ |
| 2533 | <<=|>>=|<=|>=|==|!=| |
| 2534 | \+=|-=|\*=|\/=|%=|\^=|\|=|&=| |
| 2535 | =>|->|<<|>>|<|>|=|!|~| |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2536 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| |
| 2537 | \?|: |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2538 | }x; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2539 | my @elements = split(/($ops|;)/, $opline); |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 2540 | my $off = 0; |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2541 | |
| 2542 | my $blank = copy_spacing($opline); |
| 2543 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2544 | for (my $n = 0; $n < $#elements; $n += 2) { |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2545 | $off += length($elements[$n]); |
| 2546 | |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 2547 | # Pick up the preceding and succeeding characters. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2548 | my $ca = substr($opline, 0, $off); |
| 2549 | my $cc = ''; |
| 2550 | if (length($opline) >= ($off + length($elements[$n + 1]))) { |
| 2551 | $cc = substr($opline, $off + length($elements[$n + 1])); |
| 2552 | } |
| 2553 | my $cb = "$ca$;$cc"; |
| 2554 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2555 | my $a = ''; |
| 2556 | $a = 'V' if ($elements[$n] ne ''); |
| 2557 | $a = 'W' if ($elements[$n] =~ /\s$/); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2558 | $a = 'C' if ($elements[$n] =~ /$;$/); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2559 | $a = 'B' if ($elements[$n] =~ /(\[|\()$/); |
| 2560 | $a = 'O' if ($elements[$n] eq ''); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2561 | $a = 'E' if ($ca =~ /^\s*$/); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2562 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2563 | my $op = $elements[$n + 1]; |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2564 | |
| 2565 | my $c = ''; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2566 | if (defined $elements[$n + 2]) { |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2567 | $c = 'V' if ($elements[$n + 2] ne ''); |
| 2568 | $c = 'W' if ($elements[$n + 2] =~ /^\s/); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2569 | $c = 'C' if ($elements[$n + 2] =~ /^$;/); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2570 | $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); |
| 2571 | $c = 'O' if ($elements[$n + 2] eq ''); |
Andy Whitcroft | 8b1b337 | 2009-01-06 14:41:27 -0800 | [diff] [blame] | 2572 | $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2573 | } else { |
| 2574 | $c = 'E'; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2575 | } |
| 2576 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2577 | my $ctx = "${a}x${c}"; |
| 2578 | |
| 2579 | my $at = "(ctx:$ctx)"; |
| 2580 | |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2581 | my $ptr = substr($blank, 0, $off) . "^"; |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2582 | my $hereptr = "$hereline$ptr\n"; |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2583 | |
Andy Whitcroft | 74048ed | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2584 | # Pull out the value of this operator. |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 2585 | my $op_type = substr($curr_values, $off + 1, 1); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2586 | |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2587 | # Get the full operator variant. |
| 2588 | my $opv = $op . substr($curr_vars, $off, 1); |
| 2589 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2590 | # Ignore operators passed as parameters. |
| 2591 | if ($op_type ne 'V' && |
| 2592 | $ca =~ /\s$/ && $cc =~ /^\s*,/) { |
| 2593 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2594 | # # Ignore comments |
| 2595 | # } elsif ($op =~ /^$;+$/) { |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2596 | |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 2597 | # ; should have either the end of line or a space or \ after it |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2598 | } elsif ($op eq ';') { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2599 | if ($ctx !~ /.x[WEBC]/ && |
| 2600 | $cc !~ /^\\/ && $cc !~ /^;/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2601 | ERROR("SPACING", |
| 2602 | "space required after that '$op' $at\n" . $hereptr); |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 2603 | } |
| 2604 | |
| 2605 | # // is a comment |
| 2606 | } elsif ($op eq '//') { |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2607 | |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2608 | # No spaces for: |
| 2609 | # -> |
| 2610 | # : when part of a bitfield |
| 2611 | } elsif ($op eq '->' || $opv eq ':B') { |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2612 | if ($ctx =~ /Wx.|.xW/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2613 | ERROR("SPACING", |
| 2614 | "spaces prohibited around that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2615 | } |
| 2616 | |
| 2617 | # , must have a space on the right. |
| 2618 | } elsif ($op eq ',') { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2619 | if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2620 | ERROR("SPACING", |
| 2621 | "space required after that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2622 | } |
| 2623 | |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2624 | # '*' as part of a type definition -- reported already. |
Andy Whitcroft | 74048ed | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2625 | } elsif ($opv eq '*_') { |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2626 | #warn "'*' is part of type\n"; |
| 2627 | |
| 2628 | # unary operators should have a space before and |
| 2629 | # none after. May be left adjacent to another |
| 2630 | # unary operator, or a cast |
| 2631 | } elsif ($op eq '!' || $op eq '~' || |
Andy Whitcroft | 74048ed | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2632 | $opv eq '*U' || $opv eq '-U' || |
Andy Whitcroft | 0d41386 | 2008-10-15 22:02:16 -0700 | [diff] [blame] | 2633 | $opv eq '&U' || $opv eq '&&U') { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2634 | if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2635 | ERROR("SPACING", |
| 2636 | "space required before that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2637 | } |
Andy Whitcroft | a3340b3 | 2009-02-27 14:03:07 -0800 | [diff] [blame] | 2638 | if ($op eq '*' && $cc =~/\s*$Modifier\b/) { |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 2639 | # A unary '*' may be const |
| 2640 | |
| 2641 | } elsif ($ctx =~ /.xW/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2642 | ERROR("SPACING", |
| 2643 | "space prohibited after that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2644 | } |
| 2645 | |
| 2646 | # unary ++ and unary -- are allowed no space on one side. |
| 2647 | } elsif ($op eq '++' or $op eq '--') { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2648 | if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2649 | ERROR("SPACING", |
| 2650 | "space required one side of that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2651 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2652 | if ($ctx =~ /Wx[BE]/ || |
| 2653 | ($ctx =~ /Wx./ && $cc =~ /^;/)) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2654 | ERROR("SPACING", |
| 2655 | "space prohibited before that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2656 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2657 | if ($ctx =~ /ExW/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2658 | ERROR("SPACING", |
| 2659 | "space prohibited after that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2660 | } |
| 2661 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2662 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2663 | # << and >> may either have or not have spaces both sides |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2664 | } elsif ($op eq '<<' or $op eq '>>' or |
| 2665 | $op eq '&' or $op eq '^' or $op eq '|' or |
| 2666 | $op eq '+' or $op eq '-' or |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2667 | $op eq '*' or $op eq '/' or |
| 2668 | $op eq '%') |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2669 | { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2670 | if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2671 | ERROR("SPACING", |
| 2672 | "need consistent spacing around '$op' $at\n" . |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2673 | $hereptr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2674 | } |
| 2675 | |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2676 | # A colon needs no spaces before when it is |
| 2677 | # terminating a case value or a label. |
| 2678 | } elsif ($opv eq ':C' || $opv eq ':L') { |
| 2679 | if ($ctx =~ /Wx./) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2680 | ERROR("SPACING", |
| 2681 | "space prohibited before that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2682 | } |
| 2683 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2684 | # All the others need spaces both sides. |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2685 | } elsif ($ctx !~ /[EWC]x[CWE]/) { |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2686 | my $ok = 0; |
| 2687 | |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2688 | # Ignore email addresses <foo@bar> |
Andy Whitcroft | 1f65f94 | 2008-07-23 21:29:10 -0700 | [diff] [blame] | 2689 | if (($op eq '<' && |
| 2690 | $cc =~ /^\S+\@\S+>/) || |
| 2691 | ($op eq '>' && |
| 2692 | $ca =~ /<\S+\@\S+$/)) |
| 2693 | { |
| 2694 | $ok = 1; |
| 2695 | } |
| 2696 | |
| 2697 | # Ignore ?: |
| 2698 | if (($opv eq ':O' && $ca =~ /\?$/) || |
| 2699 | ($op eq '?' && $cc =~ /^:/)) { |
| 2700 | $ok = 1; |
| 2701 | } |
| 2702 | |
| 2703 | if ($ok == 0) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2704 | ERROR("SPACING", |
| 2705 | "spaces required around that '$op' $at\n" . $hereptr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2706 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2707 | } |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2708 | $off += length($elements[$n + 1]); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2709 | } |
| 2710 | } |
| 2711 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2712 | # check for multiple assignments |
| 2713 | if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2714 | CHK("MULTIPLE_ASSIGNMENTS", |
| 2715 | "multiple assignments should be avoided\n" . $herecurr); |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2716 | } |
| 2717 | |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2718 | ## # check for multiple declarations, allowing for a function declaration |
| 2719 | ## # continuation. |
| 2720 | ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && |
| 2721 | ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { |
| 2722 | ## |
| 2723 | ## # Remove any bracketed sections to ensure we do not |
| 2724 | ## # falsly report the parameters of functions. |
| 2725 | ## my $ln = $line; |
| 2726 | ## while ($ln =~ s/\([^\(\)]*\)//g) { |
| 2727 | ## } |
| 2728 | ## if ($ln =~ /,/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2729 | ## WARN("MULTIPLE_DECLARATION", |
| 2730 | ## "declaring multiple variables together should be avoided\n" . $herecurr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2731 | ## } |
| 2732 | ## } |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 2733 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2734 | #need space before brace following if, while, etc |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2735 | if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || |
| 2736 | $line =~ /do{/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2737 | ERROR("SPACING", |
| 2738 | "space required before the open brace '{'\n" . $herecurr); |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 2739 | } |
| 2740 | |
| 2741 | # closing brace should have a space following it when it has anything |
| 2742 | # on the line |
| 2743 | if ($line =~ /}(?!(?:,|;|\)))\S/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2744 | ERROR("SPACING", |
| 2745 | "space required after that close brace '}'\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2746 | } |
| 2747 | |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2748 | # check spacing on square brackets |
| 2749 | if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2750 | ERROR("SPACING", |
| 2751 | "space prohibited after that open square bracket '['\n" . $herecurr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2752 | } |
| 2753 | if ($line =~ /\s\]/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2754 | ERROR("SPACING", |
| 2755 | "space prohibited before that close square bracket ']'\n" . $herecurr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2756 | } |
| 2757 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2758 | # check spacing on parentheses |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 2759 | if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && |
| 2760 | $line !~ /for\s*\(\s+;/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2761 | ERROR("SPACING", |
| 2762 | "space prohibited after that open parenthesis '('\n" . $herecurr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2763 | } |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2764 | if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2765 | $line !~ /for\s*\(.*;\s+\)/ && |
| 2766 | $line !~ /:\s+\)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2767 | ERROR("SPACING", |
| 2768 | "space prohibited before that close parenthesis ')'\n" . $herecurr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 2769 | } |
| 2770 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2771 | #goto labels aren't indented, allow a single space however |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2772 | if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2773 | !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2774 | WARN("INDENTED_LABEL", |
| 2775 | "labels should not be indented\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2776 | } |
| 2777 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2778 | # Return is not a function. |
| 2779 | if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { |
| 2780 | my $spacing = $1; |
| 2781 | my $value = $2; |
| 2782 | |
Andy Whitcroft | 86f9d05 | 2009-01-06 14:41:24 -0800 | [diff] [blame] | 2783 | # Flatten any parentheses |
Andy Whitcroft | fb2d2c1 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 2784 | $value =~ s/\(/ \(/g; |
| 2785 | $value =~ s/\)/\) /g; |
Andy Whitcroft | e01886a | 2012-01-10 15:10:08 -0800 | [diff] [blame] | 2786 | while ($value =~ s/\[[^\[\]]*\]/1/ || |
Andy Whitcroft | 63f17f8 | 2009-01-15 13:51:06 -0800 | [diff] [blame] | 2787 | $value !~ /(?:$Ident|-?$Constant)\s* |
| 2788 | $Compare\s* |
| 2789 | (?:$Ident|-?$Constant)/x && |
| 2790 | $value =~ s/\([^\(\)]*\)/1/) { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2791 | } |
Andy Whitcroft | fb2d2c1 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 2792 | #print "value<$value>\n"; |
| 2793 | if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2794 | ERROR("RETURN_PARENTHESES", |
| 2795 | "return is not a function, parentheses are not required\n" . $herecurr); |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2796 | |
| 2797 | } elsif ($spacing !~ /\s+/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2798 | ERROR("SPACING", |
| 2799 | "space required before the open parenthesis '('\n" . $herecurr); |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2800 | } |
| 2801 | } |
Andy Whitcroft | 53a3c44 | 2010-10-26 14:23:14 -0700 | [diff] [blame] | 2802 | # Return of what appears to be an errno should normally be -'ve |
| 2803 | if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { |
| 2804 | my $name = $1; |
| 2805 | if ($name ne 'EOF' && $name ne 'ERROR') { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2806 | WARN("USE_NEGATIVE_ERRNO", |
| 2807 | "return of an errno should typically be -ve (return -$1)\n" . $herecurr); |
Andy Whitcroft | 53a3c44 | 2010-10-26 14:23:14 -0700 | [diff] [blame] | 2808 | } |
| 2809 | } |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2810 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2811 | # Need a space before open parenthesis after if, while etc |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 2812 | if ($line=~/\b(if|while|for|switch)\(/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2813 | ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2814 | } |
| 2815 | |
Andy Whitcroft | f5fe35d | 2008-07-23 21:29:03 -0700 | [diff] [blame] | 2816 | # Check for illegal assignment in if conditional -- and check for trailing |
| 2817 | # statements after the conditional. |
Andy Whitcroft | 170d3a2 | 2008-10-15 22:02:30 -0700 | [diff] [blame] | 2818 | if ($line =~ /do\s*(?!{)/) { |
Andy Whitcroft | 3e469cd | 2012-01-10 15:10:01 -0800 | [diff] [blame] | 2819 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
| 2820 | ctx_statement_block($linenr, $realcnt, 0) |
| 2821 | if (!defined $stat); |
Andy Whitcroft | 170d3a2 | 2008-10-15 22:02:30 -0700 | [diff] [blame] | 2822 | my ($stat_next) = ctx_statement_block($line_nr_next, |
| 2823 | $remain_next, $off_next); |
| 2824 | $stat_next =~ s/\n./\n /g; |
| 2825 | ##print "stat<$stat> stat_next<$stat_next>\n"; |
| 2826 | |
| 2827 | if ($stat_next =~ /^\s*while\b/) { |
| 2828 | # If the statement carries leading newlines, |
| 2829 | # then count those as offsets. |
| 2830 | my ($whitespace) = |
| 2831 | ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); |
| 2832 | my $offset = |
| 2833 | statement_rawlines($whitespace) - 1; |
| 2834 | |
| 2835 | $suppress_whiletrailers{$line_nr_next + |
| 2836 | $offset} = 1; |
| 2837 | } |
| 2838 | } |
| 2839 | if (!defined $suppress_whiletrailers{$linenr} && |
| 2840 | $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 2841 | my ($s, $c) = ($stat, $cond); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2842 | |
Andy Whitcroft | b53c8e1 | 2009-01-06 14:41:29 -0800 | [diff] [blame] | 2843 | if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2844 | ERROR("ASSIGN_IN_IF", |
| 2845 | "do not use assignment in if condition\n" . $herecurr); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2846 | } |
| 2847 | |
| 2848 | # Find out what is on the end of the line after the |
| 2849 | # conditional. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2850 | substr($s, 0, length($c), ''); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2851 | $s =~ s/\n.*//g; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2852 | $s =~ s/$;//g; # Remove any comments |
Andy Whitcroft | 5321016 | 2008-07-23 21:29:03 -0700 | [diff] [blame] | 2853 | if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && |
| 2854 | $c !~ /}\s*while\s*/) |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2855 | { |
Andy Whitcroft | bb44ad3 | 2008-10-15 22:02:34 -0700 | [diff] [blame] | 2856 | # Find out how long the conditional actually is. |
| 2857 | my @newlines = ($c =~ /\n/gs); |
| 2858 | my $cond_lines = 1 + $#newlines; |
Hidetoshi Seto | 42bdf74 | 2010-03-05 13:43:50 -0800 | [diff] [blame] | 2859 | my $stat_real = ''; |
Andy Whitcroft | bb44ad3 | 2008-10-15 22:02:34 -0700 | [diff] [blame] | 2860 | |
Hidetoshi Seto | 42bdf74 | 2010-03-05 13:43:50 -0800 | [diff] [blame] | 2861 | $stat_real = raw_line($linenr, $cond_lines) |
| 2862 | . "\n" if ($cond_lines); |
Andy Whitcroft | bb44ad3 | 2008-10-15 22:02:34 -0700 | [diff] [blame] | 2863 | if (defined($stat_real) && $cond_lines > 1) { |
| 2864 | $stat_real = "[...]\n$stat_real"; |
| 2865 | } |
| 2866 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2867 | ERROR("TRAILING_STATEMENTS", |
| 2868 | "trailing statements should be on next line\n" . $herecurr . $stat_real); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2869 | } |
| 2870 | } |
| 2871 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2872 | # Check for bitwise tests written as boolean |
| 2873 | if ($line =~ / |
| 2874 | (?: |
| 2875 | (?:\[|\(|\&\&|\|\|) |
| 2876 | \s*0[xX][0-9]+\s* |
| 2877 | (?:\&\&|\|\|) |
| 2878 | | |
| 2879 | (?:\&\&|\|\|) |
| 2880 | \s*0[xX][0-9]+\s* |
| 2881 | (?:\&\&|\|\||\)|\]) |
| 2882 | )/x) |
| 2883 | { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2884 | WARN("HEXADECIMAL_BOOLEAN_TEST", |
| 2885 | "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2886 | } |
| 2887 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 2888 | # if and else should not have general statements after it |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2889 | if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { |
| 2890 | my $s = $1; |
| 2891 | $s =~ s/$;//g; # Remove any comments |
| 2892 | if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2893 | ERROR("TRAILING_STATEMENTS", |
| 2894 | "trailing statements should be on next line\n" . $herecurr); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 2895 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2896 | } |
Andy Whitcroft | 3966778 | 2009-01-15 13:51:06 -0800 | [diff] [blame] | 2897 | # if should not continue a brace |
| 2898 | if ($line =~ /}\s*if\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2899 | ERROR("TRAILING_STATEMENTS", |
| 2900 | "trailing statements should be on next line\n" . |
Andy Whitcroft | 3966778 | 2009-01-15 13:51:06 -0800 | [diff] [blame] | 2901 | $herecurr); |
| 2902 | } |
Andy Whitcroft | a1080bf | 2008-10-15 22:02:25 -0700 | [diff] [blame] | 2903 | # case and default should not have general statements after them |
| 2904 | if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && |
| 2905 | $line !~ /\G(?: |
Andy Whitcroft | 3fef12d | 2008-10-15 22:02:36 -0700 | [diff] [blame] | 2906 | (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| |
Andy Whitcroft | a1080bf | 2008-10-15 22:02:25 -0700 | [diff] [blame] | 2907 | \s*return\s+ |
| 2908 | )/xg) |
| 2909 | { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2910 | ERROR("TRAILING_STATEMENTS", |
| 2911 | "trailing statements should be on next line\n" . $herecurr); |
Andy Whitcroft | a1080bf | 2008-10-15 22:02:25 -0700 | [diff] [blame] | 2912 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2913 | |
| 2914 | # Check for }<nl>else {, these must be at the same |
| 2915 | # indent level to be relevant to each other. |
| 2916 | if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and |
| 2917 | $previndent == $indent) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2918 | ERROR("ELSE_AFTER_BRACE", |
| 2919 | "else should follow close brace '}'\n" . $hereprev); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2920 | } |
| 2921 | |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2922 | if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and |
| 2923 | $previndent == $indent) { |
| 2924 | my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); |
| 2925 | |
| 2926 | # Find out what is on the end of the line after the |
| 2927 | # conditional. |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 2928 | substr($s, 0, length($c), ''); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2929 | $s =~ s/\n.*//g; |
| 2930 | |
| 2931 | if ($s =~ /^\s*;/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2932 | ERROR("WHILE_AFTER_BRACE", |
| 2933 | "while should follow close brace '}'\n" . $hereprev); |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 2934 | } |
| 2935 | } |
| 2936 | |
Joe Perches | 323c126 | 2012-12-17 16:02:07 -0800 | [diff] [blame] | 2937 | #CamelCase |
| 2938 | while ($line =~ m{($Constant|$Lval)}g) { |
| 2939 | my $var = $1; |
| 2940 | if ($var !~ /$Constant/ && |
| 2941 | $var =~ /[A-Z]\w*[a-z]|[a-z]\w*[A-Z]/ && |
Joe Perches | be987d9 | 2013-02-27 17:02:38 -0800 | [diff] [blame] | 2942 | $var !~ /"^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && |
Joe Perches | 323c126 | 2012-12-17 16:02:07 -0800 | [diff] [blame] | 2943 | !defined $camelcase{$var}) { |
| 2944 | $camelcase{$var} = 1; |
| 2945 | WARN("CAMELCASE", |
| 2946 | "Avoid CamelCase: <$var>\n" . $herecurr); |
| 2947 | } |
| 2948 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2949 | |
| 2950 | #no spaces allowed after \ in define |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2951 | if ($line=~/\#\s*define.*\\\s$/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2952 | WARN("WHITESPACE_AFTER_LINE_CONTINUATION", |
| 2953 | "Whitepspace after \\ makes next lines useless\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2954 | } |
| 2955 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2956 | #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2957 | if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { |
Andy Whitcroft | e09dec4 | 2008-10-15 22:02:20 -0700 | [diff] [blame] | 2958 | my $file = "$1.h"; |
| 2959 | my $checkfile = "include/linux/$file"; |
| 2960 | if (-f "$root/$checkfile" && |
| 2961 | $realfile ne $checkfile && |
Wolfram Sang | 7840a94 | 2010-08-09 17:20:57 -0700 | [diff] [blame] | 2962 | $1 !~ /$allowed_asm_includes/) |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2963 | { |
Andy Whitcroft | e09dec4 | 2008-10-15 22:02:20 -0700 | [diff] [blame] | 2964 | if ($realfile =~ m{^arch/}) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2965 | CHK("ARCH_INCLUDE_LINUX", |
| 2966 | "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); |
Andy Whitcroft | e09dec4 | 2008-10-15 22:02:20 -0700 | [diff] [blame] | 2967 | } else { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 2968 | WARN("INCLUDE_LINUX", |
| 2969 | "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); |
Andy Whitcroft | e09dec4 | 2008-10-15 22:02:20 -0700 | [diff] [blame] | 2970 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 2971 | } |
| 2972 | } |
| 2973 | |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 2974 | # multi-statement macros should be enclosed in a do while loop, grab the |
| 2975 | # first statement and ensure its the whole macro if its not enclosed |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 2976 | # in a known good container |
Andy Whitcroft | b8f96a3 | 2008-07-23 21:29:07 -0700 | [diff] [blame] | 2977 | if ($realfile !~ m@/vmlinux.lds.h$@ && |
| 2978 | $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 2979 | my $ln = $linenr; |
| 2980 | my $cnt = $realcnt; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2981 | my ($off, $dstat, $dcond, $rest); |
| 2982 | my $ctx = ''; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2983 | ($dstat, $dcond, $ln, $cnt, $off) = |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 2984 | ctx_statement_block($linenr, $realcnt, 0); |
| 2985 | $ctx = $dstat; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2986 | #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; |
Andy Whitcroft | a3bb97a | 2008-07-23 21:29:00 -0700 | [diff] [blame] | 2987 | #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2988 | |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 2989 | $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; |
Andy Whitcroft | 292f1a9 | 2008-07-23 21:29:11 -0700 | [diff] [blame] | 2990 | $dstat =~ s/$;//g; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 2991 | $dstat =~ s/\\\n.//g; |
| 2992 | $dstat =~ s/^\s*//s; |
| 2993 | $dstat =~ s/\s*$//s; |
| 2994 | |
| 2995 | # Flatten any parentheses and braces |
Andy Whitcroft | bf30d6e | 2008-10-15 22:02:33 -0700 | [diff] [blame] | 2996 | while ($dstat =~ s/\([^\(\)]*\)/1/ || |
| 2997 | $dstat =~ s/\{[^\{\}]*\}/1/ || |
Andy Whitcroft | c81769f | 2012-01-10 15:10:10 -0800 | [diff] [blame] | 2998 | $dstat =~ s/\[[^\[\]]*\]/1/) |
Andy Whitcroft | bf30d6e | 2008-10-15 22:02:33 -0700 | [diff] [blame] | 2999 | { |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3000 | } |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 3001 | |
Andy Whitcroft | e45bab8 | 2012-03-23 15:02:18 -0700 | [diff] [blame] | 3002 | # Flatten any obvious string concatentation. |
| 3003 | while ($dstat =~ s/("X*")\s*$Ident/$1/ || |
| 3004 | $dstat =~ s/$Ident\s*("X*")/$1/) |
| 3005 | { |
| 3006 | } |
| 3007 | |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3008 | my $exceptions = qr{ |
| 3009 | $Declare| |
| 3010 | module_param_named| |
Kees Cook | a0a0a7a | 2012-10-04 17:13:38 -0700 | [diff] [blame] | 3011 | MODULE_PARM_DESC| |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3012 | DECLARE_PER_CPU| |
| 3013 | DEFINE_PER_CPU| |
Andy Whitcroft | 383099f | 2009-01-06 14:41:18 -0800 | [diff] [blame] | 3014 | __typeof__\(| |
Stefani Seibold | 22fd2d3 | 2010-03-05 13:43:52 -0800 | [diff] [blame] | 3015 | union| |
| 3016 | struct| |
Andy Whitcroft | ea71a0a | 2009-09-21 17:04:38 -0700 | [diff] [blame] | 3017 | \.$Ident\s*=\s*| |
| 3018 | ^\"|\"$ |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3019 | }x; |
Andy Whitcroft | 5eaa20b | 2010-10-26 14:23:18 -0700 | [diff] [blame] | 3020 | #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 3021 | if ($dstat ne '' && |
| 3022 | $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), |
| 3023 | $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); |
Andy Whitcroft | fd1b57a | 2012-03-23 15:02:18 -0700 | [diff] [blame] | 3024 | $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo |
Andy Whitcroft | b9df76a | 2012-03-23 15:02:17 -0700 | [diff] [blame] | 3025 | $dstat !~ /^'X'$/ && # character constants |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 3026 | $dstat !~ /$exceptions/ && |
| 3027 | $dstat !~ /^\.$Ident\s*=/ && # .foo = |
Joe Perches | e942e2c | 2013-04-17 15:58:26 -0700 | [diff] [blame] | 3028 | $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo |
Andy Whitcroft | 72f115f | 2012-01-10 15:10:06 -0800 | [diff] [blame] | 3029 | $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 3030 | $dstat !~ /^for\s*$Constant$/ && # for (...) |
| 3031 | $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() |
| 3032 | $dstat !~ /^do\s*{/ && # do {... |
| 3033 | $dstat !~ /^\({/) # ({... |
| 3034 | { |
| 3035 | $ctx =~ s/\n*$//; |
| 3036 | my $herectx = $here . "\n"; |
| 3037 | my $cnt = statement_rawlines($ctx); |
| 3038 | |
| 3039 | for (my $n = 0; $n < $cnt; $n++) { |
| 3040 | $herectx .= raw_line($linenr, $n) . "\n"; |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3041 | } |
| 3042 | |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 3043 | if ($dstat =~ /;/) { |
| 3044 | ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", |
| 3045 | "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); |
| 3046 | } else { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3047 | ERROR("COMPLEX_MACRO", |
Andy Whitcroft | f74bd19 | 2012-01-10 15:09:54 -0800 | [diff] [blame] | 3048 | "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); |
Andy Whitcroft | d8aaf12 | 2007-06-23 17:16:44 -0700 | [diff] [blame] | 3049 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 3050 | } |
Joe Perches | 5023d34 | 2012-12-17 16:01:47 -0800 | [diff] [blame] | 3051 | |
Joe Perches | 481eb48 | 2012-12-17 16:01:56 -0800 | [diff] [blame] | 3052 | # check for line continuations outside of #defines, preprocessor #, and asm |
Joe Perches | 5023d34 | 2012-12-17 16:01:47 -0800 | [diff] [blame] | 3053 | |
| 3054 | } else { |
| 3055 | if ($prevline !~ /^..*\\$/ && |
Joe Perches | 481eb48 | 2012-12-17 16:01:56 -0800 | [diff] [blame] | 3056 | $line !~ /^\+\s*\#.*\\$/ && # preprocessor |
| 3057 | $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm |
Joe Perches | 5023d34 | 2012-12-17 16:01:47 -0800 | [diff] [blame] | 3058 | $line =~ /^\+.*\\$/) { |
| 3059 | WARN("LINE_CONTINUATIONS", |
| 3060 | "Avoid unnecessary line continuations\n" . $herecurr); |
| 3061 | } |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3062 | } |
| 3063 | |
Joe Perches | b13edf7 | 2012-07-30 14:41:24 -0700 | [diff] [blame] | 3064 | # do {} while (0) macro tests: |
| 3065 | # single-statement macros do not need to be enclosed in do while (0) loop, |
| 3066 | # macro should not end with a semicolon |
| 3067 | if ($^V && $^V ge 5.10.0 && |
| 3068 | $realfile !~ m@/vmlinux.lds.h$@ && |
| 3069 | $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { |
| 3070 | my $ln = $linenr; |
| 3071 | my $cnt = $realcnt; |
| 3072 | my ($off, $dstat, $dcond, $rest); |
| 3073 | my $ctx = ''; |
| 3074 | ($dstat, $dcond, $ln, $cnt, $off) = |
| 3075 | ctx_statement_block($linenr, $realcnt, 0); |
| 3076 | $ctx = $dstat; |
| 3077 | |
| 3078 | $dstat =~ s/\\\n.//g; |
| 3079 | |
| 3080 | if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { |
| 3081 | my $stmts = $2; |
| 3082 | my $semis = $3; |
| 3083 | |
| 3084 | $ctx =~ s/\n*$//; |
| 3085 | my $cnt = statement_rawlines($ctx); |
| 3086 | my $herectx = $here . "\n"; |
| 3087 | |
| 3088 | for (my $n = 0; $n < $cnt; $n++) { |
| 3089 | $herectx .= raw_line($linenr, $n) . "\n"; |
| 3090 | } |
| 3091 | |
Joe Perches | ac8e97f | 2012-08-21 16:15:53 -0700 | [diff] [blame] | 3092 | if (($stmts =~ tr/;/;/) == 1 && |
| 3093 | $stmts !~ /^\s*(if|while|for|switch)\b/) { |
Joe Perches | b13edf7 | 2012-07-30 14:41:24 -0700 | [diff] [blame] | 3094 | WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", |
| 3095 | "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); |
| 3096 | } |
| 3097 | if (defined $semis && $semis ne "") { |
| 3098 | WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", |
| 3099 | "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); |
| 3100 | } |
| 3101 | } |
| 3102 | } |
| 3103 | |
Mike Frysinger | 080ba92 | 2009-01-06 14:41:25 -0800 | [diff] [blame] | 3104 | # make sure symbols are always wrapped with VMLINUX_SYMBOL() ... |
| 3105 | # all assignments may have only one of the following with an assignment: |
| 3106 | # . |
| 3107 | # ALIGN(...) |
| 3108 | # VMLINUX_SYMBOL(...) |
| 3109 | if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3110 | WARN("MISSING_VMLINUX_SYMBOL", |
| 3111 | "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); |
Mike Frysinger | 080ba92 | 2009-01-06 14:41:25 -0800 | [diff] [blame] | 3112 | } |
| 3113 | |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 3114 | # check for redundant bracing round if etc |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3115 | if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { |
| 3116 | my ($level, $endln, @chunks) = |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3117 | ctx_statement_full($linenr, $realcnt, 1); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3118 | #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3119 | #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; |
| 3120 | if ($#chunks > 0 && $level == 0) { |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3121 | my @allowed = (); |
| 3122 | my $allow = 0; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3123 | my $seen = 0; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3124 | my $herectx = $here . "\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3125 | my $ln = $linenr - 1; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3126 | for my $chunk (@chunks) { |
| 3127 | my ($cond, $block) = @{$chunk}; |
| 3128 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3129 | # If the condition carries leading newlines, then count those as offsets. |
| 3130 | my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); |
| 3131 | my $offset = statement_rawlines($whitespace) - 1; |
| 3132 | |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3133 | $allowed[$allow] = 0; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3134 | #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; |
| 3135 | |
| 3136 | # We have looked at and allowed this specific line. |
| 3137 | $suppress_ifbraces{$ln + $offset} = 1; |
| 3138 | |
| 3139 | $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3140 | $ln += statement_rawlines($block) - 1; |
| 3141 | |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3142 | substr($block, 0, length($cond), ''); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3143 | |
| 3144 | $seen++ if ($block =~ /^\s*{/); |
| 3145 | |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3146 | #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3147 | if (statement_lines($cond) > 1) { |
| 3148 | #print "APW: ALLOWED: cond<$cond>\n"; |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3149 | $allowed[$allow] = 1; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3150 | } |
| 3151 | if ($block =~/\b(?:if|for|while)\b/) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3152 | #print "APW: ALLOWED: block<$block>\n"; |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3153 | $allowed[$allow] = 1; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3154 | } |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3155 | if (statement_block_size($block) > 1) { |
| 3156 | #print "APW: ALLOWED: lines block<$block>\n"; |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3157 | $allowed[$allow] = 1; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3158 | } |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3159 | $allow++; |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3160 | } |
Joe Perches | aad4f61 | 2012-03-23 15:02:19 -0700 | [diff] [blame] | 3161 | if ($seen) { |
| 3162 | my $sum_allowed = 0; |
| 3163 | foreach (@allowed) { |
| 3164 | $sum_allowed += $_; |
| 3165 | } |
| 3166 | if ($sum_allowed == 0) { |
| 3167 | WARN("BRACES", |
| 3168 | "braces {} are not necessary for any arm of this statement\n" . $herectx); |
| 3169 | } elsif ($sum_allowed != $allow && |
| 3170 | $seen != $allow) { |
| 3171 | CHK("BRACES", |
| 3172 | "braces {} should be used on all arms of this statement\n" . $herectx); |
| 3173 | } |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3174 | } |
| 3175 | } |
| 3176 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3177 | if (!defined $suppress_ifbraces{$linenr - 1} && |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3178 | $line =~ /\b(if|while|for|else)\b/) { |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3179 | my $allowed = 0; |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 3180 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3181 | # Check the pre-context. |
| 3182 | if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { |
| 3183 | #print "APW: ALLOWED: pre<$1>\n"; |
| 3184 | $allowed = 1; |
| 3185 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3186 | |
| 3187 | my ($level, $endln, @chunks) = |
| 3188 | ctx_statement_full($linenr, $realcnt, $-[0]); |
| 3189 | |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3190 | # Check the condition. |
| 3191 | my ($cond, $block) = @{$chunks[0]}; |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3192 | #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3193 | if (defined $cond) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3194 | substr($block, 0, length($cond), ''); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3195 | } |
| 3196 | if (statement_lines($cond) > 1) { |
| 3197 | #print "APW: ALLOWED: cond<$cond>\n"; |
| 3198 | $allowed = 1; |
| 3199 | } |
| 3200 | if ($block =~/\b(?:if|for|while)\b/) { |
| 3201 | #print "APW: ALLOWED: block<$block>\n"; |
| 3202 | $allowed = 1; |
| 3203 | } |
| 3204 | if (statement_block_size($block) > 1) { |
| 3205 | #print "APW: ALLOWED: lines block<$block>\n"; |
| 3206 | $allowed = 1; |
| 3207 | } |
| 3208 | # Check the post-context. |
| 3209 | if (defined $chunks[1]) { |
| 3210 | my ($cond, $block) = @{$chunks[1]}; |
| 3211 | if (defined $cond) { |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3212 | substr($block, 0, length($cond), ''); |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 3213 | } |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3214 | if ($block =~ /^\s*\{/) { |
| 3215 | #print "APW: ALLOWED: chunk-1 block<$block>\n"; |
| 3216 | $allowed = 1; |
| 3217 | } |
| 3218 | } |
| 3219 | if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { |
Justin P. Mattock | 6993248 | 2011-07-26 23:06:29 -0700 | [diff] [blame] | 3220 | my $herectx = $here . "\n"; |
Andy Whitcroft | f055663 | 2008-10-15 22:02:23 -0700 | [diff] [blame] | 3221 | my $cnt = statement_rawlines($block); |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3222 | |
Andy Whitcroft | f055663 | 2008-10-15 22:02:23 -0700 | [diff] [blame] | 3223 | for (my $n = 0; $n < $cnt; $n++) { |
Justin P. Mattock | 6993248 | 2011-07-26 23:06:29 -0700 | [diff] [blame] | 3224 | $herectx .= raw_line($linenr, $n) . "\n"; |
Andy Whitcroft | cf65504 | 2008-03-04 14:28:20 -0800 | [diff] [blame] | 3225 | } |
| 3226 | |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3227 | WARN("BRACES", |
| 3228 | "braces {} are not necessary for single statement blocks\n" . $herectx); |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 3229 | } |
| 3230 | } |
| 3231 | |
Joe Perches | 0979ae6 | 2012-12-17 16:01:59 -0800 | [diff] [blame] | 3232 | # check for unnecessary blank lines around braces |
Matthijs Kooijman | 74c8f43 | 2013-04-29 16:18:16 -0700 | [diff] [blame] | 3233 | if (($line =~ /^.\s*}\s*$/ && $prevline =~ /^.\s*$/)) { |
Joe Perches | 0979ae6 | 2012-12-17 16:01:59 -0800 | [diff] [blame] | 3234 | CHK("BRACES", |
| 3235 | "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); |
| 3236 | } |
| 3237 | if (($line =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { |
| 3238 | CHK("BRACES", |
| 3239 | "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); |
| 3240 | } |
| 3241 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3242 | # no volatiles please |
Andy Whitcroft | 6c72ffa | 2007-10-18 03:05:08 -0700 | [diff] [blame] | 3243 | my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; |
| 3244 | if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3245 | WARN("VOLATILE", |
| 3246 | "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3247 | } |
| 3248 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 3249 | # warn about #if 0 |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3250 | if ($line =~ /^.\s*\#\s*if\s+0\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3251 | CHK("REDUNDANT_CODE", |
| 3252 | "if this code is redundant consider removing it\n" . |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3253 | $herecurr); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3254 | } |
| 3255 | |
Andy Whitcroft | 03df4b5 | 2012-12-17 16:01:52 -0800 | [diff] [blame] | 3256 | # check for needless "if (<foo>) fn(<foo>)" uses |
| 3257 | if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { |
| 3258 | my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; |
| 3259 | if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { |
| 3260 | WARN('NEEDLESS_IF', |
| 3261 | "$1(NULL) is safe this check is probably not required\n" . $hereprev); |
Greg Kroah-Hartman | 4c432a8 | 2008-07-23 21:29:04 -0700 | [diff] [blame] | 3262 | } |
| 3263 | } |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 3264 | |
Patrick Pannuto | 1a15a25 | 2010-08-09 17:21:01 -0700 | [diff] [blame] | 3265 | # prefer usleep_range over udelay |
Bruce Allan | 37581c2 | 2013-02-21 16:44:19 -0800 | [diff] [blame] | 3266 | if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { |
Patrick Pannuto | 1a15a25 | 2010-08-09 17:21:01 -0700 | [diff] [blame] | 3267 | # ignore udelay's < 10, however |
Bruce Allan | 37581c2 | 2013-02-21 16:44:19 -0800 | [diff] [blame] | 3268 | if (! ($1 < 10) ) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3269 | CHK("USLEEP_RANGE", |
| 3270 | "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); |
Patrick Pannuto | 1a15a25 | 2010-08-09 17:21:01 -0700 | [diff] [blame] | 3271 | } |
| 3272 | } |
| 3273 | |
Patrick Pannuto | 09ef872 | 2010-08-09 17:21:02 -0700 | [diff] [blame] | 3274 | # warn about unexpectedly long msleep's |
| 3275 | if ($line =~ /\bmsleep\s*\((\d+)\);/) { |
| 3276 | if ($1 < 20) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3277 | WARN("MSLEEP", |
| 3278 | "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); |
Patrick Pannuto | 09ef872 | 2010-08-09 17:21:02 -0700 | [diff] [blame] | 3279 | } |
| 3280 | } |
| 3281 | |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 3282 | # warn about #ifdefs in C files |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3283 | # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { |
Andy Whitcroft | 00df344 | 2007-06-08 13:47:06 -0700 | [diff] [blame] | 3284 | # print "#ifdef in C files should be avoided\n"; |
| 3285 | # print "$herecurr"; |
| 3286 | # $clean = 0; |
| 3287 | # } |
| 3288 | |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 3289 | # warn about spacing in #ifdefs |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3290 | if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3291 | ERROR("SPACING", |
| 3292 | "exactly one space required after that #$1\n" . $herecurr); |
Andy Whitcroft | 22f2a2e | 2007-08-10 13:01:03 -0700 | [diff] [blame] | 3293 | } |
| 3294 | |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3295 | # check for spinlock_t definitions without a comment. |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3296 | if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || |
| 3297 | $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3298 | my $which = $1; |
| 3299 | if (!ctx_has_comment($first_line, $linenr)) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3300 | CHK("UNCOMMENTED_DEFINITION", |
| 3301 | "$1 definition without comment\n" . $herecurr); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3302 | } |
| 3303 | } |
| 3304 | # check for memory barriers without a comment. |
| 3305 | if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { |
| 3306 | if (!ctx_has_comment($first_line, $linenr)) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3307 | CHK("MEMORY_BARRIER", |
| 3308 | "memory barrier without comment\n" . $herecurr); |
Andy Whitcroft | 4a0df2e | 2007-06-08 13:46:39 -0700 | [diff] [blame] | 3309 | } |
| 3310 | } |
| 3311 | # check of hardware specific defines |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3312 | if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3313 | CHK("ARCH_DEFINES", |
| 3314 | "architecture specific defines should be avoided\n" . $herecurr); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3315 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 3316 | |
Tobias Klauser | d4977c7 | 2010-05-24 14:33:30 -0700 | [diff] [blame] | 3317 | # Check that the storage class is at the beginning of a declaration |
| 3318 | if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3319 | WARN("STORAGE_CLASS", |
| 3320 | "storage class should be at the beginning of the declaration\n" . $herecurr) |
Tobias Klauser | d4977c7 | 2010-05-24 14:33:30 -0700 | [diff] [blame] | 3321 | } |
| 3322 | |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3323 | # check the location of the inline attribute, that it is between |
| 3324 | # storage class and type. |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 3325 | if ($line =~ /\b$Type\s+$Inline\b/ || |
| 3326 | $line =~ /\b$Inline\s+$Storage\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3327 | ERROR("INLINE_LOCATION", |
| 3328 | "inline keyword should sit between storage class and type\n" . $herecurr); |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3329 | } |
| 3330 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 3331 | # Check for __inline__ and __inline, prefer inline |
| 3332 | if ($line =~ /\b(__inline__|__inline)\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3333 | WARN("INLINE", |
| 3334 | "plain inline is preferred over $1\n" . $herecurr); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 3335 | } |
| 3336 | |
Joe Perches | 3d130fd | 2011-01-12 17:00:00 -0800 | [diff] [blame] | 3337 | # Check for __attribute__ packed, prefer __packed |
| 3338 | if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3339 | WARN("PREFER_PACKED", |
| 3340 | "__packed is preferred over __attribute__((packed))\n" . $herecurr); |
Joe Perches | 3d130fd | 2011-01-12 17:00:00 -0800 | [diff] [blame] | 3341 | } |
| 3342 | |
Joe Perches | 39b7e28 | 2011-07-25 17:13:24 -0700 | [diff] [blame] | 3343 | # Check for __attribute__ aligned, prefer __aligned |
| 3344 | if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3345 | WARN("PREFER_ALIGNED", |
| 3346 | "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); |
Joe Perches | 39b7e28 | 2011-07-25 17:13:24 -0700 | [diff] [blame] | 3347 | } |
| 3348 | |
Joe Perches | 5f14d3b | 2012-01-10 15:09:52 -0800 | [diff] [blame] | 3349 | # Check for __attribute__ format(printf, prefer __printf |
| 3350 | if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { |
| 3351 | WARN("PREFER_PRINTF", |
| 3352 | "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); |
| 3353 | } |
| 3354 | |
Joe Perches | 6061d94 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3355 | # Check for __attribute__ format(scanf, prefer __scanf |
| 3356 | if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { |
| 3357 | WARN("PREFER_SCANF", |
| 3358 | "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr); |
| 3359 | } |
| 3360 | |
Joe Perches | 8f53a9b | 2010-03-05 13:43:48 -0800 | [diff] [blame] | 3361 | # check for sizeof(&) |
| 3362 | if ($line =~ /\bsizeof\s*\(\s*\&/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3363 | WARN("SIZEOF_ADDRESS", |
| 3364 | "sizeof(& should be avoided\n" . $herecurr); |
Joe Perches | 8f53a9b | 2010-03-05 13:43:48 -0800 | [diff] [blame] | 3365 | } |
| 3366 | |
Joe Perches | 66c80b6 | 2012-07-30 14:41:22 -0700 | [diff] [blame] | 3367 | # check for sizeof without parenthesis |
| 3368 | if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { |
| 3369 | WARN("SIZEOF_PARENTHESIS", |
| 3370 | "sizeof $1 should be sizeof($1)\n" . $herecurr); |
| 3371 | } |
| 3372 | |
Joe Perches | 428e2fd | 2011-05-24 17:13:39 -0700 | [diff] [blame] | 3373 | # check for line continuations in quoted strings with odd counts of " |
| 3374 | if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3375 | WARN("LINE_CONTINUATIONS", |
| 3376 | "Avoid line continuations in quoted strings\n" . $herecurr); |
Joe Perches | 428e2fd | 2011-05-24 17:13:39 -0700 | [diff] [blame] | 3377 | } |
| 3378 | |
Joe Perches | 88982fe | 2012-12-17 16:02:00 -0800 | [diff] [blame] | 3379 | # check for struct spinlock declarations |
| 3380 | if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { |
| 3381 | WARN("USE_SPINLOCK_T", |
| 3382 | "struct spinlock should be spinlock_t\n" . $herecurr); |
| 3383 | } |
| 3384 | |
Joe Perches | a6962d7 | 2013-04-29 16:18:13 -0700 | [diff] [blame] | 3385 | # check for seq_printf uses that could be seq_puts |
| 3386 | if ($line =~ /\bseq_printf\s*\(/) { |
| 3387 | my $fmt = get_quoted_string($line, $rawline); |
| 3388 | if ($fmt !~ /[^\\]\%/) { |
| 3389 | WARN("PREFER_SEQ_PUTS", |
| 3390 | "Prefer seq_puts to seq_printf\n" . $herecurr); |
| 3391 | } |
| 3392 | } |
| 3393 | |
Andy Whitcroft | 554e165 | 2012-01-10 15:09:57 -0800 | [diff] [blame] | 3394 | # Check for misused memsets |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3395 | if ($^V && $^V ge 5.10.0 && |
| 3396 | defined $stat && |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3397 | $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { |
Andy Whitcroft | 554e165 | 2012-01-10 15:09:57 -0800 | [diff] [blame] | 3398 | |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3399 | my $ms_addr = $2; |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3400 | my $ms_val = $7; |
| 3401 | my $ms_size = $12; |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3402 | |
Andy Whitcroft | 554e165 | 2012-01-10 15:09:57 -0800 | [diff] [blame] | 3403 | if ($ms_size =~ /^(0x|)0$/i) { |
| 3404 | ERROR("MEMSET", |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3405 | "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); |
Andy Whitcroft | 554e165 | 2012-01-10 15:09:57 -0800 | [diff] [blame] | 3406 | } elsif ($ms_size =~ /^(0x|)1$/i) { |
| 3407 | WARN("MEMSET", |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3408 | "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); |
| 3409 | } |
| 3410 | } |
| 3411 | |
| 3412 | # typecasts on min/max could be min_t/max_t |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3413 | if ($^V && $^V ge 5.10.0 && |
| 3414 | defined $stat && |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3415 | $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3416 | if (defined $2 || defined $7) { |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3417 | my $call = $1; |
| 3418 | my $cast1 = deparenthesize($2); |
| 3419 | my $arg1 = $3; |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3420 | my $cast2 = deparenthesize($7); |
| 3421 | my $arg2 = $8; |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3422 | my $cast; |
| 3423 | |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3424 | if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { |
Joe Perches | d7c76ba | 2012-01-10 15:09:58 -0800 | [diff] [blame] | 3425 | $cast = "$cast1 or $cast2"; |
| 3426 | } elsif ($cast1 ne "") { |
| 3427 | $cast = $cast1; |
| 3428 | } else { |
| 3429 | $cast = $cast2; |
| 3430 | } |
| 3431 | WARN("MINMAX", |
| 3432 | "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); |
Andy Whitcroft | 554e165 | 2012-01-10 15:09:57 -0800 | [diff] [blame] | 3433 | } |
| 3434 | } |
| 3435 | |
Joe Perches | 4a27319 | 2012-07-30 14:41:20 -0700 | [diff] [blame] | 3436 | # check usleep_range arguments |
| 3437 | if ($^V && $^V ge 5.10.0 && |
| 3438 | defined $stat && |
| 3439 | $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { |
| 3440 | my $min = $1; |
| 3441 | my $max = $7; |
| 3442 | if ($min eq $max) { |
| 3443 | WARN("USLEEP_RANGE", |
| 3444 | "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); |
| 3445 | } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && |
| 3446 | $min > $max) { |
| 3447 | WARN("USLEEP_RANGE", |
| 3448 | "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); |
| 3449 | } |
| 3450 | } |
| 3451 | |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3452 | # check for new externs in .c files. |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3453 | if ($realfile =~ /\.c$/ && defined $stat && |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3454 | $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3455 | { |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3456 | my $function_name = $1; |
| 3457 | my $paren_space = $2; |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3458 | |
| 3459 | my $s = $stat; |
| 3460 | if (defined $cond) { |
| 3461 | substr($s, 0, length($cond), ''); |
| 3462 | } |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3463 | if ($s =~ /^\s*;/ && |
| 3464 | $function_name ne 'uninitialized_var') |
| 3465 | { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3466 | WARN("AVOID_EXTERNS", |
| 3467 | "externs should be avoided in .c files\n" . $herecurr); |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3468 | } |
| 3469 | |
| 3470 | if ($paren_space =~ /\n/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3471 | WARN("FUNCTION_ARGUMENTS", |
| 3472 | "arguments for function declarations should follow identifier\n" . $herecurr); |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3473 | } |
Andy Whitcroft | 9c9ba34 | 2008-04-29 00:59:33 -0700 | [diff] [blame] | 3474 | |
| 3475 | } elsif ($realfile =~ /\.c$/ && defined $stat && |
| 3476 | $stat =~ /^.\s*extern\s+/) |
| 3477 | { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3478 | WARN("AVOID_EXTERNS", |
| 3479 | "externs should be avoided in .c files\n" . $herecurr); |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3480 | } |
| 3481 | |
| 3482 | # checks for new __setup's |
| 3483 | if ($rawline =~ /\b__setup\("([^"]*)"/) { |
| 3484 | my $name = $1; |
| 3485 | |
| 3486 | if (!grep(/$name/, @setup_docs)) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3487 | CHK("UNDOCUMENTED_SETUP", |
| 3488 | "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); |
Andy Whitcroft | de7d4f0 | 2007-07-15 23:37:22 -0700 | [diff] [blame] | 3489 | } |
Andy Whitcroft | 653d487 | 2007-06-23 17:16:34 -0700 | [diff] [blame] | 3490 | } |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 3491 | |
| 3492 | # check for pointless casting of kmalloc return |
Joe Perches | caf2a54 | 2011-01-12 16:59:56 -0800 | [diff] [blame] | 3493 | if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3494 | WARN("UNNECESSARY_CASTS", |
| 3495 | "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); |
Andy Whitcroft | 9c0ca6f | 2007-10-16 23:29:38 -0700 | [diff] [blame] | 3496 | } |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3497 | |
Joe Perches | 972fdea | 2013-04-29 16:18:12 -0700 | [diff] [blame] | 3498 | # check for krealloc arg reuse |
| 3499 | if ($^V && $^V ge 5.10.0 && |
| 3500 | $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { |
| 3501 | WARN("KREALLOC_ARG_REUSE", |
| 3502 | "Reusing the krealloc arg is almost always a bug\n" . $herecurr); |
| 3503 | } |
| 3504 | |
Joe Perches | 5ce59ae | 2013-02-21 16:44:18 -0800 | [diff] [blame] | 3505 | # check for alloc argument mismatch |
| 3506 | if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { |
| 3507 | WARN("ALLOC_ARRAY_ARGS", |
| 3508 | "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); |
| 3509 | } |
| 3510 | |
Joe Perches | caf2a54 | 2011-01-12 16:59:56 -0800 | [diff] [blame] | 3511 | # check for multiple semicolons |
| 3512 | if ($line =~ /;\s*;\s*$/) { |
Joe Perches | d1e2ad0 | 2012-12-17 16:02:01 -0800 | [diff] [blame] | 3513 | WARN("ONE_SEMICOLON", |
| 3514 | "Statements terminations use 1 semicolon\n" . $herecurr); |
| 3515 | } |
| 3516 | |
| 3517 | # check for switch/default statements without a break; |
| 3518 | if ($^V && $^V ge 5.10.0 && |
| 3519 | defined $stat && |
| 3520 | $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { |
| 3521 | my $ctx = ''; |
| 3522 | my $herectx = $here . "\n"; |
| 3523 | my $cnt = statement_rawlines($stat); |
| 3524 | for (my $n = 0; $n < $cnt; $n++) { |
| 3525 | $herectx .= raw_line($linenr, $n) . "\n"; |
| 3526 | } |
| 3527 | WARN("DEFAULT_NO_BREAK", |
| 3528 | "switch default: should use break\n" . $herectx); |
Joe Perches | caf2a54 | 2011-01-12 16:59:56 -0800 | [diff] [blame] | 3529 | } |
| 3530 | |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3531 | # check for gcc specific __FUNCTION__ |
| 3532 | if ($line =~ /__FUNCTION__/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3533 | WARN("USE_FUNC", |
| 3534 | "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3535 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3536 | |
Joe Perches | 2c92488 | 2012-03-23 15:02:20 -0700 | [diff] [blame] | 3537 | # check for use of yield() |
| 3538 | if ($line =~ /\byield\s*\(\s*\)/) { |
| 3539 | WARN("YIELD", |
| 3540 | "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); |
| 3541 | } |
| 3542 | |
Thomas Gleixner | 4882720b | 2010-09-07 14:34:01 +0000 | [diff] [blame] | 3543 | # check for semaphores initialized locked |
| 3544 | if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3545 | WARN("CONSIDER_COMPLETION", |
| 3546 | "consider using a completion\n" . $herecurr); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3547 | } |
Joe Perches | 6712d85 | 2012-03-23 15:02:20 -0700 | [diff] [blame] | 3548 | |
Joe Perches | 67d0a07 | 2011-10-31 17:13:10 -0700 | [diff] [blame] | 3549 | # recommend kstrto* over simple_strto* and strict_strto* |
| 3550 | if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3551 | WARN("CONSIDER_KSTRTO", |
Joe Perches | 67d0a07 | 2011-10-31 17:13:10 -0700 | [diff] [blame] | 3552 | "$1 is obsolete, use k$3 instead\n" . $herecurr); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3553 | } |
Joe Perches | 6712d85 | 2012-03-23 15:02:20 -0700 | [diff] [blame] | 3554 | |
Michael Ellerman | f3db663 | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 3555 | # check for __initcall(), use device_initcall() explicitly please |
| 3556 | if ($line =~ /^.\s*__initcall\s*\(/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3557 | WARN("USE_DEVICE_INITCALL", |
| 3558 | "please use device_initcall() instead of __initcall()\n" . $herecurr); |
Michael Ellerman | f3db663 | 2008-07-23 21:28:57 -0700 | [diff] [blame] | 3559 | } |
Joe Perches | 6712d85 | 2012-03-23 15:02:20 -0700 | [diff] [blame] | 3560 | |
Emese Revfy | 7940484 | 2010-03-05 13:43:53 -0800 | [diff] [blame] | 3561 | # check for various ops structs, ensure they are const. |
| 3562 | my $struct_ops = qr{acpi_dock_ops| |
| 3563 | address_space_operations| |
| 3564 | backlight_ops| |
| 3565 | block_device_operations| |
| 3566 | dentry_operations| |
| 3567 | dev_pm_ops| |
| 3568 | dma_map_ops| |
| 3569 | extent_io_ops| |
| 3570 | file_lock_operations| |
| 3571 | file_operations| |
| 3572 | hv_ops| |
| 3573 | ide_dma_ops| |
| 3574 | intel_dvo_dev_ops| |
| 3575 | item_operations| |
| 3576 | iwl_ops| |
| 3577 | kgdb_arch| |
| 3578 | kgdb_io| |
| 3579 | kset_uevent_ops| |
| 3580 | lock_manager_operations| |
| 3581 | microcode_ops| |
| 3582 | mtrr_ops| |
| 3583 | neigh_ops| |
| 3584 | nlmsvc_binding| |
| 3585 | pci_raw_ops| |
| 3586 | pipe_buf_operations| |
| 3587 | platform_hibernation_ops| |
| 3588 | platform_suspend_ops| |
| 3589 | proto_ops| |
| 3590 | rpc_pipe_ops| |
| 3591 | seq_operations| |
| 3592 | snd_ac97_build_ops| |
| 3593 | soc_pcmcia_socket_ops| |
| 3594 | stacktrace_ops| |
| 3595 | sysfs_ops| |
| 3596 | tty_operations| |
| 3597 | usb_mon_operations| |
| 3598 | wd_ops}x; |
Andy Whitcroft | 6903ffb | 2009-01-15 13:51:07 -0800 | [diff] [blame] | 3599 | if ($line !~ /\bconst\b/ && |
Emese Revfy | 7940484 | 2010-03-05 13:43:53 -0800 | [diff] [blame] | 3600 | $line =~ /\bstruct\s+($struct_ops)\b/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3601 | WARN("CONST_STRUCT", |
| 3602 | "struct $1 should normally be const\n" . |
Andy Whitcroft | 6903ffb | 2009-01-15 13:51:07 -0800 | [diff] [blame] | 3603 | $herecurr); |
Andy Whitcroft | 2b6db5c | 2009-01-06 14:41:29 -0800 | [diff] [blame] | 3604 | } |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3605 | |
| 3606 | # use of NR_CPUS is usually wrong |
| 3607 | # ignore definitions of NR_CPUS and usage to define arrays as likely right |
| 3608 | if ($line =~ /\bNR_CPUS\b/ && |
Andy Whitcroft | c45dcab | 2008-06-05 22:46:01 -0700 | [diff] [blame] | 3609 | $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && |
| 3610 | $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && |
Andy Whitcroft | 171ae1a | 2008-04-29 00:59:32 -0700 | [diff] [blame] | 3611 | $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && |
| 3612 | $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && |
| 3613 | $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3614 | { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3615 | WARN("NR_CPUS", |
| 3616 | "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); |
Andy Whitcroft | 773647a | 2008-03-28 14:15:58 -0700 | [diff] [blame] | 3617 | } |
Andy Whitcroft | 9c9ba34 | 2008-04-29 00:59:33 -0700 | [diff] [blame] | 3618 | |
| 3619 | # check for %L{u,d,i} in strings |
| 3620 | my $string; |
| 3621 | while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { |
| 3622 | $string = substr($rawline, $-[1], $+[1] - $-[1]); |
Andy Whitcroft | 2a1bc5d | 2008-10-15 22:02:23 -0700 | [diff] [blame] | 3623 | $string =~ s/%%/__/g; |
Andy Whitcroft | 9c9ba34 | 2008-04-29 00:59:33 -0700 | [diff] [blame] | 3624 | if ($string =~ /(?<!%)%L[udi]/) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3625 | WARN("PRINTF_L", |
| 3626 | "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); |
Andy Whitcroft | 9c9ba34 | 2008-04-29 00:59:33 -0700 | [diff] [blame] | 3627 | last; |
| 3628 | } |
| 3629 | } |
Andy Whitcroft | 691d77b | 2009-01-06 14:41:16 -0800 | [diff] [blame] | 3630 | |
| 3631 | # whine mightly about in_atomic |
| 3632 | if ($line =~ /\bin_atomic\s*\(/) { |
| 3633 | if ($realfile =~ m@^drivers/@) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3634 | ERROR("IN_ATOMIC", |
| 3635 | "do not use in_atomic in drivers\n" . $herecurr); |
Andy Whitcroft | f4a8773 | 2009-02-27 14:03:05 -0800 | [diff] [blame] | 3636 | } elsif ($realfile !~ m@^kernel/@) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3637 | WARN("IN_ATOMIC", |
| 3638 | "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); |
Andy Whitcroft | 691d77b | 2009-01-06 14:41:16 -0800 | [diff] [blame] | 3639 | } |
| 3640 | } |
Peter Zijlstra | 1704f47 | 2010-03-19 01:37:42 +0100 | [diff] [blame] | 3641 | |
| 3642 | # check for lockdep_set_novalidate_class |
| 3643 | if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || |
| 3644 | $line =~ /__lockdep_no_validate__\s*\)/ ) { |
| 3645 | if ($realfile !~ m@^kernel/lockdep@ && |
| 3646 | $realfile !~ m@^include/linux/lockdep@ && |
| 3647 | $realfile !~ m@^drivers/base/core@) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3648 | ERROR("LOCKDEP", |
| 3649 | "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); |
Peter Zijlstra | 1704f47 | 2010-03-19 01:37:42 +0100 | [diff] [blame] | 3650 | } |
| 3651 | } |
Dave Jones | 88f8831 | 2011-01-12 16:59:59 -0800 | [diff] [blame] | 3652 | |
| 3653 | if ($line =~ /debugfs_create_file.*S_IWUGO/ || |
| 3654 | $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3655 | WARN("EXPORTED_WORLD_WRITABLE", |
| 3656 | "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); |
Dave Jones | 88f8831 | 2011-01-12 16:59:59 -0800 | [diff] [blame] | 3657 | } |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3658 | } |
| 3659 | |
| 3660 | # If we have no input at all, then there is nothing to report on |
| 3661 | # so just keep quiet. |
| 3662 | if ($#rawlines == -1) { |
| 3663 | exit(0); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3664 | } |
| 3665 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 3666 | # In mailback mode only produce a report in the negative, for |
| 3667 | # things that appear to be patches. |
| 3668 | if ($mailback && ($clean == 1 || !$is_patch)) { |
| 3669 | exit(0); |
| 3670 | } |
| 3671 | |
| 3672 | # This is not a patch, and we are are in 'no-patch' mode so |
| 3673 | # just keep quiet. |
| 3674 | if (!$chk_patch && !$is_patch) { |
| 3675 | exit(0); |
| 3676 | } |
| 3677 | |
| 3678 | if (!$is_patch) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3679 | ERROR("NOT_UNIFIED_DIFF", |
| 3680 | "Does not appear to be a unified-diff format patch\n"); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3681 | } |
| 3682 | if ($is_patch && $chk_signoff && $signoff == 0) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3683 | ERROR("MISSING_SIGN_OFF", |
| 3684 | "Missing Signed-off-by: line(s)\n"); |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3685 | } |
| 3686 | |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 3687 | print report_dump(); |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3688 | if ($summary && !($clean == 1 && $quiet == 1)) { |
| 3689 | print "$filename " if ($summary_file); |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 3690 | print "total: $cnt_error errors, $cnt_warn warnings, " . |
| 3691 | (($check)? "$cnt_chk checks, " : "") . |
| 3692 | "$cnt_lines lines checked\n"; |
| 3693 | print "\n" if ($quiet == 0); |
Andy Whitcroft | f0a594c | 2007-07-19 01:48:34 -0700 | [diff] [blame] | 3694 | } |
Andy Whitcroft | 8905a67 | 2007-11-28 16:21:06 -0800 | [diff] [blame] | 3695 | |
Andy Whitcroft | d2c0a23 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 3696 | if ($quiet == 0) { |
Joe Perches | d1fe9c0 | 2012-03-23 15:02:16 -0700 | [diff] [blame] | 3697 | |
| 3698 | if ($^V lt 5.10.0) { |
| 3699 | print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); |
| 3700 | print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); |
| 3701 | } |
| 3702 | |
Andy Whitcroft | d2c0a23 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 3703 | # If there were whitespace errors which cleanpatch can fix |
| 3704 | # then suggest that. |
| 3705 | if ($rpt_cleaners) { |
| 3706 | print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; |
| 3707 | print " scripts/cleanfile\n\n"; |
Mike Frysinger | b078121 | 2011-03-22 16:34:43 -0700 | [diff] [blame] | 3708 | $rpt_cleaners = 0; |
Andy Whitcroft | d2c0a23 | 2010-10-26 14:23:12 -0700 | [diff] [blame] | 3709 | } |
| 3710 | } |
| 3711 | |
Artem Bityutskiy | 1123268 | 2012-03-23 15:02:17 -0700 | [diff] [blame] | 3712 | if ($quiet == 0 && keys %ignore_type) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3713 | print "NOTE: Ignored message types:"; |
| 3714 | foreach my $ignore (sort keys %ignore_type) { |
| 3715 | print " $ignore"; |
| 3716 | } |
Artem Bityutskiy | 1123268 | 2012-03-23 15:02:17 -0700 | [diff] [blame] | 3717 | print "\n\n"; |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3718 | } |
| 3719 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3720 | if ($clean == 1 && $quiet == 0) { |
Andy Whitcroft | c2fdda0 | 2008-02-08 04:20:54 -0800 | [diff] [blame] | 3721 | print "$vname has no obvious style problems and is ready for submission.\n" |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3722 | } |
| 3723 | if ($clean == 0 && $quiet == 0) { |
Joe Perches | 000d1cc1 | 2011-07-25 17:13:25 -0700 | [diff] [blame] | 3724 | print << "EOM"; |
| 3725 | $vname has style problems, please review. |
| 3726 | |
| 3727 | If any of these errors are false positives, please report |
| 3728 | them to the maintainer, see CHECKPATCH in MAINTAINERS. |
| 3729 | EOM |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3730 | } |
Andy Whitcroft | 13214ad | 2008-02-08 04:22:03 -0800 | [diff] [blame] | 3731 | |
Andy Whitcroft | 0a920b5 | 2007-06-01 00:46:48 -0700 | [diff] [blame] | 3732 | return $clean; |
| 3733 | } |