blob: 9a3894dbf752354a0a05dd70e6a42ec747eb92eb [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft131edb32009-10-26 16:50:14 -07005# (c) 2008,2009, Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9
10my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
Andy Whitcroft5e8d8f62009-10-26 16:50:17 -070013my $V = '0.30';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15use Getopt::Long qw(:config no_auto_abbrev);
16
17my $quiet = 0;
18my $tree = 1;
19my $chk_signoff = 1;
20my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070021my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070022my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080023my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070024my $file = 0;
25my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $summary = 1;
27my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080028my $summary_file = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080030my %debug;
Hannes Eder77f5b102009-09-21 17:04:37 -070031my $help = 0;
32
33sub help {
34 my ($exitcode) = @_;
35
36 print << "EOM";
37Usage: $P [OPTION]... [FILE]...
38Version: $V
39
40Options:
41 -q, --quiet quiet
42 --no-tree run without a kernel tree
43 --no-signoff do not check for 'Signed-off-by' line
44 --patch treat FILE as patchfile (default)
45 --emacs emacs compile window format
46 --terse one line per report
47 -f, --file treat FILE as regular source file
48 --subjective, --strict enable more subjective tests
49 --root=PATH PATH to the kernel tree root
50 --no-summary suppress the per-file summary
51 --mailback only produce a report in case of warnings/errors
52 --summary-file include the filename in summary
53 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
54 'values', 'possible', 'type', and 'attr' (default
55 is all off)
56 --test-only=WORD report only warnings/errors containing WORD
57 literally
58 -h, --help, --version display this help and exit
59
60When FILE is - read standard input.
61EOM
62
63 exit($exitcode);
64}
65
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070066GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070067 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070068 'tree!' => \$tree,
69 'signoff!' => \$chk_signoff,
70 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070071 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -080072 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -070073 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070074 'subjective!' => \$check,
75 'strict!' => \$check,
76 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -080077 'summary!' => \$summary,
78 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -080079 'summary-file!' => \$summary_file,
80
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080081 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -070082 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -070083 'h|help' => \$help,
84 'version' => \$help
85) or help(1);
86
87help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070088
89my $exit = 0;
90
91if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -070092 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070093 exit(1);
94}
95
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080096my $dbg_values = 0;
97my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -070098my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -070099my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800100for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800101 ## no critic
102 eval "\${dbg_$key} = '$debug{$key}';";
103 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800104}
105
Andy Whitcroft8905a672007-11-28 16:21:06 -0800106if ($terse) {
107 $emacs = 1;
108 $quiet++;
109}
110
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700111if ($tree) {
112 if (defined $root) {
113 if (!top_of_kernel_tree($root)) {
114 die "$P: $root: --root does not point at a valid tree\n";
115 }
116 } else {
117 if (top_of_kernel_tree('.')) {
118 $root = '.';
119 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
120 top_of_kernel_tree($1)) {
121 $root = $1;
122 }
123 }
124
125 if (!defined $root) {
126 print "Must be run from the top-level dir. of a kernel tree\n";
127 exit(2);
128 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700129}
130
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700131my $emitted_corrupt = 0;
132
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700133our $Ident = qr{
134 [A-Za-z_][A-Za-z\d_]*
135 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
136 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700137our $Storage = qr{extern|static|asmlinkage};
138our $Sparse = qr{
139 __user|
140 __kernel|
141 __force|
142 __iomem|
143 __must_check|
144 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800145 __kprobes|
146 __ref
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700147 }x;
148our $Attribute = qr{
149 const|
150 __read_mostly|
151 __kprobes|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700152 __(?:mem|cpu|dev|)(?:initdata|init)|
153 ____cacheline_aligned|
154 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800155 ____cacheline_internodealigned_in_smp|
156 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700157 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700158our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700159our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700160our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
161our $Lval = qr{$Ident(?:$Member)*};
162
163our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
164our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800165our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700166our $Operators = qr{
167 <=|>=|==|!=|
168 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800169 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700170 }x;
171
Andy Whitcroft8905a672007-11-28 16:21:06 -0800172our $NonptrType;
173our $Type;
174our $Declare;
175
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700176our $UTF8 = qr {
177 [\x09\x0A\x0D\x20-\x7E] # ASCII
178 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
179 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
180 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
181 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
182 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
183 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
184 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
185}x;
186
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700187our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700188 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700189 atomic_t
190)};
191
Joe Perches691e6692010-03-05 13:43:51 -0800192our $logFunctions = qr{(?x:
193 printk|
194 pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
195 dev_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
196 WARN|
197 panic
198)};
199
Andy Whitcroft8905a672007-11-28 16:21:06 -0800200our @typeList = (
201 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700202 qr{(?:unsigned\s+)?char},
203 qr{(?:unsigned\s+)?short},
204 qr{(?:unsigned\s+)?int},
205 qr{(?:unsigned\s+)?long},
206 qr{(?:unsigned\s+)?long\s+int},
207 qr{(?:unsigned\s+)?long\s+long},
208 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800209 qr{unsigned},
210 qr{float},
211 qr{double},
212 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800213 qr{struct\s+$Ident},
214 qr{union\s+$Ident},
215 qr{enum\s+$Ident},
216 qr{${Ident}_t},
217 qr{${Ident}_handler},
218 qr{${Ident}_handler_fn},
219);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700220our @modifierList = (
221 qr{fastcall},
222);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800223
224sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700225 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
226 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700227 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800228 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700229 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800230 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700231 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700232 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700233 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800234 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700235 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800236 }x;
237 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700238 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800239 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700240 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800241 }x;
242 $Declare = qr{(?:$Storage\s+)?$Type};
243}
244build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700245
246$chk_signoff = 0 if ($file);
247
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700248my @dep_includes = ();
249my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700250my $removal = "Documentation/feature-removal-schedule.txt";
251if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800252 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700253 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800254 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700255 if (/^Check:\s+(.*\S)/) {
256 for my $entry (split(/[, ]+/, $1)) {
257 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700258 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700259
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700260 } elsif ($entry !~ m@/@) {
261 push(@dep_functions, $entry);
262 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700263 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700264 }
265 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800266 close($REMOVE);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700267}
268
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700269my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800270my @lines = ();
271my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700272for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800273 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700274 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800275 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700276 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800277 } elsif ($filename eq '-') {
278 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700279 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800280 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700281 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700282 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800283 if ($filename eq '-') {
284 $vname = 'Your patch';
285 } else {
286 $vname = $filename;
287 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800288 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700289 chomp;
290 push(@rawlines, $_);
291 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800292 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800293 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700294 $exit = 1;
295 }
296 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800297 @lines = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700298}
299
300exit($exit);
301
302sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303 my ($root) = @_;
304
305 my @tree_check = (
306 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
307 "README", "Documentation", "arch", "include", "drivers",
308 "fs", "init", "ipc", "kernel", "lib", "scripts",
309 );
310
311 foreach my $check (@tree_check) {
312 if (! -e $root . '/' . $check) {
313 return 0;
314 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700315 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700316 return 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700317}
318
319sub expand_tabs {
320 my ($str) = @_;
321
322 my $res = '';
323 my $n = 0;
324 for my $c (split(//, $str)) {
325 if ($c eq "\t") {
326 $res .= ' ';
327 $n++;
328 for (; ($n % 8) != 0; $n++) {
329 $res .= ' ';
330 }
331 next;
332 }
333 $res .= $c;
334 $n++;
335 }
336
337 return $res;
338}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700339sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700340 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700341 return $res;
342}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700343
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700344sub line_stats {
345 my ($line) = @_;
346
347 # Drop the diff line leader and expand tabs
348 $line =~ s/^.//;
349 $line = expand_tabs($line);
350
351 # Pick the indent from the front of the line.
352 my ($white) = ($line =~ /^(\s*)/);
353
354 return (length($line), length($white));
355}
356
Andy Whitcroft773647a2008-03-28 14:15:58 -0700357my $sanitise_quote = '';
358
359sub sanitise_line_reset {
360 my ($in_comment) = @_;
361
362 if ($in_comment) {
363 $sanitise_quote = '*/';
364 } else {
365 $sanitise_quote = '';
366 }
367}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700368sub sanitise_line {
369 my ($line) = @_;
370
371 my $res = '';
372 my $l = '';
373
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800374 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700375 my $off = 0;
376 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700377
Andy Whitcroft773647a2008-03-28 14:15:58 -0700378 # Always copy over the diff marker.
379 $res = substr($line, 0, 1);
380
381 for ($off = 1; $off < length($line); $off++) {
382 $c = substr($line, $off, 1);
383
384 # Comments we are wacking completly including the begin
385 # and end, all to $;.
386 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
387 $sanitise_quote = '*/';
388
389 substr($res, $off, 2, "$;$;");
390 $off++;
391 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800392 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700393 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700394 $sanitise_quote = '';
395 substr($res, $off, 2, "$;$;");
396 $off++;
397 next;
398 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700399 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
400 $sanitise_quote = '//';
401
402 substr($res, $off, 2, $sanitise_quote);
403 $off++;
404 next;
405 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700406
407 # A \ in a string means ignore the next character.
408 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
409 $c eq "\\") {
410 substr($res, $off, 2, 'XX');
411 $off++;
412 next;
413 }
414 # Regular quotes.
415 if ($c eq "'" || $c eq '"') {
416 if ($sanitise_quote eq '') {
417 $sanitise_quote = $c;
418
419 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700420 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700421 } elsif ($sanitise_quote eq $c) {
422 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700423 }
424 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700425
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800426 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700427 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
428 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700429 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
430 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700431 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
432 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700433 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700434 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700435 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800436 }
437
Daniel Walker113f04a2009-09-21 17:04:35 -0700438 if ($sanitise_quote eq '//') {
439 $sanitise_quote = '';
440 }
441
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800442 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700443 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800444 my $clean = 'X' x length($1);
445 $res =~ s@\<.*\>@<$clean>@;
446
447 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700448 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800449 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700450 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800451 }
452
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700453 return $res;
454}
455
Andy Whitcroft8905a672007-11-28 16:21:06 -0800456sub ctx_statement_block {
457 my ($linenr, $remain, $off) = @_;
458 my $line = $linenr - 1;
459 my $blk = '';
460 my $soff = $off;
461 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700462 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800463
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800464 my $loff = 0;
465
Andy Whitcroft8905a672007-11-28 16:21:06 -0800466 my $type = '';
467 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800468 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800469 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800470 my $c;
471 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800472
473 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800474 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800475 @stack = (['', 0]) if ($#stack == -1);
476
Andy Whitcroft773647a2008-03-28 14:15:58 -0700477 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478 # If we are about to drop off the end, pull in more
479 # context.
480 if ($off >= $len) {
481 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700482 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800483 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800484 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800485 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800486 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800487 $len = length($blk);
488 $line++;
489 last;
490 }
491 # Bail if there is no further context.
492 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800493 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800494 last;
495 }
496 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800497 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800498 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800499 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800500
Andy Whitcroft773647a2008-03-28 14:15:58 -0700501 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800502
503 # Handle nested #if/#else.
504 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
505 push(@stack, [ $type, $level ]);
506 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
507 ($type, $level) = @{$stack[$#stack - 1]};
508 } elsif ($remainder =~ /^#\s*endif\b/) {
509 ($type, $level) = @{pop(@stack)};
510 }
511
Andy Whitcroft8905a672007-11-28 16:21:06 -0800512 # Statement ends at the ';' or a close '}' at the
513 # outermost level.
514 if ($level == 0 && $c eq ';') {
515 last;
516 }
517
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800518 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700519 if ($level == 0 && $coff_set == 0 &&
520 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
521 $remainder =~ /^(else)(?:\s|{)/ &&
522 $remainder !~ /^else\s+if\b/) {
523 $coff = $off + length($1) - 1;
524 $coff_set = 1;
525 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
526 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800527 }
528
Andy Whitcroft8905a672007-11-28 16:21:06 -0800529 if (($type eq '' || $type eq '(') && $c eq '(') {
530 $level++;
531 $type = '(';
532 }
533 if ($type eq '(' && $c eq ')') {
534 $level--;
535 $type = ($level != 0)? '(' : '';
536
537 if ($level == 0 && $coff < $soff) {
538 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700539 $coff_set = 1;
540 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800541 }
542 }
543 if (($type eq '' || $type eq '{') && $c eq '{') {
544 $level++;
545 $type = '{';
546 }
547 if ($type eq '{' && $c eq '}') {
548 $level--;
549 $type = ($level != 0)? '{' : '';
550
551 if ($level == 0) {
552 last;
553 }
554 }
555 $off++;
556 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700557 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800558 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700559 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800560 $line++;
561 $remain--;
562 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800563
564 my $statement = substr($blk, $soff, $off - $soff + 1);
565 my $condition = substr($blk, $soff, $coff - $soff + 1);
566
567 #warn "STATEMENT<$statement>\n";
568 #warn "CONDITION<$condition>\n";
569
Andy Whitcroft773647a2008-03-28 14:15:58 -0700570 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800571
572 return ($statement, $condition,
573 $line, $remain + 1, $off - $loff + 1, $level);
574}
575
Andy Whitcroftcf655042008-03-04 14:28:20 -0800576sub statement_lines {
577 my ($stmt) = @_;
578
579 # Strip the diff line prefixes and rip blank lines at start and end.
580 $stmt =~ s/(^|\n)./$1/g;
581 $stmt =~ s/^\s*//;
582 $stmt =~ s/\s*$//;
583
584 my @stmt_lines = ($stmt =~ /\n/g);
585
586 return $#stmt_lines + 2;
587}
588
589sub statement_rawlines {
590 my ($stmt) = @_;
591
592 my @stmt_lines = ($stmt =~ /\n/g);
593
594 return $#stmt_lines + 2;
595}
596
597sub statement_block_size {
598 my ($stmt) = @_;
599
600 $stmt =~ s/(^|\n)./$1/g;
601 $stmt =~ s/^\s*{//;
602 $stmt =~ s/}\s*$//;
603 $stmt =~ s/^\s*//;
604 $stmt =~ s/\s*$//;
605
606 my @stmt_lines = ($stmt =~ /\n/g);
607 my @stmt_statements = ($stmt =~ /;/g);
608
609 my $stmt_lines = $#stmt_lines + 2;
610 my $stmt_statements = $#stmt_statements + 1;
611
612 if ($stmt_lines > $stmt_statements) {
613 return $stmt_lines;
614 } else {
615 return $stmt_statements;
616 }
617}
618
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800619sub ctx_statement_full {
620 my ($linenr, $remain, $off) = @_;
621 my ($statement, $condition, $level);
622
623 my (@chunks);
624
Andy Whitcroftcf655042008-03-04 14:28:20 -0800625 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800626 ($statement, $condition, $linenr, $remain, $off, $level) =
627 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700628 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800629 push(@chunks, [ $condition, $statement ]);
630 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
631 return ($level, $linenr, @chunks);
632 }
633
634 # Pull in the following conditional/block pairs and see if they
635 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800636 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800637 ($statement, $condition, $linenr, $remain, $off, $level) =
638 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800639 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700640 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800641 #print "C: push\n";
642 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800643 }
644
645 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800646}
647
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700648sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700649 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700650 my $line;
651 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700652 my $blk = '';
653 my @o;
654 my @c;
655 my @res = ();
656
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700657 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800658 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700659 for ($line = $start; $remain > 0; $line++) {
660 next if ($rawlines[$line] =~ /^-/);
661 $remain--;
662
663 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800664
665 # Handle nested #if/#else.
666 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
667 push(@stack, $level);
668 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
669 $level = $stack[$#stack - 1];
670 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
671 $level = pop(@stack);
672 }
673
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700674 foreach my $c (split(//, $rawlines[$line])) {
675 ##print "C<$c>L<$level><$open$close>O<$off>\n";
676 if ($off > 0) {
677 $off--;
678 next;
679 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700680
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700681 if ($c eq $close && $level > 0) {
682 $level--;
683 last if ($level == 0);
684 } elsif ($c eq $open) {
685 $level++;
686 }
687 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700688
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700689 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700690 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700691 }
692
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700693 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700694 }
695
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700696 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700697}
698sub ctx_block_outer {
699 my ($linenr, $remain) = @_;
700
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700701 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
702 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700703}
704sub ctx_block {
705 my ($linenr, $remain) = @_;
706
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700707 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
708 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700709}
710sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700711 my ($linenr, $remain, $off) = @_;
712
713 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
714 return @r;
715}
716sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700717 my ($linenr, $remain) = @_;
718
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700719 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700720}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700721sub ctx_statement_level {
722 my ($linenr, $remain, $off) = @_;
723
724 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
725}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700726
727sub ctx_locate_comment {
728 my ($first_line, $end_line) = @_;
729
730 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700731 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700732 return $current_comment if (defined $current_comment);
733
734 # Look through the context and try and figure out if there is a
735 # comment.
736 my $in_comment = 0;
737 $current_comment = '';
738 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700739 my $line = $rawlines[$linenr - 1];
740 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700741 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
742 $in_comment = 1;
743 }
744 if ($line =~ m@/\*@) {
745 $in_comment = 1;
746 }
747 if (!$in_comment && $current_comment ne '') {
748 $current_comment = '';
749 }
750 $current_comment .= $line . "\n" if ($in_comment);
751 if ($line =~ m@\*/@) {
752 $in_comment = 0;
753 }
754 }
755
756 chomp($current_comment);
757 return($current_comment);
758}
759sub ctx_has_comment {
760 my ($first_line, $end_line) = @_;
761 my $cmt = ctx_locate_comment($first_line, $end_line);
762
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700763 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700764 ##print "CMMT: $cmt\n";
765
766 return ($cmt ne '');
767}
768
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700769sub raw_line {
770 my ($linenr, $cnt) = @_;
771
772 my $offset = $linenr - 1;
773 $cnt++;
774
775 my $line;
776 while ($cnt) {
777 $line = $rawlines[$offset++];
778 next if (defined($line) && $line =~ /^-/);
779 $cnt--;
780 }
781
782 return $line;
783}
784
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700785sub cat_vet {
786 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700787 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700788
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700789 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700790 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
791 $res .= $1;
792 if ($2 ne '') {
793 $coded = sprintf("^%c", unpack('C', $2) + 64);
794 $res .= $coded;
795 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700796 }
797 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700798
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700799 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700800}
801
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800802my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800803my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800804my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700805my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800806
807sub annotate_reset {
808 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800809 $av_pending = '_';
810 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700811 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812}
813
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700814sub annotate_values {
815 my ($stream, $type) = @_;
816
817 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700818 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700819 my $cur = $stream;
820
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800821 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700822
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700823 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700824 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800825 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700826 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700827 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800828 print "WS($1)\n" if ($dbg_values > 1);
829 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800830 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800831 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700832 }
833
Andy Whitcroft8ea3eb92008-07-23 21:29:08 -0700834 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800835 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700836 $type = 'T';
837
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700838 } elsif ($cur =~ /^($Modifier)\s*/) {
839 print "MODIFIER($1)\n" if ($dbg_values > 1);
840 $type = 'T';
841
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700842 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700843 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800844 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700845 push(@av_paren_type, $type);
846 if ($2 ne '') {
847 $av_pending = 'N';
848 }
849 $type = 'E';
850
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700851 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700852 print "UNDEF($1)\n" if ($dbg_values > 1);
853 $av_preprocessor = 1;
854 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700856 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800857 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800858 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800859
860 push(@av_paren_type, $type);
861 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700862 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800863
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700864 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800865 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
866 $av_preprocessor = 1;
867
868 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
869
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700870 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800871
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700872 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800873 print "PRE_END($1)\n" if ($dbg_values > 1);
874
875 $av_preprocessor = 1;
876
877 # Assume all arms of the conditional end as this
878 # one does, and continue as if the #endif was not here.
879 pop(@av_paren_type);
880 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700881 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700882
883 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800884 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700885
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700886 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
887 print "ATTR($1)\n" if ($dbg_values > 1);
888 $av_pending = $type;
889 $type = 'N';
890
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700891 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800892 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700893 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800894 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700895 }
896 $type = 'N';
897
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700898 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800899 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700900 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700901 $type = 'N';
902
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700903 } elsif ($cur =~/^(case)/o) {
904 print "CASE($1)\n" if ($dbg_values > 1);
905 $av_pend_colon = 'C';
906 $type = 'N';
907
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700908 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800909 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700910 $type = 'N';
911
912 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800913 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800914 push(@av_paren_type, $av_pending);
915 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700916 $type = 'N';
917
918 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800919 my $new_type = pop(@av_paren_type);
920 if ($new_type ne '_') {
921 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800922 print "PAREN('$1') -> $type\n"
923 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700924 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800925 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700926 }
927
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700928 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800929 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700930 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800931 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700932
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800933 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
934 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700935 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800936 } elsif ($type eq 'E') {
937 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700938 }
939 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
940 $type = 'V';
941
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700942 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800943 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700944 $type = 'V';
945
946 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800947 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700948 $type = 'N';
949
Andy Whitcroftcf655042008-03-04 14:28:20 -0800950 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800951 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800952 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700953 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800954
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800955 } elsif ($cur =~/^(,)/) {
956 print "COMMA($1)\n" if ($dbg_values > 1);
957 $type = 'C';
958
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700959 } elsif ($cur =~ /^(\?)/o) {
960 print "QUESTION($1)\n" if ($dbg_values > 1);
961 $type = 'N';
962
963 } elsif ($cur =~ /^(:)/o) {
964 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
965
966 substr($var, length($res), 1, $av_pend_colon);
967 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
968 $type = 'E';
969 } else {
970 $type = 'N';
971 }
972 $av_pend_colon = 'O';
973
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800974 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800975 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700976 $type = 'N';
977
Andy Whitcroft0d413862008-10-15 22:02:16 -0700978 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700979 my $variant;
980
981 print "OPV($1)\n" if ($dbg_values > 1);
982 if ($type eq 'V') {
983 $variant = 'B';
984 } else {
985 $variant = 'U';
986 }
987
988 substr($var, length($res), 1, $variant);
989 $type = 'N';
990
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700991 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800992 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700993 if ($1 ne '++' && $1 ne '--') {
994 $type = 'N';
995 }
996
997 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800998 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700999 }
1000 if (defined $1) {
1001 $cur = substr($cur, length($1));
1002 $res .= $type x length($1);
1003 }
1004 }
1005
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001006 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001007}
1008
Andy Whitcroft8905a672007-11-28 16:21:06 -08001009sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001010 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001011 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001012 ^(?:
1013 $Modifier|
1014 $Storage|
1015 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001016 DEFINE_\S+
1017 )$|
1018 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001019 goto|
1020 return|
1021 case|
1022 else|
1023 asm|__asm__|
1024 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001025 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001026 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001027 )}x;
1028 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1029 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001030 # Check for modifiers.
1031 $possible =~ s/\s*$Storage\s*//g;
1032 $possible =~ s/\s*$Sparse\s*//g;
1033 if ($possible =~ /^\s*$/) {
1034
1035 } elsif ($possible =~ /\s/) {
1036 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001037 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001038 if ($modifier !~ $notPermitted) {
1039 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1040 push(@modifierList, $modifier);
1041 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001042 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001043
1044 } else {
1045 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1046 push(@typeList, $possible);
1047 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001048 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001049 } else {
1050 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001051 }
1052}
1053
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001054my $prefix = '';
1055
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001056sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001057 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1058 return 0;
1059 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001060 my $line = $prefix . $_[0];
1061
1062 $line = (split('\n', $line))[0] . "\n" if ($terse);
1063
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001064 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001065
1066 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001067}
1068sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001069 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001070}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001071sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001072 if (report("ERROR: $_[0]\n")) {
1073 our $clean = 0;
1074 our $cnt_error++;
1075 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001076}
1077sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001078 if (report("WARNING: $_[0]\n")) {
1079 our $clean = 0;
1080 our $cnt_warn++;
1081 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001082}
1083sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001084 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001085 our $clean = 0;
1086 our $cnt_chk++;
1087 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001088}
1089
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001090sub check_absolute_file {
1091 my ($absolute, $herecurr) = @_;
1092 my $file = $absolute;
1093
1094 ##print "absolute<$absolute>\n";
1095
1096 # See if any suffix of this path is a path within the tree.
1097 while ($file =~ s@^[^/]*/@@) {
1098 if (-f "$root/$file") {
1099 ##print "file<$file>\n";
1100 last;
1101 }
1102 }
1103 if (! -f _) {
1104 return 0;
1105 }
1106
1107 # It is, so see if the prefix is acceptable.
1108 my $prefix = $absolute;
1109 substr($prefix, -length($file)) = '';
1110
1111 ##print "prefix<$prefix>\n";
1112 if ($prefix ne ".../") {
1113 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1114 }
1115}
1116
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001117sub process {
1118 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001119
1120 my $linenr=0;
1121 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001122 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001123 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001124 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001125
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001126 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001127 my $indent;
1128 my $previndent=0;
1129 my $stashindent=0;
1130
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001131 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001132 my $signoff = 0;
1133 my $is_patch = 0;
1134
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001135 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001136 our $cnt_lines = 0;
1137 our $cnt_error = 0;
1138 our $cnt_warn = 0;
1139 our $cnt_chk = 0;
1140
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001141 # Trace the real file/line as we go.
1142 my $realfile = '';
1143 my $realline = 0;
1144 my $realcnt = 0;
1145 my $here = '';
1146 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001147 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001148 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001149 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001150
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001151 my $prev_values = 'E';
1152
1153 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001154 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001155 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001156 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001157
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001158 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001159 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001160 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001161 my @setup_docs = ();
1162 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001163
1164 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001165 my $line;
1166 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001167 $linenr++;
1168 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001169
Andy Whitcroft773647a2008-03-28 14:15:58 -07001170 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001171 $setup_docs = 0;
1172 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1173 $setup_docs = 1;
1174 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001175 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001176 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001177 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1178 $realline=$1-1;
1179 if (defined $2) {
1180 $realcnt=$3+1;
1181 } else {
1182 $realcnt=1+1;
1183 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001184 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001185
1186 # Guestimate if this is a continuing comment. Run
1187 # the context looking for a comment "edge". If this
1188 # edge is a close comment then we must be in a comment
1189 # at context start.
1190 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001191 my $cnt = $realcnt;
1192 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1193 next if (defined $rawlines[$ln - 1] &&
1194 $rawlines[$ln - 1] =~ /^-/);
1195 $cnt--;
1196 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001197 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001198 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1199 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1200 ($edge) = $1;
1201 last;
1202 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001203 }
1204 if (defined $edge && $edge eq '*/') {
1205 $in_comment = 1;
1206 }
1207
1208 # Guestimate if this is a continuing comment. If this
1209 # is the start of a diff block and this line starts
1210 # ' *' then it is very likely a comment.
1211 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001212 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001213 {
1214 $in_comment = 1;
1215 }
1216
1217 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1218 sanitise_line_reset($in_comment);
1219
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001220 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001221 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001222 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001223 $line = sanitise_line($rawline);
1224 }
1225 push(@lines, $line);
1226
1227 if ($realcnt > 1) {
1228 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1229 } else {
1230 $realcnt = 0;
1231 }
1232
1233 #print "==>$rawline\n";
1234 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001235
1236 if ($setup_docs && $line =~ /^\+/) {
1237 push(@setup_docs, $line);
1238 }
1239 }
1240
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001241 $prefix = '';
1242
Andy Whitcroft773647a2008-03-28 14:15:58 -07001243 $realcnt = 0;
1244 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001245 foreach my $line (@lines) {
1246 $linenr++;
1247
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001248 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001249
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001250#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001251 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001252 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001253 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001254 $realline=$1-1;
1255 if (defined $2) {
1256 $realcnt=$3+1;
1257 } else {
1258 $realcnt=1+1;
1259 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001260 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001261 $prev_values = 'E';
1262
Andy Whitcroft773647a2008-03-28 14:15:58 -07001263 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001264 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001265 %suppress_export = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001266 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001267
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001268# track the line number as we move through the hunk, note that
1269# new versions of GNU diff omit the leading space on completely
1270# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001271 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001272 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001273 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001274
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001275 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001276 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001277
1278 # Track the previous line.
1279 ($prevline, $stashline) = ($stashline, $line);
1280 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001281 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1282
Andy Whitcroft773647a2008-03-28 14:15:58 -07001283 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001284
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001285 } elsif ($realcnt == 1) {
1286 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001287 }
1288
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001289 my $hunk_line = ($realcnt != 0);
1290
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001291#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001292 $prefix = "$filename:$realline: " if ($emacs && $file);
1293 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1294
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001295 $here = "#$linenr: " if (!$file);
1296 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001297
1298 # extract the filename as it passes
1299 if ($line=~/^\+\+\+\s+(\S+)/) {
1300 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001301 $realfile =~ s@^([^/]*)/@@;
1302
1303 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001304 if (!$file && $tree && $p1_prefix ne '' &&
1305 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001306 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1307 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001308
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001309 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001310 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1311 }
1312 next;
1313 }
1314
Randy Dunlap389834b2007-06-08 13:47:03 -07001315 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001316
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001317 my $hereline = "$here\n$rawline\n";
1318 my $herecurr = "$here\n$rawline\n";
1319 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001320
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001321 $cnt_lines++ if ($realcnt != 0);
1322
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001323#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001324 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001325 # This is a signoff, if ugly, so do not double report.
1326 $signoff++;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001327 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001328 WARN("Signed-off-by: is the preferred form\n" .
1329 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001330 }
1331 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001332 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001333 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001334 }
1335 }
1336
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001337# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001338 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001339 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001340 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001341 }
1342
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001343# Check for absolute kernel paths.
1344 if ($tree) {
1345 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1346 my $file = $1;
1347
1348 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1349 check_absolute_file($1, $herecurr)) {
1350 #
1351 } else {
1352 check_absolute_file($file, $herecurr);
1353 }
1354 }
1355 }
1356
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001357# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1358 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001359 $rawline !~ m/^$UTF8*$/) {
1360 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1361
1362 my $blank = copy_spacing($rawline);
1363 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1364 my $hereptr = "$hereline$ptr\n";
1365
1366 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001367 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001368
Andy Whitcroft306708542008-10-15 22:02:28 -07001369# ignore non-hunk lines and lines being removed
1370 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001371
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001372#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001373 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001375 ERROR("DOS line endings\n" . $herevet);
1376
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001377 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1378 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001379 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001380 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001381
1382# check we are in a valid source file if not then ignore this hunk
1383 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1384
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001385#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001386 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001387 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches691e6692010-03-05 13:43:51 -08001388 $line !~ /^\+\s*$logFunctions\s*\(\s*(?:KERN_\S+\s*)?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001389 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001390 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001391 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001392 }
1393
Andy Whitcroft8905a672007-11-28 16:21:06 -08001394# check for adding lines without a newline.
1395 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1396 WARN("adding a line without newline at end of file\n" . $herecurr);
1397 }
1398
Mike Frysinger42e41c52009-09-21 17:04:40 -07001399# Blackfin: use hi/lo macros
1400 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1401 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1402 my $herevet = "$here\n" . cat_vet($line) . "\n";
1403 ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1404 }
1405 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1406 my $herevet = "$here\n" . cat_vet($line) . "\n";
1407 ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
1408 }
1409 }
1410
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001411# check we are in a valid source file C or perl if not then ignore this hunk
1412 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001413
1414# at the beginning of a line any tabs must come first and anything
1415# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001416 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1417 $rawline =~ /^\+\s* \s*/) {
1418 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001419 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001420 }
1421
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001422# check we are in a valid C source file if not then ignore this hunk
1423 next if ($realfile !~ /\.(h|c)$/);
1424
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001425# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001426 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001427 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1428 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001429
Mike Frysinger42e41c52009-09-21 17:04:40 -07001430# Blackfin: don't use __builtin_bfin_[cs]sync
1431 if ($line =~ /__builtin_bfin_csync/) {
1432 my $herevet = "$here\n" . cat_vet($line) . "\n";
1433 ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1434 }
1435 if ($line =~ /__builtin_bfin_ssync/) {
1436 my $herevet = "$here\n" . cat_vet($line) . "\n";
1437 ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1438 }
1439
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001440# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001441 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1442 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001443 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001444 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001445 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001446 $stat =~ s/\n./\n /g;
1447 $cond =~ s/\n./\n /g;
1448
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001449 # Find the real next line.
1450 $realline_next = $line_nr_next;
1451 if (defined $realline_next &&
1452 (!defined $lines[$realline_next - 1] ||
1453 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1454 $realline_next++;
1455 }
1456
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001457 my $s = $stat;
1458 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001459
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001460 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001461 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001462
1463 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001464 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001465
Andy Whitcroft463f2862009-09-21 17:04:34 -07001466 } elsif ($s =~ /^.\s*else\b/s) {
1467
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001468 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001469 } 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 Whitcroftc45dcab2008-06-05 22:46:01 -07001470 my $type = $1;
1471 $type =~ s/\s+/ /g;
1472 possible($type, "A:" . $s);
1473
Andy Whitcroft8905a672007-11-28 16:21:06 -08001474 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001475 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001476 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001477 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001478
1479 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001480 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001481 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001482 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001483
1484 # Check for any sort of function declaration.
1485 # int foo(something bar, other baz);
1486 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001487 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001488 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001489
Andy Whitcroftcf655042008-03-04 14:28:20 -08001490 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001491 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001492 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001493
Andy Whitcroft8905a672007-11-28 16:21:06 -08001494 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001495 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001496
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001497 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001498 }
1499 }
1500 }
1501
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001502 }
1503
Andy Whitcroft653d4872007-06-23 17:16:34 -07001504#
1505# Checks which may be anchored in the context.
1506#
1507
1508# Check for switch () and associated case and default
1509# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001510 if ($line=~/\bswitch\s*\(.*\)/) {
1511 my $err = '';
1512 my $sep = '';
1513 my @ctx = ctx_block_outer($linenr, $realcnt);
1514 shift(@ctx);
1515 for my $ctx (@ctx) {
1516 my ($clen, $cindent) = line_stats($ctx);
1517 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1518 $indent != $cindent) {
1519 $err .= "$sep$ctx\n";
1520 $sep = '';
1521 } else {
1522 $sep = "[...]\n";
1523 }
1524 }
1525 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001526 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001527 }
1528 }
1529
1530# if/while/etc brace do not go on next line, unless defining a do while loop,
1531# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001532 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001533 my $pre_ctx = "$1$2";
1534
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001535 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001536 my $ctx_cnt = $realcnt - $#ctx - 1;
1537 my $ctx = join("\n", @ctx);
1538
Andy Whitcroft548596d2008-07-23 21:29:01 -07001539 my $ctx_ln = $linenr;
1540 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001541
Andy Whitcroft548596d2008-07-23 21:29:01 -07001542 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1543 defined $lines[$ctx_ln - 1] &&
1544 $lines[$ctx_ln - 1] =~ /^-/)) {
1545 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1546 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001547 $ctx_ln++;
1548 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001549
Andy Whitcroft53210162008-07-23 21:29:03 -07001550 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1551 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001552
1553 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1554 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001555 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001556 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001557 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1558 $ctx =~ /\)\s*\;\s*$/ &&
1559 defined $lines[$ctx_ln - 1])
1560 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001561 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1562 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001563 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001564 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001565 }
1566 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001567 }
1568
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001569# Check relative indent for conditionals and blocks.
1570 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1571 my ($s, $c) = ($stat, $cond);
1572
1573 substr($s, 0, length($c), '');
1574
1575 # Make sure we remove the line prefixes as we have
1576 # none on the first line, and are going to readd them
1577 # where necessary.
1578 $s =~ s/\n./\n/gs;
1579
1580 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001581 my @newlines = ($c =~ /\n/gs);
1582 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001583
1584 # We want to check the first line inside the block
1585 # starting at the end of the conditional, so remove:
1586 # 1) any blank line termination
1587 # 2) any opening brace { on end of the line
1588 # 3) any do (...) {
1589 my $continuation = 0;
1590 my $check = 0;
1591 $s =~ s/^.*\bdo\b//;
1592 $s =~ s/^\s*{//;
1593 if ($s =~ s/^\s*\\//) {
1594 $continuation = 1;
1595 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001596 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001597 $check = 1;
1598 $cond_lines++;
1599 }
1600
1601 # Also ignore a loop construct at the end of a
1602 # preprocessor statement.
1603 if (($prevline =~ /^.\s*#\s*define\s/ ||
1604 $prevline =~ /\\\s*$/) && $continuation == 0) {
1605 $check = 0;
1606 }
1607
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001608 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001609 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001610 while ($cond_ptr != $cond_lines) {
1611 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001612
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001613 # If we see an #else/#elif then the code
1614 # is not linear.
1615 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1616 $check = 0;
1617 }
1618
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001619 # Ignore:
1620 # 1) blank lines, they should be at 0,
1621 # 2) preprocessor lines, and
1622 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001623 if ($continuation ||
1624 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001625 $s =~ /^\s*#\s*?/ ||
1626 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001627 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001628 if ($s =~ s/^.*?\n//) {
1629 $cond_lines++;
1630 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001631 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001632 }
1633
1634 my (undef, $sindent) = line_stats("+" . $s);
1635 my $stat_real = raw_line($linenr, $cond_lines);
1636
1637 # Check if either of these lines are modified, else
1638 # this is not this patch's fault.
1639 if (!defined($stat_real) ||
1640 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1641 $check = 0;
1642 }
1643 if (defined($stat_real) && $cond_lines > 1) {
1644 $stat_real = "[...]\n$stat_real";
1645 }
1646
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001647 #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 Whitcroft4d001e42008-10-15 22:02:21 -07001648
1649 if ($check && (($sindent % 8) != 0 ||
1650 ($sindent <= $indent && $s ne ''))) {
1651 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1652 }
1653 }
1654
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001655 # Track the 'values' across context and added lines.
1656 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001657 my ($curr_values, $curr_vars) =
1658 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001659 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001660 if ($dbg_values) {
1661 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001662 print "$linenr > .$outline\n";
1663 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001664 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001665 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001666 $prev_values = substr($curr_values, -1);
1667
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001668#ignore lines not being added
1669 if ($line=~/^[^\+]/) {next;}
1670
Andy Whitcroft653d4872007-06-23 17:16:34 -07001671# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001672 if ($dbg_type) {
1673 if ($line =~ /^.\s*$Declare\s*$/) {
1674 ERROR("TEST: is type\n" . $herecurr);
1675 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1676 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1677 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001678 next;
1679 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001680# TEST: allow direct testing of the attribute matcher.
1681 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001682 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001683 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001684 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001685 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1686 }
1687 next;
1688 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001689
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001690# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07001691 if ($line =~ /^.\s*{/ &&
1692 $prevline =~ /(?:^|[^=])=\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001693 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001694 }
1695
Andy Whitcroft653d4872007-06-23 17:16:34 -07001696#
1697# Checks which are anchored on the added line.
1698#
1699
1700# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001701 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001702 my $path = $1;
1703 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001704 ERROR("malformed #include filename\n" .
1705 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001706 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001707 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001708
1709# no C99 // comments
1710 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001711 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001712 }
1713 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001714 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001715 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001716
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001717# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1718# the whole statement.
1719#print "APW <$lines[$realline_next - 1]>\n";
1720 if (defined $realline_next &&
1721 exists $lines[$realline_next - 1] &&
1722 !defined $suppress_export{$realline_next} &&
1723 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1724 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001725 my $name = $1;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001726 if ($stat !~ /(?:
1727 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07001728 ^.DEFINE_$Ident\(\Q$name\E\)|
1729 ^.DECLARE_$Ident\(\Q$name\E\)|
1730 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001731 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1732 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07001733 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001734#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1735 $suppress_export{$realline_next} = 2;
1736 } else {
1737 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001738 }
1739 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001740 if (!defined $suppress_export{$linenr} &&
1741 $prevline =~ /^.\s*$/ &&
1742 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1743 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1744#print "FOO B <$lines[$linenr - 1]>\n";
1745 $suppress_export{$linenr} = 2;
1746 }
1747 if (defined $suppress_export{$linenr} &&
1748 $suppress_export{$linenr} == 2) {
1749 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1750 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001751
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001752# check for external initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001753 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001754 ERROR("do not initialise externals to 0 or NULL\n" .
1755 $herecurr);
1756 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001757# check for static initialisers.
Andy Whitcroft2d1bafd2009-01-06 14:41:28 -08001758 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001759 ERROR("do not initialise statics to 0 or NULL\n" .
1760 $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001761 }
1762
Andy Whitcroft653d4872007-06-23 17:16:34 -07001763# check for new typedefs, only function parameters and sparse annotations
1764# make sense.
1765 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001766 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001767 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001768 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001769 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001770 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001771 }
1772
1773# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001774 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001775 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001776 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001777
Andy Whitcroft65863862009-01-06 14:41:21 -08001778 # Should start with a space.
1779 $to =~ s/^(\S)/ $1/;
1780 # Should not end with a space.
1781 $to =~ s/\s+$//;
1782 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001783 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001784 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001785
Andy Whitcroft65863862009-01-06 14:41:21 -08001786 #print "from<$from> to<$to>\n";
1787 if ($from ne $to) {
1788 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1789 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001790 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001791 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001792
Andy Whitcroft65863862009-01-06 14:41:21 -08001793 # Should start with a space.
1794 $to =~ s/^(\S)/ $1/;
1795 # Should not end with a space.
1796 $to =~ s/\s+$//;
1797 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001798 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001799 }
1800 # Modifiers should have spaces.
1801 $to =~ s/(\b$Modifier$)/$1 /;
1802
Andy Whitcroft667026e2009-02-27 14:03:08 -08001803 #print "from<$from> to<$to> ident<$ident>\n";
1804 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001805 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1806 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001807 }
1808
1809# # no BUG() or BUG_ON()
1810# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1811# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1812# print "$herecurr";
1813# $clean = 0;
1814# }
1815
Andy Whitcroft8905a672007-11-28 16:21:06 -08001816 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001817 WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001818 }
1819
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001820# printk should use KERN_* levels. Note that follow on printk's on the
1821# same line do not need a level, so we use the current block context
1822# to try and find and validate the current printk. In summary the current
1823# printk includes all preceeding printk's which have no newline on the end.
1824# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001825 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001826 my $ok = 0;
1827 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1828 #print "CHECK<$lines[$ln - 1]\n";
1829 # we have a preceeding printk if it ends
1830 # with "\n" ignore it, else it is to blame
1831 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1832 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1833 $ok = 1;
1834 }
1835 last;
1836 }
1837 }
1838 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001839 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001840 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001841 }
1842
Andy Whitcroft653d4872007-06-23 17:16:34 -07001843# function brace can't be on same line, except for #defines of do while,
1844# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001845 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1846 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001847 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001848 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001849
Andy Whitcroft8905a672007-11-28 16:21:06 -08001850# open braces for enum, union and struct go on the same line.
1851 if ($line =~ /^.\s*{/ &&
1852 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1853 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1854 }
1855
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001856# check for spacing round square brackets; allowed:
1857# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001858# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1859# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001860 while ($line =~ /(.*?\s)\[/g) {
1861 my ($where, $prefix) = ($-[1], $1);
1862 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001863 ($where != 0 || $prefix !~ /^.\s+$/) &&
1864 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001865 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1866 }
1867 }
1868
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001869# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001870 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001871 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001872 my $ctx_before = substr($line, 0, $-[1]);
1873 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001874
1875 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001876 if ($name =~ /^(?:
1877 if|for|while|switch|return|case|
1878 volatile|__volatile__|
1879 __attribute__|format|__extension__|
1880 asm|__asm__)$/x)
1881 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001882
1883 # cpp #define statements have non-optional spaces, ie
1884 # if there is a space between the name and the open
1885 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001886 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001887
1888 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001889 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001890
1891 # If this whole things ends with a type its most
1892 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001893 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001894
1895 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001896 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001897 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001898 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001899# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001900 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001901 my $ops = qr{
1902 <<=|>>=|<=|>=|==|!=|
1903 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1904 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001905 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1906 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001907 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001908 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001909 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001910
1911 my $blank = copy_spacing($opline);
1912
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001913 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001914 $off += length($elements[$n]);
1915
Andy Whitcroft773647a2008-03-28 14:15:58 -07001916 # Pick up the preceeding and succeeding characters.
1917 my $ca = substr($opline, 0, $off);
1918 my $cc = '';
1919 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1920 $cc = substr($opline, $off + length($elements[$n + 1]));
1921 }
1922 my $cb = "$ca$;$cc";
1923
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001924 my $a = '';
1925 $a = 'V' if ($elements[$n] ne '');
1926 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001927 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001928 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1929 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001930 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001931
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001932 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001933
1934 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001935 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001936 $c = 'V' if ($elements[$n + 2] ne '');
1937 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001938 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001939 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1940 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001941 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001942 } else {
1943 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001944 }
1945
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001946 my $ctx = "${a}x${c}";
1947
1948 my $at = "(ctx:$ctx)";
1949
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001950 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001951 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001952
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001953 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001954 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001955
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001956 # Get the full operator variant.
1957 my $opv = $op . substr($curr_vars, $off, 1);
1958
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001959 # Ignore operators passed as parameters.
1960 if ($op_type ne 'V' &&
1961 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1962
Andy Whitcroftcf655042008-03-04 14:28:20 -08001963# # Ignore comments
1964# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001965
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001966 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001967 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001968 if ($ctx !~ /.x[WEBC]/ &&
1969 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001970 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001971 }
1972
1973 # // is a comment
1974 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001975
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001976 # No spaces for:
1977 # ->
1978 # : when part of a bitfield
1979 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001980 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001981 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001982 }
1983
1984 # , must have a space on the right.
1985 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001986 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001987 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001988 }
1989
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001990 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001991 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001992 #warn "'*' is part of type\n";
1993
1994 # unary operators should have a space before and
1995 # none after. May be left adjacent to another
1996 # unary operator, or a cast
1997 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001998 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07001999 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002000 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002001 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002002 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002003 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002004 # A unary '*' may be const
2005
2006 } elsif ($ctx =~ /.xW/) {
Andy Whitcroftfb9e9092009-09-21 17:04:38 -07002007 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002008 }
2009
2010 # unary ++ and unary -- are allowed no space on one side.
2011 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002012 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2013 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002014 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002015 if ($ctx =~ /Wx[BE]/ ||
2016 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2017 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002018 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002019 if ($ctx =~ /ExW/) {
2020 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2021 }
2022
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002023
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002024 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002025 } elsif ($op eq '<<' or $op eq '>>' or
2026 $op eq '&' or $op eq '^' or $op eq '|' or
2027 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002028 $op eq '*' or $op eq '/' or
2029 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002030 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002031 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002032 ERROR("need consistent spacing around '$op' $at\n" .
2033 $hereptr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002034 }
2035
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002036 # A colon needs no spaces before when it is
2037 # terminating a case value or a label.
2038 } elsif ($opv eq ':C' || $opv eq ':L') {
2039 if ($ctx =~ /Wx./) {
2040 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2041 }
2042
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002043 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002044 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002045 my $ok = 0;
2046
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002047 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002048 if (($op eq '<' &&
2049 $cc =~ /^\S+\@\S+>/) ||
2050 ($op eq '>' &&
2051 $ca =~ /<\S+\@\S+$/))
2052 {
2053 $ok = 1;
2054 }
2055
2056 # Ignore ?:
2057 if (($opv eq ':O' && $ca =~ /\?$/) ||
2058 ($op eq '?' && $cc =~ /^:/)) {
2059 $ok = 1;
2060 }
2061
2062 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002063 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002064 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002065 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002066 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002067 }
2068 }
2069
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002070# check for multiple assignments
2071 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002072 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002073 }
2074
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002075## # check for multiple declarations, allowing for a function declaration
2076## # continuation.
2077## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2078## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2079##
2080## # Remove any bracketed sections to ensure we do not
2081## # falsly report the parameters of functions.
2082## my $ln = $line;
2083## while ($ln =~ s/\([^\(\)]*\)//g) {
2084## }
2085## if ($ln =~ /,/) {
2086## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2087## }
2088## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002089
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002090#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002091 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2092 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002093 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002094 }
2095
2096# closing brace should have a space following it when it has anything
2097# on the line
2098 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002099 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002100 }
2101
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002102# check spacing on square brackets
2103 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002104 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002105 }
2106 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002107 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002108 }
2109
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002110# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002111 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2112 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002113 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002114 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002115 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002116 $line !~ /for\s*\(.*;\s+\)/ &&
2117 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002118 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002119 }
2120
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002121#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002122 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002123 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002124 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002125 }
2126
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002127# Return is not a function.
2128 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2129 my $spacing = $1;
2130 my $value = $2;
2131
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002132 # Flatten any parentheses
Andy Whitcroftfee61c42008-07-23 21:28:56 -07002133 $value =~ s/\)\(/\) \(/g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002134 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2135 $value !~ /(?:$Ident|-?$Constant)\s*
2136 $Compare\s*
2137 (?:$Ident|-?$Constant)/x &&
2138 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002139 }
2140
2141 if ($value =~ /^(?:$Ident|-?$Constant)$/) {
2142 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2143
2144 } elsif ($spacing !~ /\s+/) {
2145 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2146 }
2147 }
2148
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002149# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002150 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002151 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002152 }
2153
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002154# Check for illegal assignment in if conditional -- and check for trailing
2155# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002156 if ($line =~ /do\s*(?!{)/) {
2157 my ($stat_next) = ctx_statement_block($line_nr_next,
2158 $remain_next, $off_next);
2159 $stat_next =~ s/\n./\n /g;
2160 ##print "stat<$stat> stat_next<$stat_next>\n";
2161
2162 if ($stat_next =~ /^\s*while\b/) {
2163 # If the statement carries leading newlines,
2164 # then count those as offsets.
2165 my ($whitespace) =
2166 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2167 my $offset =
2168 statement_rawlines($whitespace) - 1;
2169
2170 $suppress_whiletrailers{$line_nr_next +
2171 $offset} = 1;
2172 }
2173 }
2174 if (!defined $suppress_whiletrailers{$linenr} &&
2175 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002176 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002177
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002178 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002179 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002180 }
2181
2182 # Find out what is on the end of the line after the
2183 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002184 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002185 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002186 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002187 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2188 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002189 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002190 # Find out how long the conditional actually is.
2191 my @newlines = ($c =~ /\n/gs);
2192 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002193 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002194
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002195 $stat_real = raw_line($linenr, $cond_lines)
2196 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002197 if (defined($stat_real) && $cond_lines > 1) {
2198 $stat_real = "[...]\n$stat_real";
2199 }
2200
2201 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002202 }
2203 }
2204
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002205# Check for bitwise tests written as boolean
2206 if ($line =~ /
2207 (?:
2208 (?:\[|\(|\&\&|\|\|)
2209 \s*0[xX][0-9]+\s*
2210 (?:\&\&|\|\|)
2211 |
2212 (?:\&\&|\|\|)
2213 \s*0[xX][0-9]+\s*
2214 (?:\&\&|\|\||\)|\])
2215 )/x)
2216 {
2217 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2218 }
2219
Andy Whitcroft8905a672007-11-28 16:21:06 -08002220# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002221 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2222 my $s = $1;
2223 $s =~ s/$;//g; # Remove any comments
2224 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2225 ERROR("trailing statements should be on next line\n" . $herecurr);
2226 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002227 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002228# if should not continue a brace
2229 if ($line =~ /}\s*if\b/) {
2230 ERROR("trailing statements should be on next line\n" .
2231 $herecurr);
2232 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002233# case and default should not have general statements after them
2234 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2235 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002236 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002237 \s*return\s+
2238 )/xg)
2239 {
2240 ERROR("trailing statements should be on next line\n" . $herecurr);
2241 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002242
2243 # Check for }<nl>else {, these must be at the same
2244 # indent level to be relevant to each other.
2245 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2246 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002247 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002248 }
2249
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002250 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2251 $previndent == $indent) {
2252 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2253
2254 # Find out what is on the end of the line after the
2255 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002256 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002257 $s =~ s/\n.*//g;
2258
2259 if ($s =~ /^\s*;/) {
2260 ERROR("while should follow close brace '}'\n" . $hereprev);
2261 }
2262 }
2263
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002264#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2265# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2266# print "No studly caps, use _\n";
2267# print "$herecurr";
2268# $clean = 0;
2269# }
2270
2271#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002272 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002273 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002274 }
2275
Andy Whitcroft653d4872007-06-23 17:16:34 -07002276#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002277 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002278 my $file = "$1.h";
2279 my $checkfile = "include/linux/$file";
2280 if (-f "$root/$checkfile" &&
2281 $realfile ne $checkfile &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002282 $1 ne 'irq')
2283 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002284 if ($realfile =~ m{^arch/}) {
2285 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2286 } else {
2287 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2288 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002289 }
2290 }
2291
Andy Whitcroft653d4872007-06-23 17:16:34 -07002292# multi-statement macros should be enclosed in a do while loop, grab the
2293# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002294# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07002295 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2296 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002297 my $ln = $linenr;
2298 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002299 my ($off, $dstat, $dcond, $rest);
2300 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002301
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002302 my $args = defined($1);
2303
2304 # Find the end of the macro and limit our statement
2305 # search to that.
2306 while ($cnt > 0 && defined $lines[$ln - 1] &&
2307 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2308 {
2309 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002310 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002311 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002312 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002313 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002314
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002315 ($dstat, $dcond, $ln, $cnt, $off) =
2316 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2317 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002318 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002319
2320 # Extract the remainder of the define (if any) and
2321 # rip off surrounding spaces, and trailing \'s.
2322 $rest = '';
Andy Whitcroft636d140a2008-10-15 22:02:18 -07002323 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2324 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002325 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2326 $rest .= substr($lines[$ln - 1], $off) . "\n";
2327 $cnt--;
2328 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002329 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002330 $off = 0;
2331 }
2332 $rest =~ s/\\\n.//g;
2333 $rest =~ s/^\s*//s;
2334 $rest =~ s/\s*$//s;
2335
2336 # Clean up the original statement.
2337 if ($args) {
2338 substr($dstat, 0, length($dcond), '');
2339 } else {
2340 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2341 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002342 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002343 $dstat =~ s/\\\n.//g;
2344 $dstat =~ s/^\s*//s;
2345 $dstat =~ s/\s*$//s;
2346
2347 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002348 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2349 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2350 $dstat =~ s/\[[^\{\}]*\]/1/)
2351 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002352 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002353
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002354 my $exceptions = qr{
2355 $Declare|
2356 module_param_named|
2357 MODULE_PARAM_DESC|
2358 DECLARE_PER_CPU|
2359 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002360 __typeof__\(|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002361 \.$Ident\s*=\s*|
2362 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002363 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002364 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002365 if ($rest ne '') {
2366 if ($rest !~ /while\s*\(/ &&
2367 $dstat !~ /$exceptions/)
2368 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002369 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002370 }
2371
2372 } elsif ($ctx !~ /;/) {
2373 if ($dstat ne '' &&
2374 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2375 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002376 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002377 $dstat =~ /$Operators/)
2378 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002379 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002380 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002381 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002382 }
2383
Mike Frysinger080ba922009-01-06 14:41:25 -08002384# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2385# all assignments may have only one of the following with an assignment:
2386# .
2387# ALIGN(...)
2388# VMLINUX_SYMBOL(...)
2389 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2390 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2391 }
2392
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002393# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002394 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2395 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002396 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002397 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002398 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2399 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002400 my $allowed = 0;
2401 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002402 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002403 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002404 for my $chunk (@chunks) {
2405 my ($cond, $block) = @{$chunk};
2406
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 # If the condition carries leading newlines, then count those as offsets.
2408 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2409 my $offset = statement_rawlines($whitespace) - 1;
2410
2411 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2412
2413 # We have looked at and allowed this specific line.
2414 $suppress_ifbraces{$ln + $offset} = 1;
2415
2416 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002417 $ln += statement_rawlines($block) - 1;
2418
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002420
2421 $seen++ if ($block =~ /^\s*{/);
2422
Andy Whitcroftcf655042008-03-04 14:28:20 -08002423 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2424 if (statement_lines($cond) > 1) {
2425 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002426 $allowed = 1;
2427 }
2428 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002429 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002430 $allowed = 1;
2431 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002432 if (statement_block_size($block) > 1) {
2433 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002434 $allowed = 1;
2435 }
2436 }
2437 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002438 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002439 }
2440 }
2441 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002442 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002443 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002444 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002445
Andy Whitcroftcf655042008-03-04 14:28:20 -08002446 # Check the pre-context.
2447 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2448 #print "APW: ALLOWED: pre<$1>\n";
2449 $allowed = 1;
2450 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002451
2452 my ($level, $endln, @chunks) =
2453 ctx_statement_full($linenr, $realcnt, $-[0]);
2454
Andy Whitcroftcf655042008-03-04 14:28:20 -08002455 # Check the condition.
2456 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002457 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002458 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002459 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002460 }
2461 if (statement_lines($cond) > 1) {
2462 #print "APW: ALLOWED: cond<$cond>\n";
2463 $allowed = 1;
2464 }
2465 if ($block =~/\b(?:if|for|while)\b/) {
2466 #print "APW: ALLOWED: block<$block>\n";
2467 $allowed = 1;
2468 }
2469 if (statement_block_size($block) > 1) {
2470 #print "APW: ALLOWED: lines block<$block>\n";
2471 $allowed = 1;
2472 }
2473 # Check the post-context.
2474 if (defined $chunks[1]) {
2475 my ($cond, $block) = @{$chunks[1]};
2476 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002477 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002478 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002479 if ($block =~ /^\s*\{/) {
2480 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2481 $allowed = 1;
2482 }
2483 }
2484 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2485 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002486 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002487
Andy Whitcroftf0556632008-10-15 22:02:23 -07002488 for (my $n = 0; $n < $cnt; $n++) {
2489 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002490 }
2491
2492 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002493 }
2494 }
2495
Andy Whitcroft653d4872007-06-23 17:16:34 -07002496# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002497 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002498 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002499 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002500 }
2501 }
2502
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002503# don't use deprecated functions
2504 for my $func (@dep_functions) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002505 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002506 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002507 }
2508 }
2509
2510# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002511 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2512 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002513 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002514 }
2515
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002516# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2517 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2518 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2519 }
2520
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002521# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002522 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002523 CHK("if this code is redundant consider removing it\n" .
2524 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002525 }
2526
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002527# check for needless kfree() checks
2528 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2529 my $expr = $1;
2530 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002531 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002532 }
2533 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002534# check for needless usb_free_urb() checks
2535 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2536 my $expr = $1;
2537 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2538 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2539 }
2540 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002541
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002542# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002543# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002544# print "#ifdef in C files should be avoided\n";
2545# print "$herecurr";
2546# $clean = 0;
2547# }
2548
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002549# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002550 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002551 ERROR("exactly one space required after that #$1\n" . $herecurr);
2552 }
2553
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002554# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002555 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2556 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002557 my $which = $1;
2558 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002559 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002560 }
2561 }
2562# check for memory barriers without a comment.
2563 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2564 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002565 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002566 }
2567 }
2568# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002569 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002570 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002571 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002572
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002573# check the location of the inline attribute, that it is between
2574# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002575 if ($line =~ /\b$Type\s+$Inline\b/ ||
2576 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002577 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2578 }
2579
Andy Whitcroft8905a672007-11-28 16:21:06 -08002580# Check for __inline__ and __inline, prefer inline
2581 if ($line =~ /\b(__inline__|__inline)\b/) {
2582 WARN("plain inline is preferred over $1\n" . $herecurr);
2583 }
2584
Joe Perches8f53a9b2010-03-05 13:43:48 -08002585# check for sizeof(&)
2586 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2587 WARN("sizeof(& should be avoided\n" . $herecurr);
2588 }
2589
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002590# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002591 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002592 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002593 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002594 my $function_name = $1;
2595 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002596
2597 my $s = $stat;
2598 if (defined $cond) {
2599 substr($s, 0, length($cond), '');
2600 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002601 if ($s =~ /^\s*;/ &&
2602 $function_name ne 'uninitialized_var')
2603 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002604 WARN("externs should be avoided in .c files\n" . $herecurr);
2605 }
2606
2607 if ($paren_space =~ /\n/) {
2608 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2609 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002610
2611 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2612 $stat =~ /^.\s*extern\s+/)
2613 {
2614 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002615 }
2616
2617# checks for new __setup's
2618 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2619 my $name = $1;
2620
2621 if (!grep(/$name/, @setup_docs)) {
2622 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2623 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002624 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002625
2626# check for pointless casting of kmalloc return
2627 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2628 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2629 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002630
2631# check for gcc specific __FUNCTION__
2632 if ($line =~ /__FUNCTION__/) {
2633 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2634 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002635
2636# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002637 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002638 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2639 }
2640# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002641 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002642 WARN("consider using a completion\n" . $herecurr);
2643 }
2644# recommend strict_strto* over simple_strto*
2645 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2646 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2647 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002648# check for __initcall(), use device_initcall() explicitly please
2649 if ($line =~ /^.\s*__initcall\s*\(/) {
2650 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2651 }
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002652# check for struct file_operations, ensure they are const.
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002653 if ($line !~ /\bconst\b/ &&
2654 $line =~ /\bstruct\s+(file_operations|seq_operations)\b/) {
2655 WARN("struct $1 should normally be const\n" .
2656 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002657 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002658
2659# use of NR_CPUS is usually wrong
2660# ignore definitions of NR_CPUS and usage to define arrays as likely right
2661 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002662 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2663 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002664 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2665 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2666 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002667 {
2668 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2669 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002670
2671# check for %L{u,d,i} in strings
2672 my $string;
2673 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2674 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002675 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002676 if ($string =~ /(?<!%)%L[udi]/) {
2677 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2678 last;
2679 }
2680 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002681
2682# whine mightly about in_atomic
2683 if ($line =~ /\bin_atomic\s*\(/) {
2684 if ($realfile =~ m@^drivers/@) {
2685 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002686 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002687 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2688 }
2689 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002690 }
2691
2692 # If we have no input at all, then there is nothing to report on
2693 # so just keep quiet.
2694 if ($#rawlines == -1) {
2695 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002696 }
2697
Andy Whitcroft8905a672007-11-28 16:21:06 -08002698 # In mailback mode only produce a report in the negative, for
2699 # things that appear to be patches.
2700 if ($mailback && ($clean == 1 || !$is_patch)) {
2701 exit(0);
2702 }
2703
2704 # This is not a patch, and we are are in 'no-patch' mode so
2705 # just keep quiet.
2706 if (!$chk_patch && !$is_patch) {
2707 exit(0);
2708 }
2709
2710 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002711 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002712 }
2713 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002714 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002715 }
2716
Andy Whitcroft8905a672007-11-28 16:21:06 -08002717 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002718 if ($summary && !($clean == 1 && $quiet == 1)) {
2719 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002720 print "total: $cnt_error errors, $cnt_warn warnings, " .
2721 (($check)? "$cnt_chk checks, " : "") .
2722 "$cnt_lines lines checked\n";
2723 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002724 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002725
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002726 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002727 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002728 }
2729 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002730 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002731 print "are false positives report them to the maintainer, see\n";
2732 print "CHECKPATCH in MAINTAINERS.\n";
2733 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002734
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002735 return $clean;
2736}