blob: bcdb54bd61a0d84ae0fc1397d149eb4b7392f873 [file] [log] [blame]
Andy Whitcroft0a920b52007-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 Whitcroft00df3442007-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 Whitcroft0a920b52007-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 Whitcroft00df3442007-06-08 13:47:06 -070011$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
Andy Whitcroft5e8d8f62009-10-26 16:50:17 -070013my $V = '0.30';
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -070066GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070067 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroftd2c0a232010-10-26 14:23:12 -0700106my $rpt_cleaners = 0;
107
Andy Whitcroft8905a672007-11-28 16:21:06 -0800108if ($terse) {
109 $emacs = 1;
110 $quiet++;
111}
112
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700113if ($tree) {
114 if (defined $root) {
115 if (!top_of_kernel_tree($root)) {
116 die "$P: $root: --root does not point at a valid tree\n";
117 }
118 } else {
119 if (top_of_kernel_tree('.')) {
120 $root = '.';
121 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
122 top_of_kernel_tree($1)) {
123 $root = $1;
124 }
125 }
126
127 if (!defined $root) {
128 print "Must be run from the top-level dir. of a kernel tree\n";
129 exit(2);
130 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700131}
132
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133my $emitted_corrupt = 0;
134
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700135our $Ident = qr{
136 [A-Za-z_][A-Za-z\d_]*
137 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
138 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700139our $Storage = qr{extern|static|asmlinkage};
140our $Sparse = qr{
141 __user|
142 __kernel|
143 __force|
144 __iomem|
145 __must_check|
146 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800147 __kprobes|
148 __ref
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700149 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800150
151# Notes to $Attribute:
152# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700153our $Attribute = qr{
154 const|
155 __read_mostly|
156 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800157 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700158 ____cacheline_aligned|
159 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800160 ____cacheline_internodealigned_in_smp|
161 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700162 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700163our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700164our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700165our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
166our $Lval = qr{$Ident(?:$Member)*};
167
168our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
169our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800170our $Compare = qr{<=|>=|==|!=|<|>};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700171our $Operators = qr{
172 <=|>=|==|!=|
173 =>|->|<<|>>|<|>|!|~|
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800174 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700175 }x;
176
Andy Whitcroft8905a672007-11-28 16:21:06 -0800177our $NonptrType;
178our $Type;
179our $Declare;
180
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700181our $UTF8 = qr {
182 [\x09\x0A\x0D\x20-\x7E] # ASCII
183 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
184 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
185 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
186 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
187 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
188 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
189 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
190}x;
191
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700192our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700193 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700194 atomic_t
195)};
196
Joe Perches691e6692010-03-05 13:43:51 -0800197our $logFunctions = qr{(?x:
198 printk|
199 pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
Joe Perches8bbea962010-08-09 17:21:01 -0700200 (dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
Joe Perches691e6692010-03-05 13:43:51 -0800201 WARN|
202 panic
203)};
204
Andy Whitcroft8905a672007-11-28 16:21:06 -0800205our @typeList = (
206 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700207 qr{(?:unsigned\s+)?char},
208 qr{(?:unsigned\s+)?short},
209 qr{(?:unsigned\s+)?int},
210 qr{(?:unsigned\s+)?long},
211 qr{(?:unsigned\s+)?long\s+int},
212 qr{(?:unsigned\s+)?long\s+long},
213 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800214 qr{unsigned},
215 qr{float},
216 qr{double},
217 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800218 qr{struct\s+$Ident},
219 qr{union\s+$Ident},
220 qr{enum\s+$Ident},
221 qr{${Ident}_t},
222 qr{${Ident}_handler},
223 qr{${Ident}_handler_fn},
224);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700225our @modifierList = (
226 qr{fastcall},
227);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800228
Wolfram Sang7840a942010-08-09 17:20:57 -0700229our $allowed_asm_includes = qr{(?x:
230 irq|
231 memory
232)};
233# memory.h: ARM has a custom one
234
Andy Whitcroft8905a672007-11-28 16:21:06 -0800235sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700236 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
237 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700238 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800239 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700240 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800241 (?:
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700242 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700243 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700244 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800245 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700246 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800247 }x;
248 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700249 $NonptrType
Andy Whitcroft65863862009-01-06 14:41:21 -0800250 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700251 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800252 }x;
253 $Declare = qr{(?:$Storage\s+)?$Type};
254}
255build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700256
257$chk_signoff = 0 if ($file);
258
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700259my @dep_includes = ();
260my @dep_functions = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261my $removal = "Documentation/feature-removal-schedule.txt";
262if ($tree && -f "$root/$removal") {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800263 open(my $REMOVE, '<', "$root/$removal") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700264 die "$P: $removal: open failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800265 while (<$REMOVE>) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700266 if (/^Check:\s+(.*\S)/) {
267 for my $entry (split(/[, ]+/, $1)) {
268 if ($entry =~ m@include/(.*)@) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700269 push(@dep_includes, $1);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700270
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700271 } elsif ($entry !~ m@/@) {
272 push(@dep_functions, $entry);
273 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700274 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700275 }
276 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800277 close($REMOVE);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700278}
279
Andy Whitcroft00df3442007-06-08 13:47:06 -0700280my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800281my @lines = ();
282my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800284 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800286 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700287 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800288 } elsif ($filename eq '-') {
289 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700290 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800291 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700292 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700293 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800294 if ($filename eq '-') {
295 $vname = 'Your patch';
296 } else {
297 $vname = $filename;
298 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800299 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700300 chomp;
301 push(@rawlines, $_);
302 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800303 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800304 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305 $exit = 1;
306 }
307 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800308 @lines = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700309}
310
311exit($exit);
312
313sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700314 my ($root) = @_;
315
316 my @tree_check = (
317 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
318 "README", "Documentation", "arch", "include", "drivers",
319 "fs", "init", "ipc", "kernel", "lib", "scripts",
320 );
321
322 foreach my $check (@tree_check) {
323 if (! -e $root . '/' . $check) {
324 return 0;
325 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700326 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700327 return 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700328}
329
330sub expand_tabs {
331 my ($str) = @_;
332
333 my $res = '';
334 my $n = 0;
335 for my $c (split(//, $str)) {
336 if ($c eq "\t") {
337 $res .= ' ';
338 $n++;
339 for (; ($n % 8) != 0; $n++) {
340 $res .= ' ';
341 }
342 next;
343 }
344 $res .= $c;
345 $n++;
346 }
347
348 return $res;
349}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700350sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700351 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700352 return $res;
353}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700354
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700355sub line_stats {
356 my ($line) = @_;
357
358 # Drop the diff line leader and expand tabs
359 $line =~ s/^.//;
360 $line = expand_tabs($line);
361
362 # Pick the indent from the front of the line.
363 my ($white) = ($line =~ /^(\s*)/);
364
365 return (length($line), length($white));
366}
367
Andy Whitcroft773647a2008-03-28 14:15:58 -0700368my $sanitise_quote = '';
369
370sub sanitise_line_reset {
371 my ($in_comment) = @_;
372
373 if ($in_comment) {
374 $sanitise_quote = '*/';
375 } else {
376 $sanitise_quote = '';
377 }
378}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700379sub sanitise_line {
380 my ($line) = @_;
381
382 my $res = '';
383 my $l = '';
384
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800385 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700386 my $off = 0;
387 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700388
Andy Whitcroft773647a2008-03-28 14:15:58 -0700389 # Always copy over the diff marker.
390 $res = substr($line, 0, 1);
391
392 for ($off = 1; $off < length($line); $off++) {
393 $c = substr($line, $off, 1);
394
395 # Comments we are wacking completly including the begin
396 # and end, all to $;.
397 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
398 $sanitise_quote = '*/';
399
400 substr($res, $off, 2, "$;$;");
401 $off++;
402 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800403 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700404 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700405 $sanitise_quote = '';
406 substr($res, $off, 2, "$;$;");
407 $off++;
408 next;
409 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700410 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
411 $sanitise_quote = '//';
412
413 substr($res, $off, 2, $sanitise_quote);
414 $off++;
415 next;
416 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700417
418 # A \ in a string means ignore the next character.
419 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
420 $c eq "\\") {
421 substr($res, $off, 2, 'XX');
422 $off++;
423 next;
424 }
425 # Regular quotes.
426 if ($c eq "'" || $c eq '"') {
427 if ($sanitise_quote eq '') {
428 $sanitise_quote = $c;
429
430 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700431 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700432 } elsif ($sanitise_quote eq $c) {
433 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700434 }
435 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700436
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800437 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700438 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
439 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700440 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
441 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700442 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
443 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700444 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700445 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700446 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800447 }
448
Daniel Walker113f04a2009-09-21 17:04:35 -0700449 if ($sanitise_quote eq '//') {
450 $sanitise_quote = '';
451 }
452
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800453 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700454 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800455 my $clean = 'X' x length($1);
456 $res =~ s@\<.*\>@<$clean>@;
457
458 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700459 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800460 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700461 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800462 }
463
Andy Whitcroft00df3442007-06-08 13:47:06 -0700464 return $res;
465}
466
Andy Whitcroft8905a672007-11-28 16:21:06 -0800467sub ctx_statement_block {
468 my ($linenr, $remain, $off) = @_;
469 my $line = $linenr - 1;
470 my $blk = '';
471 my $soff = $off;
472 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700473 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800474
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800475 my $loff = 0;
476
Andy Whitcroft8905a672007-11-28 16:21:06 -0800477 my $type = '';
478 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800479 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800480 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800481 my $c;
482 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800483
484 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800486 @stack = (['', 0]) if ($#stack == -1);
487
Andy Whitcroft773647a2008-03-28 14:15:58 -0700488 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800489 # If we are about to drop off the end, pull in more
490 # context.
491 if ($off >= $len) {
492 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700493 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800494 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800495 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800496 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800497 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800498 $len = length($blk);
499 $line++;
500 last;
501 }
502 # Bail if there is no further context.
503 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800504 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800505 last;
506 }
507 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800508 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800509 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800510 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800511
Andy Whitcroft773647a2008-03-28 14:15:58 -0700512 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800513
514 # Handle nested #if/#else.
515 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
516 push(@stack, [ $type, $level ]);
517 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
518 ($type, $level) = @{$stack[$#stack - 1]};
519 } elsif ($remainder =~ /^#\s*endif\b/) {
520 ($type, $level) = @{pop(@stack)};
521 }
522
Andy Whitcroft8905a672007-11-28 16:21:06 -0800523 # Statement ends at the ';' or a close '}' at the
524 # outermost level.
525 if ($level == 0 && $c eq ';') {
526 last;
527 }
528
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800529 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700530 if ($level == 0 && $coff_set == 0 &&
531 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
532 $remainder =~ /^(else)(?:\s|{)/ &&
533 $remainder !~ /^else\s+if\b/) {
534 $coff = $off + length($1) - 1;
535 $coff_set = 1;
536 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
537 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800538 }
539
Andy Whitcroft8905a672007-11-28 16:21:06 -0800540 if (($type eq '' || $type eq '(') && $c eq '(') {
541 $level++;
542 $type = '(';
543 }
544 if ($type eq '(' && $c eq ')') {
545 $level--;
546 $type = ($level != 0)? '(' : '';
547
548 if ($level == 0 && $coff < $soff) {
549 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700550 $coff_set = 1;
551 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800552 }
553 }
554 if (($type eq '' || $type eq '{') && $c eq '{') {
555 $level++;
556 $type = '{';
557 }
558 if ($type eq '{' && $c eq '}') {
559 $level--;
560 $type = ($level != 0)? '{' : '';
561
562 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700563 if (substr($blk, $off + 1, 1) eq ';') {
564 $off++;
565 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800566 last;
567 }
568 }
569 $off++;
570 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700571 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800572 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700573 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800574 $line++;
575 $remain--;
576 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800577
578 my $statement = substr($blk, $soff, $off - $soff + 1);
579 my $condition = substr($blk, $soff, $coff - $soff + 1);
580
581 #warn "STATEMENT<$statement>\n";
582 #warn "CONDITION<$condition>\n";
583
Andy Whitcroft773647a2008-03-28 14:15:58 -0700584 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800585
586 return ($statement, $condition,
587 $line, $remain + 1, $off - $loff + 1, $level);
588}
589
Andy Whitcroftcf655042008-03-04 14:28:20 -0800590sub statement_lines {
591 my ($stmt) = @_;
592
593 # Strip the diff line prefixes and rip blank lines at start and end.
594 $stmt =~ s/(^|\n)./$1/g;
595 $stmt =~ s/^\s*//;
596 $stmt =~ s/\s*$//;
597
598 my @stmt_lines = ($stmt =~ /\n/g);
599
600 return $#stmt_lines + 2;
601}
602
603sub statement_rawlines {
604 my ($stmt) = @_;
605
606 my @stmt_lines = ($stmt =~ /\n/g);
607
608 return $#stmt_lines + 2;
609}
610
611sub statement_block_size {
612 my ($stmt) = @_;
613
614 $stmt =~ s/(^|\n)./$1/g;
615 $stmt =~ s/^\s*{//;
616 $stmt =~ s/}\s*$//;
617 $stmt =~ s/^\s*//;
618 $stmt =~ s/\s*$//;
619
620 my @stmt_lines = ($stmt =~ /\n/g);
621 my @stmt_statements = ($stmt =~ /;/g);
622
623 my $stmt_lines = $#stmt_lines + 2;
624 my $stmt_statements = $#stmt_statements + 1;
625
626 if ($stmt_lines > $stmt_statements) {
627 return $stmt_lines;
628 } else {
629 return $stmt_statements;
630 }
631}
632
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800633sub ctx_statement_full {
634 my ($linenr, $remain, $off) = @_;
635 my ($statement, $condition, $level);
636
637 my (@chunks);
638
Andy Whitcroftcf655042008-03-04 14:28:20 -0800639 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800640 ($statement, $condition, $linenr, $remain, $off, $level) =
641 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700642 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800643 push(@chunks, [ $condition, $statement ]);
644 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
645 return ($level, $linenr, @chunks);
646 }
647
648 # Pull in the following conditional/block pairs and see if they
649 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800650 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800651 ($statement, $condition, $linenr, $remain, $off, $level) =
652 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800653 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700654 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800655 #print "C: push\n";
656 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800657 }
658
659 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800660}
661
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700662sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700663 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700664 my $line;
665 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700666 my $blk = '';
667 my @o;
668 my @c;
669 my @res = ();
670
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700671 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800672 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700673 for ($line = $start; $remain > 0; $line++) {
674 next if ($rawlines[$line] =~ /^-/);
675 $remain--;
676
677 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800678
679 # Handle nested #if/#else.
680 if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
681 push(@stack, $level);
682 } elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
683 $level = $stack[$#stack - 1];
684 } elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
685 $level = pop(@stack);
686 }
687
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700688 foreach my $c (split(//, $rawlines[$line])) {
689 ##print "C<$c>L<$level><$open$close>O<$off>\n";
690 if ($off > 0) {
691 $off--;
692 next;
693 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700694
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700695 if ($c eq $close && $level > 0) {
696 $level--;
697 last if ($level == 0);
698 } elsif ($c eq $open) {
699 $level++;
700 }
701 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700702
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700703 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700704 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700705 }
706
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700707 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700708 }
709
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700710 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700711}
712sub ctx_block_outer {
713 my ($linenr, $remain) = @_;
714
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700715 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
716 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700717}
718sub ctx_block {
719 my ($linenr, $remain) = @_;
720
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700721 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
722 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -0700723}
724sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700725 my ($linenr, $remain, $off) = @_;
726
727 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
728 return @r;
729}
730sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -0700731 my ($linenr, $remain) = @_;
732
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700733 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700734}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700735sub ctx_statement_level {
736 my ($linenr, $remain, $off) = @_;
737
738 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
739}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700740
741sub ctx_locate_comment {
742 my ($first_line, $end_line) = @_;
743
744 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -0700745 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700746 return $current_comment if (defined $current_comment);
747
748 # Look through the context and try and figure out if there is a
749 # comment.
750 my $in_comment = 0;
751 $current_comment = '';
752 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700753 my $line = $rawlines[$linenr - 1];
754 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700755 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
756 $in_comment = 1;
757 }
758 if ($line =~ m@/\*@) {
759 $in_comment = 1;
760 }
761 if (!$in_comment && $current_comment ne '') {
762 $current_comment = '';
763 }
764 $current_comment .= $line . "\n" if ($in_comment);
765 if ($line =~ m@\*/@) {
766 $in_comment = 0;
767 }
768 }
769
770 chomp($current_comment);
771 return($current_comment);
772}
773sub ctx_has_comment {
774 my ($first_line, $end_line) = @_;
775 my $cmt = ctx_locate_comment($first_line, $end_line);
776
Andy Whitcroft00df3442007-06-08 13:47:06 -0700777 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700778 ##print "CMMT: $cmt\n";
779
780 return ($cmt ne '');
781}
782
Andy Whitcroft4d001e42008-10-15 22:02:21 -0700783sub raw_line {
784 my ($linenr, $cnt) = @_;
785
786 my $offset = $linenr - 1;
787 $cnt++;
788
789 my $line;
790 while ($cnt) {
791 $line = $rawlines[$offset++];
792 next if (defined($line) && $line =~ /^-/);
793 $cnt--;
794 }
795
796 return $line;
797}
798
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700799sub cat_vet {
800 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700801 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700802
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700803 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700804 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
805 $res .= $1;
806 if ($2 ne '') {
807 $coded = sprintf("^%c", unpack('C', $2) + 64);
808 $res .= $coded;
809 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700810 }
811 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700812
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -0700813 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700814}
815
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800816my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800817my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800818my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700819my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800820
821sub annotate_reset {
822 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800823 $av_pending = '_';
824 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700825 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800826}
827
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700828sub annotate_values {
829 my ($stream, $type) = @_;
830
831 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700832 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833 my $cur = $stream;
834
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800835 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700836
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700837 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700838 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700840 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700841 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800842 print "WS($1)\n" if ($dbg_values > 1);
843 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800844 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800845 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700846 }
847
Andy Whitcroft9446ef52010-10-26 14:23:13 -0700848 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/) {
849 print "CAST($1)\n" if ($dbg_values > 1);
850 push(@av_paren_type, $type);
851 $type = 'C';
852
Andy Whitcrofte91b6e22010-10-26 14:23:11 -0700853 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800854 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855 $type = 'T';
856
Andy Whitcroft389a2fe2008-07-23 21:29:05 -0700857 } elsif ($cur =~ /^($Modifier)\s*/) {
858 print "MODIFIER($1)\n" if ($dbg_values > 1);
859 $type = 'T';
860
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700861 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700862 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800863 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700864 push(@av_paren_type, $type);
865 if ($2 ne '') {
866 $av_pending = 'N';
867 }
868 $type = 'E';
869
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700870 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700871 print "UNDEF($1)\n" if ($dbg_values > 1);
872 $av_preprocessor = 1;
873 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700874
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700875 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800876 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800877 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -0800878
879 push(@av_paren_type, $type);
880 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700881 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800882
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700883 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800884 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
885 $av_preprocessor = 1;
886
887 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
888
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700889 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800890
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700891 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800892 print "PRE_END($1)\n" if ($dbg_values > 1);
893
894 $av_preprocessor = 1;
895
896 # Assume all arms of the conditional end as this
897 # one does, and continue as if the #endif was not here.
898 pop(@av_paren_type);
899 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700900 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700901
902 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800903 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700905 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
906 print "ATTR($1)\n" if ($dbg_values > 1);
907 $av_pending = $type;
908 $type = 'N';
909
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700910 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800911 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700912 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800913 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700914 }
915 $type = 'N';
916
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700917 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800918 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700919 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700920 $type = 'N';
921
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700922 } elsif ($cur =~/^(case)/o) {
923 print "CASE($1)\n" if ($dbg_values > 1);
924 $av_pend_colon = 'C';
925 $type = 'N';
926
Andy Whitcroft14b111c2008-10-15 22:02:16 -0700927 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800928 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700929 $type = 'N';
930
931 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800932 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800933 push(@av_paren_type, $av_pending);
934 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700935 $type = 'N';
936
937 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -0800938 my $new_type = pop(@av_paren_type);
939 if ($new_type ne '_') {
940 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800941 print "PAREN('$1') -> $type\n"
942 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700943 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800944 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700945 }
946
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700947 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800948 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700949 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -0800950 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700951
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800952 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
953 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700954 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800955 } elsif ($type eq 'E') {
956 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700957 }
958 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
959 $type = 'V';
960
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700961 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800962 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700963 $type = 'V';
964
965 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800966 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700967 $type = 'N';
968
Andy Whitcroftcf655042008-03-04 14:28:20 -0800969 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800970 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800971 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700972 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800973
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800974 } elsif ($cur =~/^(,)/) {
975 print "COMMA($1)\n" if ($dbg_values > 1);
976 $type = 'C';
977
Andy Whitcroft1f65f942008-07-23 21:29:10 -0700978 } elsif ($cur =~ /^(\?)/o) {
979 print "QUESTION($1)\n" if ($dbg_values > 1);
980 $type = 'N';
981
982 } elsif ($cur =~ /^(:)/o) {
983 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
984
985 substr($var, length($res), 1, $av_pend_colon);
986 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
987 $type = 'E';
988 } else {
989 $type = 'N';
990 }
991 $av_pend_colon = 'O';
992
Andy Whitcroft8e761b02009-01-06 14:41:19 -0800993 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800994 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700995 $type = 'N';
996
Andy Whitcroft0d413862008-10-15 22:02:16 -0700997 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -0700998 my $variant;
999
1000 print "OPV($1)\n" if ($dbg_values > 1);
1001 if ($type eq 'V') {
1002 $variant = 'B';
1003 } else {
1004 $variant = 'U';
1005 }
1006
1007 substr($var, length($res), 1, $variant);
1008 $type = 'N';
1009
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001010 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001011 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001012 if ($1 ne '++' && $1 ne '--') {
1013 $type = 'N';
1014 }
1015
1016 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001017 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001018 }
1019 if (defined $1) {
1020 $cur = substr($cur, length($1));
1021 $res .= $type x length($1);
1022 }
1023 }
1024
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001025 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001026}
1027
Andy Whitcroft8905a672007-11-28 16:21:06 -08001028sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001029 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001030 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001031 ^(?:
1032 $Modifier|
1033 $Storage|
1034 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001035 DEFINE_\S+
1036 )$|
1037 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001038 goto|
1039 return|
1040 case|
1041 else|
1042 asm|__asm__|
1043 do
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001044 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001045 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001046 )}x;
1047 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1048 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001049 # Check for modifiers.
1050 $possible =~ s/\s*$Storage\s*//g;
1051 $possible =~ s/\s*$Sparse\s*//g;
1052 if ($possible =~ /^\s*$/) {
1053
1054 } elsif ($possible =~ /\s/) {
1055 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001056 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001057 if ($modifier !~ $notPermitted) {
1058 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1059 push(@modifierList, $modifier);
1060 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001061 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001062
1063 } else {
1064 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1065 push(@typeList, $possible);
1066 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001067 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001068 } else {
1069 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001070 }
1071}
1072
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001073my $prefix = '';
1074
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001075sub report {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001076 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1077 return 0;
1078 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001079 my $line = $prefix . $_[0];
1080
1081 $line = (split('\n', $line))[0] . "\n" if ($terse);
1082
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001083 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001084
1085 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001086}
1087sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001088 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001089}
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001090sub ERROR {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001091 if (report("ERROR: $_[0]\n")) {
1092 our $clean = 0;
1093 our $cnt_error++;
1094 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001095}
1096sub WARN {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001097 if (report("WARNING: $_[0]\n")) {
1098 our $clean = 0;
1099 our $cnt_warn++;
1100 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001101}
1102sub CHK {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001103 if ($check && report("CHECK: $_[0]\n")) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001104 our $clean = 0;
1105 our $cnt_chk++;
1106 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001107}
1108
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001109sub check_absolute_file {
1110 my ($absolute, $herecurr) = @_;
1111 my $file = $absolute;
1112
1113 ##print "absolute<$absolute>\n";
1114
1115 # See if any suffix of this path is a path within the tree.
1116 while ($file =~ s@^[^/]*/@@) {
1117 if (-f "$root/$file") {
1118 ##print "file<$file>\n";
1119 last;
1120 }
1121 }
1122 if (! -f _) {
1123 return 0;
1124 }
1125
1126 # It is, so see if the prefix is acceptable.
1127 my $prefix = $absolute;
1128 substr($prefix, -length($file)) = '';
1129
1130 ##print "prefix<$prefix>\n";
1131 if ($prefix ne ".../") {
1132 WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
1133 }
1134}
1135
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001136sub process {
1137 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001138
1139 my $linenr=0;
1140 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001141 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001142 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001143 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001144
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001145 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001146 my $indent;
1147 my $previndent=0;
1148 my $stashindent=0;
1149
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001150 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001151 my $signoff = 0;
1152 my $is_patch = 0;
1153
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001154 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001155 our $cnt_lines = 0;
1156 our $cnt_error = 0;
1157 our $cnt_warn = 0;
1158 our $cnt_chk = 0;
1159
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001160 # Trace the real file/line as we go.
1161 my $realfile = '';
1162 my $realline = 0;
1163 my $realcnt = 0;
1164 my $here = '';
1165 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001166 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001167 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001168 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001169
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001170 my $prev_values = 'E';
1171
1172 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001173 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001174 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001175 my %suppress_export;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001176
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001177 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001178 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001179 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001180 my @setup_docs = ();
1181 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182
1183 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184 my $line;
1185 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001186 $linenr++;
1187 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188
Andy Whitcroft773647a2008-03-28 14:15:58 -07001189 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001190 $setup_docs = 0;
1191 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1192 $setup_docs = 1;
1193 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001194 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001195 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001196 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1197 $realline=$1-1;
1198 if (defined $2) {
1199 $realcnt=$3+1;
1200 } else {
1201 $realcnt=1+1;
1202 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001203 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001204
1205 # Guestimate if this is a continuing comment. Run
1206 # the context looking for a comment "edge". If this
1207 # edge is a close comment then we must be in a comment
1208 # at context start.
1209 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001210 my $cnt = $realcnt;
1211 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1212 next if (defined $rawlines[$ln - 1] &&
1213 $rawlines[$ln - 1] =~ /^-/);
1214 $cnt--;
1215 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001216 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001217 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1218 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1219 ($edge) = $1;
1220 last;
1221 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001222 }
1223 if (defined $edge && $edge eq '*/') {
1224 $in_comment = 1;
1225 }
1226
1227 # Guestimate if this is a continuing comment. If this
1228 # is the start of a diff block and this line starts
1229 # ' *' then it is very likely a comment.
1230 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001231 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001232 {
1233 $in_comment = 1;
1234 }
1235
1236 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1237 sanitise_line_reset($in_comment);
1238
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001239 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001240 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001241 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001242 $line = sanitise_line($rawline);
1243 }
1244 push(@lines, $line);
1245
1246 if ($realcnt > 1) {
1247 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1248 } else {
1249 $realcnt = 0;
1250 }
1251
1252 #print "==>$rawline\n";
1253 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001254
1255 if ($setup_docs && $line =~ /^\+/) {
1256 push(@setup_docs, $line);
1257 }
1258 }
1259
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001260 $prefix = '';
1261
Andy Whitcroft773647a2008-03-28 14:15:58 -07001262 $realcnt = 0;
1263 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001264 foreach my $line (@lines) {
1265 $linenr++;
1266
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001267 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001268
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001269#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001270 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001271 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001272 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001273 $realline=$1-1;
1274 if (defined $2) {
1275 $realcnt=$3+1;
1276 } else {
1277 $realcnt=1+1;
1278 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001279 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001280 $prev_values = 'E';
1281
Andy Whitcroft773647a2008-03-28 14:15:58 -07001282 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001283 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001284 %suppress_export = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001285 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001286
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001287# track the line number as we move through the hunk, note that
1288# new versions of GNU diff omit the leading space on completely
1289# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001290 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001291 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001292 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001293
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001294 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001295 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001296
1297 # Track the previous line.
1298 ($prevline, $stashline) = ($stashline, $line);
1299 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1301
Andy Whitcroft773647a2008-03-28 14:15:58 -07001302 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001303
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001304 } elsif ($realcnt == 1) {
1305 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001306 }
1307
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001308 my $hunk_line = ($realcnt != 0);
1309
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001310#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001311 $prefix = "$filename:$realline: " if ($emacs && $file);
1312 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1313
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001314 $here = "#$linenr: " if (!$file);
1315 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001316
1317 # extract the filename as it passes
1318 if ($line=~/^\+\+\+\s+(\S+)/) {
1319 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001320 $realfile =~ s@^([^/]*)/@@;
1321
1322 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001323 if (!$file && $tree && $p1_prefix ne '' &&
1324 -e "$root/$p1_prefix") {
Wolfram Sang1e855722009-01-06 14:41:24 -08001325 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1326 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001327
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001328 if ($realfile =~ m@^include/asm/@) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001329 ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1330 }
1331 next;
1332 }
1333
Randy Dunlap389834b2007-06-08 13:47:03 -07001334 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001335
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001336 my $hereline = "$here\n$rawline\n";
1337 my $herecurr = "$here\n$rawline\n";
1338 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001339
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001340 $cnt_lines++ if ($realcnt != 0);
1341
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001342#check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001343 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001344 # This is a signoff, if ugly, so do not double report.
1345 $signoff++;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001346 if (!($line =~ /^\s*Signed-off-by:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001347 WARN("Signed-off-by: is the preferred form\n" .
1348 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001349 }
1350 if ($line =~ /^\s*signed-off-by:\S/i) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001351 WARN("space required after Signed-off-by:\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001352 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001353 }
1354 }
1355
Andy Whitcroft00df3442007-06-08 13:47:06 -07001356# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001357 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001358 ERROR("patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001359 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001360 }
1361
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001362# Check for absolute kernel paths.
1363 if ($tree) {
1364 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1365 my $file = $1;
1366
1367 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1368 check_absolute_file($1, $herecurr)) {
1369 #
1370 } else {
1371 check_absolute_file($file, $herecurr);
1372 }
1373 }
1374 }
1375
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001376# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1377 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001378 $rawline !~ m/^$UTF8*$/) {
1379 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1380
1381 my $blank = copy_spacing($rawline);
1382 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1383 my $hereptr = "$hereline$ptr\n";
1384
1385 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001386 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001387
Andy Whitcroft306708542008-10-15 22:02:28 -07001388# ignore non-hunk lines and lines being removed
1389 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001390
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001391#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001392 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001393 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001394 ERROR("DOS line endings\n" . $herevet);
1395
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001396 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1397 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001398 ERROR("trailing whitespace\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001399 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001400 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001401
Andi Kleen33549572010-05-24 14:33:29 -07001402# check for Kconfig help text having a real description
1403 if ($realfile =~ /Kconfig/ &&
1404 $line =~ /\+?\s*(---)?help(---)?$/) {
1405 my $length = 0;
1406 for (my $l = $linenr; defined($lines[$l]); $l++) {
1407 my $f = $lines[$l];
1408 $f =~ s/#.*//;
1409 $f =~ s/^\s+//;
1410 next if ($f =~ /^$/);
1411 last if ($f =~ /^\s*config\s/);
1412 $length++;
1413 }
1414 WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($length < 4);
1415 }
1416
Andy Whitcroft5368df22008-10-15 22:02:27 -07001417# check we are in a valid source file if not then ignore this hunk
1418 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1419
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001420#80 column limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001421 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001422 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches8bbea962010-08-09 17:21:01 -07001423 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
1424 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001425 $length > 80)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001426 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001427 WARN("line over 80 characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001428 }
1429
Joe Perches5e79d962010-03-05 13:43:55 -08001430# check for spaces before a quoted newline
1431 if ($rawline =~ /^.*\".*\s\\n/) {
1432 WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
1433 }
1434
Andy Whitcroft8905a672007-11-28 16:21:06 -08001435# check for adding lines without a newline.
1436 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1437 WARN("adding a line without newline at end of file\n" . $herecurr);
1438 }
1439
Mike Frysinger42e41c52009-09-21 17:04:40 -07001440# Blackfin: use hi/lo macros
1441 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1442 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1443 my $herevet = "$here\n" . cat_vet($line) . "\n";
1444 ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1445 }
1446 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1447 my $herevet = "$here\n" . cat_vet($line) . "\n";
1448 ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
1449 }
1450 }
1451
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001452# check we are in a valid source file C or perl if not then ignore this hunk
1453 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001454
1455# at the beginning of a line any tabs must come first and anything
1456# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001457 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1458 $rawline =~ /^\+\s* \s*/) {
1459 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001460 ERROR("code indent should use tabs where possible\n" . $herevet);
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001461 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001462 }
1463
Alberto Panizzo08e44362010-03-05 13:43:54 -08001464# check for space before tabs.
1465 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1466 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1467 WARN("please, no space before tabs\n" . $herevet);
1468 }
1469
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001470# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001471# Exceptions:
1472# 1) within comments
1473# 2) indented preprocessor commands
1474# 3) hanging labels
1475 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001476 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07001477 WARN("please, no spaces at the start of a line\n" . $herevet);
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07001478 }
1479
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001480# check we are in a valid C source file if not then ignore this hunk
1481 next if ($realfile !~ /\.(h|c)$/);
1482
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001483# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08001484 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001485 WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1486 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07001487
Mike Frysinger42e41c52009-09-21 17:04:40 -07001488# Blackfin: don't use __builtin_bfin_[cs]sync
1489 if ($line =~ /__builtin_bfin_csync/) {
1490 my $herevet = "$here\n" . cat_vet($line) . "\n";
1491 ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1492 }
1493 if ($line =~ /__builtin_bfin_ssync/) {
1494 my $herevet = "$here\n" . cat_vet($line) . "\n";
1495 ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1496 }
1497
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001498# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001499 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1500 $realline_next);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07001501 if ($realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001502 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07001503 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001504 $stat =~ s/\n./\n /g;
1505 $cond =~ s/\n./\n /g;
1506
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001507 # Find the real next line.
1508 $realline_next = $line_nr_next;
1509 if (defined $realline_next &&
1510 (!defined $lines[$realline_next - 1] ||
1511 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1512 $realline_next++;
1513 }
1514
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001515 my $s = $stat;
1516 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001517
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001518 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001519 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001520
1521 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001522 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523
Andy Whitcroft463f2862009-09-21 17:04:34 -07001524 } elsif ($s =~ /^.\s*else\b/s) {
1525
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001526 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07001527 } 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 -07001528 my $type = $1;
1529 $type =~ s/\s+/ /g;
1530 possible($type, "A:" . $s);
1531
Andy Whitcroft8905a672007-11-28 16:21:06 -08001532 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07001533 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001534 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001535 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001536
1537 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08001538 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001539 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001540 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001541
1542 # Check for any sort of function declaration.
1543 # int foo(something bar, other baz);
1544 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001545 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 -08001546 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001547
Andy Whitcroftcf655042008-03-04 14:28:20 -08001548 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001549 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08001550 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001551
Andy Whitcroft8905a672007-11-28 16:21:06 -08001552 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001553 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001554
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001555 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001556 }
1557 }
1558 }
1559
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001560 }
1561
Andy Whitcroft653d4872007-06-23 17:16:34 -07001562#
1563# Checks which may be anchored in the context.
1564#
1565
1566# Check for switch () and associated case and default
1567# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07001568 if ($line=~/\bswitch\s*\(.*\)/) {
1569 my $err = '';
1570 my $sep = '';
1571 my @ctx = ctx_block_outer($linenr, $realcnt);
1572 shift(@ctx);
1573 for my $ctx (@ctx) {
1574 my ($clen, $cindent) = line_stats($ctx);
1575 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1576 $indent != $cindent) {
1577 $err .= "$sep$ctx\n";
1578 $sep = '';
1579 } else {
1580 $sep = "[...]\n";
1581 }
1582 }
1583 if ($err ne '') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001584 ERROR("switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001585 }
1586 }
1587
1588# if/while/etc brace do not go on next line, unless defining a do while loop,
1589# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001590 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001591 my $pre_ctx = "$1$2";
1592
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001593 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001594 my $ctx_cnt = $realcnt - $#ctx - 1;
1595 my $ctx = join("\n", @ctx);
1596
Andy Whitcroft548596d2008-07-23 21:29:01 -07001597 my $ctx_ln = $linenr;
1598 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001599
Andy Whitcroft548596d2008-07-23 21:29:01 -07001600 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1601 defined $lines[$ctx_ln - 1] &&
1602 $lines[$ctx_ln - 1] =~ /^-/)) {
1603 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1604 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001605 $ctx_ln++;
1606 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07001607
Andy Whitcroft53210162008-07-23 21:29:03 -07001608 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1609 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001610
1611 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
1612 ERROR("that open brace { should be on the previous line\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001613 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07001614 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001615 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1616 $ctx =~ /\)\s*\;\s*$/ &&
1617 defined $lines[$ctx_ln - 1])
1618 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001619 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1620 if ($nindent > $indent) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001621 WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001622 "$here\n$ctx\n$lines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001623 }
1624 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001625 }
1626
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001627# Check relative indent for conditionals and blocks.
1628 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1629 my ($s, $c) = ($stat, $cond);
1630
1631 substr($s, 0, length($c), '');
1632
1633 # Make sure we remove the line prefixes as we have
1634 # none on the first line, and are going to readd them
1635 # where necessary.
1636 $s =~ s/\n./\n/gs;
1637
1638 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07001639 my @newlines = ($c =~ /\n/gs);
1640 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001641
1642 # We want to check the first line inside the block
1643 # starting at the end of the conditional, so remove:
1644 # 1) any blank line termination
1645 # 2) any opening brace { on end of the line
1646 # 3) any do (...) {
1647 my $continuation = 0;
1648 my $check = 0;
1649 $s =~ s/^.*\bdo\b//;
1650 $s =~ s/^\s*{//;
1651 if ($s =~ s/^\s*\\//) {
1652 $continuation = 1;
1653 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001654 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001655 $check = 1;
1656 $cond_lines++;
1657 }
1658
1659 # Also ignore a loop construct at the end of a
1660 # preprocessor statement.
1661 if (($prevline =~ /^.\s*#\s*define\s/ ||
1662 $prevline =~ /\\\s*$/) && $continuation == 0) {
1663 $check = 0;
1664 }
1665
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001666 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07001667 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001668 while ($cond_ptr != $cond_lines) {
1669 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001670
Andy Whitcroftf16fa282008-10-15 22:02:32 -07001671 # If we see an #else/#elif then the code
1672 # is not linear.
1673 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1674 $check = 0;
1675 }
1676
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001677 # Ignore:
1678 # 1) blank lines, they should be at 0,
1679 # 2) preprocessor lines, and
1680 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07001681 if ($continuation ||
1682 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001683 $s =~ /^\s*#\s*?/ ||
1684 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07001685 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07001686 if ($s =~ s/^.*?\n//) {
1687 $cond_lines++;
1688 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001689 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001690 }
1691
1692 my (undef, $sindent) = line_stats("+" . $s);
1693 my $stat_real = raw_line($linenr, $cond_lines);
1694
1695 # Check if either of these lines are modified, else
1696 # this is not this patch's fault.
1697 if (!defined($stat_real) ||
1698 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1699 $check = 0;
1700 }
1701 if (defined($stat_real) && $cond_lines > 1) {
1702 $stat_real = "[...]\n$stat_real";
1703 }
1704
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07001705 #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 -07001706
1707 if ($check && (($sindent % 8) != 0 ||
1708 ($sindent <= $indent && $s ne ''))) {
1709 WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1710 }
1711 }
1712
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001713 # Track the 'values' across context and added lines.
1714 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001715 my ($curr_values, $curr_vars) =
1716 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 if ($dbg_values) {
1719 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001720 print "$linenr > .$outline\n";
1721 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001722 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001723 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001724 $prev_values = substr($curr_values, -1);
1725
Andy Whitcroft00df3442007-06-08 13:47:06 -07001726#ignore lines not being added
1727 if ($line=~/^[^\+]/) {next;}
1728
Andy Whitcroft653d4872007-06-23 17:16:34 -07001729# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07001730 if ($dbg_type) {
1731 if ($line =~ /^.\s*$Declare\s*$/) {
1732 ERROR("TEST: is type\n" . $herecurr);
1733 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1734 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1735 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001736 next;
1737 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001738# TEST: allow direct testing of the attribute matcher.
1739 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001740 if ($line =~ /^.\s*$Modifier\s*$/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001741 ERROR("TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08001742 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07001743 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1744 }
1745 next;
1746 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001747
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001748# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07001749 if ($line =~ /^.\s*{/ &&
1750 $prevline =~ /(?:^|[^=])=\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001751 ERROR("that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001752 }
1753
Andy Whitcroft653d4872007-06-23 17:16:34 -07001754#
1755# Checks which are anchored on the added line.
1756#
1757
1758# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001759 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001760 my $path = $1;
1761 if ($path =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001762 ERROR("malformed #include filename\n" .
1763 $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07001764 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001765 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07001766
1767# no C99 // comments
1768 if ($line =~ m{//}) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001769 ERROR("do not use C99 // comments\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001770 }
1771 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001772 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001773 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001774
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001775# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
1776# the whole statement.
1777#print "APW <$lines[$realline_next - 1]>\n";
1778 if (defined $realline_next &&
1779 exists $lines[$realline_next - 1] &&
1780 !defined $suppress_export{$realline_next} &&
1781 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1782 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001783 my $name = $1;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001784 if ($stat !~ /(?:
1785 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07001786 ^.DEFINE_$Ident\(\Q$name\E\)|
1787 ^.DECLARE_$Ident\(\Q$name\E\)|
1788 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001789 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
1790 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07001791 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001792#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
1793 $suppress_export{$realline_next} = 2;
1794 } else {
1795 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001796 }
1797 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001798 if (!defined $suppress_export{$linenr} &&
1799 $prevline =~ /^.\s*$/ &&
1800 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
1801 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
1802#print "FOO B <$lines[$linenr - 1]>\n";
1803 $suppress_export{$linenr} = 2;
1804 }
1805 if (defined $suppress_export{$linenr} &&
1806 $suppress_export{$linenr} == 2) {
1807 WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
1808 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001809
Joe Eloff5150bda2010-08-09 17:21:00 -07001810# check for global initialisers.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001811 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
Joe Eloff5150bda2010-08-09 17:21:00 -07001812 ERROR("do not initialise globals to 0 or NULL\n" .
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001813 $herecurr);
1814 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001815# check for static initialisers.
Andy Whitcroft2d1bafd72009-01-06 14:41:28 -08001816 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001817 ERROR("do not initialise statics to 0 or NULL\n" .
1818 $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001819 }
1820
Andy Whitcroft653d4872007-06-23 17:16:34 -07001821# check for new typedefs, only function parameters and sparse annotations
1822# make sense.
1823 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08001824 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001825 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07001826 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07001827 $line !~ /\b__bitwise(?:__|)\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001828 WARN("do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001829 }
1830
1831# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08001832 # (char*[ const])
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001833 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001834 my ($from, $to) = ($1, $1);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001835
Andy Whitcroft65863862009-01-06 14:41:21 -08001836 # Should start with a space.
1837 $to =~ s/^(\S)/ $1/;
1838 # Should not end with a space.
1839 $to =~ s/\s+$//;
1840 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001841 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001842 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001843
Andy Whitcroft65863862009-01-06 14:41:21 -08001844 #print "from<$from> to<$to>\n";
1845 if ($from ne $to) {
1846 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1847 }
Andy Whitcroft00ef4ec2009-02-27 14:03:07 -08001848 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001849 my ($from, $to, $ident) = ($1, $1, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001850
Andy Whitcroft65863862009-01-06 14:41:21 -08001851 # Should start with a space.
1852 $to =~ s/^(\S)/ $1/;
1853 # Should not end with a space.
1854 $to =~ s/\s+$//;
1855 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08001856 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001857 }
1858 # Modifiers should have spaces.
1859 $to =~ s/(\b$Modifier$)/$1 /;
1860
Andy Whitcroft667026e2009-02-27 14:03:08 -08001861 #print "from<$from> to<$to> ident<$ident>\n";
1862 if ($from ne $to && $ident !~ /^$Modifier$/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08001863 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1864 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001865 }
1866
1867# # no BUG() or BUG_ON()
1868# if ($line =~ /\b(BUG|BUG_ON)\b/) {
1869# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
1870# print "$herecurr";
1871# $clean = 0;
1872# }
1873
Andy Whitcroft8905a672007-11-28 16:21:06 -08001874 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001875 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 -08001876 }
1877
Andy Whitcroft00df3442007-06-08 13:47:06 -07001878# printk should use KERN_* levels. Note that follow on printk's on the
1879# same line do not need a level, so we use the current block context
1880# to try and find and validate the current printk. In summary the current
1881# printk includes all preceeding printk's which have no newline on the end.
1882# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001883 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001884 my $ok = 0;
1885 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
1886 #print "CHECK<$lines[$ln - 1]\n";
1887 # we have a preceeding printk if it ends
1888 # with "\n" ignore it, else it is to blame
1889 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
1890 if ($rawlines[$ln - 1] !~ m{\\n"}) {
1891 $ok = 1;
1892 }
1893 last;
1894 }
1895 }
1896 if ($ok == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001897 WARN("printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001898 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001899 }
1900
Andy Whitcroft653d4872007-06-23 17:16:34 -07001901# function brace can't be on same line, except for #defines of do while,
1902# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001903 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
1904 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001905 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001906 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001907
Andy Whitcroft8905a672007-11-28 16:21:06 -08001908# open braces for enum, union and struct go on the same line.
1909 if ($line =~ /^.\s*{/ &&
1910 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1911 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1912 }
1913
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001914# check for spacing round square brackets; allowed:
1915# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001916# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1917# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001918 while ($line =~ /(.*?\s)\[/g) {
1919 my ($where, $prefix) = ($-[1], $1);
1920 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07001921 ($where != 0 || $prefix !~ /^.\s+$/) &&
1922 $prefix !~ /{\s+$/) {
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07001923 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1924 }
1925 }
1926
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001927# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001928 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001929 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001930 my $ctx_before = substr($line, 0, $-[1]);
1931 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001932
1933 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001934 if ($name =~ /^(?:
1935 if|for|while|switch|return|case|
1936 volatile|__volatile__|
1937 __attribute__|format|__extension__|
1938 asm|__asm__)$/x)
1939 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001940
1941 # cpp #define statements have non-optional spaces, ie
1942 # if there is a space between the name and the open
1943 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001944 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001945
1946 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001947 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001948
1949 # If this whole things ends with a type its most
1950 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001951 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001952
1953 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001954 WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001955 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001956 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07001957# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001958 if (!($line=~/\#\s*include/)) {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001959 my $ops = qr{
1960 <<=|>>=|<=|>=|==|!=|
1961 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1962 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001963 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1964 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001965 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001966 my @elements = split(/($ops|;)/, $opline);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001967 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001968
1969 my $blank = copy_spacing($opline);
1970
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001971 for (my $n = 0; $n < $#elements; $n += 2) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001972 $off += length($elements[$n]);
1973
Andy Whitcroft773647a2008-03-28 14:15:58 -07001974 # Pick up the preceeding and succeeding characters.
1975 my $ca = substr($opline, 0, $off);
1976 my $cc = '';
1977 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1978 $cc = substr($opline, $off + length($elements[$n + 1]));
1979 }
1980 my $cb = "$ca$;$cc";
1981
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001982 my $a = '';
1983 $a = 'V' if ($elements[$n] ne '');
1984 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001985 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001986 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1987 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07001988 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001989
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001990 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001991
1992 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001993 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001994 $c = 'V' if ($elements[$n + 2] ne '');
1995 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001996 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001997 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1998 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08001999 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002000 } else {
2001 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002002 }
2003
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002004 my $ctx = "${a}x${c}";
2005
2006 my $at = "(ctx:$ctx)";
2007
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002008 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002009 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002010
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002011 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002012 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002013
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002014 # Get the full operator variant.
2015 my $opv = $op . substr($curr_vars, $off, 1);
2016
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002017 # Ignore operators passed as parameters.
2018 if ($op_type ne 'V' &&
2019 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2020
Andy Whitcroftcf655042008-03-04 14:28:20 -08002021# # Ignore comments
2022# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002023
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002024 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002025 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002026 if ($ctx !~ /.x[WEBC]/ &&
2027 $cc !~ /^\\/ && $cc !~ /^;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002028 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002029 }
2030
2031 # // is a comment
2032 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002033
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002034 # No spaces for:
2035 # ->
2036 # : when part of a bitfield
2037 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002038 if ($ctx =~ /Wx.|.xW/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002039 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002040 }
2041
2042 # , must have a space on the right.
2043 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002044 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002045 ERROR("space required after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002046 }
2047
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002048 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002049 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002050 #warn "'*' is part of type\n";
2051
2052 # unary operators should have a space before and
2053 # none after. May be left adjacent to another
2054 # unary operator, or a cast
2055 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002056 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002057 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002058 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002059 ERROR("space required before that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002060 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002061 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002062 # A unary '*' may be const
2063
2064 } elsif ($ctx =~ /.xW/) {
Andy Whitcroftfb9e9092009-09-21 17:04:38 -07002065 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002066 }
2067
2068 # unary ++ and unary -- are allowed no space on one side.
2069 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002070 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2071 ERROR("space required one side of that '$op' $at\n" . $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002072 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002073 if ($ctx =~ /Wx[BE]/ ||
2074 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2075 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002076 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002077 if ($ctx =~ /ExW/) {
2078 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2079 }
2080
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002081
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002082 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002083 } elsif ($op eq '<<' or $op eq '>>' or
2084 $op eq '&' or $op eq '^' or $op eq '|' or
2085 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002086 $op eq '*' or $op eq '/' or
2087 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002088 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002089 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002090 ERROR("need consistent spacing around '$op' $at\n" .
2091 $hereptr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002092 }
2093
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002094 # A colon needs no spaces before when it is
2095 # terminating a case value or a label.
2096 } elsif ($opv eq ':C' || $opv eq ':L') {
2097 if ($ctx =~ /Wx./) {
2098 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2099 }
2100
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002101 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002102 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002103 my $ok = 0;
2104
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002105 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002106 if (($op eq '<' &&
2107 $cc =~ /^\S+\@\S+>/) ||
2108 ($op eq '>' &&
2109 $ca =~ /<\S+\@\S+$/))
2110 {
2111 $ok = 1;
2112 }
2113
2114 # Ignore ?:
2115 if (($opv eq ':O' && $ca =~ /\?$/) ||
2116 ($op eq '?' && $cc =~ /^:/)) {
2117 $ok = 1;
2118 }
2119
2120 if ($ok == 0) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002121 ERROR("spaces required around that '$op' $at\n" . $hereptr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002122 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002123 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002124 $off += length($elements[$n + 1]);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002125 }
2126 }
2127
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002128# check for multiple assignments
2129 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002130 CHK("multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002131 }
2132
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002133## # check for multiple declarations, allowing for a function declaration
2134## # continuation.
2135## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2136## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2137##
2138## # Remove any bracketed sections to ensure we do not
2139## # falsly report the parameters of functions.
2140## my $ln = $line;
2141## while ($ln =~ s/\([^\(\)]*\)//g) {
2142## }
2143## if ($ln =~ /,/) {
2144## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
2145## }
2146## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002147
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002148#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002149 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2150 $line =~ /do{/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002151 ERROR("space required before the open brace '{'\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002152 }
2153
2154# closing brace should have a space following it when it has anything
2155# on the line
2156 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002157 ERROR("space required after that close brace '}'\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002158 }
2159
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002160# check spacing on square brackets
2161 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002162 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002163 }
2164 if ($line =~ /\s\]/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002165 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002166 }
2167
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002168# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002169 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2170 $line !~ /for\s*\(\s+;/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002171 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002172 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002173 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002174 $line !~ /for\s*\(.*;\s+\)/ &&
2175 $line !~ /:\s+\)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002176 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002177 }
2178
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002179#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002180 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002181 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002182 WARN("labels should not be indented\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002183 }
2184
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002185# Return is not a function.
2186 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2187 my $spacing = $1;
2188 my $value = $2;
2189
Andy Whitcroft86f9d052009-01-06 14:41:24 -08002190 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002191 $value =~ s/\(/ \(/g;
2192 $value =~ s/\)/\) /g;
Andy Whitcroft63f17f82009-01-15 13:51:06 -08002193 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2194 $value !~ /(?:$Ident|-?$Constant)\s*
2195 $Compare\s*
2196 (?:$Ident|-?$Constant)/x &&
2197 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002198 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07002199#print "value<$value>\n";
2200 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002201 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2202
2203 } elsif ($spacing !~ /\s+/) {
2204 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2205 }
2206 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07002207# Return of what appears to be an errno should normally be -'ve
2208 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2209 my $name = $1;
2210 if ($name ne 'EOF' && $name ne 'ERROR') {
2211 WARN("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2212 }
2213 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002214
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002215# Need a space before open parenthesis after if, while etc
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002216 if ($line=~/\b(if|while|for|switch)\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002217 ERROR("space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002218 }
2219
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002220# Check for illegal assignment in if conditional -- and check for trailing
2221# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002222 if ($line =~ /do\s*(?!{)/) {
2223 my ($stat_next) = ctx_statement_block($line_nr_next,
2224 $remain_next, $off_next);
2225 $stat_next =~ s/\n./\n /g;
2226 ##print "stat<$stat> stat_next<$stat_next>\n";
2227
2228 if ($stat_next =~ /^\s*while\b/) {
2229 # If the statement carries leading newlines,
2230 # then count those as offsets.
2231 my ($whitespace) =
2232 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2233 my $offset =
2234 statement_rawlines($whitespace) - 1;
2235
2236 $suppress_whiletrailers{$line_nr_next +
2237 $offset} = 1;
2238 }
2239 }
2240 if (!defined $suppress_whiletrailers{$linenr} &&
2241 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002242 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002243
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08002244 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002245 ERROR("do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002246 }
2247
2248 # Find out what is on the end of the line after the
2249 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002250 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002251 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002252 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07002253 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2254 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002255 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002256 # Find out how long the conditional actually is.
2257 my @newlines = ($c =~ /\n/gs);
2258 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002259 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002260
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08002261 $stat_real = raw_line($linenr, $cond_lines)
2262 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07002263 if (defined($stat_real) && $cond_lines > 1) {
2264 $stat_real = "[...]\n$stat_real";
2265 }
2266
2267 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002268 }
2269 }
2270
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002271# Check for bitwise tests written as boolean
2272 if ($line =~ /
2273 (?:
2274 (?:\[|\(|\&\&|\|\|)
2275 \s*0[xX][0-9]+\s*
2276 (?:\&\&|\|\|)
2277 |
2278 (?:\&\&|\|\|)
2279 \s*0[xX][0-9]+\s*
2280 (?:\&\&|\|\||\)|\])
2281 )/x)
2282 {
2283 WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2284 }
2285
Andy Whitcroft8905a672007-11-28 16:21:06 -08002286# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002287 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2288 my $s = $1;
2289 $s =~ s/$;//g; # Remove any comments
2290 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2291 ERROR("trailing statements should be on next line\n" . $herecurr);
2292 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002293 }
Andy Whitcroft39667782009-01-15 13:51:06 -08002294# if should not continue a brace
2295 if ($line =~ /}\s*if\b/) {
2296 ERROR("trailing statements should be on next line\n" .
2297 $herecurr);
2298 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002299# case and default should not have general statements after them
2300 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2301 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07002302 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07002303 \s*return\s+
2304 )/xg)
2305 {
2306 ERROR("trailing statements should be on next line\n" . $herecurr);
2307 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002308
2309 # Check for }<nl>else {, these must be at the same
2310 # indent level to be relevant to each other.
2311 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2312 $previndent == $indent) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002313 ERROR("else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002314 }
2315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002316 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2317 $previndent == $indent) {
2318 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2319
2320 # Find out what is on the end of the line after the
2321 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002322 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002323 $s =~ s/\n.*//g;
2324
2325 if ($s =~ /^\s*;/) {
2326 ERROR("while should follow close brace '}'\n" . $hereprev);
2327 }
2328 }
2329
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002330#studly caps, commented out until figure out how to distinguish between use of existing and adding new
2331# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2332# print "No studly caps, use _\n";
2333# print "$herecurr";
2334# $clean = 0;
2335# }
2336
2337#no spaces allowed after \ in define
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002338 if ($line=~/\#\s*define.*\\\s$/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002339 WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002340 }
2341
Andy Whitcroft653d4872007-06-23 17:16:34 -07002342#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002343 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002344 my $file = "$1.h";
2345 my $checkfile = "include/linux/$file";
2346 if (-f "$root/$checkfile" &&
2347 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07002348 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002349 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07002350 if ($realfile =~ m{^arch/}) {
2351 CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2352 } else {
2353 WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2354 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002355 }
2356 }
2357
Andy Whitcroft653d4872007-06-23 17:16:34 -07002358# multi-statement macros should be enclosed in a do while loop, grab the
2359# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08002360# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07002361 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2362 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002363 my $ln = $linenr;
2364 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002365 my ($off, $dstat, $dcond, $rest);
2366 my $ctx = '';
Andy Whitcroft653d4872007-06-23 17:16:34 -07002367
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002368 my $args = defined($1);
2369
2370 # Find the end of the macro and limit our statement
2371 # search to that.
2372 while ($cnt > 0 && defined $lines[$ln - 1] &&
2373 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2374 {
2375 $ctx .= $rawlines[$ln - 1] . "\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002376 $cnt-- if ($lines[$ln - 1] !~ /^-/);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002377 $ln++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002378 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002379 $ctx .= $rawlines[$ln - 1];
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002380
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002381 ($dstat, $dcond, $ln, $cnt, $off) =
2382 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2383 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002384 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002385
2386 # Extract the remainder of the define (if any) and
2387 # rip off surrounding spaces, and trailing \'s.
2388 $rest = '';
Andy Whitcroft636d1402008-10-15 22:02:18 -07002389 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2390 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07002391 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2392 $rest .= substr($lines[$ln - 1], $off) . "\n";
2393 $cnt--;
2394 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002395 $ln++;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002396 $off = 0;
2397 }
2398 $rest =~ s/\\\n.//g;
2399 $rest =~ s/^\s*//s;
2400 $rest =~ s/\s*$//s;
2401
2402 # Clean up the original statement.
2403 if ($args) {
2404 substr($dstat, 0, length($dcond), '');
2405 } else {
2406 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2407 }
Andy Whitcroft292f1a92008-07-23 21:29:11 -07002408 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002409 $dstat =~ s/\\\n.//g;
2410 $dstat =~ s/^\s*//s;
2411 $dstat =~ s/\s*$//s;
2412
2413 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07002414 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2415 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2416 $dstat =~ s/\[[^\{\}]*\]/1/)
2417 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002418 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002419
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002420 my $exceptions = qr{
2421 $Declare|
2422 module_param_named|
2423 MODULE_PARAM_DESC|
2424 DECLARE_PER_CPU|
2425 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08002426 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08002427 union|
2428 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07002429 \.$Ident\s*=\s*|
2430 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002431 }x;
Andy Whitcroft383099f2009-01-06 14:41:18 -08002432 #print "REST<$rest> dstat<$dstat>\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002433 if ($rest ne '') {
2434 if ($rest !~ /while\s*\(/ &&
2435 $dstat !~ /$exceptions/)
2436 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002437 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 -07002438 }
2439
2440 } elsif ($ctx !~ /;/) {
2441 if ($dstat ne '' &&
2442 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2443 $dstat !~ /$exceptions/ &&
Andy Whitcroftb132e5d2008-10-15 22:02:31 -07002444 $dstat !~ /^\.$Ident\s*=/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002445 $dstat =~ /$Operators/)
2446 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002447 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002448 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002449 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002450 }
2451
Mike Frysinger080ba922009-01-06 14:41:25 -08002452# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2453# all assignments may have only one of the following with an assignment:
2454# .
2455# ALIGN(...)
2456# VMLINUX_SYMBOL(...)
2457 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2458 WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2459 }
2460
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002461# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002462 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2463 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08002464 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002465 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002466 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2467 if ($#chunks > 0 && $level == 0) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002468 my $allowed = 0;
2469 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002470 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002471 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002472 for my $chunk (@chunks) {
2473 my ($cond, $block) = @{$chunk};
2474
Andy Whitcroft773647a2008-03-28 14:15:58 -07002475 # If the condition carries leading newlines, then count those as offsets.
2476 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2477 my $offset = statement_rawlines($whitespace) - 1;
2478
2479 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2480
2481 # We have looked at and allowed this specific line.
2482 $suppress_ifbraces{$ln + $offset} = 1;
2483
2484 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002485 $ln += statement_rawlines($block) - 1;
2486
Andy Whitcroft773647a2008-03-28 14:15:58 -07002487 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002488
2489 $seen++ if ($block =~ /^\s*{/);
2490
Andy Whitcroftcf655042008-03-04 14:28:20 -08002491 #print "cond<$cond> block<$block> allowed<$allowed>\n";
2492 if (statement_lines($cond) > 1) {
2493 #print "APW: ALLOWED: cond<$cond>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002494 $allowed = 1;
2495 }
2496 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002497 #print "APW: ALLOWED: block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002498 $allowed = 1;
2499 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002500 if (statement_block_size($block) > 1) {
2501 #print "APW: ALLOWED: lines block<$block>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002502 $allowed = 1;
2503 }
2504 }
2505 if ($seen && !$allowed) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002506 WARN("braces {} are not necessary for any arm of this statement\n" . $herectx);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002507 }
2508 }
2509 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002510 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002511 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002512 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002513
Andy Whitcroftcf655042008-03-04 14:28:20 -08002514 # Check the pre-context.
2515 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2516 #print "APW: ALLOWED: pre<$1>\n";
2517 $allowed = 1;
2518 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002519
2520 my ($level, $endln, @chunks) =
2521 ctx_statement_full($linenr, $realcnt, $-[0]);
2522
Andy Whitcroftcf655042008-03-04 14:28:20 -08002523 # Check the condition.
2524 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07002525 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08002526 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002527 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08002528 }
2529 if (statement_lines($cond) > 1) {
2530 #print "APW: ALLOWED: cond<$cond>\n";
2531 $allowed = 1;
2532 }
2533 if ($block =~/\b(?:if|for|while)\b/) {
2534 #print "APW: ALLOWED: block<$block>\n";
2535 $allowed = 1;
2536 }
2537 if (statement_block_size($block) > 1) {
2538 #print "APW: ALLOWED: lines block<$block>\n";
2539 $allowed = 1;
2540 }
2541 # Check the post-context.
2542 if (defined $chunks[1]) {
2543 my ($cond, $block) = @{$chunks[1]};
2544 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002545 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002546 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08002547 if ($block =~ /^\s*\{/) {
2548 #print "APW: ALLOWED: chunk-1 block<$block>\n";
2549 $allowed = 1;
2550 }
2551 }
2552 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
2553 my $herectx = $here . "\n";;
Andy Whitcroftf0556632008-10-15 22:02:23 -07002554 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002555
Andy Whitcroftf0556632008-10-15 22:02:23 -07002556 for (my $n = 0; $n < $cnt; $n++) {
2557 $herectx .= raw_line($linenr, $n) . "\n";;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002558 }
2559
2560 WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002561 }
2562 }
2563
Andy Whitcroft653d4872007-06-23 17:16:34 -07002564# don't include deprecated include files (uses RAW line)
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002565 for my $inc (@dep_includes) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002566 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002567 ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002568 }
2569 }
2570
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002571# don't use deprecated functions
2572 for my $func (@dep_functions) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002573 if ($line =~ /\b$func\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002574 ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002575 }
2576 }
2577
2578# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002579 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2580 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002581 WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002582 }
2583
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002584# SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
2585 if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
2586 ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
2587 }
2588
Andy Whitcroft00df3442007-06-08 13:47:06 -07002589# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002590 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002591 CHK("if this code is redundant consider removing it\n" .
2592 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002593 }
2594
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002595# check for needless kfree() checks
2596 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2597 my $expr = $1;
2598 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
Wolfram Sang3c232142008-07-23 21:29:05 -07002599 WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002600 }
2601 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07002602# check for needless usb_free_urb() checks
2603 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2604 my $expr = $1;
2605 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
2606 WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
2607 }
2608 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002609
Patrick Pannuto1a15a252010-08-09 17:21:01 -07002610# prefer usleep_range over udelay
2611 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
2612 # ignore udelay's < 10, however
2613 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
2614 CHK("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
2615 }
2616 }
2617
Patrick Pannuto09ef8722010-08-09 17:21:02 -07002618# warn about unexpectedly long msleep's
2619 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
2620 if ($1 < 20) {
2621 WARN("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
2622 }
2623 }
2624
Andy Whitcroft00df3442007-06-08 13:47:06 -07002625# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002626# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002627# print "#ifdef in C files should be avoided\n";
2628# print "$herecurr";
2629# $clean = 0;
2630# }
2631
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002632# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002633 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002634 ERROR("exactly one space required after that #$1\n" . $herecurr);
2635 }
2636
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002637# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002638 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
2639 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002640 my $which = $1;
2641 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002642 CHK("$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002643 }
2644 }
2645# check for memory barriers without a comment.
2646 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2647 if (!ctx_has_comment($first_line, $linenr)) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002648 CHK("memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002649 }
2650 }
2651# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002652 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002653 CHK("architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002654 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002655
Tobias Klauserd4977c72010-05-24 14:33:30 -07002656# Check that the storage class is at the beginning of a declaration
2657 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2658 WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
2659 }
2660
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002661# check the location of the inline attribute, that it is between
2662# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002663 if ($line =~ /\b$Type\s+$Inline\b/ ||
2664 $line =~ /\b$Inline\s+$Storage\b/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002665 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2666 }
2667
Andy Whitcroft8905a672007-11-28 16:21:06 -08002668# Check for __inline__ and __inline, prefer inline
2669 if ($line =~ /\b(__inline__|__inline)\b/) {
2670 WARN("plain inline is preferred over $1\n" . $herecurr);
2671 }
2672
Joe Perches8f53a9b2010-03-05 13:43:48 -08002673# check for sizeof(&)
2674 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2675 WARN("sizeof(& should be avoided\n" . $herecurr);
2676 }
2677
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002678# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002679 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002680 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002681 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002682 my $function_name = $1;
2683 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002684
2685 my $s = $stat;
2686 if (defined $cond) {
2687 substr($s, 0, length($cond), '');
2688 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002689 if ($s =~ /^\s*;/ &&
2690 $function_name ne 'uninitialized_var')
2691 {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002692 WARN("externs should be avoided in .c files\n" . $herecurr);
2693 }
2694
2695 if ($paren_space =~ /\n/) {
2696 WARN("arguments for function declarations should follow identifier\n" . $herecurr);
2697 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002698
2699 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2700 $stat =~ /^.\s*extern\s+/)
2701 {
2702 WARN("externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002703 }
2704
2705# checks for new __setup's
2706 if ($rawline =~ /\b__setup\("([^"]*)"/) {
2707 my $name = $1;
2708
2709 if (!grep(/$name/, @setup_docs)) {
2710 CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
2711 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002712 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002713
2714# check for pointless casting of kmalloc return
2715 if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
2716 WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
2717 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002718
2719# check for gcc specific __FUNCTION__
2720 if ($line =~ /__FUNCTION__/) {
2721 WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2722 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002723
2724# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002725 if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002726 WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
2727 }
2728# check for semaphores used as mutexes
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002729 if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002730 WARN("consider using a completion\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01002731
Andy Whitcroft773647a2008-03-28 14:15:58 -07002732 }
2733# recommend strict_strto* over simple_strto*
2734 if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
2735 WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
2736 }
Michael Ellermanf3db6632008-07-23 21:28:57 -07002737# check for __initcall(), use device_initcall() explicitly please
2738 if ($line =~ /^.\s*__initcall\s*\(/) {
2739 WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
2740 }
Emese Revfy79404842010-03-05 13:43:53 -08002741# check for various ops structs, ensure they are const.
2742 my $struct_ops = qr{acpi_dock_ops|
2743 address_space_operations|
2744 backlight_ops|
2745 block_device_operations|
2746 dentry_operations|
2747 dev_pm_ops|
2748 dma_map_ops|
2749 extent_io_ops|
2750 file_lock_operations|
2751 file_operations|
2752 hv_ops|
2753 ide_dma_ops|
2754 intel_dvo_dev_ops|
2755 item_operations|
2756 iwl_ops|
2757 kgdb_arch|
2758 kgdb_io|
2759 kset_uevent_ops|
2760 lock_manager_operations|
2761 microcode_ops|
2762 mtrr_ops|
2763 neigh_ops|
2764 nlmsvc_binding|
2765 pci_raw_ops|
2766 pipe_buf_operations|
2767 platform_hibernation_ops|
2768 platform_suspend_ops|
2769 proto_ops|
2770 rpc_pipe_ops|
2771 seq_operations|
2772 snd_ac97_build_ops|
2773 soc_pcmcia_socket_ops|
2774 stacktrace_ops|
2775 sysfs_ops|
2776 tty_operations|
2777 usb_mon_operations|
2778 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002779 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08002780 $line =~ /\bstruct\s+($struct_ops)\b/) {
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08002781 WARN("struct $1 should normally be const\n" .
2782 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08002783 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002784
2785# use of NR_CPUS is usually wrong
2786# ignore definitions of NR_CPUS and usage to define arrays as likely right
2787 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002788 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
2789 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002790 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
2791 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
2792 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002793 {
2794 WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
2795 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002796
2797# check for %L{u,d,i} in strings
2798 my $string;
2799 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2800 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07002801 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07002802 if ($string =~ /(?<!%)%L[udi]/) {
2803 WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2804 last;
2805 }
2806 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002807
2808# whine mightly about in_atomic
2809 if ($line =~ /\bin_atomic\s*\(/) {
2810 if ($realfile =~ m@^drivers/@) {
2811 ERROR("do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08002812 } elsif ($realfile !~ m@^kernel/@) {
Andy Whitcroft691d77b2009-01-06 14:41:16 -08002813 WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
2814 }
2815 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01002816
2817# check for lockdep_set_novalidate_class
2818 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
2819 $line =~ /__lockdep_no_validate__\s*\)/ ) {
2820 if ($realfile !~ m@^kernel/lockdep@ &&
2821 $realfile !~ m@^include/linux/lockdep@ &&
2822 $realfile !~ m@^drivers/base/core@) {
2823 ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
2824 }
2825 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002826 }
2827
2828 # If we have no input at all, then there is nothing to report on
2829 # so just keep quiet.
2830 if ($#rawlines == -1) {
2831 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002832 }
2833
Andy Whitcroft8905a672007-11-28 16:21:06 -08002834 # In mailback mode only produce a report in the negative, for
2835 # things that appear to be patches.
2836 if ($mailback && ($clean == 1 || !$is_patch)) {
2837 exit(0);
2838 }
2839
2840 # This is not a patch, and we are are in 'no-patch' mode so
2841 # just keep quiet.
2842 if (!$chk_patch && !$is_patch) {
2843 exit(0);
2844 }
2845
2846 if (!$is_patch) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002847 ERROR("Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002848 }
2849 if ($is_patch && $chk_signoff && $signoff == 0) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002850 ERROR("Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002851 }
2852
Andy Whitcroft8905a672007-11-28 16:21:06 -08002853 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002854 if ($summary && !($clean == 1 && $quiet == 1)) {
2855 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002856 print "total: $cnt_error errors, $cnt_warn warnings, " .
2857 (($check)? "$cnt_chk checks, " : "") .
2858 "$cnt_lines lines checked\n";
2859 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002860 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002861
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002862 if ($quiet == 0) {
2863 # If there were whitespace errors which cleanpatch can fix
2864 # then suggest that.
2865 if ($rpt_cleaners) {
2866 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2867 print " scripts/cleanfile\n\n";
2868 }
2869 }
2870
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002871 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002872 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002873 }
2874 if ($clean == 0 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002875 print "$vname has style problems, please review. If any of these errors\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002876 print "are false positives report them to the maintainer, see\n";
2877 print "CHECKPATCH in MAINTAINERS.\n";
2878 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002879
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002880 return $clean;
2881}