checkpatch: add types for other OS typedefs
[deliverable/linux.git] / scripts / checkpatch.pl
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
7
8 use strict;
9 use POSIX;
10 use File::Basename;
11 use Cwd 'abs_path';
12
13 my $P = $0;
14 my $D = dirname(abs_path($P));
15
16 my $V = '0.32';
17
18 use Getopt::Long qw(:config no_auto_abbrev);
19
20 my $quiet = 0;
21 my $tree = 1;
22 my $chk_signoff = 1;
23 my $chk_patch = 1;
24 my $tst_only;
25 my $emacs = 0;
26 my $terse = 0;
27 my $file = 0;
28 my $check = 0;
29 my $check_orig = 0;
30 my $summary = 1;
31 my $mailback = 0;
32 my $summary_file = 0;
33 my $show_types = 0;
34 my $fix = 0;
35 my $fix_inplace = 0;
36 my $root;
37 my %debug;
38 my %camelcase = ();
39 my %use_type = ();
40 my @use = ();
41 my %ignore_type = ();
42 my @ignore = ();
43 my $help = 0;
44 my $configuration_file = ".checkpatch.conf";
45 my $max_line_length = 80;
46 my $ignore_perl_version = 0;
47 my $minimum_perl_version = 5.10.0;
48 my $min_conf_desc_length = 4;
49 my $spelling_file = "$D/spelling.txt";
50
51 sub help {
52 my ($exitcode) = @_;
53
54 print << "EOM";
55 Usage: $P [OPTION]... [FILE]...
56 Version: $V
57
58 Options:
59 -q, --quiet quiet
60 --no-tree run without a kernel tree
61 --no-signoff do not check for 'Signed-off-by' line
62 --patch treat FILE as patchfile (default)
63 --emacs emacs compile window format
64 --terse one line per report
65 -f, --file treat FILE as regular source file
66 --subjective, --strict enable more subjective tests
67 --types TYPE(,TYPE2...) show only these comma separated message types
68 --ignore TYPE(,TYPE2...) ignore various comma separated message types
69 --max-line-length=n set the maximum line length, if exceeded, warn
70 --min-conf-desc-length=n set the min description length, if shorter, warn
71 --show-types show the message "types" in the output
72 --root=PATH PATH to the kernel tree root
73 --no-summary suppress the per-file summary
74 --mailback only produce a report in case of warnings/errors
75 --summary-file include the filename in summary
76 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
77 'values', 'possible', 'type', and 'attr' (default
78 is all off)
79 --test-only=WORD report only warnings/errors containing WORD
80 literally
81 --fix EXPERIMENTAL - may create horrible results
82 If correctable single-line errors exist, create
83 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
84 with potential errors corrected to the preferred
85 checkpatch style
86 --fix-inplace EXPERIMENTAL - may create horrible results
87 Is the same as --fix, but overwrites the input
88 file. It's your fault if there's no backup or git
89 --ignore-perl-version override checking of perl version. expect
90 runtime errors.
91 -h, --help, --version display this help and exit
92
93 When FILE is - read standard input.
94 EOM
95
96 exit($exitcode);
97 }
98
99 my $conf = which_conf($configuration_file);
100 if (-f $conf) {
101 my @conf_args;
102 open(my $conffile, '<', "$conf")
103 or warn "$P: Can't find a readable $configuration_file file $!\n";
104
105 while (<$conffile>) {
106 my $line = $_;
107
108 $line =~ s/\s*\n?$//g;
109 $line =~ s/^\s*//g;
110 $line =~ s/\s+/ /g;
111
112 next if ($line =~ m/^\s*#/);
113 next if ($line =~ m/^\s*$/);
114
115 my @words = split(" ", $line);
116 foreach my $word (@words) {
117 last if ($word =~ m/^#/);
118 push (@conf_args, $word);
119 }
120 }
121 close($conffile);
122 unshift(@ARGV, @conf_args) if @conf_args;
123 }
124
125 GetOptions(
126 'q|quiet+' => \$quiet,
127 'tree!' => \$tree,
128 'signoff!' => \$chk_signoff,
129 'patch!' => \$chk_patch,
130 'emacs!' => \$emacs,
131 'terse!' => \$terse,
132 'f|file!' => \$file,
133 'subjective!' => \$check,
134 'strict!' => \$check,
135 'ignore=s' => \@ignore,
136 'types=s' => \@use,
137 'show-types!' => \$show_types,
138 'max-line-length=i' => \$max_line_length,
139 'min-conf-desc-length=i' => \$min_conf_desc_length,
140 'root=s' => \$root,
141 'summary!' => \$summary,
142 'mailback!' => \$mailback,
143 'summary-file!' => \$summary_file,
144 'fix!' => \$fix,
145 'fix-inplace!' => \$fix_inplace,
146 'ignore-perl-version!' => \$ignore_perl_version,
147 'debug=s' => \%debug,
148 'test-only=s' => \$tst_only,
149 'h|help' => \$help,
150 'version' => \$help
151 ) or help(1);
152
153 help(0) if ($help);
154
155 $fix = 1 if ($fix_inplace);
156 $check_orig = $check;
157
158 my $exit = 0;
159
160 if ($^V && $^V lt $minimum_perl_version) {
161 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
162 if (!$ignore_perl_version) {
163 exit(1);
164 }
165 }
166
167 if ($#ARGV < 0) {
168 print "$P: no input files\n";
169 exit(1);
170 }
171
172 sub hash_save_array_words {
173 my ($hashRef, $arrayRef) = @_;
174
175 my @array = split(/,/, join(',', @$arrayRef));
176 foreach my $word (@array) {
177 $word =~ s/\s*\n?$//g;
178 $word =~ s/^\s*//g;
179 $word =~ s/\s+/ /g;
180 $word =~ tr/[a-z]/[A-Z]/;
181
182 next if ($word =~ m/^\s*#/);
183 next if ($word =~ m/^\s*$/);
184
185 $hashRef->{$word}++;
186 }
187 }
188
189 sub hash_show_words {
190 my ($hashRef, $prefix) = @_;
191
192 if ($quiet == 0 && keys %$hashRef) {
193 print "NOTE: $prefix message types:";
194 foreach my $word (sort keys %$hashRef) {
195 print " $word";
196 }
197 print "\n\n";
198 }
199 }
200
201 hash_save_array_words(\%ignore_type, \@ignore);
202 hash_save_array_words(\%use_type, \@use);
203
204 my $dbg_values = 0;
205 my $dbg_possible = 0;
206 my $dbg_type = 0;
207 my $dbg_attr = 0;
208 for my $key (keys %debug) {
209 ## no critic
210 eval "\${dbg_$key} = '$debug{$key}';";
211 die "$@" if ($@);
212 }
213
214 my $rpt_cleaners = 0;
215
216 if ($terse) {
217 $emacs = 1;
218 $quiet++;
219 }
220
221 if ($tree) {
222 if (defined $root) {
223 if (!top_of_kernel_tree($root)) {
224 die "$P: $root: --root does not point at a valid tree\n";
225 }
226 } else {
227 if (top_of_kernel_tree('.')) {
228 $root = '.';
229 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
230 top_of_kernel_tree($1)) {
231 $root = $1;
232 }
233 }
234
235 if (!defined $root) {
236 print "Must be run from the top-level dir. of a kernel tree\n";
237 exit(2);
238 }
239 }
240
241 my $emitted_corrupt = 0;
242
243 our $Ident = qr{
244 [A-Za-z_][A-Za-z\d_]*
245 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
246 }x;
247 our $Storage = qr{extern|static|asmlinkage};
248 our $Sparse = qr{
249 __user|
250 __kernel|
251 __force|
252 __iomem|
253 __must_check|
254 __init_refok|
255 __kprobes|
256 __ref|
257 __rcu
258 }x;
259 our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
260 our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
261 our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
262 our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
263 our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
264
265 # Notes to $Attribute:
266 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
267 our $Attribute = qr{
268 const|
269 __percpu|
270 __nocast|
271 __safe|
272 __bitwise__|
273 __packed__|
274 __packed2__|
275 __naked|
276 __maybe_unused|
277 __always_unused|
278 __noreturn|
279 __used|
280 __cold|
281 __pure|
282 __noclone|
283 __deprecated|
284 __read_mostly|
285 __kprobes|
286 $InitAttribute|
287 ____cacheline_aligned|
288 ____cacheline_aligned_in_smp|
289 ____cacheline_internodealigned_in_smp|
290 __weak
291 }x;
292 our $Modifier;
293 our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
294 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
295 our $Lval = qr{$Ident(?:$Member)*};
296
297 our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
298 our $Binary = qr{(?i)0b[01]+$Int_type?};
299 our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
300 our $Int = qr{[0-9]+$Int_type?};
301 our $Octal = qr{0[0-7]+$Int_type?};
302 our $String = qr{"[X\t]*"};
303 our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
304 our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
305 our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
306 our $Float = qr{$Float_hex|$Float_dec|$Float_int};
307 our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
308 our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
309 our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
310 our $Arithmetic = qr{\+|-|\*|\/|%};
311 our $Operators = qr{
312 <=|>=|==|!=|
313 =>|->|<<|>>|<|>|!|~|
314 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
315 }x;
316
317 our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
318
319 our $NonptrType;
320 our $NonptrTypeMisordered;
321 our $NonptrTypeWithAttr;
322 our $Type;
323 our $TypeMisordered;
324 our $Declare;
325 our $DeclareMisordered;
326
327 our $NON_ASCII_UTF8 = qr{
328 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
329 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
330 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
331 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
332 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
333 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
334 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
335 }x;
336
337 our $UTF8 = qr{
338 [\x09\x0A\x0D\x20-\x7E] # ASCII
339 | $NON_ASCII_UTF8
340 }x;
341
342 our $typeOtherOSTypedefs = qr{(?x:
343 u_(?:char|short|int|long) | # bsd
344 u(?:nchar|short|int|long) # sysv
345 )};
346
347 our $typeTypedefs = qr{(?x:
348 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
349 atomic_t
350 )};
351
352 our $logFunctions = qr{(?x:
353 printk(?:_ratelimited|_once|)|
354 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
355 WARN(?:_RATELIMIT|_ONCE|)|
356 panic|
357 MODULE_[A-Z_]+|
358 seq_vprintf|seq_printf|seq_puts
359 )};
360
361 our $signature_tags = qr{(?xi:
362 Signed-off-by:|
363 Acked-by:|
364 Tested-by:|
365 Reviewed-by:|
366 Reported-by:|
367 Suggested-by:|
368 To:|
369 Cc:
370 )};
371
372 our @typeListMisordered = (
373 qr{char\s+(?:un)?signed},
374 qr{int\s+(?:(?:un)?signed\s+)?short\s},
375 qr{int\s+short(?:\s+(?:un)?signed)},
376 qr{short\s+int(?:\s+(?:un)?signed)},
377 qr{(?:un)?signed\s+int\s+short},
378 qr{short\s+(?:un)?signed},
379 qr{long\s+int\s+(?:un)?signed},
380 qr{int\s+long\s+(?:un)?signed},
381 qr{long\s+(?:un)?signed\s+int},
382 qr{int\s+(?:un)?signed\s+long},
383 qr{int\s+(?:un)?signed},
384 qr{int\s+long\s+long\s+(?:un)?signed},
385 qr{long\s+long\s+int\s+(?:un)?signed},
386 qr{long\s+long\s+(?:un)?signed\s+int},
387 qr{long\s+long\s+(?:un)?signed},
388 qr{long\s+(?:un)?signed},
389 );
390
391 our @typeList = (
392 qr{void},
393 qr{(?:(?:un)?signed\s+)?char},
394 qr{(?:(?:un)?signed\s+)?short\s+int},
395 qr{(?:(?:un)?signed\s+)?short},
396 qr{(?:(?:un)?signed\s+)?int},
397 qr{(?:(?:un)?signed\s+)?long\s+int},
398 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
399 qr{(?:(?:un)?signed\s+)?long\s+long},
400 qr{(?:(?:un)?signed\s+)?long},
401 qr{(?:un)?signed},
402 qr{float},
403 qr{double},
404 qr{bool},
405 qr{struct\s+$Ident},
406 qr{union\s+$Ident},
407 qr{enum\s+$Ident},
408 qr{${Ident}_t},
409 qr{${Ident}_handler},
410 qr{${Ident}_handler_fn},
411 @typeListMisordered,
412 );
413 our @typeListWithAttr = (
414 @typeList,
415 qr{struct\s+$InitAttribute\s+$Ident},
416 qr{union\s+$InitAttribute\s+$Ident},
417 );
418
419 our @modifierList = (
420 qr{fastcall},
421 );
422
423 our @mode_permission_funcs = (
424 ["module_param", 3],
425 ["module_param_(?:array|named|string)", 4],
426 ["module_param_array_named", 5],
427 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
428 ["proc_create(?:_data|)", 2],
429 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
430 );
431
432 #Create a search pattern for all these functions to speed up a loop below
433 our $mode_perms_search = "";
434 foreach my $entry (@mode_permission_funcs) {
435 $mode_perms_search .= '|' if ($mode_perms_search ne "");
436 $mode_perms_search .= $entry->[0];
437 }
438
439 our $allowed_asm_includes = qr{(?x:
440 irq|
441 memory|
442 time|
443 reboot
444 )};
445 # memory.h: ARM has a custom one
446
447 # Load common spelling mistakes and build regular expression list.
448 my $misspellings;
449 my %spelling_fix;
450
451 if (open(my $spelling, '<', $spelling_file)) {
452 my @spelling_list;
453 while (<$spelling>) {
454 my $line = $_;
455
456 $line =~ s/\s*\n?$//g;
457 $line =~ s/^\s*//g;
458
459 next if ($line =~ m/^\s*#/);
460 next if ($line =~ m/^\s*$/);
461
462 my ($suspect, $fix) = split(/\|\|/, $line);
463
464 push(@spelling_list, $suspect);
465 $spelling_fix{$suspect} = $fix;
466 }
467 close($spelling);
468 $misspellings = join("|", @spelling_list);
469 } else {
470 warn "No typos will be found - file '$spelling_file': $!\n";
471 }
472
473 sub build_types {
474 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
475 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
476 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
477 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
478 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
479 $NonptrType = qr{
480 (?:$Modifier\s+|const\s+)*
481 (?:
482 (?:typeof|__typeof__)\s*\([^\)]*\)|
483 (?:$typeOtherOSTypedefs\b)|
484 (?:$typeTypedefs\b)|
485 (?:${all}\b)
486 )
487 (?:\s+$Modifier|\s+const)*
488 }x;
489 $NonptrTypeMisordered = qr{
490 (?:$Modifier\s+|const\s+)*
491 (?:
492 (?:${Misordered}\b)
493 )
494 (?:\s+$Modifier|\s+const)*
495 }x;
496 $NonptrTypeWithAttr = qr{
497 (?:$Modifier\s+|const\s+)*
498 (?:
499 (?:typeof|__typeof__)\s*\([^\)]*\)|
500 (?:$typeTypedefs\b)|
501 (?:$typeOtherOSTypedefs\b)|
502 (?:${allWithAttr}\b)
503 )
504 (?:\s+$Modifier|\s+const)*
505 }x;
506 $Type = qr{
507 $NonptrType
508 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
509 (?:\s+$Inline|\s+$Modifier)*
510 }x;
511 $TypeMisordered = qr{
512 $NonptrTypeMisordered
513 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
514 (?:\s+$Inline|\s+$Modifier)*
515 }x;
516 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
517 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
518 }
519 build_types();
520
521 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
522
523 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
524 # requires at least perl version v5.10.0
525 # Any use must be runtime checked with $^V
526
527 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
528 our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
529 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
530
531 our $declaration_macros = qr{(?x:
532 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
533 (?:$Storage\s+)?LIST_HEAD\s*\(|
534 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
535 )};
536
537 sub deparenthesize {
538 my ($string) = @_;
539 return "" if (!defined($string));
540
541 while ($string =~ /^\s*\(.*\)\s*$/) {
542 $string =~ s@^\s*\(\s*@@;
543 $string =~ s@\s*\)\s*$@@;
544 }
545
546 $string =~ s@\s+@ @g;
547
548 return $string;
549 }
550
551 sub seed_camelcase_file {
552 my ($file) = @_;
553
554 return if (!(-f $file));
555
556 local $/;
557
558 open(my $include_file, '<', "$file")
559 or warn "$P: Can't read '$file' $!\n";
560 my $text = <$include_file>;
561 close($include_file);
562
563 my @lines = split('\n', $text);
564
565 foreach my $line (@lines) {
566 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
567 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
568 $camelcase{$1} = 1;
569 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
570 $camelcase{$1} = 1;
571 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
572 $camelcase{$1} = 1;
573 }
574 }
575 }
576
577 my $camelcase_seeded = 0;
578 sub seed_camelcase_includes {
579 return if ($camelcase_seeded);
580
581 my $files;
582 my $camelcase_cache = "";
583 my @include_files = ();
584
585 $camelcase_seeded = 1;
586
587 if (-e ".git") {
588 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
589 chomp $git_last_include_commit;
590 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
591 } else {
592 my $last_mod_date = 0;
593 $files = `find $root/include -name "*.h"`;
594 @include_files = split('\n', $files);
595 foreach my $file (@include_files) {
596 my $date = POSIX::strftime("%Y%m%d%H%M",
597 localtime((stat $file)[9]));
598 $last_mod_date = $date if ($last_mod_date < $date);
599 }
600 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
601 }
602
603 if ($camelcase_cache ne "" && -f $camelcase_cache) {
604 open(my $camelcase_file, '<', "$camelcase_cache")
605 or warn "$P: Can't read '$camelcase_cache' $!\n";
606 while (<$camelcase_file>) {
607 chomp;
608 $camelcase{$_} = 1;
609 }
610 close($camelcase_file);
611
612 return;
613 }
614
615 if (-e ".git") {
616 $files = `git ls-files "include/*.h"`;
617 @include_files = split('\n', $files);
618 }
619
620 foreach my $file (@include_files) {
621 seed_camelcase_file($file);
622 }
623
624 if ($camelcase_cache ne "") {
625 unlink glob ".checkpatch-camelcase.*";
626 open(my $camelcase_file, '>', "$camelcase_cache")
627 or warn "$P: Can't write '$camelcase_cache' $!\n";
628 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
629 print $camelcase_file ("$_\n");
630 }
631 close($camelcase_file);
632 }
633 }
634
635 sub git_commit_info {
636 my ($commit, $id, $desc) = @_;
637
638 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
639
640 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
641 $output =~ s/^\s*//gm;
642 my @lines = split("\n", $output);
643
644 return ($id, $desc) if ($#lines < 0);
645
646 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
647 # Maybe one day convert this block of bash into something that returns
648 # all matching commit ids, but it's very slow...
649 #
650 # echo "checking commits $1..."
651 # git rev-list --remotes | grep -i "^$1" |
652 # while read line ; do
653 # git log --format='%H %s' -1 $line |
654 # echo "commit $(cut -c 1-12,41-)"
655 # done
656 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
657 } else {
658 $id = substr($lines[0], 0, 12);
659 $desc = substr($lines[0], 41);
660 }
661
662 return ($id, $desc);
663 }
664
665 $chk_signoff = 0 if ($file);
666
667 my @rawlines = ();
668 my @lines = ();
669 my @fixed = ();
670 my @fixed_inserted = ();
671 my @fixed_deleted = ();
672 my $fixlinenr = -1;
673
674 my $vname;
675 for my $filename (@ARGV) {
676 my $FILE;
677 if ($file) {
678 open($FILE, '-|', "diff -u /dev/null $filename") ||
679 die "$P: $filename: diff failed - $!\n";
680 } elsif ($filename eq '-') {
681 open($FILE, '<&STDIN');
682 } else {
683 open($FILE, '<', "$filename") ||
684 die "$P: $filename: open failed - $!\n";
685 }
686 if ($filename eq '-') {
687 $vname = 'Your patch';
688 } else {
689 $vname = $filename;
690 }
691 while (<$FILE>) {
692 chomp;
693 push(@rawlines, $_);
694 }
695 close($FILE);
696 if (!process($filename)) {
697 $exit = 1;
698 }
699 @rawlines = ();
700 @lines = ();
701 @fixed = ();
702 @fixed_inserted = ();
703 @fixed_deleted = ();
704 $fixlinenr = -1;
705 }
706
707 exit($exit);
708
709 sub top_of_kernel_tree {
710 my ($root) = @_;
711
712 my @tree_check = (
713 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
714 "README", "Documentation", "arch", "include", "drivers",
715 "fs", "init", "ipc", "kernel", "lib", "scripts",
716 );
717
718 foreach my $check (@tree_check) {
719 if (! -e $root . '/' . $check) {
720 return 0;
721 }
722 }
723 return 1;
724 }
725
726 sub parse_email {
727 my ($formatted_email) = @_;
728
729 my $name = "";
730 my $address = "";
731 my $comment = "";
732
733 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
734 $name = $1;
735 $address = $2;
736 $comment = $3 if defined $3;
737 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
738 $address = $1;
739 $comment = $2 if defined $2;
740 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
741 $address = $1;
742 $comment = $2 if defined $2;
743 $formatted_email =~ s/$address.*$//;
744 $name = $formatted_email;
745 $name = trim($name);
746 $name =~ s/^\"|\"$//g;
747 # If there's a name left after stripping spaces and
748 # leading quotes, and the address doesn't have both
749 # leading and trailing angle brackets, the address
750 # is invalid. ie:
751 # "joe smith joe@smith.com" bad
752 # "joe smith <joe@smith.com" bad
753 if ($name ne "" && $address !~ /^<[^>]+>$/) {
754 $name = "";
755 $address = "";
756 $comment = "";
757 }
758 }
759
760 $name = trim($name);
761 $name =~ s/^\"|\"$//g;
762 $address = trim($address);
763 $address =~ s/^\<|\>$//g;
764
765 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
766 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
767 $name = "\"$name\"";
768 }
769
770 return ($name, $address, $comment);
771 }
772
773 sub format_email {
774 my ($name, $address) = @_;
775
776 my $formatted_email;
777
778 $name = trim($name);
779 $name =~ s/^\"|\"$//g;
780 $address = trim($address);
781
782 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
783 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
784 $name = "\"$name\"";
785 }
786
787 if ("$name" eq "") {
788 $formatted_email = "$address";
789 } else {
790 $formatted_email = "$name <$address>";
791 }
792
793 return $formatted_email;
794 }
795
796 sub which {
797 my ($bin) = @_;
798
799 foreach my $path (split(/:/, $ENV{PATH})) {
800 if (-e "$path/$bin") {
801 return "$path/$bin";
802 }
803 }
804
805 return "";
806 }
807
808 sub which_conf {
809 my ($conf) = @_;
810
811 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
812 if (-e "$path/$conf") {
813 return "$path/$conf";
814 }
815 }
816
817 return "";
818 }
819
820 sub expand_tabs {
821 my ($str) = @_;
822
823 my $res = '';
824 my $n = 0;
825 for my $c (split(//, $str)) {
826 if ($c eq "\t") {
827 $res .= ' ';
828 $n++;
829 for (; ($n % 8) != 0; $n++) {
830 $res .= ' ';
831 }
832 next;
833 }
834 $res .= $c;
835 $n++;
836 }
837
838 return $res;
839 }
840 sub copy_spacing {
841 (my $res = shift) =~ tr/\t/ /c;
842 return $res;
843 }
844
845 sub line_stats {
846 my ($line) = @_;
847
848 # Drop the diff line leader and expand tabs
849 $line =~ s/^.//;
850 $line = expand_tabs($line);
851
852 # Pick the indent from the front of the line.
853 my ($white) = ($line =~ /^(\s*)/);
854
855 return (length($line), length($white));
856 }
857
858 my $sanitise_quote = '';
859
860 sub sanitise_line_reset {
861 my ($in_comment) = @_;
862
863 if ($in_comment) {
864 $sanitise_quote = '*/';
865 } else {
866 $sanitise_quote = '';
867 }
868 }
869 sub sanitise_line {
870 my ($line) = @_;
871
872 my $res = '';
873 my $l = '';
874
875 my $qlen = 0;
876 my $off = 0;
877 my $c;
878
879 # Always copy over the diff marker.
880 $res = substr($line, 0, 1);
881
882 for ($off = 1; $off < length($line); $off++) {
883 $c = substr($line, $off, 1);
884
885 # Comments we are wacking completly including the begin
886 # and end, all to $;.
887 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
888 $sanitise_quote = '*/';
889
890 substr($res, $off, 2, "$;$;");
891 $off++;
892 next;
893 }
894 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
895 $sanitise_quote = '';
896 substr($res, $off, 2, "$;$;");
897 $off++;
898 next;
899 }
900 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
901 $sanitise_quote = '//';
902
903 substr($res, $off, 2, $sanitise_quote);
904 $off++;
905 next;
906 }
907
908 # A \ in a string means ignore the next character.
909 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
910 $c eq "\\") {
911 substr($res, $off, 2, 'XX');
912 $off++;
913 next;
914 }
915 # Regular quotes.
916 if ($c eq "'" || $c eq '"') {
917 if ($sanitise_quote eq '') {
918 $sanitise_quote = $c;
919
920 substr($res, $off, 1, $c);
921 next;
922 } elsif ($sanitise_quote eq $c) {
923 $sanitise_quote = '';
924 }
925 }
926
927 #print "c<$c> SQ<$sanitise_quote>\n";
928 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
929 substr($res, $off, 1, $;);
930 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
931 substr($res, $off, 1, $;);
932 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
933 substr($res, $off, 1, 'X');
934 } else {
935 substr($res, $off, 1, $c);
936 }
937 }
938
939 if ($sanitise_quote eq '//') {
940 $sanitise_quote = '';
941 }
942
943 # The pathname on a #include may be surrounded by '<' and '>'.
944 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
945 my $clean = 'X' x length($1);
946 $res =~ s@\<.*\>@<$clean>@;
947
948 # The whole of a #error is a string.
949 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
950 my $clean = 'X' x length($1);
951 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
952 }
953
954 return $res;
955 }
956
957 sub get_quoted_string {
958 my ($line, $rawline) = @_;
959
960 return "" if ($line !~ m/(\"[X\t]+\")/g);
961 return substr($rawline, $-[0], $+[0] - $-[0]);
962 }
963
964 sub ctx_statement_block {
965 my ($linenr, $remain, $off) = @_;
966 my $line = $linenr - 1;
967 my $blk = '';
968 my $soff = $off;
969 my $coff = $off - 1;
970 my $coff_set = 0;
971
972 my $loff = 0;
973
974 my $type = '';
975 my $level = 0;
976 my @stack = ();
977 my $p;
978 my $c;
979 my $len = 0;
980
981 my $remainder;
982 while (1) {
983 @stack = (['', 0]) if ($#stack == -1);
984
985 #warn "CSB: blk<$blk> remain<$remain>\n";
986 # If we are about to drop off the end, pull in more
987 # context.
988 if ($off >= $len) {
989 for (; $remain > 0; $line++) {
990 last if (!defined $lines[$line]);
991 next if ($lines[$line] =~ /^-/);
992 $remain--;
993 $loff = $len;
994 $blk .= $lines[$line] . "\n";
995 $len = length($blk);
996 $line++;
997 last;
998 }
999 # Bail if there is no further context.
1000 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1001 if ($off >= $len) {
1002 last;
1003 }
1004 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1005 $level++;
1006 $type = '#';
1007 }
1008 }
1009 $p = $c;
1010 $c = substr($blk, $off, 1);
1011 $remainder = substr($blk, $off);
1012
1013 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1014
1015 # Handle nested #if/#else.
1016 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1017 push(@stack, [ $type, $level ]);
1018 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1019 ($type, $level) = @{$stack[$#stack - 1]};
1020 } elsif ($remainder =~ /^#\s*endif\b/) {
1021 ($type, $level) = @{pop(@stack)};
1022 }
1023
1024 # Statement ends at the ';' or a close '}' at the
1025 # outermost level.
1026 if ($level == 0 && $c eq ';') {
1027 last;
1028 }
1029
1030 # An else is really a conditional as long as its not else if
1031 if ($level == 0 && $coff_set == 0 &&
1032 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1033 $remainder =~ /^(else)(?:\s|{)/ &&
1034 $remainder !~ /^else\s+if\b/) {
1035 $coff = $off + length($1) - 1;
1036 $coff_set = 1;
1037 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1038 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1039 }
1040
1041 if (($type eq '' || $type eq '(') && $c eq '(') {
1042 $level++;
1043 $type = '(';
1044 }
1045 if ($type eq '(' && $c eq ')') {
1046 $level--;
1047 $type = ($level != 0)? '(' : '';
1048
1049 if ($level == 0 && $coff < $soff) {
1050 $coff = $off;
1051 $coff_set = 1;
1052 #warn "CSB: mark coff<$coff>\n";
1053 }
1054 }
1055 if (($type eq '' || $type eq '{') && $c eq '{') {
1056 $level++;
1057 $type = '{';
1058 }
1059 if ($type eq '{' && $c eq '}') {
1060 $level--;
1061 $type = ($level != 0)? '{' : '';
1062
1063 if ($level == 0) {
1064 if (substr($blk, $off + 1, 1) eq ';') {
1065 $off++;
1066 }
1067 last;
1068 }
1069 }
1070 # Preprocessor commands end at the newline unless escaped.
1071 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1072 $level--;
1073 $type = '';
1074 $off++;
1075 last;
1076 }
1077 $off++;
1078 }
1079 # We are truly at the end, so shuffle to the next line.
1080 if ($off == $len) {
1081 $loff = $len + 1;
1082 $line++;
1083 $remain--;
1084 }
1085
1086 my $statement = substr($blk, $soff, $off - $soff + 1);
1087 my $condition = substr($blk, $soff, $coff - $soff + 1);
1088
1089 #warn "STATEMENT<$statement>\n";
1090 #warn "CONDITION<$condition>\n";
1091
1092 #print "coff<$coff> soff<$off> loff<$loff>\n";
1093
1094 return ($statement, $condition,
1095 $line, $remain + 1, $off - $loff + 1, $level);
1096 }
1097
1098 sub statement_lines {
1099 my ($stmt) = @_;
1100
1101 # Strip the diff line prefixes and rip blank lines at start and end.
1102 $stmt =~ s/(^|\n)./$1/g;
1103 $stmt =~ s/^\s*//;
1104 $stmt =~ s/\s*$//;
1105
1106 my @stmt_lines = ($stmt =~ /\n/g);
1107
1108 return $#stmt_lines + 2;
1109 }
1110
1111 sub statement_rawlines {
1112 my ($stmt) = @_;
1113
1114 my @stmt_lines = ($stmt =~ /\n/g);
1115
1116 return $#stmt_lines + 2;
1117 }
1118
1119 sub statement_block_size {
1120 my ($stmt) = @_;
1121
1122 $stmt =~ s/(^|\n)./$1/g;
1123 $stmt =~ s/^\s*{//;
1124 $stmt =~ s/}\s*$//;
1125 $stmt =~ s/^\s*//;
1126 $stmt =~ s/\s*$//;
1127
1128 my @stmt_lines = ($stmt =~ /\n/g);
1129 my @stmt_statements = ($stmt =~ /;/g);
1130
1131 my $stmt_lines = $#stmt_lines + 2;
1132 my $stmt_statements = $#stmt_statements + 1;
1133
1134 if ($stmt_lines > $stmt_statements) {
1135 return $stmt_lines;
1136 } else {
1137 return $stmt_statements;
1138 }
1139 }
1140
1141 sub ctx_statement_full {
1142 my ($linenr, $remain, $off) = @_;
1143 my ($statement, $condition, $level);
1144
1145 my (@chunks);
1146
1147 # Grab the first conditional/block pair.
1148 ($statement, $condition, $linenr, $remain, $off, $level) =
1149 ctx_statement_block($linenr, $remain, $off);
1150 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1151 push(@chunks, [ $condition, $statement ]);
1152 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1153 return ($level, $linenr, @chunks);
1154 }
1155
1156 # Pull in the following conditional/block pairs and see if they
1157 # could continue the statement.
1158 for (;;) {
1159 ($statement, $condition, $linenr, $remain, $off, $level) =
1160 ctx_statement_block($linenr, $remain, $off);
1161 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1162 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1163 #print "C: push\n";
1164 push(@chunks, [ $condition, $statement ]);
1165 }
1166
1167 return ($level, $linenr, @chunks);
1168 }
1169
1170 sub ctx_block_get {
1171 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1172 my $line;
1173 my $start = $linenr - 1;
1174 my $blk = '';
1175 my @o;
1176 my @c;
1177 my @res = ();
1178
1179 my $level = 0;
1180 my @stack = ($level);
1181 for ($line = $start; $remain > 0; $line++) {
1182 next if ($rawlines[$line] =~ /^-/);
1183 $remain--;
1184
1185 $blk .= $rawlines[$line];
1186
1187 # Handle nested #if/#else.
1188 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1189 push(@stack, $level);
1190 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1191 $level = $stack[$#stack - 1];
1192 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1193 $level = pop(@stack);
1194 }
1195
1196 foreach my $c (split(//, $lines[$line])) {
1197 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1198 if ($off > 0) {
1199 $off--;
1200 next;
1201 }
1202
1203 if ($c eq $close && $level > 0) {
1204 $level--;
1205 last if ($level == 0);
1206 } elsif ($c eq $open) {
1207 $level++;
1208 }
1209 }
1210
1211 if (!$outer || $level <= 1) {
1212 push(@res, $rawlines[$line]);
1213 }
1214
1215 last if ($level == 0);
1216 }
1217
1218 return ($level, @res);
1219 }
1220 sub ctx_block_outer {
1221 my ($linenr, $remain) = @_;
1222
1223 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1224 return @r;
1225 }
1226 sub ctx_block {
1227 my ($linenr, $remain) = @_;
1228
1229 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1230 return @r;
1231 }
1232 sub ctx_statement {
1233 my ($linenr, $remain, $off) = @_;
1234
1235 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1236 return @r;
1237 }
1238 sub ctx_block_level {
1239 my ($linenr, $remain) = @_;
1240
1241 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1242 }
1243 sub ctx_statement_level {
1244 my ($linenr, $remain, $off) = @_;
1245
1246 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1247 }
1248
1249 sub ctx_locate_comment {
1250 my ($first_line, $end_line) = @_;
1251
1252 # Catch a comment on the end of the line itself.
1253 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1254 return $current_comment if (defined $current_comment);
1255
1256 # Look through the context and try and figure out if there is a
1257 # comment.
1258 my $in_comment = 0;
1259 $current_comment = '';
1260 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1261 my $line = $rawlines[$linenr - 1];
1262 #warn " $line\n";
1263 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1264 $in_comment = 1;
1265 }
1266 if ($line =~ m@/\*@) {
1267 $in_comment = 1;
1268 }
1269 if (!$in_comment && $current_comment ne '') {
1270 $current_comment = '';
1271 }
1272 $current_comment .= $line . "\n" if ($in_comment);
1273 if ($line =~ m@\*/@) {
1274 $in_comment = 0;
1275 }
1276 }
1277
1278 chomp($current_comment);
1279 return($current_comment);
1280 }
1281 sub ctx_has_comment {
1282 my ($first_line, $end_line) = @_;
1283 my $cmt = ctx_locate_comment($first_line, $end_line);
1284
1285 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1286 ##print "CMMT: $cmt\n";
1287
1288 return ($cmt ne '');
1289 }
1290
1291 sub raw_line {
1292 my ($linenr, $cnt) = @_;
1293
1294 my $offset = $linenr - 1;
1295 $cnt++;
1296
1297 my $line;
1298 while ($cnt) {
1299 $line = $rawlines[$offset++];
1300 next if (defined($line) && $line =~ /^-/);
1301 $cnt--;
1302 }
1303
1304 return $line;
1305 }
1306
1307 sub cat_vet {
1308 my ($vet) = @_;
1309 my ($res, $coded);
1310
1311 $res = '';
1312 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1313 $res .= $1;
1314 if ($2 ne '') {
1315 $coded = sprintf("^%c", unpack('C', $2) + 64);
1316 $res .= $coded;
1317 }
1318 }
1319 $res =~ s/$/\$/;
1320
1321 return $res;
1322 }
1323
1324 my $av_preprocessor = 0;
1325 my $av_pending;
1326 my @av_paren_type;
1327 my $av_pend_colon;
1328
1329 sub annotate_reset {
1330 $av_preprocessor = 0;
1331 $av_pending = '_';
1332 @av_paren_type = ('E');
1333 $av_pend_colon = 'O';
1334 }
1335
1336 sub annotate_values {
1337 my ($stream, $type) = @_;
1338
1339 my $res;
1340 my $var = '_' x length($stream);
1341 my $cur = $stream;
1342
1343 print "$stream\n" if ($dbg_values > 1);
1344
1345 while (length($cur)) {
1346 @av_paren_type = ('E') if ($#av_paren_type < 0);
1347 print " <" . join('', @av_paren_type) .
1348 "> <$type> <$av_pending>" if ($dbg_values > 1);
1349 if ($cur =~ /^(\s+)/o) {
1350 print "WS($1)\n" if ($dbg_values > 1);
1351 if ($1 =~ /\n/ && $av_preprocessor) {
1352 $type = pop(@av_paren_type);
1353 $av_preprocessor = 0;
1354 }
1355
1356 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1357 print "CAST($1)\n" if ($dbg_values > 1);
1358 push(@av_paren_type, $type);
1359 $type = 'c';
1360
1361 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1362 print "DECLARE($1)\n" if ($dbg_values > 1);
1363 $type = 'T';
1364
1365 } elsif ($cur =~ /^($Modifier)\s*/) {
1366 print "MODIFIER($1)\n" if ($dbg_values > 1);
1367 $type = 'T';
1368
1369 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1370 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1371 $av_preprocessor = 1;
1372 push(@av_paren_type, $type);
1373 if ($2 ne '') {
1374 $av_pending = 'N';
1375 }
1376 $type = 'E';
1377
1378 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1379 print "UNDEF($1)\n" if ($dbg_values > 1);
1380 $av_preprocessor = 1;
1381 push(@av_paren_type, $type);
1382
1383 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1384 print "PRE_START($1)\n" if ($dbg_values > 1);
1385 $av_preprocessor = 1;
1386
1387 push(@av_paren_type, $type);
1388 push(@av_paren_type, $type);
1389 $type = 'E';
1390
1391 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1392 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1393 $av_preprocessor = 1;
1394
1395 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1396
1397 $type = 'E';
1398
1399 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1400 print "PRE_END($1)\n" if ($dbg_values > 1);
1401
1402 $av_preprocessor = 1;
1403
1404 # Assume all arms of the conditional end as this
1405 # one does, and continue as if the #endif was not here.
1406 pop(@av_paren_type);
1407 push(@av_paren_type, $type);
1408 $type = 'E';
1409
1410 } elsif ($cur =~ /^(\\\n)/o) {
1411 print "PRECONT($1)\n" if ($dbg_values > 1);
1412
1413 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1414 print "ATTR($1)\n" if ($dbg_values > 1);
1415 $av_pending = $type;
1416 $type = 'N';
1417
1418 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1419 print "SIZEOF($1)\n" if ($dbg_values > 1);
1420 if (defined $2) {
1421 $av_pending = 'V';
1422 }
1423 $type = 'N';
1424
1425 } elsif ($cur =~ /^(if|while|for)\b/o) {
1426 print "COND($1)\n" if ($dbg_values > 1);
1427 $av_pending = 'E';
1428 $type = 'N';
1429
1430 } elsif ($cur =~/^(case)/o) {
1431 print "CASE($1)\n" if ($dbg_values > 1);
1432 $av_pend_colon = 'C';
1433 $type = 'N';
1434
1435 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1436 print "KEYWORD($1)\n" if ($dbg_values > 1);
1437 $type = 'N';
1438
1439 } elsif ($cur =~ /^(\()/o) {
1440 print "PAREN('$1')\n" if ($dbg_values > 1);
1441 push(@av_paren_type, $av_pending);
1442 $av_pending = '_';
1443 $type = 'N';
1444
1445 } elsif ($cur =~ /^(\))/o) {
1446 my $new_type = pop(@av_paren_type);
1447 if ($new_type ne '_') {
1448 $type = $new_type;
1449 print "PAREN('$1') -> $type\n"
1450 if ($dbg_values > 1);
1451 } else {
1452 print "PAREN('$1')\n" if ($dbg_values > 1);
1453 }
1454
1455 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1456 print "FUNC($1)\n" if ($dbg_values > 1);
1457 $type = 'V';
1458 $av_pending = 'V';
1459
1460 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1461 if (defined $2 && $type eq 'C' || $type eq 'T') {
1462 $av_pend_colon = 'B';
1463 } elsif ($type eq 'E') {
1464 $av_pend_colon = 'L';
1465 }
1466 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1467 $type = 'V';
1468
1469 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1470 print "IDENT($1)\n" if ($dbg_values > 1);
1471 $type = 'V';
1472
1473 } elsif ($cur =~ /^($Assignment)/o) {
1474 print "ASSIGN($1)\n" if ($dbg_values > 1);
1475 $type = 'N';
1476
1477 } elsif ($cur =~/^(;|{|})/) {
1478 print "END($1)\n" if ($dbg_values > 1);
1479 $type = 'E';
1480 $av_pend_colon = 'O';
1481
1482 } elsif ($cur =~/^(,)/) {
1483 print "COMMA($1)\n" if ($dbg_values > 1);
1484 $type = 'C';
1485
1486 } elsif ($cur =~ /^(\?)/o) {
1487 print "QUESTION($1)\n" if ($dbg_values > 1);
1488 $type = 'N';
1489
1490 } elsif ($cur =~ /^(:)/o) {
1491 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1492
1493 substr($var, length($res), 1, $av_pend_colon);
1494 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1495 $type = 'E';
1496 } else {
1497 $type = 'N';
1498 }
1499 $av_pend_colon = 'O';
1500
1501 } elsif ($cur =~ /^(\[)/o) {
1502 print "CLOSE($1)\n" if ($dbg_values > 1);
1503 $type = 'N';
1504
1505 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1506 my $variant;
1507
1508 print "OPV($1)\n" if ($dbg_values > 1);
1509 if ($type eq 'V') {
1510 $variant = 'B';
1511 } else {
1512 $variant = 'U';
1513 }
1514
1515 substr($var, length($res), 1, $variant);
1516 $type = 'N';
1517
1518 } elsif ($cur =~ /^($Operators)/o) {
1519 print "OP($1)\n" if ($dbg_values > 1);
1520 if ($1 ne '++' && $1 ne '--') {
1521 $type = 'N';
1522 }
1523
1524 } elsif ($cur =~ /(^.)/o) {
1525 print "C($1)\n" if ($dbg_values > 1);
1526 }
1527 if (defined $1) {
1528 $cur = substr($cur, length($1));
1529 $res .= $type x length($1);
1530 }
1531 }
1532
1533 return ($res, $var);
1534 }
1535
1536 sub possible {
1537 my ($possible, $line) = @_;
1538 my $notPermitted = qr{(?:
1539 ^(?:
1540 $Modifier|
1541 $Storage|
1542 $Type|
1543 DEFINE_\S+
1544 )$|
1545 ^(?:
1546 goto|
1547 return|
1548 case|
1549 else|
1550 asm|__asm__|
1551 do|
1552 \#|
1553 \#\#|
1554 )(?:\s|$)|
1555 ^(?:typedef|struct|enum)\b
1556 )}x;
1557 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1558 if ($possible !~ $notPermitted) {
1559 # Check for modifiers.
1560 $possible =~ s/\s*$Storage\s*//g;
1561 $possible =~ s/\s*$Sparse\s*//g;
1562 if ($possible =~ /^\s*$/) {
1563
1564 } elsif ($possible =~ /\s/) {
1565 $possible =~ s/\s*$Type\s*//g;
1566 for my $modifier (split(' ', $possible)) {
1567 if ($modifier !~ $notPermitted) {
1568 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1569 push(@modifierList, $modifier);
1570 }
1571 }
1572
1573 } else {
1574 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1575 push(@typeList, $possible);
1576 }
1577 build_types();
1578 } else {
1579 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1580 }
1581 }
1582
1583 my $prefix = '';
1584
1585 sub show_type {
1586 my ($type) = @_;
1587
1588 return defined $use_type{$type} if (scalar keys %use_type > 0);
1589
1590 return !defined $ignore_type{$type};
1591 }
1592
1593 sub report {
1594 my ($level, $type, $msg) = @_;
1595
1596 if (!show_type($type) ||
1597 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1598 return 0;
1599 }
1600 my $line;
1601 if ($show_types) {
1602 $line = "$prefix$level:$type: $msg\n";
1603 } else {
1604 $line = "$prefix$level: $msg\n";
1605 }
1606 $line = (split('\n', $line))[0] . "\n" if ($terse);
1607
1608 push(our @report, $line);
1609
1610 return 1;
1611 }
1612
1613 sub report_dump {
1614 our @report;
1615 }
1616
1617 sub fixup_current_range {
1618 my ($lineRef, $offset, $length) = @_;
1619
1620 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1621 my $o = $1;
1622 my $l = $2;
1623 my $no = $o + $offset;
1624 my $nl = $l + $length;
1625 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1626 }
1627 }
1628
1629 sub fix_inserted_deleted_lines {
1630 my ($linesRef, $insertedRef, $deletedRef) = @_;
1631
1632 my $range_last_linenr = 0;
1633 my $delta_offset = 0;
1634
1635 my $old_linenr = 0;
1636 my $new_linenr = 0;
1637
1638 my $next_insert = 0;
1639 my $next_delete = 0;
1640
1641 my @lines = ();
1642
1643 my $inserted = @{$insertedRef}[$next_insert++];
1644 my $deleted = @{$deletedRef}[$next_delete++];
1645
1646 foreach my $old_line (@{$linesRef}) {
1647 my $save_line = 1;
1648 my $line = $old_line; #don't modify the array
1649 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1650 $delta_offset = 0;
1651 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1652 $range_last_linenr = $new_linenr;
1653 fixup_current_range(\$line, $delta_offset, 0);
1654 }
1655
1656 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1657 $deleted = @{$deletedRef}[$next_delete++];
1658 $save_line = 0;
1659 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1660 }
1661
1662 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1663 push(@lines, ${$inserted}{'LINE'});
1664 $inserted = @{$insertedRef}[$next_insert++];
1665 $new_linenr++;
1666 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1667 }
1668
1669 if ($save_line) {
1670 push(@lines, $line);
1671 $new_linenr++;
1672 }
1673
1674 $old_linenr++;
1675 }
1676
1677 return @lines;
1678 }
1679
1680 sub fix_insert_line {
1681 my ($linenr, $line) = @_;
1682
1683 my $inserted = {
1684 LINENR => $linenr,
1685 LINE => $line,
1686 };
1687 push(@fixed_inserted, $inserted);
1688 }
1689
1690 sub fix_delete_line {
1691 my ($linenr, $line) = @_;
1692
1693 my $deleted = {
1694 LINENR => $linenr,
1695 LINE => $line,
1696 };
1697
1698 push(@fixed_deleted, $deleted);
1699 }
1700
1701 sub ERROR {
1702 my ($type, $msg) = @_;
1703
1704 if (report("ERROR", $type, $msg)) {
1705 our $clean = 0;
1706 our $cnt_error++;
1707 return 1;
1708 }
1709 return 0;
1710 }
1711 sub WARN {
1712 my ($type, $msg) = @_;
1713
1714 if (report("WARNING", $type, $msg)) {
1715 our $clean = 0;
1716 our $cnt_warn++;
1717 return 1;
1718 }
1719 return 0;
1720 }
1721 sub CHK {
1722 my ($type, $msg) = @_;
1723
1724 if ($check && report("CHECK", $type, $msg)) {
1725 our $clean = 0;
1726 our $cnt_chk++;
1727 return 1;
1728 }
1729 return 0;
1730 }
1731
1732 sub check_absolute_file {
1733 my ($absolute, $herecurr) = @_;
1734 my $file = $absolute;
1735
1736 ##print "absolute<$absolute>\n";
1737
1738 # See if any suffix of this path is a path within the tree.
1739 while ($file =~ s@^[^/]*/@@) {
1740 if (-f "$root/$file") {
1741 ##print "file<$file>\n";
1742 last;
1743 }
1744 }
1745 if (! -f _) {
1746 return 0;
1747 }
1748
1749 # It is, so see if the prefix is acceptable.
1750 my $prefix = $absolute;
1751 substr($prefix, -length($file)) = '';
1752
1753 ##print "prefix<$prefix>\n";
1754 if ($prefix ne ".../") {
1755 WARN("USE_RELATIVE_PATH",
1756 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1757 }
1758 }
1759
1760 sub trim {
1761 my ($string) = @_;
1762
1763 $string =~ s/^\s+|\s+$//g;
1764
1765 return $string;
1766 }
1767
1768 sub ltrim {
1769 my ($string) = @_;
1770
1771 $string =~ s/^\s+//;
1772
1773 return $string;
1774 }
1775
1776 sub rtrim {
1777 my ($string) = @_;
1778
1779 $string =~ s/\s+$//;
1780
1781 return $string;
1782 }
1783
1784 sub string_find_replace {
1785 my ($string, $find, $replace) = @_;
1786
1787 $string =~ s/$find/$replace/g;
1788
1789 return $string;
1790 }
1791
1792 sub tabify {
1793 my ($leading) = @_;
1794
1795 my $source_indent = 8;
1796 my $max_spaces_before_tab = $source_indent - 1;
1797 my $spaces_to_tab = " " x $source_indent;
1798
1799 #convert leading spaces to tabs
1800 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1801 #Remove spaces before a tab
1802 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1803
1804 return "$leading";
1805 }
1806
1807 sub pos_last_openparen {
1808 my ($line) = @_;
1809
1810 my $pos = 0;
1811
1812 my $opens = $line =~ tr/\(/\(/;
1813 my $closes = $line =~ tr/\)/\)/;
1814
1815 my $last_openparen = 0;
1816
1817 if (($opens == 0) || ($closes >= $opens)) {
1818 return -1;
1819 }
1820
1821 my $len = length($line);
1822
1823 for ($pos = 0; $pos < $len; $pos++) {
1824 my $string = substr($line, $pos);
1825 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1826 $pos += length($1) - 1;
1827 } elsif (substr($line, $pos, 1) eq '(') {
1828 $last_openparen = $pos;
1829 } elsif (index($string, '(') == -1) {
1830 last;
1831 }
1832 }
1833
1834 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1835 }
1836
1837 sub process {
1838 my $filename = shift;
1839
1840 my $linenr=0;
1841 my $prevline="";
1842 my $prevrawline="";
1843 my $stashline="";
1844 my $stashrawline="";
1845
1846 my $length;
1847 my $indent;
1848 my $previndent=0;
1849 my $stashindent=0;
1850
1851 our $clean = 1;
1852 my $signoff = 0;
1853 my $is_patch = 0;
1854
1855 my $in_header_lines = $file ? 0 : 1;
1856 my $in_commit_log = 0; #Scanning lines before patch
1857 my $reported_maintainer_file = 0;
1858 my $non_utf8_charset = 0;
1859
1860 my $last_blank_line = 0;
1861 my $last_coalesced_string_linenr = -1;
1862
1863 our @report = ();
1864 our $cnt_lines = 0;
1865 our $cnt_error = 0;
1866 our $cnt_warn = 0;
1867 our $cnt_chk = 0;
1868
1869 # Trace the real file/line as we go.
1870 my $realfile = '';
1871 my $realline = 0;
1872 my $realcnt = 0;
1873 my $here = '';
1874 my $in_comment = 0;
1875 my $comment_edge = 0;
1876 my $first_line = 0;
1877 my $p1_prefix = '';
1878
1879 my $prev_values = 'E';
1880
1881 # suppression flags
1882 my %suppress_ifbraces;
1883 my %suppress_whiletrailers;
1884 my %suppress_export;
1885 my $suppress_statement = 0;
1886
1887 my %signatures = ();
1888
1889 # Pre-scan the patch sanitizing the lines.
1890 # Pre-scan the patch looking for any __setup documentation.
1891 #
1892 my @setup_docs = ();
1893 my $setup_docs = 0;
1894
1895 my $camelcase_file_seeded = 0;
1896
1897 sanitise_line_reset();
1898 my $line;
1899 foreach my $rawline (@rawlines) {
1900 $linenr++;
1901 $line = $rawline;
1902
1903 push(@fixed, $rawline) if ($fix);
1904
1905 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1906 $setup_docs = 0;
1907 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1908 $setup_docs = 1;
1909 }
1910 #next;
1911 }
1912 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1913 $realline=$1-1;
1914 if (defined $2) {
1915 $realcnt=$3+1;
1916 } else {
1917 $realcnt=1+1;
1918 }
1919 $in_comment = 0;
1920
1921 # Guestimate if this is a continuing comment. Run
1922 # the context looking for a comment "edge". If this
1923 # edge is a close comment then we must be in a comment
1924 # at context start.
1925 my $edge;
1926 my $cnt = $realcnt;
1927 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1928 next if (defined $rawlines[$ln - 1] &&
1929 $rawlines[$ln - 1] =~ /^-/);
1930 $cnt--;
1931 #print "RAW<$rawlines[$ln - 1]>\n";
1932 last if (!defined $rawlines[$ln - 1]);
1933 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1934 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1935 ($edge) = $1;
1936 last;
1937 }
1938 }
1939 if (defined $edge && $edge eq '*/') {
1940 $in_comment = 1;
1941 }
1942
1943 # Guestimate if this is a continuing comment. If this
1944 # is the start of a diff block and this line starts
1945 # ' *' then it is very likely a comment.
1946 if (!defined $edge &&
1947 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1948 {
1949 $in_comment = 1;
1950 }
1951
1952 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1953 sanitise_line_reset($in_comment);
1954
1955 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1956 # Standardise the strings and chars within the input to
1957 # simplify matching -- only bother with positive lines.
1958 $line = sanitise_line($rawline);
1959 }
1960 push(@lines, $line);
1961
1962 if ($realcnt > 1) {
1963 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1964 } else {
1965 $realcnt = 0;
1966 }
1967
1968 #print "==>$rawline\n";
1969 #print "-->$line\n";
1970
1971 if ($setup_docs && $line =~ /^\+/) {
1972 push(@setup_docs, $line);
1973 }
1974 }
1975
1976 $prefix = '';
1977
1978 $realcnt = 0;
1979 $linenr = 0;
1980 $fixlinenr = -1;
1981 foreach my $line (@lines) {
1982 $linenr++;
1983 $fixlinenr++;
1984 my $sline = $line; #copy of $line
1985 $sline =~ s/$;/ /g; #with comments as spaces
1986
1987 my $rawline = $rawlines[$linenr - 1];
1988
1989 #extract the line range in the file after the patch is applied
1990 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1991 $is_patch = 1;
1992 $first_line = $linenr + 1;
1993 $realline=$1-1;
1994 if (defined $2) {
1995 $realcnt=$3+1;
1996 } else {
1997 $realcnt=1+1;
1998 }
1999 annotate_reset();
2000 $prev_values = 'E';
2001
2002 %suppress_ifbraces = ();
2003 %suppress_whiletrailers = ();
2004 %suppress_export = ();
2005 $suppress_statement = 0;
2006 next;
2007
2008 # track the line number as we move through the hunk, note that
2009 # new versions of GNU diff omit the leading space on completely
2010 # blank context lines so we need to count that too.
2011 } elsif ($line =~ /^( |\+|$)/) {
2012 $realline++;
2013 $realcnt-- if ($realcnt != 0);
2014
2015 # Measure the line length and indent.
2016 ($length, $indent) = line_stats($rawline);
2017
2018 # Track the previous line.
2019 ($prevline, $stashline) = ($stashline, $line);
2020 ($previndent, $stashindent) = ($stashindent, $indent);
2021 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2022
2023 #warn "line<$line>\n";
2024
2025 } elsif ($realcnt == 1) {
2026 $realcnt--;
2027 }
2028
2029 my $hunk_line = ($realcnt != 0);
2030
2031 #make up the handle for any error we report on this line
2032 $prefix = "$filename:$realline: " if ($emacs && $file);
2033 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2034
2035 $here = "#$linenr: " if (!$file);
2036 $here = "#$realline: " if ($file);
2037
2038 my $found_file = 0;
2039 # extract the filename as it passes
2040 if ($line =~ /^diff --git.*?(\S+)$/) {
2041 $realfile = $1;
2042 $realfile =~ s@^([^/]*)/@@ if (!$file);
2043 $in_commit_log = 0;
2044 $found_file = 1;
2045 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2046 $realfile = $1;
2047 $realfile =~ s@^([^/]*)/@@ if (!$file);
2048 $in_commit_log = 0;
2049
2050 $p1_prefix = $1;
2051 if (!$file && $tree && $p1_prefix ne '' &&
2052 -e "$root/$p1_prefix") {
2053 WARN("PATCH_PREFIX",
2054 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2055 }
2056
2057 if ($realfile =~ m@^include/asm/@) {
2058 ERROR("MODIFIED_INCLUDE_ASM",
2059 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2060 }
2061 $found_file = 1;
2062 }
2063
2064 if ($found_file) {
2065 if ($realfile =~ m@^(drivers/net/|net/)@) {
2066 $check = 1;
2067 } else {
2068 $check = $check_orig;
2069 }
2070 next;
2071 }
2072
2073 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2074
2075 my $hereline = "$here\n$rawline\n";
2076 my $herecurr = "$here\n$rawline\n";
2077 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2078
2079 $cnt_lines++ if ($realcnt != 0);
2080
2081 # Check for incorrect file permissions
2082 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2083 my $permhere = $here . "FILE: $realfile\n";
2084 if ($realfile !~ m@scripts/@ &&
2085 $realfile !~ /\.(py|pl|awk|sh)$/) {
2086 ERROR("EXECUTE_PERMISSIONS",
2087 "do not set execute permissions for source files\n" . $permhere);
2088 }
2089 }
2090
2091 # Check the patch for a signoff:
2092 if ($line =~ /^\s*signed-off-by:/i) {
2093 $signoff++;
2094 $in_commit_log = 0;
2095 }
2096
2097 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2098 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2099 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2100 $reported_maintainer_file = 1;
2101 }
2102
2103 # Check signature styles
2104 if (!$in_header_lines &&
2105 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2106 my $space_before = $1;
2107 my $sign_off = $2;
2108 my $space_after = $3;
2109 my $email = $4;
2110 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2111
2112 if ($sign_off !~ /$signature_tags/) {
2113 WARN("BAD_SIGN_OFF",
2114 "Non-standard signature: $sign_off\n" . $herecurr);
2115 }
2116 if (defined $space_before && $space_before ne "") {
2117 if (WARN("BAD_SIGN_OFF",
2118 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2119 $fix) {
2120 $fixed[$fixlinenr] =
2121 "$ucfirst_sign_off $email";
2122 }
2123 }
2124 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2125 if (WARN("BAD_SIGN_OFF",
2126 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2127 $fix) {
2128 $fixed[$fixlinenr] =
2129 "$ucfirst_sign_off $email";
2130 }
2131
2132 }
2133 if (!defined $space_after || $space_after ne " ") {
2134 if (WARN("BAD_SIGN_OFF",
2135 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2136 $fix) {
2137 $fixed[$fixlinenr] =
2138 "$ucfirst_sign_off $email";
2139 }
2140 }
2141
2142 my ($email_name, $email_address, $comment) = parse_email($email);
2143 my $suggested_email = format_email(($email_name, $email_address));
2144 if ($suggested_email eq "") {
2145 ERROR("BAD_SIGN_OFF",
2146 "Unrecognized email address: '$email'\n" . $herecurr);
2147 } else {
2148 my $dequoted = $suggested_email;
2149 $dequoted =~ s/^"//;
2150 $dequoted =~ s/" </ </;
2151 # Don't force email to have quotes
2152 # Allow just an angle bracketed address
2153 if ("$dequoted$comment" ne $email &&
2154 "<$email_address>$comment" ne $email &&
2155 "$suggested_email$comment" ne $email) {
2156 WARN("BAD_SIGN_OFF",
2157 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2158 }
2159 }
2160
2161 # Check for duplicate signatures
2162 my $sig_nospace = $line;
2163 $sig_nospace =~ s/\s//g;
2164 $sig_nospace = lc($sig_nospace);
2165 if (defined $signatures{$sig_nospace}) {
2166 WARN("BAD_SIGN_OFF",
2167 "Duplicate signature\n" . $herecurr);
2168 } else {
2169 $signatures{$sig_nospace} = 1;
2170 }
2171 }
2172
2173 # Check for old stable address
2174 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2175 ERROR("STABLE_ADDRESS",
2176 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2177 }
2178
2179 # Check for unwanted Gerrit info
2180 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2181 ERROR("GERRIT_CHANGE_ID",
2182 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2183 }
2184
2185 # Check for git id commit length and improperly formed commit descriptions
2186 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
2187 my $init_char = $1;
2188 my $orig_commit = lc($2);
2189 my $short = 1;
2190 my $long = 0;
2191 my $case = 1;
2192 my $space = 1;
2193 my $hasdesc = 0;
2194 my $id = '0123456789ab';
2195 my $orig_desc = "commit description";
2196 my $description = "";
2197
2198 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2199 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2200 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2201 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2202 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2203 $orig_desc = $1;
2204 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2205 defined $rawlines[$linenr] &&
2206 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2207 $orig_desc = $1;
2208 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2209 defined $rawlines[$linenr] &&
2210 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2211 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2212 $orig_desc = $1;
2213 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2214 $orig_desc .= " " . $1;
2215 }
2216
2217 ($id, $description) = git_commit_info($orig_commit,
2218 $id, $orig_desc);
2219
2220 if ($short || $long || $space || $case || ($orig_desc ne $description)) {
2221 ERROR("GIT_COMMIT_ID",
2222 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2223 }
2224 }
2225
2226 # Check for added, moved or deleted files
2227 if (!$reported_maintainer_file && !$in_commit_log &&
2228 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2229 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2230 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2231 (defined($1) || defined($2))))) {
2232 $reported_maintainer_file = 1;
2233 WARN("FILE_PATH_CHANGES",
2234 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2235 }
2236
2237 # Check for wrappage within a valid hunk of the file
2238 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2239 ERROR("CORRUPTED_PATCH",
2240 "patch seems to be corrupt (line wrapped?)\n" .
2241 $herecurr) if (!$emitted_corrupt++);
2242 }
2243
2244 # Check for absolute kernel paths.
2245 if ($tree) {
2246 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2247 my $file = $1;
2248
2249 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2250 check_absolute_file($1, $herecurr)) {
2251 #
2252 } else {
2253 check_absolute_file($file, $herecurr);
2254 }
2255 }
2256 }
2257
2258 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2259 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2260 $rawline !~ m/^$UTF8*$/) {
2261 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2262
2263 my $blank = copy_spacing($rawline);
2264 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2265 my $hereptr = "$hereline$ptr\n";
2266
2267 CHK("INVALID_UTF8",
2268 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2269 }
2270
2271 # Check if it's the start of a commit log
2272 # (not a header line and we haven't seen the patch filename)
2273 if ($in_header_lines && $realfile =~ /^$/ &&
2274 !($rawline =~ /^\s+\S/ ||
2275 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2276 $in_header_lines = 0;
2277 $in_commit_log = 1;
2278 }
2279
2280 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2281 # declined it, i.e defined some charset where it is missing.
2282 if ($in_header_lines &&
2283 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2284 $1 !~ /utf-8/i) {
2285 $non_utf8_charset = 1;
2286 }
2287
2288 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2289 $rawline =~ /$NON_ASCII_UTF8/) {
2290 WARN("UTF8_BEFORE_PATCH",
2291 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2292 }
2293
2294 # Check for various typo / spelling mistakes
2295 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
2296 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2297 my $typo = $1;
2298 my $typo_fix = $spelling_fix{lc($typo)};
2299 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2300 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2301 my $msg_type = \&WARN;
2302 $msg_type = \&CHK if ($file);
2303 if (&{$msg_type}("TYPO_SPELLING",
2304 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2305 $fix) {
2306 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2307 }
2308 }
2309 }
2310
2311 # ignore non-hunk lines and lines being removed
2312 next if (!$hunk_line || $line =~ /^-/);
2313
2314 #trailing whitespace
2315 if ($line =~ /^\+.*\015/) {
2316 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2317 if (ERROR("DOS_LINE_ENDINGS",
2318 "DOS line endings\n" . $herevet) &&
2319 $fix) {
2320 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2321 }
2322 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2323 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2324 if (ERROR("TRAILING_WHITESPACE",
2325 "trailing whitespace\n" . $herevet) &&
2326 $fix) {
2327 $fixed[$fixlinenr] =~ s/\s+$//;
2328 }
2329
2330 $rpt_cleaners = 1;
2331 }
2332
2333 # Check for FSF mailing addresses.
2334 if ($rawline =~ /\bwrite to the Free/i ||
2335 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2336 $rawline =~ /\b51\s+Franklin\s+St/i) {
2337 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2338 my $msg_type = \&ERROR;
2339 $msg_type = \&CHK if ($file);
2340 &{$msg_type}("FSF_MAILING_ADDRESS",
2341 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
2342 }
2343
2344 # check for Kconfig help text having a real description
2345 # Only applies when adding the entry originally, after that we do not have
2346 # sufficient context to determine whether it is indeed long enough.
2347 if ($realfile =~ /Kconfig/ &&
2348 $line =~ /^\+\s*config\s+/) {
2349 my $length = 0;
2350 my $cnt = $realcnt;
2351 my $ln = $linenr + 1;
2352 my $f;
2353 my $is_start = 0;
2354 my $is_end = 0;
2355 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2356 $f = $lines[$ln - 1];
2357 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2358 $is_end = $lines[$ln - 1] =~ /^\+/;
2359
2360 next if ($f =~ /^-/);
2361 last if (!$file && $f =~ /^\@\@/);
2362
2363 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2364 $is_start = 1;
2365 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2366 $length = -1;
2367 }
2368
2369 $f =~ s/^.//;
2370 $f =~ s/#.*//;
2371 $f =~ s/^\s+//;
2372 next if ($f =~ /^$/);
2373 if ($f =~ /^\s*config\s/) {
2374 $is_end = 1;
2375 last;
2376 }
2377 $length++;
2378 }
2379 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2380 WARN("CONFIG_DESCRIPTION",
2381 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2382 }
2383 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2384 }
2385
2386 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2387 if ($realfile =~ /Kconfig/ &&
2388 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2389 WARN("CONFIG_EXPERIMENTAL",
2390 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2391 }
2392
2393 # discourage the use of boolean for type definition attributes of Kconfig options
2394 if ($realfile =~ /Kconfig/ &&
2395 $line =~ /^\+\s*\bboolean\b/) {
2396 WARN("CONFIG_TYPE_BOOLEAN",
2397 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2398 }
2399
2400 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2401 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2402 my $flag = $1;
2403 my $replacement = {
2404 'EXTRA_AFLAGS' => 'asflags-y',
2405 'EXTRA_CFLAGS' => 'ccflags-y',
2406 'EXTRA_CPPFLAGS' => 'cppflags-y',
2407 'EXTRA_LDFLAGS' => 'ldflags-y',
2408 };
2409
2410 WARN("DEPRECATED_VARIABLE",
2411 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2412 }
2413
2414 # check for DT compatible documentation
2415 if (defined $root &&
2416 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2417 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2418
2419 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2420
2421 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2422 my $vp_file = $dt_path . "vendor-prefixes.txt";
2423
2424 foreach my $compat (@compats) {
2425 my $compat2 = $compat;
2426 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2427 my $compat3 = $compat;
2428 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2429 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2430 if ( $? >> 8 ) {
2431 WARN("UNDOCUMENTED_DT_STRING",
2432 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2433 }
2434
2435 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2436 my $vendor = $1;
2437 `grep -Eq "^$vendor\\b" $vp_file`;
2438 if ( $? >> 8 ) {
2439 WARN("UNDOCUMENTED_DT_STRING",
2440 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2441 }
2442 }
2443 }
2444
2445 # check we are in a valid source file if not then ignore this hunk
2446 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2447
2448 #line length limit
2449 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
2450 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
2451 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2452 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
2453 $length > $max_line_length)
2454 {
2455 WARN("LONG_LINE",
2456 "line over $max_line_length characters\n" . $herecurr);
2457 }
2458
2459 # check for adding lines without a newline.
2460 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2461 WARN("MISSING_EOF_NEWLINE",
2462 "adding a line without newline at end of file\n" . $herecurr);
2463 }
2464
2465 # Blackfin: use hi/lo macros
2466 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2467 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2468 my $herevet = "$here\n" . cat_vet($line) . "\n";
2469 ERROR("LO_MACRO",
2470 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2471 }
2472 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2473 my $herevet = "$here\n" . cat_vet($line) . "\n";
2474 ERROR("HI_MACRO",
2475 "use the HI() macro, not (... >> 16)\n" . $herevet);
2476 }
2477 }
2478
2479 # check we are in a valid source file C or perl if not then ignore this hunk
2480 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2481
2482 # at the beginning of a line any tabs must come first and anything
2483 # more than 8 must use tabs.
2484 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2485 $rawline =~ /^\+\s* \s*/) {
2486 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2487 $rpt_cleaners = 1;
2488 if (ERROR("CODE_INDENT",
2489 "code indent should use tabs where possible\n" . $herevet) &&
2490 $fix) {
2491 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2492 }
2493 }
2494
2495 # check for space before tabs.
2496 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2497 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2498 if (WARN("SPACE_BEFORE_TAB",
2499 "please, no space before tabs\n" . $herevet) &&
2500 $fix) {
2501 while ($fixed[$fixlinenr] =~
2502 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2503 while ($fixed[$fixlinenr] =~
2504 s/(^\+.*) +\t/$1\t/) {}
2505 }
2506 }
2507
2508 # check for && or || at the start of a line
2509 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2510 CHK("LOGICAL_CONTINUATIONS",
2511 "Logical continuations should be on the previous line\n" . $hereprev);
2512 }
2513
2514 # check multi-line statement indentation matches previous line
2515 if ($^V && $^V ge 5.10.0 &&
2516 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2517 $prevline =~ /^\+(\t*)(.*)$/;
2518 my $oldindent = $1;
2519 my $rest = $2;
2520
2521 my $pos = pos_last_openparen($rest);
2522 if ($pos >= 0) {
2523 $line =~ /^(\+| )([ \t]*)/;
2524 my $newindent = $2;
2525
2526 my $goodtabindent = $oldindent .
2527 "\t" x ($pos / 8) .
2528 " " x ($pos % 8);
2529 my $goodspaceindent = $oldindent . " " x $pos;
2530
2531 if ($newindent ne $goodtabindent &&
2532 $newindent ne $goodspaceindent) {
2533
2534 if (CHK("PARENTHESIS_ALIGNMENT",
2535 "Alignment should match open parenthesis\n" . $hereprev) &&
2536 $fix && $line =~ /^\+/) {
2537 $fixed[$fixlinenr] =~
2538 s/^\+[ \t]*/\+$goodtabindent/;
2539 }
2540 }
2541 }
2542 }
2543
2544 if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ &&
2545 (!defined($1) || $1 !~ /sizeof\s*/)) {
2546 if (CHK("SPACING",
2547 "No space is necessary after a cast\n" . $herecurr) &&
2548 $fix) {
2549 $fixed[$fixlinenr] =~
2550 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2551 }
2552 }
2553
2554 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2555 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2556 $rawline =~ /^\+[ \t]*\*/ &&
2557 $realline > 2) {
2558 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2559 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2560 }
2561
2562 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2563 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2564 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2565 $rawline =~ /^\+/ && #line is new
2566 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2567 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2568 "networking block comments start with * on subsequent lines\n" . $hereprev);
2569 }
2570
2571 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2572 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2573 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2574 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2575 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2576 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2577 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2578 }
2579
2580 # check for missing blank lines after struct/union declarations
2581 # with exceptions for various attributes and macros
2582 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2583 $line =~ /^\+/ &&
2584 !($line =~ /^\+\s*$/ ||
2585 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2586 $line =~ /^\+\s*MODULE_/i ||
2587 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2588 $line =~ /^\+[a-z_]*init/ ||
2589 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2590 $line =~ /^\+\s*DECLARE/ ||
2591 $line =~ /^\+\s*__setup/)) {
2592 if (CHK("LINE_SPACING",
2593 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2594 $fix) {
2595 fix_insert_line($fixlinenr, "\+");
2596 }
2597 }
2598
2599 # check for multiple consecutive blank lines
2600 if ($prevline =~ /^[\+ ]\s*$/ &&
2601 $line =~ /^\+\s*$/ &&
2602 $last_blank_line != ($linenr - 1)) {
2603 if (CHK("LINE_SPACING",
2604 "Please don't use multiple blank lines\n" . $hereprev) &&
2605 $fix) {
2606 fix_delete_line($fixlinenr, $rawline);
2607 }
2608
2609 $last_blank_line = $linenr;
2610 }
2611
2612 # check for missing blank lines after declarations
2613 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2614 # actual declarations
2615 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2616 # function pointer declarations
2617 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2618 # foo bar; where foo is some local typedef or #define
2619 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2620 # known declaration macros
2621 $prevline =~ /^\+\s+$declaration_macros/) &&
2622 # for "else if" which can look like "$Ident $Ident"
2623 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2624 # other possible extensions of declaration lines
2625 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2626 # not starting a section or a macro "\" extended line
2627 $prevline =~ /(?:\{\s*|\\)$/) &&
2628 # looks like a declaration
2629 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2630 # function pointer declarations
2631 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2632 # foo bar; where foo is some local typedef or #define
2633 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2634 # known declaration macros
2635 $sline =~ /^\+\s+$declaration_macros/ ||
2636 # start of struct or union or enum
2637 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2638 # start or end of block or continuation of declaration
2639 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2640 # bitfield continuation
2641 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2642 # other possible extensions of declaration lines
2643 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2644 # indentation of previous and current line are the same
2645 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2646 if (WARN("LINE_SPACING",
2647 "Missing a blank line after declarations\n" . $hereprev) &&
2648 $fix) {
2649 fix_insert_line($fixlinenr, "\+");
2650 }
2651 }
2652
2653 # check for spaces at the beginning of a line.
2654 # Exceptions:
2655 # 1) within comments
2656 # 2) indented preprocessor commands
2657 # 3) hanging labels
2658 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2659 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2660 if (WARN("LEADING_SPACE",
2661 "please, no spaces at the start of a line\n" . $herevet) &&
2662 $fix) {
2663 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2664 }
2665 }
2666
2667 # check we are in a valid C source file if not then ignore this hunk
2668 next if ($realfile !~ /\.(h|c)$/);
2669
2670 # check indentation of any line with a bare else
2671 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2672 # if the previous line is a break or return and is indented 1 tab more...
2673 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2674 my $tabs = length($1) + 1;
2675 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2676 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2677 defined $lines[$linenr] &&
2678 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2679 WARN("UNNECESSARY_ELSE",
2680 "else is not generally useful after a break or return\n" . $hereprev);
2681 }
2682 }
2683
2684 # check indentation of a line with a break;
2685 # if the previous line is a goto or return and is indented the same # of tabs
2686 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2687 my $tabs = $1;
2688 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2689 WARN("UNNECESSARY_BREAK",
2690 "break is not useful after a goto or return\n" . $hereprev);
2691 }
2692 }
2693
2694 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2695 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2696 WARN("CONFIG_EXPERIMENTAL",
2697 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2698 }
2699
2700 # check for RCS/CVS revision markers
2701 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2702 WARN("CVS_KEYWORD",
2703 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2704 }
2705
2706 # Blackfin: don't use __builtin_bfin_[cs]sync
2707 if ($line =~ /__builtin_bfin_csync/) {
2708 my $herevet = "$here\n" . cat_vet($line) . "\n";
2709 ERROR("CSYNC",
2710 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2711 }
2712 if ($line =~ /__builtin_bfin_ssync/) {
2713 my $herevet = "$here\n" . cat_vet($line) . "\n";
2714 ERROR("SSYNC",
2715 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2716 }
2717
2718 # check for old HOTPLUG __dev<foo> section markings
2719 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2720 WARN("HOTPLUG_SECTION",
2721 "Using $1 is unnecessary\n" . $herecurr);
2722 }
2723
2724 # Check for potential 'bare' types
2725 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2726 $realline_next);
2727 #print "LINE<$line>\n";
2728 if ($linenr >= $suppress_statement &&
2729 $realcnt && $sline =~ /.\s*\S/) {
2730 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2731 ctx_statement_block($linenr, $realcnt, 0);
2732 $stat =~ s/\n./\n /g;
2733 $cond =~ s/\n./\n /g;
2734
2735 #print "linenr<$linenr> <$stat>\n";
2736 # If this statement has no statement boundaries within
2737 # it there is no point in retrying a statement scan
2738 # until we hit end of it.
2739 my $frag = $stat; $frag =~ s/;+\s*$//;
2740 if ($frag !~ /(?:{|;)/) {
2741 #print "skip<$line_nr_next>\n";
2742 $suppress_statement = $line_nr_next;
2743 }
2744
2745 # Find the real next line.
2746 $realline_next = $line_nr_next;
2747 if (defined $realline_next &&
2748 (!defined $lines[$realline_next - 1] ||
2749 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2750 $realline_next++;
2751 }
2752
2753 my $s = $stat;
2754 $s =~ s/{.*$//s;
2755
2756 # Ignore goto labels.
2757 if ($s =~ /$Ident:\*$/s) {
2758
2759 # Ignore functions being called
2760 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
2761
2762 } elsif ($s =~ /^.\s*else\b/s) {
2763
2764 # declarations always start with types
2765 } 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) {
2766 my $type = $1;
2767 $type =~ s/\s+/ /g;
2768 possible($type, "A:" . $s);
2769
2770 # definitions in global scope can only start with types
2771 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2772 possible($1, "B:" . $s);
2773 }
2774
2775 # any (foo ... *) is a pointer cast, and foo is a type
2776 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2777 possible($1, "C:" . $s);
2778 }
2779
2780 # Check for any sort of function declaration.
2781 # int foo(something bar, other baz);
2782 # void (*store_gdt)(x86_descr_ptr *);
2783 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2784 my ($name_len) = length($1);
2785
2786 my $ctx = $s;
2787 substr($ctx, 0, $name_len + 1, '');
2788 $ctx =~ s/\)[^\)]*$//;
2789
2790 for my $arg (split(/\s*,\s*/, $ctx)) {
2791 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2792
2793 possible($1, "D:" . $s);
2794 }
2795 }
2796 }
2797
2798 }
2799
2800 #
2801 # Checks which may be anchored in the context.
2802 #
2803
2804 # Check for switch () and associated case and default
2805 # statements should be at the same indent.
2806 if ($line=~/\bswitch\s*\(.*\)/) {
2807 my $err = '';
2808 my $sep = '';
2809 my @ctx = ctx_block_outer($linenr, $realcnt);
2810 shift(@ctx);
2811 for my $ctx (@ctx) {
2812 my ($clen, $cindent) = line_stats($ctx);
2813 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2814 $indent != $cindent) {
2815 $err .= "$sep$ctx\n";
2816 $sep = '';
2817 } else {
2818 $sep = "[...]\n";
2819 }
2820 }
2821 if ($err ne '') {
2822 ERROR("SWITCH_CASE_INDENT_LEVEL",
2823 "switch and case should be at the same indent\n$hereline$err");
2824 }
2825 }
2826
2827 # if/while/etc brace do not go on next line, unless defining a do while loop,
2828 # or if that brace on the next line is for something else
2829 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2830 my $pre_ctx = "$1$2";
2831
2832 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2833
2834 if ($line =~ /^\+\t{6,}/) {
2835 WARN("DEEP_INDENTATION",
2836 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2837 }
2838
2839 my $ctx_cnt = $realcnt - $#ctx - 1;
2840 my $ctx = join("\n", @ctx);
2841
2842 my $ctx_ln = $linenr;
2843 my $ctx_skip = $realcnt;
2844
2845 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2846 defined $lines[$ctx_ln - 1] &&
2847 $lines[$ctx_ln - 1] =~ /^-/)) {
2848 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2849 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2850 $ctx_ln++;
2851 }
2852
2853 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2854 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2855
2856 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2857 ERROR("OPEN_BRACE",
2858 "that open brace { should be on the previous line\n" .
2859 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2860 }
2861 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2862 $ctx =~ /\)\s*\;\s*$/ &&
2863 defined $lines[$ctx_ln - 1])
2864 {
2865 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2866 if ($nindent > $indent) {
2867 WARN("TRAILING_SEMICOLON",
2868 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2869 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2870 }
2871 }
2872 }
2873
2874 # Check relative indent for conditionals and blocks.
2875 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2876 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2877 ctx_statement_block($linenr, $realcnt, 0)
2878 if (!defined $stat);
2879 my ($s, $c) = ($stat, $cond);
2880
2881 substr($s, 0, length($c), '');
2882
2883 # Make sure we remove the line prefixes as we have
2884 # none on the first line, and are going to readd them
2885 # where necessary.
2886 $s =~ s/\n./\n/gs;
2887
2888 # Find out how long the conditional actually is.
2889 my @newlines = ($c =~ /\n/gs);
2890 my $cond_lines = 1 + $#newlines;
2891
2892 # We want to check the first line inside the block
2893 # starting at the end of the conditional, so remove:
2894 # 1) any blank line termination
2895 # 2) any opening brace { on end of the line
2896 # 3) any do (...) {
2897 my $continuation = 0;
2898 my $check = 0;
2899 $s =~ s/^.*\bdo\b//;
2900 $s =~ s/^\s*{//;
2901 if ($s =~ s/^\s*\\//) {
2902 $continuation = 1;
2903 }
2904 if ($s =~ s/^\s*?\n//) {
2905 $check = 1;
2906 $cond_lines++;
2907 }
2908
2909 # Also ignore a loop construct at the end of a
2910 # preprocessor statement.
2911 if (($prevline =~ /^.\s*#\s*define\s/ ||
2912 $prevline =~ /\\\s*$/) && $continuation == 0) {
2913 $check = 0;
2914 }
2915
2916 my $cond_ptr = -1;
2917 $continuation = 0;
2918 while ($cond_ptr != $cond_lines) {
2919 $cond_ptr = $cond_lines;
2920
2921 # If we see an #else/#elif then the code
2922 # is not linear.
2923 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2924 $check = 0;
2925 }
2926
2927 # Ignore:
2928 # 1) blank lines, they should be at 0,
2929 # 2) preprocessor lines, and
2930 # 3) labels.
2931 if ($continuation ||
2932 $s =~ /^\s*?\n/ ||
2933 $s =~ /^\s*#\s*?/ ||
2934 $s =~ /^\s*$Ident\s*:/) {
2935 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2936 if ($s =~ s/^.*?\n//) {
2937 $cond_lines++;
2938 }
2939 }
2940 }
2941
2942 my (undef, $sindent) = line_stats("+" . $s);
2943 my $stat_real = raw_line($linenr, $cond_lines);
2944
2945 # Check if either of these lines are modified, else
2946 # this is not this patch's fault.
2947 if (!defined($stat_real) ||
2948 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2949 $check = 0;
2950 }
2951 if (defined($stat_real) && $cond_lines > 1) {
2952 $stat_real = "[...]\n$stat_real";
2953 }
2954
2955 #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";
2956
2957 if ($check && (($sindent % 8) != 0 ||
2958 ($sindent <= $indent && $s ne ''))) {
2959 WARN("SUSPECT_CODE_INDENT",
2960 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2961 }
2962 }
2963
2964 # Track the 'values' across context and added lines.
2965 my $opline = $line; $opline =~ s/^./ /;
2966 my ($curr_values, $curr_vars) =
2967 annotate_values($opline . "\n", $prev_values);
2968 $curr_values = $prev_values . $curr_values;
2969 if ($dbg_values) {
2970 my $outline = $opline; $outline =~ s/\t/ /g;
2971 print "$linenr > .$outline\n";
2972 print "$linenr > $curr_values\n";
2973 print "$linenr > $curr_vars\n";
2974 }
2975 $prev_values = substr($curr_values, -1);
2976
2977 #ignore lines not being added
2978 next if ($line =~ /^[^\+]/);
2979
2980 # TEST: allow direct testing of the type matcher.
2981 if ($dbg_type) {
2982 if ($line =~ /^.\s*$Declare\s*$/) {
2983 ERROR("TEST_TYPE",
2984 "TEST: is type\n" . $herecurr);
2985 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2986 ERROR("TEST_NOT_TYPE",
2987 "TEST: is not type ($1 is)\n". $herecurr);
2988 }
2989 next;
2990 }
2991 # TEST: allow direct testing of the attribute matcher.
2992 if ($dbg_attr) {
2993 if ($line =~ /^.\s*$Modifier\s*$/) {
2994 ERROR("TEST_ATTR",
2995 "TEST: is attr\n" . $herecurr);
2996 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2997 ERROR("TEST_NOT_ATTR",
2998 "TEST: is not attr ($1 is)\n". $herecurr);
2999 }
3000 next;
3001 }
3002
3003 # check for initialisation to aggregates open brace on the next line
3004 if ($line =~ /^.\s*{/ &&
3005 $prevline =~ /(?:^|[^=])=\s*$/) {
3006 if (ERROR("OPEN_BRACE",
3007 "that open brace { should be on the previous line\n" . $hereprev) &&
3008 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3009 fix_delete_line($fixlinenr - 1, $prevrawline);
3010 fix_delete_line($fixlinenr, $rawline);
3011 my $fixedline = $prevrawline;
3012 $fixedline =~ s/\s*=\s*$/ = {/;
3013 fix_insert_line($fixlinenr, $fixedline);
3014 $fixedline = $line;
3015 $fixedline =~ s/^(.\s*){\s*/$1/;
3016 fix_insert_line($fixlinenr, $fixedline);
3017 }
3018 }
3019
3020 #
3021 # Checks which are anchored on the added line.
3022 #
3023
3024 # check for malformed paths in #include statements (uses RAW line)
3025 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3026 my $path = $1;
3027 if ($path =~ m{//}) {
3028 ERROR("MALFORMED_INCLUDE",
3029 "malformed #include filename\n" . $herecurr);
3030 }
3031 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3032 ERROR("UAPI_INCLUDE",
3033 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3034 }
3035 }
3036
3037 # no C99 // comments
3038 if ($line =~ m{//}) {
3039 if (ERROR("C99_COMMENTS",
3040 "do not use C99 // comments\n" . $herecurr) &&
3041 $fix) {
3042 my $line = $fixed[$fixlinenr];
3043 if ($line =~ /\/\/(.*)$/) {
3044 my $comment = trim($1);
3045 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3046 }
3047 }
3048 }
3049 # Remove C99 comments.
3050 $line =~ s@//.*@@;
3051 $opline =~ s@//.*@@;
3052
3053 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3054 # the whole statement.
3055 #print "APW <$lines[$realline_next - 1]>\n";
3056 if (defined $realline_next &&
3057 exists $lines[$realline_next - 1] &&
3058 !defined $suppress_export{$realline_next} &&
3059 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3060 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3061 # Handle definitions which produce identifiers with
3062 # a prefix:
3063 # XXX(foo);
3064 # EXPORT_SYMBOL(something_foo);
3065 my $name = $1;
3066 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3067 $name =~ /^${Ident}_$2/) {
3068 #print "FOO C name<$name>\n";
3069 $suppress_export{$realline_next} = 1;
3070
3071 } elsif ($stat !~ /(?:
3072 \n.}\s*$|
3073 ^.DEFINE_$Ident\(\Q$name\E\)|
3074 ^.DECLARE_$Ident\(\Q$name\E\)|
3075 ^.LIST_HEAD\(\Q$name\E\)|
3076 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3077 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3078 )/x) {
3079 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3080 $suppress_export{$realline_next} = 2;
3081 } else {
3082 $suppress_export{$realline_next} = 1;
3083 }
3084 }
3085 if (!defined $suppress_export{$linenr} &&
3086 $prevline =~ /^.\s*$/ &&
3087 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3088 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3089 #print "FOO B <$lines[$linenr - 1]>\n";
3090 $suppress_export{$linenr} = 2;
3091 }
3092 if (defined $suppress_export{$linenr} &&
3093 $suppress_export{$linenr} == 2) {
3094 WARN("EXPORT_SYMBOL",
3095 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3096 }
3097
3098 # check for global initialisers.
3099 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3100 if (ERROR("GLOBAL_INITIALISERS",
3101 "do not initialise globals to 0 or NULL\n" .
3102 $herecurr) &&
3103 $fix) {
3104 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
3105 }
3106 }
3107 # check for static initialisers.
3108 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3109 if (ERROR("INITIALISED_STATIC",
3110 "do not initialise statics to 0 or NULL\n" .
3111 $herecurr) &&
3112 $fix) {
3113 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
3114 }
3115 }
3116
3117 # check for misordered declarations of char/short/int/long with signed/unsigned
3118 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3119 my $tmp = trim($1);
3120 WARN("MISORDERED_TYPE",
3121 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3122 }
3123
3124 # check for static const char * arrays.
3125 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3126 WARN("STATIC_CONST_CHAR_ARRAY",
3127 "static const char * array should probably be static const char * const\n" .
3128 $herecurr);
3129 }
3130
3131 # check for static char foo[] = "bar" declarations.
3132 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3133 WARN("STATIC_CONST_CHAR_ARRAY",
3134 "static char array declaration should probably be static const char\n" .
3135 $herecurr);
3136 }
3137
3138 # check for non-global char *foo[] = {"bar", ...} declarations.
3139 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3140 WARN("STATIC_CONST_CHAR_ARRAY",
3141 "char * array declaration might be better as static const\n" .
3142 $herecurr);
3143 }
3144
3145 # check for function declarations without arguments like "int foo()"
3146 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3147 if (ERROR("FUNCTION_WITHOUT_ARGS",
3148 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3149 $fix) {
3150 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3151 }
3152 }
3153
3154 # check for uses of DEFINE_PCI_DEVICE_TABLE
3155 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3156 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3157 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3158 $fix) {
3159 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3160 }
3161 }
3162
3163 # check for new typedefs, only function parameters and sparse annotations
3164 # make sense.
3165 if ($line =~ /\btypedef\s/ &&
3166 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3167 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3168 $line !~ /\b$typeTypedefs\b/ &&
3169 $line !~ /\b$typeOtherOSTypedefs\b/ &&
3170 $line !~ /\b__bitwise(?:__|)\b/) {
3171 WARN("NEW_TYPEDEFS",
3172 "do not add new typedefs\n" . $herecurr);
3173 }
3174
3175 # * goes on variable not on type
3176 # (char*[ const])
3177 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3178 #print "AA<$1>\n";
3179 my ($ident, $from, $to) = ($1, $2, $2);
3180
3181 # Should start with a space.
3182 $to =~ s/^(\S)/ $1/;
3183 # Should not end with a space.
3184 $to =~ s/\s+$//;
3185 # '*'s should not have spaces between.
3186 while ($to =~ s/\*\s+\*/\*\*/) {
3187 }
3188
3189 ## print "1: from<$from> to<$to> ident<$ident>\n";
3190 if ($from ne $to) {
3191 if (ERROR("POINTER_LOCATION",
3192 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3193 $fix) {
3194 my $sub_from = $ident;
3195 my $sub_to = $ident;
3196 $sub_to =~ s/\Q$from\E/$to/;
3197 $fixed[$fixlinenr] =~
3198 s@\Q$sub_from\E@$sub_to@;
3199 }
3200 }
3201 }
3202 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3203 #print "BB<$1>\n";
3204 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3205
3206 # Should start with a space.
3207 $to =~ s/^(\S)/ $1/;
3208 # Should not end with a space.
3209 $to =~ s/\s+$//;
3210 # '*'s should not have spaces between.
3211 while ($to =~ s/\*\s+\*/\*\*/) {
3212 }
3213 # Modifiers should have spaces.
3214 $to =~ s/(\b$Modifier$)/$1 /;
3215
3216 ## print "2: from<$from> to<$to> ident<$ident>\n";
3217 if ($from ne $to && $ident !~ /^$Modifier$/) {
3218 if (ERROR("POINTER_LOCATION",
3219 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3220 $fix) {
3221
3222 my $sub_from = $match;
3223 my $sub_to = $match;
3224 $sub_to =~ s/\Q$from\E/$to/;
3225 $fixed[$fixlinenr] =~
3226 s@\Q$sub_from\E@$sub_to@;
3227 }
3228 }
3229 }
3230
3231 # # no BUG() or BUG_ON()
3232 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3233 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3234 # print "$herecurr";
3235 # $clean = 0;
3236 # }
3237
3238 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3239 WARN("LINUX_VERSION_CODE",
3240 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3241 }
3242
3243 # check for uses of printk_ratelimit
3244 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3245 WARN("PRINTK_RATELIMITED",
3246 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3247 }
3248
3249 # printk should use KERN_* levels. Note that follow on printk's on the
3250 # same line do not need a level, so we use the current block context
3251 # to try and find and validate the current printk. In summary the current
3252 # printk includes all preceding printk's which have no newline on the end.
3253 # we assume the first bad printk is the one to report.
3254 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3255 my $ok = 0;
3256 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3257 #print "CHECK<$lines[$ln - 1]\n";
3258 # we have a preceding printk if it ends
3259 # with "\n" ignore it, else it is to blame
3260 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3261 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3262 $ok = 1;
3263 }
3264 last;
3265 }
3266 }
3267 if ($ok == 0) {
3268 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3269 "printk() should include KERN_ facility level\n" . $herecurr);
3270 }
3271 }
3272
3273 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3274 my $orig = $1;
3275 my $level = lc($orig);
3276 $level = "warn" if ($level eq "warning");
3277 my $level2 = $level;
3278 $level2 = "dbg" if ($level eq "debug");
3279 WARN("PREFER_PR_LEVEL",
3280 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3281 }
3282
3283 if ($line =~ /\bpr_warning\s*\(/) {
3284 if (WARN("PREFER_PR_LEVEL",
3285 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3286 $fix) {
3287 $fixed[$fixlinenr] =~
3288 s/\bpr_warning\b/pr_warn/;
3289 }
3290 }
3291
3292 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3293 my $orig = $1;
3294 my $level = lc($orig);
3295 $level = "warn" if ($level eq "warning");
3296 $level = "dbg" if ($level eq "debug");
3297 WARN("PREFER_DEV_LEVEL",
3298 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3299 }
3300
3301 # function brace can't be on same line, except for #defines of do while,
3302 # or if closed on same line
3303 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3304 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
3305 if (ERROR("OPEN_BRACE",
3306 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3307 $fix) {
3308 fix_delete_line($fixlinenr, $rawline);
3309 my $fixed_line = $rawline;
3310 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3311 my $line1 = $1;
3312 my $line2 = $2;
3313 fix_insert_line($fixlinenr, ltrim($line1));
3314 fix_insert_line($fixlinenr, "\+{");
3315 if ($line2 !~ /^\s*$/) {
3316 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3317 }
3318 }
3319 }
3320
3321 # open braces for enum, union and struct go on the same line.
3322 if ($line =~ /^.\s*{/ &&
3323 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3324 if (ERROR("OPEN_BRACE",
3325 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3326 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3327 fix_delete_line($fixlinenr - 1, $prevrawline);
3328 fix_delete_line($fixlinenr, $rawline);
3329 my $fixedline = rtrim($prevrawline) . " {";
3330 fix_insert_line($fixlinenr, $fixedline);
3331 $fixedline = $rawline;
3332 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3333 if ($fixedline !~ /^\+\s*$/) {
3334 fix_insert_line($fixlinenr, $fixedline);
3335 }
3336 }
3337 }
3338
3339 # missing space after union, struct or enum definition
3340 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3341 if (WARN("SPACING",
3342 "missing space after $1 definition\n" . $herecurr) &&
3343 $fix) {
3344 $fixed[$fixlinenr] =~
3345 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3346 }
3347 }
3348
3349 # Function pointer declarations
3350 # check spacing between type, funcptr, and args
3351 # canonical declaration is "type (*funcptr)(args...)"
3352 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3353 my $declare = $1;
3354 my $pre_pointer_space = $2;
3355 my $post_pointer_space = $3;
3356 my $funcname = $4;
3357 my $post_funcname_space = $5;
3358 my $pre_args_space = $6;
3359
3360 # the $Declare variable will capture all spaces after the type
3361 # so check it for a missing trailing missing space but pointer return types
3362 # don't need a space so don't warn for those.
3363 my $post_declare_space = "";
3364 if ($declare =~ /(\s+)$/) {
3365 $post_declare_space = $1;
3366 $declare = rtrim($declare);
3367 }
3368 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3369 WARN("SPACING",
3370 "missing space after return type\n" . $herecurr);
3371 $post_declare_space = " ";
3372 }
3373
3374 # unnecessary space "type (*funcptr)(args...)"
3375 # This test is not currently implemented because these declarations are
3376 # equivalent to
3377 # int foo(int bar, ...)
3378 # and this is form shouldn't/doesn't generate a checkpatch warning.
3379 #
3380 # elsif ($declare =~ /\s{2,}$/) {
3381 # WARN("SPACING",
3382 # "Multiple spaces after return type\n" . $herecurr);
3383 # }
3384
3385 # unnecessary space "type ( *funcptr)(args...)"
3386 if (defined $pre_pointer_space &&
3387 $pre_pointer_space =~ /^\s/) {
3388 WARN("SPACING",
3389 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3390 }
3391
3392 # unnecessary space "type (* funcptr)(args...)"
3393 if (defined $post_pointer_space &&
3394 $post_pointer_space =~ /^\s/) {
3395 WARN("SPACING",
3396 "Unnecessary space before function pointer name\n" . $herecurr);
3397 }
3398
3399 # unnecessary space "type (*funcptr )(args...)"
3400 if (defined $post_funcname_space &&
3401 $post_funcname_space =~ /^\s/) {
3402 WARN("SPACING",
3403 "Unnecessary space after function pointer name\n" . $herecurr);
3404 }
3405
3406 # unnecessary space "type (*funcptr) (args...)"
3407 if (defined $pre_args_space &&
3408 $pre_args_space =~ /^\s/) {
3409 WARN("SPACING",
3410 "Unnecessary space before function pointer arguments\n" . $herecurr);
3411 }
3412
3413 if (show_type("SPACING") && $fix) {
3414 $fixed[$fixlinenr] =~
3415 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3416 }
3417 }
3418
3419 # check for spacing round square brackets; allowed:
3420 # 1. with a type on the left -- int [] a;
3421 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3422 # 3. inside a curly brace -- = { [0...10] = 5 }
3423 while ($line =~ /(.*?\s)\[/g) {
3424 my ($where, $prefix) = ($-[1], $1);
3425 if ($prefix !~ /$Type\s+$/ &&
3426 ($where != 0 || $prefix !~ /^.\s+$/) &&
3427 $prefix !~ /[{,]\s+$/) {
3428 if (ERROR("BRACKET_SPACE",
3429 "space prohibited before open square bracket '['\n" . $herecurr) &&
3430 $fix) {
3431 $fixed[$fixlinenr] =~
3432 s/^(\+.*?)\s+\[/$1\[/;
3433 }
3434 }
3435 }
3436
3437 # check for spaces between functions and their parentheses.
3438 while ($line =~ /($Ident)\s+\(/g) {
3439 my $name = $1;
3440 my $ctx_before = substr($line, 0, $-[1]);
3441 my $ctx = "$ctx_before$name";
3442
3443 # Ignore those directives where spaces _are_ permitted.
3444 if ($name =~ /^(?:
3445 if|for|while|switch|return|case|
3446 volatile|__volatile__|
3447 __attribute__|format|__extension__|
3448 asm|__asm__)$/x)
3449 {
3450 # cpp #define statements have non-optional spaces, ie
3451 # if there is a space between the name and the open
3452 # parenthesis it is simply not a parameter group.
3453 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3454
3455 # cpp #elif statement condition may start with a (
3456 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3457
3458 # If this whole things ends with a type its most
3459 # likely a typedef for a function.
3460 } elsif ($ctx =~ /$Type$/) {
3461
3462 } else {
3463 if (WARN("SPACING",
3464 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3465 $fix) {
3466 $fixed[$fixlinenr] =~
3467 s/\b$name\s+\(/$name\(/;
3468 }
3469 }
3470 }
3471
3472 # Check operator spacing.
3473 if (!($line=~/\#\s*include/)) {
3474 my $fixed_line = "";
3475 my $line_fixed = 0;
3476
3477 my $ops = qr{
3478 <<=|>>=|<=|>=|==|!=|
3479 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3480 =>|->|<<|>>|<|>|=|!|~|
3481 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3482 \?:|\?|:
3483 }x;
3484 my @elements = split(/($ops|;)/, $opline);
3485
3486 ## print("element count: <" . $#elements . ">\n");
3487 ## foreach my $el (@elements) {
3488 ## print("el: <$el>\n");
3489 ## }
3490
3491 my @fix_elements = ();
3492 my $off = 0;
3493
3494 foreach my $el (@elements) {
3495 push(@fix_elements, substr($rawline, $off, length($el)));
3496 $off += length($el);
3497 }
3498
3499 $off = 0;
3500
3501 my $blank = copy_spacing($opline);
3502 my $last_after = -1;
3503
3504 for (my $n = 0; $n < $#elements; $n += 2) {
3505
3506 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3507
3508 ## print("n: <$n> good: <$good>\n");
3509
3510 $off += length($elements[$n]);
3511
3512 # Pick up the preceding and succeeding characters.
3513 my $ca = substr($opline, 0, $off);
3514 my $cc = '';
3515 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3516 $cc = substr($opline, $off + length($elements[$n + 1]));
3517 }
3518 my $cb = "$ca$;$cc";
3519
3520 my $a = '';
3521 $a = 'V' if ($elements[$n] ne '');
3522 $a = 'W' if ($elements[$n] =~ /\s$/);
3523 $a = 'C' if ($elements[$n] =~ /$;$/);
3524 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3525 $a = 'O' if ($elements[$n] eq '');
3526 $a = 'E' if ($ca =~ /^\s*$/);
3527
3528 my $op = $elements[$n + 1];
3529
3530 my $c = '';
3531 if (defined $elements[$n + 2]) {
3532 $c = 'V' if ($elements[$n + 2] ne '');
3533 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3534 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3535 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3536 $c = 'O' if ($elements[$n + 2] eq '');
3537 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3538 } else {
3539 $c = 'E';
3540 }
3541
3542 my $ctx = "${a}x${c}";
3543
3544 my $at = "(ctx:$ctx)";
3545
3546 my $ptr = substr($blank, 0, $off) . "^";
3547 my $hereptr = "$hereline$ptr\n";
3548
3549 # Pull out the value of this operator.
3550 my $op_type = substr($curr_values, $off + 1, 1);
3551
3552 # Get the full operator variant.
3553 my $opv = $op . substr($curr_vars, $off, 1);
3554
3555 # Ignore operators passed as parameters.
3556 if ($op_type ne 'V' &&
3557 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3558
3559 # # Ignore comments
3560 # } elsif ($op =~ /^$;+$/) {
3561
3562 # ; should have either the end of line or a space or \ after it
3563 } elsif ($op eq ';') {
3564 if ($ctx !~ /.x[WEBC]/ &&
3565 $cc !~ /^\\/ && $cc !~ /^;/) {
3566 if (ERROR("SPACING",
3567 "space required after that '$op' $at\n" . $hereptr)) {
3568 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3569 $line_fixed = 1;
3570 }
3571 }
3572
3573 # // is a comment
3574 } elsif ($op eq '//') {
3575
3576 # : when part of a bitfield
3577 } elsif ($opv eq ':B') {
3578 # skip the bitfield test for now
3579
3580 # No spaces for:
3581 # ->
3582 } elsif ($op eq '->') {
3583 if ($ctx =~ /Wx.|.xW/) {
3584 if (ERROR("SPACING",
3585 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3586 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3587 if (defined $fix_elements[$n + 2]) {
3588 $fix_elements[$n + 2] =~ s/^\s+//;
3589 }
3590 $line_fixed = 1;
3591 }
3592 }
3593
3594 # , must not have a space before and must have a space on the right.
3595 } elsif ($op eq ',') {
3596 my $rtrim_before = 0;
3597 my $space_after = 0;
3598 if ($ctx =~ /Wx./) {
3599 if (ERROR("SPACING",
3600 "space prohibited before that '$op' $at\n" . $hereptr)) {
3601 $line_fixed = 1;
3602 $rtrim_before = 1;
3603 }
3604 }
3605 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3606 if (ERROR("SPACING",
3607 "space required after that '$op' $at\n" . $hereptr)) {
3608 $line_fixed = 1;
3609 $last_after = $n;
3610 $space_after = 1;
3611 }
3612 }
3613 if ($rtrim_before || $space_after) {
3614 if ($rtrim_before) {
3615 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3616 } else {
3617 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3618 }
3619 if ($space_after) {
3620 $good .= " ";
3621 }
3622 }
3623
3624 # '*' as part of a type definition -- reported already.
3625 } elsif ($opv eq '*_') {
3626 #warn "'*' is part of type\n";
3627
3628 # unary operators should have a space before and
3629 # none after. May be left adjacent to another
3630 # unary operator, or a cast
3631 } elsif ($op eq '!' || $op eq '~' ||
3632 $opv eq '*U' || $opv eq '-U' ||
3633 $opv eq '&U' || $opv eq '&&U') {
3634 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3635 if (ERROR("SPACING",
3636 "space required before that '$op' $at\n" . $hereptr)) {
3637 if ($n != $last_after + 2) {
3638 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3639 $line_fixed = 1;
3640 }
3641 }
3642 }
3643 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3644 # A unary '*' may be const
3645
3646 } elsif ($ctx =~ /.xW/) {
3647 if (ERROR("SPACING",
3648 "space prohibited after that '$op' $at\n" . $hereptr)) {
3649 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3650 if (defined $fix_elements[$n + 2]) {
3651 $fix_elements[$n + 2] =~ s/^\s+//;
3652 }
3653 $line_fixed = 1;
3654 }
3655 }
3656
3657 # unary ++ and unary -- are allowed no space on one side.
3658 } elsif ($op eq '++' or $op eq '--') {
3659 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3660 if (ERROR("SPACING",
3661 "space required one side of that '$op' $at\n" . $hereptr)) {
3662 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3663 $line_fixed = 1;
3664 }
3665 }
3666 if ($ctx =~ /Wx[BE]/ ||
3667 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3668 if (ERROR("SPACING",
3669 "space prohibited before that '$op' $at\n" . $hereptr)) {
3670 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3671 $line_fixed = 1;
3672 }
3673 }
3674 if ($ctx =~ /ExW/) {
3675 if (ERROR("SPACING",
3676 "space prohibited after that '$op' $at\n" . $hereptr)) {
3677 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3678 if (defined $fix_elements[$n + 2]) {
3679 $fix_elements[$n + 2] =~ s/^\s+//;
3680 }
3681 $line_fixed = 1;
3682 }
3683 }
3684
3685 # << and >> may either have or not have spaces both sides
3686 } elsif ($op eq '<<' or $op eq '>>' or
3687 $op eq '&' or $op eq '^' or $op eq '|' or
3688 $op eq '+' or $op eq '-' or
3689 $op eq '*' or $op eq '/' or
3690 $op eq '%')
3691 {
3692 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
3693 if (ERROR("SPACING",
3694 "need consistent spacing around '$op' $at\n" . $hereptr)) {
3695 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3696 if (defined $fix_elements[$n + 2]) {
3697 $fix_elements[$n + 2] =~ s/^\s+//;
3698 }
3699 $line_fixed = 1;
3700 }
3701 }
3702
3703 # A colon needs no spaces before when it is
3704 # terminating a case value or a label.
3705 } elsif ($opv eq ':C' || $opv eq ':L') {
3706 if ($ctx =~ /Wx./) {
3707 if (ERROR("SPACING",
3708 "space prohibited before that '$op' $at\n" . $hereptr)) {
3709 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3710 $line_fixed = 1;
3711 }
3712 }
3713
3714 # All the others need spaces both sides.
3715 } elsif ($ctx !~ /[EWC]x[CWE]/) {
3716 my $ok = 0;
3717
3718 # Ignore email addresses <foo@bar>
3719 if (($op eq '<' &&
3720 $cc =~ /^\S+\@\S+>/) ||
3721 ($op eq '>' &&
3722 $ca =~ /<\S+\@\S+$/))
3723 {
3724 $ok = 1;
3725 }
3726
3727 # messages are ERROR, but ?: are CHK
3728 if ($ok == 0) {
3729 my $msg_type = \&ERROR;
3730 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3731
3732 if (&{$msg_type}("SPACING",
3733 "spaces required around that '$op' $at\n" . $hereptr)) {
3734 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3735 if (defined $fix_elements[$n + 2]) {
3736 $fix_elements[$n + 2] =~ s/^\s+//;
3737 }
3738 $line_fixed = 1;
3739 }
3740 }
3741 }
3742 $off += length($elements[$n + 1]);
3743
3744 ## print("n: <$n> GOOD: <$good>\n");
3745
3746 $fixed_line = $fixed_line . $good;
3747 }
3748
3749 if (($#elements % 2) == 0) {
3750 $fixed_line = $fixed_line . $fix_elements[$#elements];
3751 }
3752
3753 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3754 $fixed[$fixlinenr] = $fixed_line;
3755 }
3756
3757
3758 }
3759
3760 # check for whitespace before a non-naked semicolon
3761 if ($line =~ /^\+.*\S\s+;\s*$/) {
3762 if (WARN("SPACING",
3763 "space prohibited before semicolon\n" . $herecurr) &&
3764 $fix) {
3765 1 while $fixed[$fixlinenr] =~
3766 s/^(\+.*\S)\s+;/$1;/;
3767 }
3768 }
3769
3770 # check for multiple assignments
3771 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
3772 CHK("MULTIPLE_ASSIGNMENTS",
3773 "multiple assignments should be avoided\n" . $herecurr);
3774 }
3775
3776 ## # check for multiple declarations, allowing for a function declaration
3777 ## # continuation.
3778 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3779 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3780 ##
3781 ## # Remove any bracketed sections to ensure we do not
3782 ## # falsly report the parameters of functions.
3783 ## my $ln = $line;
3784 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3785 ## }
3786 ## if ($ln =~ /,/) {
3787 ## WARN("MULTIPLE_DECLARATION",
3788 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3789 ## }
3790 ## }
3791
3792 #need space before brace following if, while, etc
3793 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3794 $line =~ /do{/) {
3795 if (ERROR("SPACING",
3796 "space required before the open brace '{'\n" . $herecurr) &&
3797 $fix) {
3798 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
3799 }
3800 }
3801
3802 ## # check for blank lines before declarations
3803 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3804 ## $prevrawline =~ /^.\s*$/) {
3805 ## WARN("SPACING",
3806 ## "No blank lines before declarations\n" . $hereprev);
3807 ## }
3808 ##
3809
3810 # closing brace should have a space following it when it has anything
3811 # on the line
3812 if ($line =~ /}(?!(?:,|;|\)))\S/) {
3813 if (ERROR("SPACING",
3814 "space required after that close brace '}'\n" . $herecurr) &&
3815 $fix) {
3816 $fixed[$fixlinenr] =~
3817 s/}((?!(?:,|;|\)))\S)/} $1/;
3818 }
3819 }
3820
3821 # check spacing on square brackets
3822 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
3823 if (ERROR("SPACING",
3824 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3825 $fix) {
3826 $fixed[$fixlinenr] =~
3827 s/\[\s+/\[/;
3828 }
3829 }
3830 if ($line =~ /\s\]/) {
3831 if (ERROR("SPACING",
3832 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3833 $fix) {
3834 $fixed[$fixlinenr] =~
3835 s/\s+\]/\]/;
3836 }
3837 }
3838
3839 # check spacing on parentheses
3840 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3841 $line !~ /for\s*\(\s+;/) {
3842 if (ERROR("SPACING",
3843 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3844 $fix) {
3845 $fixed[$fixlinenr] =~
3846 s/\(\s+/\(/;
3847 }
3848 }
3849 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
3850 $line !~ /for\s*\(.*;\s+\)/ &&
3851 $line !~ /:\s+\)/) {
3852 if (ERROR("SPACING",
3853 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3854 $fix) {
3855 $fixed[$fixlinenr] =~
3856 s/\s+\)/\)/;
3857 }
3858 }
3859
3860 # check unnecessary parentheses around addressof/dereference single $Lvals
3861 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3862
3863 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3864 my $var = $1;
3865 if (CHK("UNNECESSARY_PARENTHESES",
3866 "Unnecessary parentheses around $var\n" . $herecurr) &&
3867 $fix) {
3868 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3869 }
3870 }
3871
3872 # check for unnecessary parentheses around function pointer uses
3873 # ie: (foo->bar)(); should be foo->bar();
3874 # but not "if (foo->bar) (" to avoid some false positives
3875 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3876 my $var = $2;
3877 if (CHK("UNNECESSARY_PARENTHESES",
3878 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3879 $fix) {
3880 my $var2 = deparenthesize($var);
3881 $var2 =~ s/\s//g;
3882 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3883 }
3884 }
3885
3886 #goto labels aren't indented, allow a single space however
3887 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
3888 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
3889 if (WARN("INDENTED_LABEL",
3890 "labels should not be indented\n" . $herecurr) &&
3891 $fix) {
3892 $fixed[$fixlinenr] =~
3893 s/^(.)\s+/$1/;
3894 }
3895 }
3896
3897 # return is not a function
3898 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
3899 my $spacing = $1;
3900 if ($^V && $^V ge 5.10.0 &&
3901 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3902 my $value = $1;
3903 $value = deparenthesize($value);
3904 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3905 ERROR("RETURN_PARENTHESES",
3906 "return is not a function, parentheses are not required\n" . $herecurr);
3907 }
3908 } elsif ($spacing !~ /\s+/) {
3909 ERROR("SPACING",
3910 "space required before the open parenthesis '('\n" . $herecurr);
3911 }
3912 }
3913
3914 # unnecessary return in a void function
3915 # at end-of-function, with the previous line a single leading tab, then return;
3916 # and the line before that not a goto label target like "out:"
3917 if ($sline =~ /^[ \+]}\s*$/ &&
3918 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3919 $linenr >= 3 &&
3920 $lines[$linenr - 3] =~ /^[ +]/ &&
3921 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
3922 WARN("RETURN_VOID",
3923 "void function return statements are not generally useful\n" . $hereprev);
3924 }
3925
3926 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3927 if ($^V && $^V ge 5.10.0 &&
3928 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3929 my $openparens = $1;
3930 my $count = $openparens =~ tr@\(@\(@;
3931 my $msg = "";
3932 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3933 my $comp = $4; #Not $1 because of $LvalOrFunc
3934 $msg = " - maybe == should be = ?" if ($comp eq "==");
3935 WARN("UNNECESSARY_PARENTHESES",
3936 "Unnecessary parentheses$msg\n" . $herecurr);
3937 }
3938 }
3939
3940 # Return of what appears to be an errno should normally be -'ve
3941 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3942 my $name = $1;
3943 if ($name ne 'EOF' && $name ne 'ERROR') {
3944 WARN("USE_NEGATIVE_ERRNO",
3945 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
3946 }
3947 }
3948
3949 # Need a space before open parenthesis after if, while etc
3950 if ($line =~ /\b(if|while|for|switch)\(/) {
3951 if (ERROR("SPACING",
3952 "space required before the open parenthesis '('\n" . $herecurr) &&
3953 $fix) {
3954 $fixed[$fixlinenr] =~
3955 s/\b(if|while|for|switch)\(/$1 \(/;
3956 }
3957 }
3958
3959 # Check for illegal assignment in if conditional -- and check for trailing
3960 # statements after the conditional.
3961 if ($line =~ /do\s*(?!{)/) {
3962 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3963 ctx_statement_block($linenr, $realcnt, 0)
3964 if (!defined $stat);
3965 my ($stat_next) = ctx_statement_block($line_nr_next,
3966 $remain_next, $off_next);
3967 $stat_next =~ s/\n./\n /g;
3968 ##print "stat<$stat> stat_next<$stat_next>\n";
3969
3970 if ($stat_next =~ /^\s*while\b/) {
3971 # If the statement carries leading newlines,
3972 # then count those as offsets.
3973 my ($whitespace) =
3974 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3975 my $offset =
3976 statement_rawlines($whitespace) - 1;
3977
3978 $suppress_whiletrailers{$line_nr_next +
3979 $offset} = 1;
3980 }
3981 }
3982 if (!defined $suppress_whiletrailers{$linenr} &&
3983 defined($stat) && defined($cond) &&
3984 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
3985 my ($s, $c) = ($stat, $cond);
3986
3987 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
3988 ERROR("ASSIGN_IN_IF",
3989 "do not use assignment in if condition\n" . $herecurr);
3990 }
3991
3992 # Find out what is on the end of the line after the
3993 # conditional.
3994 substr($s, 0, length($c), '');
3995 $s =~ s/\n.*//g;
3996 $s =~ s/$;//g; # Remove any comments
3997 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3998 $c !~ /}\s*while\s*/)
3999 {
4000 # Find out how long the conditional actually is.
4001 my @newlines = ($c =~ /\n/gs);
4002 my $cond_lines = 1 + $#newlines;
4003 my $stat_real = '';
4004
4005 $stat_real = raw_line($linenr, $cond_lines)
4006 . "\n" if ($cond_lines);
4007 if (defined($stat_real) && $cond_lines > 1) {
4008 $stat_real = "[...]\n$stat_real";
4009 }
4010
4011 ERROR("TRAILING_STATEMENTS",
4012 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4013 }
4014 }
4015
4016 # Check for bitwise tests written as boolean
4017 if ($line =~ /
4018 (?:
4019 (?:\[|\(|\&\&|\|\|)
4020 \s*0[xX][0-9]+\s*
4021 (?:\&\&|\|\|)
4022 |
4023 (?:\&\&|\|\|)
4024 \s*0[xX][0-9]+\s*
4025 (?:\&\&|\|\||\)|\])
4026 )/x)
4027 {
4028 WARN("HEXADECIMAL_BOOLEAN_TEST",
4029 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4030 }
4031
4032 # if and else should not have general statements after it
4033 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4034 my $s = $1;
4035 $s =~ s/$;//g; # Remove any comments
4036 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4037 ERROR("TRAILING_STATEMENTS",
4038 "trailing statements should be on next line\n" . $herecurr);
4039 }
4040 }
4041 # if should not continue a brace
4042 if ($line =~ /}\s*if\b/) {
4043 ERROR("TRAILING_STATEMENTS",
4044 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4045 $herecurr);
4046 }
4047 # case and default should not have general statements after them
4048 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4049 $line !~ /\G(?:
4050 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4051 \s*return\s+
4052 )/xg)
4053 {
4054 ERROR("TRAILING_STATEMENTS",
4055 "trailing statements should be on next line\n" . $herecurr);
4056 }
4057
4058 # Check for }<nl>else {, these must be at the same
4059 # indent level to be relevant to each other.
4060 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4061 $previndent == $indent) {
4062 if (ERROR("ELSE_AFTER_BRACE",
4063 "else should follow close brace '}'\n" . $hereprev) &&
4064 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4065 fix_delete_line($fixlinenr - 1, $prevrawline);
4066 fix_delete_line($fixlinenr, $rawline);
4067 my $fixedline = $prevrawline;
4068 $fixedline =~ s/}\s*$//;
4069 if ($fixedline !~ /^\+\s*$/) {
4070 fix_insert_line($fixlinenr, $fixedline);
4071 }
4072 $fixedline = $rawline;
4073 $fixedline =~ s/^(.\s*)else/$1} else/;
4074 fix_insert_line($fixlinenr, $fixedline);
4075 }
4076 }
4077
4078 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4079 $previndent == $indent) {
4080 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4081
4082 # Find out what is on the end of the line after the
4083 # conditional.
4084 substr($s, 0, length($c), '');
4085 $s =~ s/\n.*//g;
4086
4087 if ($s =~ /^\s*;/) {
4088 if (ERROR("WHILE_AFTER_BRACE",
4089 "while should follow close brace '}'\n" . $hereprev) &&
4090 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4091 fix_delete_line($fixlinenr - 1, $prevrawline);
4092 fix_delete_line($fixlinenr, $rawline);
4093 my $fixedline = $prevrawline;
4094 my $trailing = $rawline;
4095 $trailing =~ s/^\+//;
4096 $trailing = trim($trailing);
4097 $fixedline =~ s/}\s*$/} $trailing/;
4098 fix_insert_line($fixlinenr, $fixedline);
4099 }
4100 }
4101 }
4102
4103 #Specific variable tests
4104 while ($line =~ m{($Constant|$Lval)}g) {
4105 my $var = $1;
4106
4107 #gcc binary extension
4108 if ($var =~ /^$Binary$/) {
4109 if (WARN("GCC_BINARY_CONSTANT",
4110 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4111 $fix) {
4112 my $hexval = sprintf("0x%x", oct($var));
4113 $fixed[$fixlinenr] =~
4114 s/\b$var\b/$hexval/;
4115 }
4116 }
4117
4118 #CamelCase
4119 if ($var !~ /^$Constant$/ &&
4120 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4121 #Ignore Page<foo> variants
4122 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4123 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4124 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4125 #Ignore some three character SI units explicitly, like MiB and KHz
4126 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4127 while ($var =~ m{($Ident)}g) {
4128 my $word = $1;
4129 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4130 if ($check) {
4131 seed_camelcase_includes();
4132 if (!$file && !$camelcase_file_seeded) {
4133 seed_camelcase_file($realfile);
4134 $camelcase_file_seeded = 1;
4135 }
4136 }
4137 if (!defined $camelcase{$word}) {
4138 $camelcase{$word} = 1;
4139 CHK("CAMELCASE",
4140 "Avoid CamelCase: <$word>\n" . $herecurr);
4141 }
4142 }
4143 }
4144 }
4145
4146 #no spaces allowed after \ in define
4147 if ($line =~ /\#\s*define.*\\\s+$/) {
4148 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4149 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4150 $fix) {
4151 $fixed[$fixlinenr] =~ s/\s+$//;
4152 }
4153 }
4154
4155 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4156 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4157 my $file = "$1.h";
4158 my $checkfile = "include/linux/$file";
4159 if (-f "$root/$checkfile" &&
4160 $realfile ne $checkfile &&
4161 $1 !~ /$allowed_asm_includes/)
4162 {
4163 if ($realfile =~ m{^arch/}) {
4164 CHK("ARCH_INCLUDE_LINUX",
4165 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4166 } else {
4167 WARN("INCLUDE_LINUX",
4168 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4169 }
4170 }
4171 }
4172
4173 # multi-statement macros should be enclosed in a do while loop, grab the
4174 # first statement and ensure its the whole macro if its not enclosed
4175 # in a known good container
4176 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4177 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4178 my $ln = $linenr;
4179 my $cnt = $realcnt;
4180 my ($off, $dstat, $dcond, $rest);
4181 my $ctx = '';
4182 my $has_flow_statement = 0;
4183 my $has_arg_concat = 0;
4184 ($dstat, $dcond, $ln, $cnt, $off) =
4185 ctx_statement_block($linenr, $realcnt, 0);
4186 $ctx = $dstat;
4187 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4188 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4189
4190 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4191 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4192
4193 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4194 $dstat =~ s/$;//g;
4195 $dstat =~ s/\\\n.//g;
4196 $dstat =~ s/^\s*//s;
4197 $dstat =~ s/\s*$//s;
4198
4199 # Flatten any parentheses and braces
4200 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4201 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4202 $dstat =~ s/\[[^\[\]]*\]/1/)
4203 {
4204 }
4205
4206 # Flatten any obvious string concatentation.
4207 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4208 $dstat =~ s/$Ident\s*("X*")/$1/)
4209 {
4210 }
4211
4212 my $exceptions = qr{
4213 $Declare|
4214 module_param_named|
4215 MODULE_PARM_DESC|
4216 DECLARE_PER_CPU|
4217 DEFINE_PER_CPU|
4218 __typeof__\(|
4219 union|
4220 struct|
4221 \.$Ident\s*=\s*|
4222 ^\"|\"$
4223 }x;
4224 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4225 if ($dstat ne '' &&
4226 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4227 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4228 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4229 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4230 $dstat !~ /$exceptions/ &&
4231 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4232 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4233 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4234 $dstat !~ /^for\s*$Constant$/ && # for (...)
4235 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4236 $dstat !~ /^do\s*{/ && # do {...
4237 $dstat !~ /^\({/ && # ({...
4238 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4239 {
4240 $ctx =~ s/\n*$//;
4241 my $herectx = $here . "\n";
4242 my $cnt = statement_rawlines($ctx);
4243
4244 for (my $n = 0; $n < $cnt; $n++) {
4245 $herectx .= raw_line($linenr, $n) . "\n";
4246 }
4247
4248 if ($dstat =~ /;/) {
4249 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4250 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4251 } else {
4252 ERROR("COMPLEX_MACRO",
4253 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4254 }
4255 }
4256
4257 # check for macros with flow control, but without ## concatenation
4258 # ## concatenation is commonly a macro that defines a function so ignore those
4259 if ($has_flow_statement && !$has_arg_concat) {
4260 my $herectx = $here . "\n";
4261 my $cnt = statement_rawlines($ctx);
4262
4263 for (my $n = 0; $n < $cnt; $n++) {
4264 $herectx .= raw_line($linenr, $n) . "\n";
4265 }
4266 WARN("MACRO_WITH_FLOW_CONTROL",
4267 "Macros with flow control statements should be avoided\n" . "$herectx");
4268 }
4269
4270 # check for line continuations outside of #defines, preprocessor #, and asm
4271
4272 } else {
4273 if ($prevline !~ /^..*\\$/ &&
4274 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4275 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4276 $line =~ /^\+.*\\$/) {
4277 WARN("LINE_CONTINUATIONS",
4278 "Avoid unnecessary line continuations\n" . $herecurr);
4279 }
4280 }
4281
4282 # do {} while (0) macro tests:
4283 # single-statement macros do not need to be enclosed in do while (0) loop,
4284 # macro should not end with a semicolon
4285 if ($^V && $^V ge 5.10.0 &&
4286 $realfile !~ m@/vmlinux.lds.h$@ &&
4287 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4288 my $ln = $linenr;
4289 my $cnt = $realcnt;
4290 my ($off, $dstat, $dcond, $rest);
4291 my $ctx = '';
4292 ($dstat, $dcond, $ln, $cnt, $off) =
4293 ctx_statement_block($linenr, $realcnt, 0);
4294 $ctx = $dstat;
4295
4296 $dstat =~ s/\\\n.//g;
4297 $dstat =~ s/$;/ /g;
4298
4299 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4300 my $stmts = $2;
4301 my $semis = $3;
4302
4303 $ctx =~ s/\n*$//;
4304 my $cnt = statement_rawlines($ctx);
4305 my $herectx = $here . "\n";
4306
4307 for (my $n = 0; $n < $cnt; $n++) {
4308 $herectx .= raw_line($linenr, $n) . "\n";
4309 }
4310
4311 if (($stmts =~ tr/;/;/) == 1 &&
4312 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4313 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4314 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4315 }
4316 if (defined $semis && $semis ne "") {
4317 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4318 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4319 }
4320 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4321 $ctx =~ s/\n*$//;
4322 my $cnt = statement_rawlines($ctx);
4323 my $herectx = $here . "\n";
4324
4325 for (my $n = 0; $n < $cnt; $n++) {
4326 $herectx .= raw_line($linenr, $n) . "\n";
4327 }
4328
4329 WARN("TRAILING_SEMICOLON",
4330 "macros should not use a trailing semicolon\n" . "$herectx");
4331 }
4332 }
4333
4334 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4335 # all assignments may have only one of the following with an assignment:
4336 # .
4337 # ALIGN(...)
4338 # VMLINUX_SYMBOL(...)
4339 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4340 WARN("MISSING_VMLINUX_SYMBOL",
4341 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4342 }
4343
4344 # check for redundant bracing round if etc
4345 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4346 my ($level, $endln, @chunks) =
4347 ctx_statement_full($linenr, $realcnt, 1);
4348 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4349 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4350 if ($#chunks > 0 && $level == 0) {
4351 my @allowed = ();
4352 my $allow = 0;
4353 my $seen = 0;
4354 my $herectx = $here . "\n";
4355 my $ln = $linenr - 1;
4356 for my $chunk (@chunks) {
4357 my ($cond, $block) = @{$chunk};
4358
4359 # If the condition carries leading newlines, then count those as offsets.
4360 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4361 my $offset = statement_rawlines($whitespace) - 1;
4362
4363 $allowed[$allow] = 0;
4364 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4365
4366 # We have looked at and allowed this specific line.
4367 $suppress_ifbraces{$ln + $offset} = 1;
4368
4369 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4370 $ln += statement_rawlines($block) - 1;
4371
4372 substr($block, 0, length($cond), '');
4373
4374 $seen++ if ($block =~ /^\s*{/);
4375
4376 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4377 if (statement_lines($cond) > 1) {
4378 #print "APW: ALLOWED: cond<$cond>\n";
4379 $allowed[$allow] = 1;
4380 }
4381 if ($block =~/\b(?:if|for|while)\b/) {
4382 #print "APW: ALLOWED: block<$block>\n";
4383 $allowed[$allow] = 1;
4384 }
4385 if (statement_block_size($block) > 1) {
4386 #print "APW: ALLOWED: lines block<$block>\n";
4387 $allowed[$allow] = 1;
4388 }
4389 $allow++;
4390 }
4391 if ($seen) {
4392 my $sum_allowed = 0;
4393 foreach (@allowed) {
4394 $sum_allowed += $_;
4395 }
4396 if ($sum_allowed == 0) {
4397 WARN("BRACES",
4398 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4399 } elsif ($sum_allowed != $allow &&
4400 $seen != $allow) {
4401 CHK("BRACES",
4402 "braces {} should be used on all arms of this statement\n" . $herectx);
4403 }
4404 }
4405 }
4406 }
4407 if (!defined $suppress_ifbraces{$linenr - 1} &&
4408 $line =~ /\b(if|while|for|else)\b/) {
4409 my $allowed = 0;
4410
4411 # Check the pre-context.
4412 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4413 #print "APW: ALLOWED: pre<$1>\n";
4414 $allowed = 1;
4415 }
4416
4417 my ($level, $endln, @chunks) =
4418 ctx_statement_full($linenr, $realcnt, $-[0]);
4419
4420 # Check the condition.
4421 my ($cond, $block) = @{$chunks[0]};
4422 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4423 if (defined $cond) {
4424 substr($block, 0, length($cond), '');
4425 }
4426 if (statement_lines($cond) > 1) {
4427 #print "APW: ALLOWED: cond<$cond>\n";
4428 $allowed = 1;
4429 }
4430 if ($block =~/\b(?:if|for|while)\b/) {
4431 #print "APW: ALLOWED: block<$block>\n";
4432 $allowed = 1;
4433 }
4434 if (statement_block_size($block) > 1) {
4435 #print "APW: ALLOWED: lines block<$block>\n";
4436 $allowed = 1;
4437 }
4438 # Check the post-context.
4439 if (defined $chunks[1]) {
4440 my ($cond, $block) = @{$chunks[1]};
4441 if (defined $cond) {
4442 substr($block, 0, length($cond), '');
4443 }
4444 if ($block =~ /^\s*\{/) {
4445 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4446 $allowed = 1;
4447 }
4448 }
4449 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4450 my $herectx = $here . "\n";
4451 my $cnt = statement_rawlines($block);
4452
4453 for (my $n = 0; $n < $cnt; $n++) {
4454 $herectx .= raw_line($linenr, $n) . "\n";
4455 }
4456
4457 WARN("BRACES",
4458 "braces {} are not necessary for single statement blocks\n" . $herectx);
4459 }
4460 }
4461
4462 # check for unnecessary blank lines around braces
4463 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4464 CHK("BRACES",
4465 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4466 }
4467 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4468 CHK("BRACES",
4469 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4470 }
4471
4472 # no volatiles please
4473 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4474 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4475 WARN("VOLATILE",
4476 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4477 }
4478
4479 # Check for user-visible strings broken across lines, which breaks the ability
4480 # to grep for the string. Make exceptions when the previous string ends in a
4481 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4482 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4483 if ($line =~ /^\+\s*"[X\t]*"/ &&
4484 $prevline =~ /"\s*$/ &&
4485 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4486 if (WARN("SPLIT_STRING",
4487 "quoted string split across lines\n" . $hereprev) &&
4488 $fix &&
4489 $prevrawline =~ /^\+.*"\s*$/ &&
4490 $last_coalesced_string_linenr != $linenr - 1) {
4491 my $extracted_string = get_quoted_string($line, $rawline);
4492 my $comma_close = "";
4493 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4494 $comma_close = $1;
4495 }
4496
4497 fix_delete_line($fixlinenr - 1, $prevrawline);
4498 fix_delete_line($fixlinenr, $rawline);
4499 my $fixedline = $prevrawline;
4500 $fixedline =~ s/"\s*$//;
4501 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4502 fix_insert_line($fixlinenr - 1, $fixedline);
4503 $fixedline = $rawline;
4504 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4505 if ($fixedline !~ /\+\s*$/) {
4506 fix_insert_line($fixlinenr, $fixedline);
4507 }
4508 $last_coalesced_string_linenr = $linenr;
4509 }
4510 }
4511
4512 # check for missing a space in a string concatenation
4513 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4514 WARN('MISSING_SPACE',
4515 "break quoted strings at a space character\n" . $hereprev);
4516 }
4517
4518 # check for spaces before a quoted newline
4519 if ($rawline =~ /^.*\".*\s\\n/) {
4520 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4521 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4522 $fix) {
4523 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4524 }
4525
4526 }
4527
4528 # concatenated string without spaces between elements
4529 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4530 CHK("CONCATENATED_STRING",
4531 "Concatenated strings should use spaces between elements\n" . $herecurr);
4532 }
4533
4534 # uncoalesced string fragments
4535 if ($line =~ /"X*"\s*"/) {
4536 WARN("STRING_FRAGMENTS",
4537 "Consecutive strings are generally better as a single string\n" . $herecurr);
4538 }
4539
4540 # check for %L{u,d,i} in strings
4541 my $string;
4542 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4543 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4544 $string =~ s/%%/__/g;
4545 if ($string =~ /(?<!%)%L[udi]/) {
4546 WARN("PRINTF_L",
4547 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4548 last;
4549 }
4550 }
4551
4552 # check for line continuations in quoted strings with odd counts of "
4553 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4554 WARN("LINE_CONTINUATIONS",
4555 "Avoid line continuations in quoted strings\n" . $herecurr);
4556 }
4557
4558 # warn about #if 0
4559 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4560 CHK("REDUNDANT_CODE",
4561 "if this code is redundant consider removing it\n" .
4562 $herecurr);
4563 }
4564
4565 # check for needless "if (<foo>) fn(<foo>)" uses
4566 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4567 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4568 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4569 WARN('NEEDLESS_IF',
4570 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
4571 }
4572 }
4573
4574 # check for unnecessary "Out of Memory" messages
4575 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4576 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4577 (defined $1 || defined $3) &&
4578 $linenr > 3) {
4579 my $testval = $2;
4580 my $testline = $lines[$linenr - 3];
4581
4582 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4583 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4584
4585 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4586 WARN("OOM_MESSAGE",
4587 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4588 }
4589 }
4590
4591 # check for logging functions with KERN_<LEVEL>
4592 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
4593 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4594 my $level = $1;
4595 if (WARN("UNNECESSARY_KERN_LEVEL",
4596 "Possible unnecessary $level\n" . $herecurr) &&
4597 $fix) {
4598 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4599 }
4600 }
4601
4602 # check for mask then right shift without a parentheses
4603 if ($^V && $^V ge 5.10.0 &&
4604 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4605 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4606 WARN("MASK_THEN_SHIFT",
4607 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4608 }
4609
4610 # check for pointer comparisons to NULL
4611 if ($^V && $^V ge 5.10.0) {
4612 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4613 my $val = $1;
4614 my $equal = "!";
4615 $equal = "" if ($4 eq "!=");
4616 if (CHK("COMPARISON_TO_NULL",
4617 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4618 $fix) {
4619 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4620 }
4621 }
4622 }
4623
4624 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4625 if ($line =~ /(\b$InitAttribute\b)/) {
4626 my $attr = $1;
4627 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4628 my $ptr = $1;
4629 my $var = $2;
4630 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4631 ERROR("MISPLACED_INIT",
4632 "$attr should be placed after $var\n" . $herecurr)) ||
4633 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4634 WARN("MISPLACED_INIT",
4635 "$attr should be placed after $var\n" . $herecurr))) &&
4636 $fix) {
4637 $fixed[$fixlinenr] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
4638 }
4639 }
4640 }
4641
4642 # check for $InitAttributeData (ie: __initdata) with const
4643 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4644 my $attr = $1;
4645 $attr =~ /($InitAttributePrefix)(.*)/;
4646 my $attr_prefix = $1;
4647 my $attr_type = $2;
4648 if (ERROR("INIT_ATTRIBUTE",
4649 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4650 $fix) {
4651 $fixed[$fixlinenr] =~
4652 s/$InitAttributeData/${attr_prefix}initconst/;
4653 }
4654 }
4655
4656 # check for $InitAttributeConst (ie: __initconst) without const
4657 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4658 my $attr = $1;
4659 if (ERROR("INIT_ATTRIBUTE",
4660 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4661 $fix) {
4662 my $lead = $fixed[$fixlinenr] =~
4663 /(^\+\s*(?:static\s+))/;
4664 $lead = rtrim($1);
4665 $lead = "$lead " if ($lead !~ /^\+$/);
4666 $lead = "${lead}const ";
4667 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
4668 }
4669 }
4670
4671 # don't use __constant_<foo> functions outside of include/uapi/
4672 if ($realfile !~ m@^include/uapi/@ &&
4673 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4674 my $constant_func = $1;
4675 my $func = $constant_func;
4676 $func =~ s/^__constant_//;
4677 if (WARN("CONSTANT_CONVERSION",
4678 "$constant_func should be $func\n" . $herecurr) &&
4679 $fix) {
4680 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
4681 }
4682 }
4683
4684 # prefer usleep_range over udelay
4685 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
4686 my $delay = $1;
4687 # ignore udelay's < 10, however
4688 if (! ($delay < 10) ) {
4689 CHK("USLEEP_RANGE",
4690 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4691 }
4692 if ($delay > 2000) {
4693 WARN("LONG_UDELAY",
4694 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
4695 }
4696 }
4697
4698 # warn about unexpectedly long msleep's
4699 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4700 if ($1 < 20) {
4701 WARN("MSLEEP",
4702 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4703 }
4704 }
4705
4706 # check for comparisons of jiffies
4707 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4708 WARN("JIFFIES_COMPARISON",
4709 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4710 }
4711
4712 # check for comparisons of get_jiffies_64()
4713 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4714 WARN("JIFFIES_COMPARISON",
4715 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4716 }
4717
4718 # warn about #ifdefs in C files
4719 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4720 # print "#ifdef in C files should be avoided\n";
4721 # print "$herecurr";
4722 # $clean = 0;
4723 # }
4724
4725 # warn about spacing in #ifdefs
4726 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
4727 if (ERROR("SPACING",
4728 "exactly one space required after that #$1\n" . $herecurr) &&
4729 $fix) {
4730 $fixed[$fixlinenr] =~
4731 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4732 }
4733
4734 }
4735
4736 # check for spinlock_t definitions without a comment.
4737 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4738 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
4739 my $which = $1;
4740 if (!ctx_has_comment($first_line, $linenr)) {
4741 CHK("UNCOMMENTED_DEFINITION",
4742 "$1 definition without comment\n" . $herecurr);
4743 }
4744 }
4745 # check for memory barriers without a comment.
4746 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4747 if (!ctx_has_comment($first_line, $linenr)) {
4748 WARN("MEMORY_BARRIER",
4749 "memory barrier without comment\n" . $herecurr);
4750 }
4751 }
4752 # check of hardware specific defines
4753 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4754 CHK("ARCH_DEFINES",
4755 "architecture specific defines should be avoided\n" . $herecurr);
4756 }
4757
4758 # Check that the storage class is at the beginning of a declaration
4759 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
4760 WARN("STORAGE_CLASS",
4761 "storage class should be at the beginning of the declaration\n" . $herecurr)
4762 }
4763
4764 # check the location of the inline attribute, that it is between
4765 # storage class and type.
4766 if ($line =~ /\b$Type\s+$Inline\b/ ||
4767 $line =~ /\b$Inline\s+$Storage\b/) {
4768 ERROR("INLINE_LOCATION",
4769 "inline keyword should sit between storage class and type\n" . $herecurr);
4770 }
4771
4772 # Check for __inline__ and __inline, prefer inline
4773 if ($realfile !~ m@\binclude/uapi/@ &&
4774 $line =~ /\b(__inline__|__inline)\b/) {
4775 if (WARN("INLINE",
4776 "plain inline is preferred over $1\n" . $herecurr) &&
4777 $fix) {
4778 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
4779
4780 }
4781 }
4782
4783 # Check for __attribute__ packed, prefer __packed
4784 if ($realfile !~ m@\binclude/uapi/@ &&
4785 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
4786 WARN("PREFER_PACKED",
4787 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
4788 }
4789
4790 # Check for __attribute__ aligned, prefer __aligned
4791 if ($realfile !~ m@\binclude/uapi/@ &&
4792 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
4793 WARN("PREFER_ALIGNED",
4794 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
4795 }
4796
4797 # Check for __attribute__ format(printf, prefer __printf
4798 if ($realfile !~ m@\binclude/uapi/@ &&
4799 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
4800 if (WARN("PREFER_PRINTF",
4801 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4802 $fix) {
4803 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4804
4805 }
4806 }
4807
4808 # Check for __attribute__ format(scanf, prefer __scanf
4809 if ($realfile !~ m@\binclude/uapi/@ &&
4810 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
4811 if (WARN("PREFER_SCANF",
4812 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4813 $fix) {
4814 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4815 }
4816 }
4817
4818 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4819 if ($^V && $^V ge 5.10.0 &&
4820 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4821 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4822 $line =~ /\b__weak\b/)) {
4823 ERROR("WEAK_DECLARATION",
4824 "Using weak declarations can have unintended link defects\n" . $herecurr);
4825 }
4826
4827 # check for sizeof(&)
4828 if ($line =~ /\bsizeof\s*\(\s*\&/) {
4829 WARN("SIZEOF_ADDRESS",
4830 "sizeof(& should be avoided\n" . $herecurr);
4831 }
4832
4833 # check for sizeof without parenthesis
4834 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
4835 if (WARN("SIZEOF_PARENTHESIS",
4836 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4837 $fix) {
4838 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4839 }
4840 }
4841
4842 # check for struct spinlock declarations
4843 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4844 WARN("USE_SPINLOCK_T",
4845 "struct spinlock should be spinlock_t\n" . $herecurr);
4846 }
4847
4848 # check for seq_printf uses that could be seq_puts
4849 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
4850 my $fmt = get_quoted_string($line, $rawline);
4851 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
4852 if (WARN("PREFER_SEQ_PUTS",
4853 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4854 $fix) {
4855 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
4856 }
4857 }
4858 }
4859
4860 # Check for misused memsets
4861 if ($^V && $^V ge 5.10.0 &&
4862 defined $stat &&
4863 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
4864
4865 my $ms_addr = $2;
4866 my $ms_val = $7;
4867 my $ms_size = $12;
4868
4869 if ($ms_size =~ /^(0x|)0$/i) {
4870 ERROR("MEMSET",
4871 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
4872 } elsif ($ms_size =~ /^(0x|)1$/i) {
4873 WARN("MEMSET",
4874 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4875 }
4876 }
4877
4878 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4879 if ($^V && $^V ge 5.10.0 &&
4880 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4881 if (WARN("PREFER_ETHER_ADDR_COPY",
4882 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4883 $fix) {
4884 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4885 }
4886 }
4887
4888 # typecasts on min/max could be min_t/max_t
4889 if ($^V && $^V ge 5.10.0 &&
4890 defined $stat &&
4891 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
4892 if (defined $2 || defined $7) {
4893 my $call = $1;
4894 my $cast1 = deparenthesize($2);
4895 my $arg1 = $3;
4896 my $cast2 = deparenthesize($7);
4897 my $arg2 = $8;
4898 my $cast;
4899
4900 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
4901 $cast = "$cast1 or $cast2";
4902 } elsif ($cast1 ne "") {
4903 $cast = $cast1;
4904 } else {
4905 $cast = $cast2;
4906 }
4907 WARN("MINMAX",
4908 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
4909 }
4910 }
4911
4912 # check usleep_range arguments
4913 if ($^V && $^V ge 5.10.0 &&
4914 defined $stat &&
4915 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4916 my $min = $1;
4917 my $max = $7;
4918 if ($min eq $max) {
4919 WARN("USLEEP_RANGE",
4920 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4921 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4922 $min > $max) {
4923 WARN("USLEEP_RANGE",
4924 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4925 }
4926 }
4927
4928 # check for naked sscanf
4929 if ($^V && $^V ge 5.10.0 &&
4930 defined $stat &&
4931 $line =~ /\bsscanf\b/ &&
4932 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4933 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4934 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4935 my $lc = $stat =~ tr@\n@@;
4936 $lc = $lc + $linenr;
4937 my $stat_real = raw_line($linenr, 0);
4938 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4939 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4940 }
4941 WARN("NAKED_SSCANF",
4942 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4943 }
4944
4945 # check for simple sscanf that should be kstrto<foo>
4946 if ($^V && $^V ge 5.10.0 &&
4947 defined $stat &&
4948 $line =~ /\bsscanf\b/) {
4949 my $lc = $stat =~ tr@\n@@;
4950 $lc = $lc + $linenr;
4951 my $stat_real = raw_line($linenr, 0);
4952 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4953 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4954 }
4955 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4956 my $format = $6;
4957 my $count = $format =~ tr@%@%@;
4958 if ($count == 1 &&
4959 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4960 WARN("SSCANF_TO_KSTRTO",
4961 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4962 }
4963 }
4964 }
4965
4966 # check for new externs in .h files.
4967 if ($realfile =~ /\.h$/ &&
4968 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
4969 if (CHK("AVOID_EXTERNS",
4970 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
4971 $fix) {
4972 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4973 }
4974 }
4975
4976 # check for new externs in .c files.
4977 if ($realfile =~ /\.c$/ && defined $stat &&
4978 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
4979 {
4980 my $function_name = $1;
4981 my $paren_space = $2;
4982
4983 my $s = $stat;
4984 if (defined $cond) {
4985 substr($s, 0, length($cond), '');
4986 }
4987 if ($s =~ /^\s*;/ &&
4988 $function_name ne 'uninitialized_var')
4989 {
4990 WARN("AVOID_EXTERNS",
4991 "externs should be avoided in .c files\n" . $herecurr);
4992 }
4993
4994 if ($paren_space =~ /\n/) {
4995 WARN("FUNCTION_ARGUMENTS",
4996 "arguments for function declarations should follow identifier\n" . $herecurr);
4997 }
4998
4999 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5000 $stat =~ /^.\s*extern\s+/)
5001 {
5002 WARN("AVOID_EXTERNS",
5003 "externs should be avoided in .c files\n" . $herecurr);
5004 }
5005
5006 # checks for new __setup's
5007 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5008 my $name = $1;
5009
5010 if (!grep(/$name/, @setup_docs)) {
5011 CHK("UNDOCUMENTED_SETUP",
5012 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5013 }
5014 }
5015
5016 # check for pointless casting of kmalloc return
5017 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5018 WARN("UNNECESSARY_CASTS",
5019 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5020 }
5021
5022 # alloc style
5023 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5024 if ($^V && $^V ge 5.10.0 &&
5025 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5026 CHK("ALLOC_SIZEOF_STRUCT",
5027 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5028 }
5029
5030 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5031 if ($^V && $^V ge 5.10.0 &&
5032 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5033 my $oldfunc = $3;
5034 my $a1 = $4;
5035 my $a2 = $10;
5036 my $newfunc = "kmalloc_array";
5037 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5038 my $r1 = $a1;
5039 my $r2 = $a2;
5040 if ($a1 =~ /^sizeof\s*\S/) {
5041 $r1 = $a2;
5042 $r2 = $a1;
5043 }
5044 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5045 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5046 if (WARN("ALLOC_WITH_MULTIPLY",
5047 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5048 $fix) {
5049 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
5050
5051 }
5052 }
5053 }
5054
5055 # check for krealloc arg reuse
5056 if ($^V && $^V ge 5.10.0 &&
5057 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5058 WARN("KREALLOC_ARG_REUSE",
5059 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5060 }
5061
5062 # check for alloc argument mismatch
5063 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5064 WARN("ALLOC_ARRAY_ARGS",
5065 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5066 }
5067
5068 # check for multiple semicolons
5069 if ($line =~ /;\s*;\s*$/) {
5070 if (WARN("ONE_SEMICOLON",
5071 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5072 $fix) {
5073 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5074 }
5075 }
5076
5077 # check for #defines like: 1 << <digit> that could be BIT(digit)
5078 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5079 my $ull = "";
5080 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5081 if (CHK("BIT_MACRO",
5082 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5083 $fix) {
5084 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5085 }
5086 }
5087
5088 # check for case / default statements not preceded by break/fallthrough/switch
5089 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5090 my $has_break = 0;
5091 my $has_statement = 0;
5092 my $count = 0;
5093 my $prevline = $linenr;
5094 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5095 $prevline--;
5096 my $rline = $rawlines[$prevline - 1];
5097 my $fline = $lines[$prevline - 1];
5098 last if ($fline =~ /^\@\@/);
5099 next if ($fline =~ /^\-/);
5100 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5101 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5102 next if ($fline =~ /^.[\s$;]*$/);
5103 $has_statement = 1;
5104 $count++;
5105 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5106 }
5107 if (!$has_break && $has_statement) {
5108 WARN("MISSING_BREAK",
5109 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5110 }
5111 }
5112
5113 # check for switch/default statements without a break;
5114 if ($^V && $^V ge 5.10.0 &&
5115 defined $stat &&
5116 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5117 my $ctx = '';
5118 my $herectx = $here . "\n";
5119 my $cnt = statement_rawlines($stat);
5120 for (my $n = 0; $n < $cnt; $n++) {
5121 $herectx .= raw_line($linenr, $n) . "\n";
5122 }
5123 WARN("DEFAULT_NO_BREAK",
5124 "switch default: should use break\n" . $herectx);
5125 }
5126
5127 # check for gcc specific __FUNCTION__
5128 if ($line =~ /\b__FUNCTION__\b/) {
5129 if (WARN("USE_FUNC",
5130 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5131 $fix) {
5132 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5133 }
5134 }
5135
5136 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5137 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5138 ERROR("DATE_TIME",
5139 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5140 }
5141
5142 # check for use of yield()
5143 if ($line =~ /\byield\s*\(\s*\)/) {
5144 WARN("YIELD",
5145 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5146 }
5147
5148 # check for comparisons against true and false
5149 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5150 my $lead = $1;
5151 my $arg = $2;
5152 my $test = $3;
5153 my $otype = $4;
5154 my $trail = $5;
5155 my $op = "!";
5156
5157 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5158
5159 my $type = lc($otype);
5160 if ($type =~ /^(?:true|false)$/) {
5161 if (("$test" eq "==" && "$type" eq "true") ||
5162 ("$test" eq "!=" && "$type" eq "false")) {
5163 $op = "";
5164 }
5165
5166 CHK("BOOL_COMPARISON",
5167 "Using comparison to $otype is error prone\n" . $herecurr);
5168
5169 ## maybe suggesting a correct construct would better
5170 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5171
5172 }
5173 }
5174
5175 # check for semaphores initialized locked
5176 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5177 WARN("CONSIDER_COMPLETION",
5178 "consider using a completion\n" . $herecurr);
5179 }
5180
5181 # recommend kstrto* over simple_strto* and strict_strto*
5182 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5183 WARN("CONSIDER_KSTRTO",
5184 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5185 }
5186
5187 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5188 if ($line =~ /^.\s*__initcall\s*\(/) {
5189 WARN("USE_DEVICE_INITCALL",
5190 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5191 }
5192
5193 # check for various ops structs, ensure they are const.
5194 my $struct_ops = qr{acpi_dock_ops|
5195 address_space_operations|
5196 backlight_ops|
5197 block_device_operations|
5198 dentry_operations|
5199 dev_pm_ops|
5200 dma_map_ops|
5201 extent_io_ops|
5202 file_lock_operations|
5203 file_operations|
5204 hv_ops|
5205 ide_dma_ops|
5206 intel_dvo_dev_ops|
5207 item_operations|
5208 iwl_ops|
5209 kgdb_arch|
5210 kgdb_io|
5211 kset_uevent_ops|
5212 lock_manager_operations|
5213 microcode_ops|
5214 mtrr_ops|
5215 neigh_ops|
5216 nlmsvc_binding|
5217 pci_raw_ops|
5218 pipe_buf_operations|
5219 platform_hibernation_ops|
5220 platform_suspend_ops|
5221 proto_ops|
5222 rpc_pipe_ops|
5223 seq_operations|
5224 snd_ac97_build_ops|
5225 soc_pcmcia_socket_ops|
5226 stacktrace_ops|
5227 sysfs_ops|
5228 tty_operations|
5229 usb_mon_operations|
5230 wd_ops}x;
5231 if ($line !~ /\bconst\b/ &&
5232 $line =~ /\bstruct\s+($struct_ops)\b/) {
5233 WARN("CONST_STRUCT",
5234 "struct $1 should normally be const\n" .
5235 $herecurr);
5236 }
5237
5238 # use of NR_CPUS is usually wrong
5239 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5240 if ($line =~ /\bNR_CPUS\b/ &&
5241 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5242 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5243 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5244 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5245 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5246 {
5247 WARN("NR_CPUS",
5248 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5249 }
5250
5251 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5252 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5253 ERROR("DEFINE_ARCH_HAS",
5254 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5255 }
5256
5257 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5258 if ($^V && $^V ge 5.10.0 &&
5259 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5260 WARN("LIKELY_MISUSE",
5261 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5262 }
5263
5264 # whine mightly about in_atomic
5265 if ($line =~ /\bin_atomic\s*\(/) {
5266 if ($realfile =~ m@^drivers/@) {
5267 ERROR("IN_ATOMIC",
5268 "do not use in_atomic in drivers\n" . $herecurr);
5269 } elsif ($realfile !~ m@^kernel/@) {
5270 WARN("IN_ATOMIC",
5271 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5272 }
5273 }
5274
5275 # check for lockdep_set_novalidate_class
5276 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5277 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5278 if ($realfile !~ m@^kernel/lockdep@ &&
5279 $realfile !~ m@^include/linux/lockdep@ &&
5280 $realfile !~ m@^drivers/base/core@) {
5281 ERROR("LOCKDEP",
5282 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5283 }
5284 }
5285
5286 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5287 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
5288 WARN("EXPORTED_WORLD_WRITABLE",
5289 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5290 }
5291
5292 # Mode permission misuses where it seems decimal should be octal
5293 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5294 if ($^V && $^V ge 5.10.0 &&
5295 $line =~ /$mode_perms_search/) {
5296 foreach my $entry (@mode_permission_funcs) {
5297 my $func = $entry->[0];
5298 my $arg_pos = $entry->[1];
5299
5300 my $skip_args = "";
5301 if ($arg_pos > 1) {
5302 $arg_pos--;
5303 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5304 }
5305 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5306 if ($line =~ /$test/) {
5307 my $val = $1;
5308 $val = $6 if ($skip_args ne "");
5309
5310 if ($val !~ /^0$/ &&
5311 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5312 length($val) ne 4)) {
5313 ERROR("NON_OCTAL_PERMISSIONS",
5314 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5315 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5316 ERROR("EXPORTED_WORLD_WRITABLE",
5317 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5318 }
5319 }
5320 }
5321 }
5322 }
5323
5324 # If we have no input at all, then there is nothing to report on
5325 # so just keep quiet.
5326 if ($#rawlines == -1) {
5327 exit(0);
5328 }
5329
5330 # In mailback mode only produce a report in the negative, for
5331 # things that appear to be patches.
5332 if ($mailback && ($clean == 1 || !$is_patch)) {
5333 exit(0);
5334 }
5335
5336 # This is not a patch, and we are are in 'no-patch' mode so
5337 # just keep quiet.
5338 if (!$chk_patch && !$is_patch) {
5339 exit(0);
5340 }
5341
5342 if (!$is_patch) {
5343 ERROR("NOT_UNIFIED_DIFF",
5344 "Does not appear to be a unified-diff format patch\n");
5345 }
5346 if ($is_patch && $chk_signoff && $signoff == 0) {
5347 ERROR("MISSING_SIGN_OFF",
5348 "Missing Signed-off-by: line(s)\n");
5349 }
5350
5351 print report_dump();
5352 if ($summary && !($clean == 1 && $quiet == 1)) {
5353 print "$filename " if ($summary_file);
5354 print "total: $cnt_error errors, $cnt_warn warnings, " .
5355 (($check)? "$cnt_chk checks, " : "") .
5356 "$cnt_lines lines checked\n";
5357 print "\n" if ($quiet == 0);
5358 }
5359
5360 if ($quiet == 0) {
5361
5362 if ($^V lt 5.10.0) {
5363 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5364 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5365 }
5366
5367 # If there were whitespace errors which cleanpatch can fix
5368 # then suggest that.
5369 if ($rpt_cleaners) {
5370 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5371 print " scripts/cleanfile\n\n";
5372 $rpt_cleaners = 0;
5373 }
5374 }
5375
5376 hash_show_words(\%use_type, "Used");
5377 hash_show_words(\%ignore_type, "Ignored");
5378
5379 if ($clean == 0 && $fix &&
5380 ("@rawlines" ne "@fixed" ||
5381 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5382 my $newfile = $filename;
5383 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5384 my $linecount = 0;
5385 my $f;
5386
5387 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5388
5389 open($f, '>', $newfile)
5390 or die "$P: Can't open $newfile for write\n";
5391 foreach my $fixed_line (@fixed) {
5392 $linecount++;
5393 if ($file) {
5394 if ($linecount > 3) {
5395 $fixed_line =~ s/^\+//;
5396 print $f $fixed_line . "\n";
5397 }
5398 } else {
5399 print $f $fixed_line . "\n";
5400 }
5401 }
5402 close($f);
5403
5404 if (!$quiet) {
5405 print << "EOM";
5406 Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5407
5408 Do _NOT_ trust the results written to this file.
5409 Do _NOT_ submit these changes without inspecting them for correctness.
5410
5411 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5412 No warranties, expressed or implied...
5413
5414 EOM
5415 }
5416 }
5417
5418 if ($clean == 1 && $quiet == 0) {
5419 print "$vname has no obvious style problems and is ready for submission.\n"
5420 }
5421 if ($clean == 0 && $quiet == 0) {
5422 print << "EOM";
5423 $vname has style problems, please review.
5424
5425 If any of these errors are false positives, please report
5426 them to the maintainer, see CHECKPATCH in MAINTAINERS.
5427 EOM
5428 }
5429
5430 return $clean;
5431 }
This page took 0.220064 seconds and 6 git commands to generate.