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