Loading...
1#!/usr/bin/env perl
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 warnings;
10use POSIX;
11use File::Basename;
12use Cwd 'abs_path';
13use Term::ANSIColor qw(:constants);
14
15my $P = $0;
16my $D = dirname(abs_path($P));
17
18my $V = '0.32';
19
20use Getopt::Long qw(:config no_auto_abbrev);
21
22my $quiet = 0;
23my $tree = 1;
24my $chk_signoff = 1;
25my $chk_patch = 1;
26my $tst_only;
27my $emacs = 0;
28my $terse = 0;
29my $showfile = 0;
30my $file = 0;
31my $git = 0;
32my %git_commits = ();
33my $check = 0;
34my $check_orig = 0;
35my $summary = 1;
36my $mailback = 0;
37my $summary_file = 0;
38my $show_types = 0;
39my $list_types = 0;
40my $fix = 0;
41my $fix_inplace = 0;
42my $root;
43my %debug;
44my %camelcase = ();
45my %use_type = ();
46my @use = ();
47my %ignore_type = ();
48my @ignore = ();
49my $help = 0;
50my $configuration_file = ".checkpatch.conf";
51my $max_line_length = 80;
52my $ignore_perl_version = 0;
53my $minimum_perl_version = 5.10.0;
54my $min_conf_desc_length = 4;
55my $spelling_file = "$D/spelling.txt";
56my $codespell = 0;
57my $codespellfile = "/usr/share/codespell/dictionary.txt";
58my $conststructsfile = "$D/const_structs.checkpatch";
59my $typedefsfile = "";
60my $color = "auto";
61my $allow_c99_comments = 1;
62
63sub help {
64 my ($exitcode) = @_;
65
66 print << "EOM";
67Usage: $P [OPTION]... [FILE]...
68Version: $V
69
70Options:
71 -q, --quiet quiet
72 --no-tree run without a kernel tree
73 --no-signoff do not check for 'Signed-off-by' line
74 --patch treat FILE as patchfile (default)
75 --emacs emacs compile window format
76 --terse one line per report
77 --showfile emit diffed file position, not input file position
78 -g, --git treat FILE as a single commit or git revision range
79 single git commit with:
80 <rev>
81 <rev>^
82 <rev>~n
83 multiple git commits with:
84 <rev1>..<rev2>
85 <rev1>...<rev2>
86 <rev>-<count>
87 git merges are ignored
88 -f, --file treat FILE as regular source file
89 --subjective, --strict enable more subjective tests
90 --list-types list the possible message types
91 --types TYPE(,TYPE2...) show only these comma separated message types
92 --ignore TYPE(,TYPE2...) ignore various comma separated message types
93 --show-types show the specific message type in the output
94 --max-line-length=n set the maximum line length, if exceeded, warn
95 --min-conf-desc-length=n set the min description length, if shorter, warn
96 --root=PATH PATH to the kernel tree root
97 --no-summary suppress the per-file summary
98 --mailback only produce a report in case of warnings/errors
99 --summary-file include the filename in summary
100 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
101 'values', 'possible', 'type', and 'attr' (default
102 is all off)
103 --test-only=WORD report only warnings/errors containing WORD
104 literally
105 --fix EXPERIMENTAL - may create horrible results
106 If correctable single-line errors exist, create
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
110 --fix-inplace EXPERIMENTAL - may create horrible results
111 Is the same as --fix, but overwrites the input
112 file. It's your fault if there's no backup or git
113 --ignore-perl-version override checking of perl version. expect
114 runtime errors.
115 --codespell Use the codespell dictionary for spelling/typos
116 (default:/usr/share/codespell/dictionary.txt)
117 --codespellfile Use this codespell dictionary
118 --typedefsfile Read additional types from this file
119 --color[=WHEN] Use colors 'always', 'never', or only when output
120 is a terminal ('auto'). Default is 'auto'.
121 -h, --help, --version display this help and exit
122
123When FILE is - read standard input.
124EOM
125
126 exit($exitcode);
127}
128
129sub uniq {
130 my %seen;
131 return grep { !$seen{$_}++ } @_;
132}
133
134sub list_types {
135 my ($exitcode) = @_;
136
137 my $count = 0;
138
139 local $/ = undef;
140
141 open(my $script, '<', abs_path($P)) or
142 die "$P: Can't read '$P' $!\n";
143
144 my $text = <$script>;
145 close($script);
146
147 my @types = ();
148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
150 push (@types, $_);
151 }
152 @types = sort(uniq(@types));
153 print("#\tMessage type\n\n");
154 foreach my $type (@types) {
155 print(++$count . "\t" . $type . "\n");
156 }
157
158 exit($exitcode);
159}
160
161my $conf = which_conf($configuration_file);
162if (-f $conf) {
163 my @conf_args;
164 open(my $conffile, '<', "$conf")
165 or warn "$P: Can't find a readable $configuration_file file $!\n";
166
167 while (<$conffile>) {
168 my $line = $_;
169
170 $line =~ s/\s*\n?$//g;
171 $line =~ s/^\s*//g;
172 $line =~ s/\s+/ /g;
173
174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
176
177 my @words = split(" ", $line);
178 foreach my $word (@words) {
179 last if ($word =~ m/^#/);
180 push (@conf_args, $word);
181 }
182 }
183 close($conffile);
184 unshift(@ARGV, @conf_args) if @conf_args;
185}
186
187# Perl's Getopt::Long allows options to take optional arguments after a space.
188# Prevent --color by itself from consuming other arguments
189foreach (@ARGV) {
190 if ($_ eq "--color" || $_ eq "-color") {
191 $_ = "--color=$color";
192 }
193}
194
195GetOptions(
196 'q|quiet+' => \$quiet,
197 'tree!' => \$tree,
198 'signoff!' => \$chk_signoff,
199 'patch!' => \$chk_patch,
200 'emacs!' => \$emacs,
201 'terse!' => \$terse,
202 'showfile!' => \$showfile,
203 'f|file!' => \$file,
204 'g|git!' => \$git,
205 'subjective!' => \$check,
206 'strict!' => \$check,
207 'ignore=s' => \@ignore,
208 'types=s' => \@use,
209 'show-types!' => \$show_types,
210 'list-types!' => \$list_types,
211 'max-line-length=i' => \$max_line_length,
212 'min-conf-desc-length=i' => \$min_conf_desc_length,
213 'root=s' => \$root,
214 'summary!' => \$summary,
215 'mailback!' => \$mailback,
216 'summary-file!' => \$summary_file,
217 'fix!' => \$fix,
218 'fix-inplace!' => \$fix_inplace,
219 'ignore-perl-version!' => \$ignore_perl_version,
220 'debug=s' => \%debug,
221 'test-only=s' => \$tst_only,
222 'codespell!' => \$codespell,
223 'codespellfile=s' => \$codespellfile,
224 'typedefsfile=s' => \$typedefsfile,
225 'color=s' => \$color,
226 'no-color' => \$color, #keep old behaviors of -nocolor
227 'nocolor' => \$color, #keep old behaviors of -nocolor
228 'h|help' => \$help,
229 'version' => \$help
230) or help(1);
231
232help(0) if ($help);
233
234list_types(0) if ($list_types);
235
236$fix = 1 if ($fix_inplace);
237$check_orig = $check;
238
239my $exit = 0;
240
241if ($^V && $^V lt $minimum_perl_version) {
242 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
243 if (!$ignore_perl_version) {
244 exit(1);
245 }
246}
247
248#if no filenames are given, push '-' to read patch from stdin
249if ($#ARGV < 0) {
250 push(@ARGV, '-');
251}
252
253if ($color =~ /^[01]$/) {
254 $color = !$color;
255} elsif ($color =~ /^always$/i) {
256 $color = 1;
257} elsif ($color =~ /^never$/i) {
258 $color = 0;
259} elsif ($color =~ /^auto$/i) {
260 $color = (-t STDOUT);
261} else {
262 die "Invalid color mode: $color\n";
263}
264
265sub hash_save_array_words {
266 my ($hashRef, $arrayRef) = @_;
267
268 my @array = split(/,/, join(',', @$arrayRef));
269 foreach my $word (@array) {
270 $word =~ s/\s*\n?$//g;
271 $word =~ s/^\s*//g;
272 $word =~ s/\s+/ /g;
273 $word =~ tr/[a-z]/[A-Z]/;
274
275 next if ($word =~ m/^\s*#/);
276 next if ($word =~ m/^\s*$/);
277
278 $hashRef->{$word}++;
279 }
280}
281
282sub hash_show_words {
283 my ($hashRef, $prefix) = @_;
284
285 if (keys %$hashRef) {
286 print "\nNOTE: $prefix message types:";
287 foreach my $word (sort keys %$hashRef) {
288 print " $word";
289 }
290 print "\n";
291 }
292}
293
294hash_save_array_words(\%ignore_type, \@ignore);
295hash_save_array_words(\%use_type, \@use);
296
297my $dbg_values = 0;
298my $dbg_possible = 0;
299my $dbg_type = 0;
300my $dbg_attr = 0;
301for my $key (keys %debug) {
302 ## no critic
303 eval "\${dbg_$key} = '$debug{$key}';";
304 die "$@" if ($@);
305}
306
307my $rpt_cleaners = 0;
308
309if ($terse) {
310 $emacs = 1;
311 $quiet++;
312}
313
314if ($tree) {
315 if (defined $root) {
316 if (!top_of_kernel_tree($root)) {
317 die "$P: $root: --root does not point at a valid tree\n";
318 }
319 } else {
320 if (top_of_kernel_tree('.')) {
321 $root = '.';
322 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
323 top_of_kernel_tree($1)) {
324 $root = $1;
325 }
326 }
327
328 if (!defined $root) {
329 print "Must be run from the top-level dir. of a kernel tree\n";
330 exit(2);
331 }
332}
333
334my $emitted_corrupt = 0;
335
336our $Ident = qr{
337 [A-Za-z_][A-Za-z\d_]*
338 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
339 }x;
340our $Storage = qr{extern|static|asmlinkage};
341our $Sparse = qr{
342 __user|
343 __kernel|
344 __force|
345 __iomem|
346 __must_check|
347 __init_refok|
348 __kprobes|
349 __ref|
350 __rcu|
351 __private
352 }x;
353our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
354our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
355our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
356our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
357our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
358
359# Notes to $Attribute:
360# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
361our $Attribute = qr{
362 const|
363 __percpu|
364 __nocast|
365 __safe|
366 __bitwise|
367 __packed__|
368 __packed2__|
369 __naked|
370 __maybe_unused|
371 __always_unused|
372 __noreturn|
373 __used|
374 __cold|
375 __pure|
376 __noclone|
377 __deprecated|
378 __read_mostly|
379 __kprobes|
380 $InitAttribute|
381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
383 ____cacheline_internodealigned_in_smp|
384 __weak
385 }x;
386our $Modifier;
387our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
388our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
389our $Lval = qr{$Ident(?:$Member)*};
390
391our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
392our $Binary = qr{(?i)0b[01]+$Int_type?};
393our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
394our $Int = qr{[0-9]+$Int_type?};
395our $Octal = qr{0[0-7]+$Int_type?};
396our $String = qr{"[X\t]*"};
397our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
398our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
399our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
400our $Float = qr{$Float_hex|$Float_dec|$Float_int};
401our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
402our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
403our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
404our $Arithmetic = qr{\+|-|\*|\/|%};
405our $Operators = qr{
406 <=|>=|==|!=|
407 =>|->|<<|>>|<|>|!|~|
408 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
409 }x;
410
411our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
412
413our $BasicType;
414our $NonptrType;
415our $NonptrTypeMisordered;
416our $NonptrTypeWithAttr;
417our $Type;
418our $TypeMisordered;
419our $Declare;
420our $DeclareMisordered;
421
422our $NON_ASCII_UTF8 = qr{
423 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
424 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
425 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
426 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
427 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
428 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
429 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
430}x;
431
432our $UTF8 = qr{
433 [\x09\x0A\x0D\x20-\x7E] # ASCII
434 | $NON_ASCII_UTF8
435}x;
436
437our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
438our $typeOtherOSTypedefs = qr{(?x:
439 u_(?:char|short|int|long) | # bsd
440 u(?:nchar|short|int|long) # sysv
441)};
442our $typeKernelTypedefs = qr{(?x:
443 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
444 atomic_t
445)};
446our $typeTypedefs = qr{(?x:
447 $typeC99Typedefs\b|
448 $typeOtherOSTypedefs\b|
449 $typeKernelTypedefs\b
450)};
451
452our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
453
454our $logFunctions = qr{(?x:
455 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
456 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
457 TP_printk|
458 WARN(?:_RATELIMIT|_ONCE|)|
459 panic|
460 MODULE_[A-Z_]+|
461 seq_vprintf|seq_printf|seq_puts
462)};
463
464our $signature_tags = qr{(?xi:
465 Signed-off-by:|
466 Acked-by:|
467 Tested-by:|
468 Reviewed-by:|
469 Reported-by:|
470 Suggested-by:|
471 To:|
472 Cc:
473)};
474
475our @typeListMisordered = (
476 qr{char\s+(?:un)?signed},
477 qr{int\s+(?:(?:un)?signed\s+)?short\s},
478 qr{int\s+short(?:\s+(?:un)?signed)},
479 qr{short\s+int(?:\s+(?:un)?signed)},
480 qr{(?:un)?signed\s+int\s+short},
481 qr{short\s+(?:un)?signed},
482 qr{long\s+int\s+(?:un)?signed},
483 qr{int\s+long\s+(?:un)?signed},
484 qr{long\s+(?:un)?signed\s+int},
485 qr{int\s+(?:un)?signed\s+long},
486 qr{int\s+(?:un)?signed},
487 qr{int\s+long\s+long\s+(?:un)?signed},
488 qr{long\s+long\s+int\s+(?:un)?signed},
489 qr{long\s+long\s+(?:un)?signed\s+int},
490 qr{long\s+long\s+(?:un)?signed},
491 qr{long\s+(?:un)?signed},
492);
493
494our @typeList = (
495 qr{void},
496 qr{(?:(?:un)?signed\s+)?char},
497 qr{(?:(?:un)?signed\s+)?short\s+int},
498 qr{(?:(?:un)?signed\s+)?short},
499 qr{(?:(?:un)?signed\s+)?int},
500 qr{(?:(?:un)?signed\s+)?long\s+int},
501 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
502 qr{(?:(?:un)?signed\s+)?long\s+long},
503 qr{(?:(?:un)?signed\s+)?long},
504 qr{(?:un)?signed},
505 qr{float},
506 qr{double},
507 qr{bool},
508 qr{struct\s+$Ident},
509 qr{union\s+$Ident},
510 qr{enum\s+$Ident},
511 qr{${Ident}_t},
512 qr{${Ident}_handler},
513 qr{${Ident}_handler_fn},
514 @typeListMisordered,
515);
516
517our $C90_int_types = qr{(?x:
518 long\s+long\s+int\s+(?:un)?signed|
519 long\s+long\s+(?:un)?signed\s+int|
520 long\s+long\s+(?:un)?signed|
521 (?:(?:un)?signed\s+)?long\s+long\s+int|
522 (?:(?:un)?signed\s+)?long\s+long|
523 int\s+long\s+long\s+(?:un)?signed|
524 int\s+(?:(?:un)?signed\s+)?long\s+long|
525
526 long\s+int\s+(?:un)?signed|
527 long\s+(?:un)?signed\s+int|
528 long\s+(?:un)?signed|
529 (?:(?:un)?signed\s+)?long\s+int|
530 (?:(?:un)?signed\s+)?long|
531 int\s+long\s+(?:un)?signed|
532 int\s+(?:(?:un)?signed\s+)?long|
533
534 int\s+(?:un)?signed|
535 (?:(?:un)?signed\s+)?int
536)};
537
538our @typeListFile = ();
539our @typeListWithAttr = (
540 @typeList,
541 qr{struct\s+$InitAttribute\s+$Ident},
542 qr{union\s+$InitAttribute\s+$Ident},
543);
544
545our @modifierList = (
546 qr{fastcall},
547);
548our @modifierListFile = ();
549
550our @mode_permission_funcs = (
551 ["module_param", 3],
552 ["module_param_(?:array|named|string)", 4],
553 ["module_param_array_named", 5],
554 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
555 ["proc_create(?:_data|)", 2],
556 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
557 ["IIO_DEV_ATTR_[A-Z_]+", 1],
558 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
559 ["SENSOR_TEMPLATE(?:_2|)", 3],
560 ["__ATTR", 2],
561);
562
563#Create a search pattern for all these functions to speed up a loop below
564our $mode_perms_search = "";
565foreach my $entry (@mode_permission_funcs) {
566 $mode_perms_search .= '|' if ($mode_perms_search ne "");
567 $mode_perms_search .= $entry->[0];
568}
569$mode_perms_search = "(?:${mode_perms_search})";
570
571our $mode_perms_world_writable = qr{
572 S_IWUGO |
573 S_IWOTH |
574 S_IRWXUGO |
575 S_IALLUGO |
576 0[0-7][0-7][2367]
577}x;
578
579our %mode_permission_string_types = (
580 "S_IRWXU" => 0700,
581 "S_IRUSR" => 0400,
582 "S_IWUSR" => 0200,
583 "S_IXUSR" => 0100,
584 "S_IRWXG" => 0070,
585 "S_IRGRP" => 0040,
586 "S_IWGRP" => 0020,
587 "S_IXGRP" => 0010,
588 "S_IRWXO" => 0007,
589 "S_IROTH" => 0004,
590 "S_IWOTH" => 0002,
591 "S_IXOTH" => 0001,
592 "S_IRWXUGO" => 0777,
593 "S_IRUGO" => 0444,
594 "S_IWUGO" => 0222,
595 "S_IXUGO" => 0111,
596);
597
598#Create a search pattern for all these strings to speed up a loop below
599our $mode_perms_string_search = "";
600foreach my $entry (keys %mode_permission_string_types) {
601 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
602 $mode_perms_string_search .= $entry;
603}
604our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
605our $multi_mode_perms_string_search = qr{
606 ${single_mode_perms_string_search}
607 (?:\s*\|\s*${single_mode_perms_string_search})*
608}x;
609
610sub perms_to_octal {
611 my ($string) = @_;
612
613 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
614
615 my $val = "";
616 my $oval = "";
617 my $to = 0;
618 my $curpos = 0;
619 my $lastpos = 0;
620 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
621 $curpos = pos($string);
622 my $match = $2;
623 my $omatch = $1;
624 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
625 $lastpos = $curpos;
626 $to |= $mode_permission_string_types{$match};
627 $val .= '\s*\|\s*' if ($val ne "");
628 $val .= $match;
629 $oval .= $omatch;
630 }
631 $oval =~ s/^\s*\|\s*//;
632 $oval =~ s/\s*\|\s*$//;
633 return sprintf("%04o", $to);
634}
635
636our $allowed_asm_includes = qr{(?x:
637 irq|
638 memory|
639 time|
640 reboot
641)};
642# memory.h: ARM has a custom one
643
644# Load common spelling mistakes and build regular expression list.
645my $misspellings;
646my %spelling_fix;
647
648if (open(my $spelling, '<', $spelling_file)) {
649 while (<$spelling>) {
650 my $line = $_;
651
652 $line =~ s/\s*\n?$//g;
653 $line =~ s/^\s*//g;
654
655 next if ($line =~ m/^\s*#/);
656 next if ($line =~ m/^\s*$/);
657
658 my ($suspect, $fix) = split(/\|\|/, $line);
659
660 $spelling_fix{$suspect} = $fix;
661 }
662 close($spelling);
663} else {
664 warn "No typos will be found - file '$spelling_file': $!\n";
665}
666
667if ($codespell) {
668 if (open(my $spelling, '<', $codespellfile)) {
669 while (<$spelling>) {
670 my $line = $_;
671
672 $line =~ s/\s*\n?$//g;
673 $line =~ s/^\s*//g;
674
675 next if ($line =~ m/^\s*#/);
676 next if ($line =~ m/^\s*$/);
677 next if ($line =~ m/, disabled/i);
678
679 $line =~ s/,.*$//;
680
681 my ($suspect, $fix) = split(/->/, $line);
682
683 $spelling_fix{$suspect} = $fix;
684 }
685 close($spelling);
686 } else {
687 warn "No codespell typos will be found - file '$codespellfile': $!\n";
688 }
689}
690
691$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
692
693sub read_words {
694 my ($wordsRef, $file) = @_;
695
696 if (open(my $words, '<', $file)) {
697 while (<$words>) {
698 my $line = $_;
699
700 $line =~ s/\s*\n?$//g;
701 $line =~ s/^\s*//g;
702
703 next if ($line =~ m/^\s*#/);
704 next if ($line =~ m/^\s*$/);
705 if ($line =~ /\s/) {
706 print("$file: '$line' invalid - ignored\n");
707 next;
708 }
709
710 $$wordsRef .= '|' if ($$wordsRef ne "");
711 $$wordsRef .= $line;
712 }
713 close($file);
714 return 1;
715 }
716
717 return 0;
718}
719
720my $const_structs = "";
721read_words(\$const_structs, $conststructsfile)
722 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
723
724my $typeOtherTypedefs = "";
725if (length($typedefsfile)) {
726 read_words(\$typeOtherTypedefs, $typedefsfile)
727 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
728}
729$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
730
731sub build_types {
732 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
733 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
734 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
735 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
736 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
737 $BasicType = qr{
738 (?:$typeTypedefs\b)|
739 (?:${all}\b)
740 }x;
741 $NonptrType = qr{
742 (?:$Modifier\s+|const\s+)*
743 (?:
744 (?:typeof|__typeof__)\s*\([^\)]*\)|
745 (?:$typeTypedefs\b)|
746 (?:${all}\b)
747 )
748 (?:\s+$Modifier|\s+const)*
749 }x;
750 $NonptrTypeMisordered = qr{
751 (?:$Modifier\s+|const\s+)*
752 (?:
753 (?:${Misordered}\b)
754 )
755 (?:\s+$Modifier|\s+const)*
756 }x;
757 $NonptrTypeWithAttr = qr{
758 (?:$Modifier\s+|const\s+)*
759 (?:
760 (?:typeof|__typeof__)\s*\([^\)]*\)|
761 (?:$typeTypedefs\b)|
762 (?:${allWithAttr}\b)
763 )
764 (?:\s+$Modifier|\s+const)*
765 }x;
766 $Type = qr{
767 $NonptrType
768 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
769 (?:\s+$Inline|\s+$Modifier)*
770 }x;
771 $TypeMisordered = qr{
772 $NonptrTypeMisordered
773 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
774 (?:\s+$Inline|\s+$Modifier)*
775 }x;
776 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
777 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
778}
779build_types();
780
781our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
782
783# Using $balanced_parens, $LvalOrFunc, or $FuncArg
784# requires at least perl version v5.10.0
785# Any use must be runtime checked with $^V
786
787our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
788our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
789our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
790
791our $declaration_macros = qr{(?x:
792 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
793 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
794 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
795 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
796)};
797
798sub deparenthesize {
799 my ($string) = @_;
800 return "" if (!defined($string));
801
802 while ($string =~ /^\s*\(.*\)\s*$/) {
803 $string =~ s@^\s*\(\s*@@;
804 $string =~ s@\s*\)\s*$@@;
805 }
806
807 $string =~ s@\s+@ @g;
808
809 return $string;
810}
811
812sub seed_camelcase_file {
813 my ($file) = @_;
814
815 return if (!(-f $file));
816
817 local $/;
818
819 open(my $include_file, '<', "$file")
820 or warn "$P: Can't read '$file' $!\n";
821 my $text = <$include_file>;
822 close($include_file);
823
824 my @lines = split('\n', $text);
825
826 foreach my $line (@lines) {
827 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
828 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
829 $camelcase{$1} = 1;
830 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
831 $camelcase{$1} = 1;
832 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
833 $camelcase{$1} = 1;
834 }
835 }
836}
837
838sub is_maintained_obsolete {
839 my ($filename) = @_;
840
841 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
842
843 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
844
845 return $status =~ /obsolete/i;
846}
847
848my $camelcase_seeded = 0;
849sub seed_camelcase_includes {
850 return if ($camelcase_seeded);
851
852 my $files;
853 my $camelcase_cache = "";
854 my @include_files = ();
855
856 $camelcase_seeded = 1;
857
858 if (-e ".git") {
859 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
860 chomp $git_last_include_commit;
861 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
862 } else {
863 my $last_mod_date = 0;
864 $files = `find $root/include -name "*.h"`;
865 @include_files = split('\n', $files);
866 foreach my $file (@include_files) {
867 my $date = POSIX::strftime("%Y%m%d%H%M",
868 localtime((stat $file)[9]));
869 $last_mod_date = $date if ($last_mod_date < $date);
870 }
871 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
872 }
873
874 if ($camelcase_cache ne "" && -f $camelcase_cache) {
875 open(my $camelcase_file, '<', "$camelcase_cache")
876 or warn "$P: Can't read '$camelcase_cache' $!\n";
877 while (<$camelcase_file>) {
878 chomp;
879 $camelcase{$_} = 1;
880 }
881 close($camelcase_file);
882
883 return;
884 }
885
886 if (-e ".git") {
887 $files = `git ls-files "include/*.h"`;
888 @include_files = split('\n', $files);
889 }
890
891 foreach my $file (@include_files) {
892 seed_camelcase_file($file);
893 }
894
895 if ($camelcase_cache ne "") {
896 unlink glob ".checkpatch-camelcase.*";
897 open(my $camelcase_file, '>', "$camelcase_cache")
898 or warn "$P: Can't write '$camelcase_cache' $!\n";
899 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
900 print $camelcase_file ("$_\n");
901 }
902 close($camelcase_file);
903 }
904}
905
906sub git_commit_info {
907 my ($commit, $id, $desc) = @_;
908
909 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
910
911 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
912 $output =~ s/^\s*//gm;
913 my @lines = split("\n", $output);
914
915 return ($id, $desc) if ($#lines < 0);
916
917 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
918# Maybe one day convert this block of bash into something that returns
919# all matching commit ids, but it's very slow...
920#
921# echo "checking commits $1..."
922# git rev-list --remotes | grep -i "^$1" |
923# while read line ; do
924# git log --format='%H %s' -1 $line |
925# echo "commit $(cut -c 1-12,41-)"
926# done
927 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
928 $id = undef;
929 } else {
930 $id = substr($lines[0], 0, 12);
931 $desc = substr($lines[0], 41);
932 }
933
934 return ($id, $desc);
935}
936
937$chk_signoff = 0 if ($file);
938
939my @rawlines = ();
940my @lines = ();
941my @fixed = ();
942my @fixed_inserted = ();
943my @fixed_deleted = ();
944my $fixlinenr = -1;
945
946# If input is git commits, extract all commits from the commit expressions.
947# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
948die "$P: No git repository found\n" if ($git && !-e ".git");
949
950if ($git) {
951 my @commits = ();
952 foreach my $commit_expr (@ARGV) {
953 my $git_range;
954 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
955 $git_range = "-$2 $1";
956 } elsif ($commit_expr =~ m/\.\./) {
957 $git_range = "$commit_expr";
958 } else {
959 $git_range = "-1 $commit_expr";
960 }
961 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
962 foreach my $line (split(/\n/, $lines)) {
963 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
964 next if (!defined($1) || !defined($2));
965 my $sha1 = $1;
966 my $subject = $2;
967 unshift(@commits, $sha1);
968 $git_commits{$sha1} = $subject;
969 }
970 }
971 die "$P: no git commits after extraction!\n" if (@commits == 0);
972 @ARGV = @commits;
973}
974
975my $vname;
976for my $filename (@ARGV) {
977 my $FILE;
978 if ($git) {
979 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
980 die "$P: $filename: git format-patch failed - $!\n";
981 } elsif ($file) {
982 open($FILE, '-|', "diff -u /dev/null $filename") ||
983 die "$P: $filename: diff failed - $!\n";
984 } elsif ($filename eq '-') {
985 open($FILE, '<&STDIN');
986 } else {
987 open($FILE, '<', "$filename") ||
988 die "$P: $filename: open failed - $!\n";
989 }
990 if ($filename eq '-') {
991 $vname = 'Your patch';
992 } elsif ($git) {
993 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
994 } else {
995 $vname = $filename;
996 }
997 while (<$FILE>) {
998 chomp;
999 push(@rawlines, $_);
1000 }
1001 close($FILE);
1002
1003 if ($#ARGV > 0 && $quiet == 0) {
1004 print '-' x length($vname) . "\n";
1005 print "$vname\n";
1006 print '-' x length($vname) . "\n";
1007 }
1008
1009 if (!process($filename)) {
1010 $exit = 1;
1011 }
1012 @rawlines = ();
1013 @lines = ();
1014 @fixed = ();
1015 @fixed_inserted = ();
1016 @fixed_deleted = ();
1017 $fixlinenr = -1;
1018 @modifierListFile = ();
1019 @typeListFile = ();
1020 build_types();
1021}
1022
1023if (!$quiet) {
1024 hash_show_words(\%use_type, "Used");
1025 hash_show_words(\%ignore_type, "Ignored");
1026
1027 if ($^V lt 5.10.0) {
1028 print << "EOM"
1029
1030NOTE: perl $^V is not modern enough to detect all possible issues.
1031 An upgrade to at least perl v5.10.0 is suggested.
1032EOM
1033 }
1034 if ($exit) {
1035 print << "EOM"
1036
1037NOTE: If any of the errors are false positives, please report
1038 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1039EOM
1040 }
1041}
1042
1043exit($exit);
1044
1045sub top_of_kernel_tree {
1046 my ($root) = @_;
1047
1048 my @tree_check = (
1049 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1050 "README", "Documentation", "arch", "include", "drivers",
1051 "fs", "init", "ipc", "kernel", "lib", "scripts",
1052 );
1053
1054 foreach my $check (@tree_check) {
1055 if (! -e $root . '/' . $check) {
1056 return 0;
1057 }
1058 }
1059 return 1;
1060}
1061
1062sub parse_email {
1063 my ($formatted_email) = @_;
1064
1065 my $name = "";
1066 my $address = "";
1067 my $comment = "";
1068
1069 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1070 $name = $1;
1071 $address = $2;
1072 $comment = $3 if defined $3;
1073 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1074 $address = $1;
1075 $comment = $2 if defined $2;
1076 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1077 $address = $1;
1078 $comment = $2 if defined $2;
1079 $formatted_email =~ s/\Q$address\E.*$//;
1080 $name = $formatted_email;
1081 $name = trim($name);
1082 $name =~ s/^\"|\"$//g;
1083 # If there's a name left after stripping spaces and
1084 # leading quotes, and the address doesn't have both
1085 # leading and trailing angle brackets, the address
1086 # is invalid. ie:
1087 # "joe smith joe@smith.com" bad
1088 # "joe smith <joe@smith.com" bad
1089 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1090 $name = "";
1091 $address = "";
1092 $comment = "";
1093 }
1094 }
1095
1096 $name = trim($name);
1097 $name =~ s/^\"|\"$//g;
1098 $address = trim($address);
1099 $address =~ s/^\<|\>$//g;
1100
1101 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1102 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1103 $name = "\"$name\"";
1104 }
1105
1106 return ($name, $address, $comment);
1107}
1108
1109sub format_email {
1110 my ($name, $address) = @_;
1111
1112 my $formatted_email;
1113
1114 $name = trim($name);
1115 $name =~ s/^\"|\"$//g;
1116 $address = trim($address);
1117
1118 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1119 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1120 $name = "\"$name\"";
1121 }
1122
1123 if ("$name" eq "") {
1124 $formatted_email = "$address";
1125 } else {
1126 $formatted_email = "$name <$address>";
1127 }
1128
1129 return $formatted_email;
1130}
1131
1132sub which {
1133 my ($bin) = @_;
1134
1135 foreach my $path (split(/:/, $ENV{PATH})) {
1136 if (-e "$path/$bin") {
1137 return "$path/$bin";
1138 }
1139 }
1140
1141 return "";
1142}
1143
1144sub which_conf {
1145 my ($conf) = @_;
1146
1147 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1148 if (-e "$path/$conf") {
1149 return "$path/$conf";
1150 }
1151 }
1152
1153 return "";
1154}
1155
1156sub expand_tabs {
1157 my ($str) = @_;
1158
1159 my $res = '';
1160 my $n = 0;
1161 for my $c (split(//, $str)) {
1162 if ($c eq "\t") {
1163 $res .= ' ';
1164 $n++;
1165 for (; ($n % 8) != 0; $n++) {
1166 $res .= ' ';
1167 }
1168 next;
1169 }
1170 $res .= $c;
1171 $n++;
1172 }
1173
1174 return $res;
1175}
1176sub copy_spacing {
1177 (my $res = shift) =~ tr/\t/ /c;
1178 return $res;
1179}
1180
1181sub line_stats {
1182 my ($line) = @_;
1183
1184 # Drop the diff line leader and expand tabs
1185 $line =~ s/^.//;
1186 $line = expand_tabs($line);
1187
1188 # Pick the indent from the front of the line.
1189 my ($white) = ($line =~ /^(\s*)/);
1190
1191 return (length($line), length($white));
1192}
1193
1194my $sanitise_quote = '';
1195
1196sub sanitise_line_reset {
1197 my ($in_comment) = @_;
1198
1199 if ($in_comment) {
1200 $sanitise_quote = '*/';
1201 } else {
1202 $sanitise_quote = '';
1203 }
1204}
1205sub sanitise_line {
1206 my ($line) = @_;
1207
1208 my $res = '';
1209 my $l = '';
1210
1211 my $qlen = 0;
1212 my $off = 0;
1213 my $c;
1214
1215 # Always copy over the diff marker.
1216 $res = substr($line, 0, 1);
1217
1218 for ($off = 1; $off < length($line); $off++) {
1219 $c = substr($line, $off, 1);
1220
1221 # Comments we are whacking completely including the begin
1222 # and end, all to $;.
1223 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1224 $sanitise_quote = '*/';
1225
1226 substr($res, $off, 2, "$;$;");
1227 $off++;
1228 next;
1229 }
1230 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1231 $sanitise_quote = '';
1232 substr($res, $off, 2, "$;$;");
1233 $off++;
1234 next;
1235 }
1236 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1237 $sanitise_quote = '//';
1238
1239 substr($res, $off, 2, $sanitise_quote);
1240 $off++;
1241 next;
1242 }
1243
1244 # A \ in a string means ignore the next character.
1245 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1246 $c eq "\\") {
1247 substr($res, $off, 2, 'XX');
1248 $off++;
1249 next;
1250 }
1251 # Regular quotes.
1252 if ($c eq "'" || $c eq '"') {
1253 if ($sanitise_quote eq '') {
1254 $sanitise_quote = $c;
1255
1256 substr($res, $off, 1, $c);
1257 next;
1258 } elsif ($sanitise_quote eq $c) {
1259 $sanitise_quote = '';
1260 }
1261 }
1262
1263 #print "c<$c> SQ<$sanitise_quote>\n";
1264 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1265 substr($res, $off, 1, $;);
1266 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1267 substr($res, $off, 1, $;);
1268 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1269 substr($res, $off, 1, 'X');
1270 } else {
1271 substr($res, $off, 1, $c);
1272 }
1273 }
1274
1275 if ($sanitise_quote eq '//') {
1276 $sanitise_quote = '';
1277 }
1278
1279 # The pathname on a #include may be surrounded by '<' and '>'.
1280 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1281 my $clean = 'X' x length($1);
1282 $res =~ s@\<.*\>@<$clean>@;
1283
1284 # The whole of a #error is a string.
1285 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1286 my $clean = 'X' x length($1);
1287 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1288 }
1289
1290 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1291 my $match = $1;
1292 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1293 }
1294
1295 return $res;
1296}
1297
1298sub get_quoted_string {
1299 my ($line, $rawline) = @_;
1300
1301 return "" if (!defined($line) || !defined($rawline));
1302 return "" if ($line !~ m/($String)/g);
1303 return substr($rawline, $-[0], $+[0] - $-[0]);
1304}
1305
1306sub ctx_statement_block {
1307 my ($linenr, $remain, $off) = @_;
1308 my $line = $linenr - 1;
1309 my $blk = '';
1310 my $soff = $off;
1311 my $coff = $off - 1;
1312 my $coff_set = 0;
1313
1314 my $loff = 0;
1315
1316 my $type = '';
1317 my $level = 0;
1318 my @stack = ();
1319 my $p;
1320 my $c;
1321 my $len = 0;
1322
1323 my $remainder;
1324 while (1) {
1325 @stack = (['', 0]) if ($#stack == -1);
1326
1327 #warn "CSB: blk<$blk> remain<$remain>\n";
1328 # If we are about to drop off the end, pull in more
1329 # context.
1330 if ($off >= $len) {
1331 for (; $remain > 0; $line++) {
1332 last if (!defined $lines[$line]);
1333 next if ($lines[$line] =~ /^-/);
1334 $remain--;
1335 $loff = $len;
1336 $blk .= $lines[$line] . "\n";
1337 $len = length($blk);
1338 $line++;
1339 last;
1340 }
1341 # Bail if there is no further context.
1342 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1343 if ($off >= $len) {
1344 last;
1345 }
1346 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1347 $level++;
1348 $type = '#';
1349 }
1350 }
1351 $p = $c;
1352 $c = substr($blk, $off, 1);
1353 $remainder = substr($blk, $off);
1354
1355 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1356
1357 # Handle nested #if/#else.
1358 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1359 push(@stack, [ $type, $level ]);
1360 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1361 ($type, $level) = @{$stack[$#stack - 1]};
1362 } elsif ($remainder =~ /^#\s*endif\b/) {
1363 ($type, $level) = @{pop(@stack)};
1364 }
1365
1366 # Statement ends at the ';' or a close '}' at the
1367 # outermost level.
1368 if ($level == 0 && $c eq ';') {
1369 last;
1370 }
1371
1372 # An else is really a conditional as long as its not else if
1373 if ($level == 0 && $coff_set == 0 &&
1374 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1375 $remainder =~ /^(else)(?:\s|{)/ &&
1376 $remainder !~ /^else\s+if\b/) {
1377 $coff = $off + length($1) - 1;
1378 $coff_set = 1;
1379 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1380 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1381 }
1382
1383 if (($type eq '' || $type eq '(') && $c eq '(') {
1384 $level++;
1385 $type = '(';
1386 }
1387 if ($type eq '(' && $c eq ')') {
1388 $level--;
1389 $type = ($level != 0)? '(' : '';
1390
1391 if ($level == 0 && $coff < $soff) {
1392 $coff = $off;
1393 $coff_set = 1;
1394 #warn "CSB: mark coff<$coff>\n";
1395 }
1396 }
1397 if (($type eq '' || $type eq '{') && $c eq '{') {
1398 $level++;
1399 $type = '{';
1400 }
1401 if ($type eq '{' && $c eq '}') {
1402 $level--;
1403 $type = ($level != 0)? '{' : '';
1404
1405 if ($level == 0) {
1406 if (substr($blk, $off + 1, 1) eq ';') {
1407 $off++;
1408 }
1409 last;
1410 }
1411 }
1412 # Preprocessor commands end at the newline unless escaped.
1413 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1414 $level--;
1415 $type = '';
1416 $off++;
1417 last;
1418 }
1419 $off++;
1420 }
1421 # We are truly at the end, so shuffle to the next line.
1422 if ($off == $len) {
1423 $loff = $len + 1;
1424 $line++;
1425 $remain--;
1426 }
1427
1428 my $statement = substr($blk, $soff, $off - $soff + 1);
1429 my $condition = substr($blk, $soff, $coff - $soff + 1);
1430
1431 #warn "STATEMENT<$statement>\n";
1432 #warn "CONDITION<$condition>\n";
1433
1434 #print "coff<$coff> soff<$off> loff<$loff>\n";
1435
1436 return ($statement, $condition,
1437 $line, $remain + 1, $off - $loff + 1, $level);
1438}
1439
1440sub statement_lines {
1441 my ($stmt) = @_;
1442
1443 # Strip the diff line prefixes and rip blank lines at start and end.
1444 $stmt =~ s/(^|\n)./$1/g;
1445 $stmt =~ s/^\s*//;
1446 $stmt =~ s/\s*$//;
1447
1448 my @stmt_lines = ($stmt =~ /\n/g);
1449
1450 return $#stmt_lines + 2;
1451}
1452
1453sub statement_rawlines {
1454 my ($stmt) = @_;
1455
1456 my @stmt_lines = ($stmt =~ /\n/g);
1457
1458 return $#stmt_lines + 2;
1459}
1460
1461sub statement_block_size {
1462 my ($stmt) = @_;
1463
1464 $stmt =~ s/(^|\n)./$1/g;
1465 $stmt =~ s/^\s*{//;
1466 $stmt =~ s/}\s*$//;
1467 $stmt =~ s/^\s*//;
1468 $stmt =~ s/\s*$//;
1469
1470 my @stmt_lines = ($stmt =~ /\n/g);
1471 my @stmt_statements = ($stmt =~ /;/g);
1472
1473 my $stmt_lines = $#stmt_lines + 2;
1474 my $stmt_statements = $#stmt_statements + 1;
1475
1476 if ($stmt_lines > $stmt_statements) {
1477 return $stmt_lines;
1478 } else {
1479 return $stmt_statements;
1480 }
1481}
1482
1483sub ctx_statement_full {
1484 my ($linenr, $remain, $off) = @_;
1485 my ($statement, $condition, $level);
1486
1487 my (@chunks);
1488
1489 # Grab the first conditional/block pair.
1490 ($statement, $condition, $linenr, $remain, $off, $level) =
1491 ctx_statement_block($linenr, $remain, $off);
1492 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1493 push(@chunks, [ $condition, $statement ]);
1494 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1495 return ($level, $linenr, @chunks);
1496 }
1497
1498 # Pull in the following conditional/block pairs and see if they
1499 # could continue the statement.
1500 for (;;) {
1501 ($statement, $condition, $linenr, $remain, $off, $level) =
1502 ctx_statement_block($linenr, $remain, $off);
1503 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1504 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1505 #print "C: push\n";
1506 push(@chunks, [ $condition, $statement ]);
1507 }
1508
1509 return ($level, $linenr, @chunks);
1510}
1511
1512sub ctx_block_get {
1513 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1514 my $line;
1515 my $start = $linenr - 1;
1516 my $blk = '';
1517 my @o;
1518 my @c;
1519 my @res = ();
1520
1521 my $level = 0;
1522 my @stack = ($level);
1523 for ($line = $start; $remain > 0; $line++) {
1524 next if ($rawlines[$line] =~ /^-/);
1525 $remain--;
1526
1527 $blk .= $rawlines[$line];
1528
1529 # Handle nested #if/#else.
1530 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1531 push(@stack, $level);
1532 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1533 $level = $stack[$#stack - 1];
1534 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1535 $level = pop(@stack);
1536 }
1537
1538 foreach my $c (split(//, $lines[$line])) {
1539 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1540 if ($off > 0) {
1541 $off--;
1542 next;
1543 }
1544
1545 if ($c eq $close && $level > 0) {
1546 $level--;
1547 last if ($level == 0);
1548 } elsif ($c eq $open) {
1549 $level++;
1550 }
1551 }
1552
1553 if (!$outer || $level <= 1) {
1554 push(@res, $rawlines[$line]);
1555 }
1556
1557 last if ($level == 0);
1558 }
1559
1560 return ($level, @res);
1561}
1562sub ctx_block_outer {
1563 my ($linenr, $remain) = @_;
1564
1565 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1566 return @r;
1567}
1568sub ctx_block {
1569 my ($linenr, $remain) = @_;
1570
1571 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1572 return @r;
1573}
1574sub ctx_statement {
1575 my ($linenr, $remain, $off) = @_;
1576
1577 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1578 return @r;
1579}
1580sub ctx_block_level {
1581 my ($linenr, $remain) = @_;
1582
1583 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1584}
1585sub ctx_statement_level {
1586 my ($linenr, $remain, $off) = @_;
1587
1588 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1589}
1590
1591sub ctx_locate_comment {
1592 my ($first_line, $end_line) = @_;
1593
1594 # Catch a comment on the end of the line itself.
1595 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1596 return $current_comment if (defined $current_comment);
1597
1598 # Look through the context and try and figure out if there is a
1599 # comment.
1600 my $in_comment = 0;
1601 $current_comment = '';
1602 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1603 my $line = $rawlines[$linenr - 1];
1604 #warn " $line\n";
1605 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1606 $in_comment = 1;
1607 }
1608 if ($line =~ m@/\*@) {
1609 $in_comment = 1;
1610 }
1611 if (!$in_comment && $current_comment ne '') {
1612 $current_comment = '';
1613 }
1614 $current_comment .= $line . "\n" if ($in_comment);
1615 if ($line =~ m@\*/@) {
1616 $in_comment = 0;
1617 }
1618 }
1619
1620 chomp($current_comment);
1621 return($current_comment);
1622}
1623sub ctx_has_comment {
1624 my ($first_line, $end_line) = @_;
1625 my $cmt = ctx_locate_comment($first_line, $end_line);
1626
1627 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1628 ##print "CMMT: $cmt\n";
1629
1630 return ($cmt ne '');
1631}
1632
1633sub raw_line {
1634 my ($linenr, $cnt) = @_;
1635
1636 my $offset = $linenr - 1;
1637 $cnt++;
1638
1639 my $line;
1640 while ($cnt) {
1641 $line = $rawlines[$offset++];
1642 next if (defined($line) && $line =~ /^-/);
1643 $cnt--;
1644 }
1645
1646 return $line;
1647}
1648
1649sub get_stat_real {
1650 my ($linenr, $lc) = @_;
1651
1652 my $stat_real = raw_line($linenr, 0);
1653 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1654 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1655 }
1656
1657 return $stat_real;
1658}
1659
1660sub get_stat_here {
1661 my ($linenr, $cnt, $here) = @_;
1662
1663 my $herectx = $here . "\n";
1664 for (my $n = 0; $n < $cnt; $n++) {
1665 $herectx .= raw_line($linenr, $n) . "\n";
1666 }
1667
1668 return $herectx;
1669}
1670
1671sub cat_vet {
1672 my ($vet) = @_;
1673 my ($res, $coded);
1674
1675 $res = '';
1676 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1677 $res .= $1;
1678 if ($2 ne '') {
1679 $coded = sprintf("^%c", unpack('C', $2) + 64);
1680 $res .= $coded;
1681 }
1682 }
1683 $res =~ s/$/\$/;
1684
1685 return $res;
1686}
1687
1688my $av_preprocessor = 0;
1689my $av_pending;
1690my @av_paren_type;
1691my $av_pend_colon;
1692
1693sub annotate_reset {
1694 $av_preprocessor = 0;
1695 $av_pending = '_';
1696 @av_paren_type = ('E');
1697 $av_pend_colon = 'O';
1698}
1699
1700sub annotate_values {
1701 my ($stream, $type) = @_;
1702
1703 my $res;
1704 my $var = '_' x length($stream);
1705 my $cur = $stream;
1706
1707 print "$stream\n" if ($dbg_values > 1);
1708
1709 while (length($cur)) {
1710 @av_paren_type = ('E') if ($#av_paren_type < 0);
1711 print " <" . join('', @av_paren_type) .
1712 "> <$type> <$av_pending>" if ($dbg_values > 1);
1713 if ($cur =~ /^(\s+)/o) {
1714 print "WS($1)\n" if ($dbg_values > 1);
1715 if ($1 =~ /\n/ && $av_preprocessor) {
1716 $type = pop(@av_paren_type);
1717 $av_preprocessor = 0;
1718 }
1719
1720 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1721 print "CAST($1)\n" if ($dbg_values > 1);
1722 push(@av_paren_type, $type);
1723 $type = 'c';
1724
1725 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1726 print "DECLARE($1)\n" if ($dbg_values > 1);
1727 $type = 'T';
1728
1729 } elsif ($cur =~ /^($Modifier)\s*/) {
1730 print "MODIFIER($1)\n" if ($dbg_values > 1);
1731 $type = 'T';
1732
1733 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1734 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1735 $av_preprocessor = 1;
1736 push(@av_paren_type, $type);
1737 if ($2 ne '') {
1738 $av_pending = 'N';
1739 }
1740 $type = 'E';
1741
1742 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1743 print "UNDEF($1)\n" if ($dbg_values > 1);
1744 $av_preprocessor = 1;
1745 push(@av_paren_type, $type);
1746
1747 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1748 print "PRE_START($1)\n" if ($dbg_values > 1);
1749 $av_preprocessor = 1;
1750
1751 push(@av_paren_type, $type);
1752 push(@av_paren_type, $type);
1753 $type = 'E';
1754
1755 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1756 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1757 $av_preprocessor = 1;
1758
1759 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1760
1761 $type = 'E';
1762
1763 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1764 print "PRE_END($1)\n" if ($dbg_values > 1);
1765
1766 $av_preprocessor = 1;
1767
1768 # Assume all arms of the conditional end as this
1769 # one does, and continue as if the #endif was not here.
1770 pop(@av_paren_type);
1771 push(@av_paren_type, $type);
1772 $type = 'E';
1773
1774 } elsif ($cur =~ /^(\\\n)/o) {
1775 print "PRECONT($1)\n" if ($dbg_values > 1);
1776
1777 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1778 print "ATTR($1)\n" if ($dbg_values > 1);
1779 $av_pending = $type;
1780 $type = 'N';
1781
1782 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1783 print "SIZEOF($1)\n" if ($dbg_values > 1);
1784 if (defined $2) {
1785 $av_pending = 'V';
1786 }
1787 $type = 'N';
1788
1789 } elsif ($cur =~ /^(if|while|for)\b/o) {
1790 print "COND($1)\n" if ($dbg_values > 1);
1791 $av_pending = 'E';
1792 $type = 'N';
1793
1794 } elsif ($cur =~/^(case)/o) {
1795 print "CASE($1)\n" if ($dbg_values > 1);
1796 $av_pend_colon = 'C';
1797 $type = 'N';
1798
1799 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1800 print "KEYWORD($1)\n" if ($dbg_values > 1);
1801 $type = 'N';
1802
1803 } elsif ($cur =~ /^(\()/o) {
1804 print "PAREN('$1')\n" if ($dbg_values > 1);
1805 push(@av_paren_type, $av_pending);
1806 $av_pending = '_';
1807 $type = 'N';
1808
1809 } elsif ($cur =~ /^(\))/o) {
1810 my $new_type = pop(@av_paren_type);
1811 if ($new_type ne '_') {
1812 $type = $new_type;
1813 print "PAREN('$1') -> $type\n"
1814 if ($dbg_values > 1);
1815 } else {
1816 print "PAREN('$1')\n" if ($dbg_values > 1);
1817 }
1818
1819 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1820 print "FUNC($1)\n" if ($dbg_values > 1);
1821 $type = 'V';
1822 $av_pending = 'V';
1823
1824 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1825 if (defined $2 && $type eq 'C' || $type eq 'T') {
1826 $av_pend_colon = 'B';
1827 } elsif ($type eq 'E') {
1828 $av_pend_colon = 'L';
1829 }
1830 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1831 $type = 'V';
1832
1833 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1834 print "IDENT($1)\n" if ($dbg_values > 1);
1835 $type = 'V';
1836
1837 } elsif ($cur =~ /^($Assignment)/o) {
1838 print "ASSIGN($1)\n" if ($dbg_values > 1);
1839 $type = 'N';
1840
1841 } elsif ($cur =~/^(;|{|})/) {
1842 print "END($1)\n" if ($dbg_values > 1);
1843 $type = 'E';
1844 $av_pend_colon = 'O';
1845
1846 } elsif ($cur =~/^(,)/) {
1847 print "COMMA($1)\n" if ($dbg_values > 1);
1848 $type = 'C';
1849
1850 } elsif ($cur =~ /^(\?)/o) {
1851 print "QUESTION($1)\n" if ($dbg_values > 1);
1852 $type = 'N';
1853
1854 } elsif ($cur =~ /^(:)/o) {
1855 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1856
1857 substr($var, length($res), 1, $av_pend_colon);
1858 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1859 $type = 'E';
1860 } else {
1861 $type = 'N';
1862 }
1863 $av_pend_colon = 'O';
1864
1865 } elsif ($cur =~ /^(\[)/o) {
1866 print "CLOSE($1)\n" if ($dbg_values > 1);
1867 $type = 'N';
1868
1869 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1870 my $variant;
1871
1872 print "OPV($1)\n" if ($dbg_values > 1);
1873 if ($type eq 'V') {
1874 $variant = 'B';
1875 } else {
1876 $variant = 'U';
1877 }
1878
1879 substr($var, length($res), 1, $variant);
1880 $type = 'N';
1881
1882 } elsif ($cur =~ /^($Operators)/o) {
1883 print "OP($1)\n" if ($dbg_values > 1);
1884 if ($1 ne '++' && $1 ne '--') {
1885 $type = 'N';
1886 }
1887
1888 } elsif ($cur =~ /(^.)/o) {
1889 print "C($1)\n" if ($dbg_values > 1);
1890 }
1891 if (defined $1) {
1892 $cur = substr($cur, length($1));
1893 $res .= $type x length($1);
1894 }
1895 }
1896
1897 return ($res, $var);
1898}
1899
1900sub possible {
1901 my ($possible, $line) = @_;
1902 my $notPermitted = qr{(?:
1903 ^(?:
1904 $Modifier|
1905 $Storage|
1906 $Type|
1907 DEFINE_\S+
1908 )$|
1909 ^(?:
1910 goto|
1911 return|
1912 case|
1913 else|
1914 asm|__asm__|
1915 do|
1916 \#|
1917 \#\#|
1918 )(?:\s|$)|
1919 ^(?:typedef|struct|enum)\b
1920 )}x;
1921 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1922 if ($possible !~ $notPermitted) {
1923 # Check for modifiers.
1924 $possible =~ s/\s*$Storage\s*//g;
1925 $possible =~ s/\s*$Sparse\s*//g;
1926 if ($possible =~ /^\s*$/) {
1927
1928 } elsif ($possible =~ /\s/) {
1929 $possible =~ s/\s*$Type\s*//g;
1930 for my $modifier (split(' ', $possible)) {
1931 if ($modifier !~ $notPermitted) {
1932 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1933 push(@modifierListFile, $modifier);
1934 }
1935 }
1936
1937 } else {
1938 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1939 push(@typeListFile, $possible);
1940 }
1941 build_types();
1942 } else {
1943 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1944 }
1945}
1946
1947my $prefix = '';
1948
1949sub show_type {
1950 my ($type) = @_;
1951
1952 $type =~ tr/[a-z]/[A-Z]/;
1953
1954 return defined $use_type{$type} if (scalar keys %use_type > 0);
1955
1956 return !defined $ignore_type{$type};
1957}
1958
1959sub report {
1960 my ($level, $type, $msg) = @_;
1961
1962 if (!show_type($type) ||
1963 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1964 return 0;
1965 }
1966 my $output = '';
1967 if ($color) {
1968 if ($level eq 'ERROR') {
1969 $output .= RED;
1970 } elsif ($level eq 'WARNING') {
1971 $output .= YELLOW;
1972 } else {
1973 $output .= GREEN;
1974 }
1975 }
1976 $output .= $prefix . $level . ':';
1977 if ($show_types) {
1978 $output .= BLUE if ($color);
1979 $output .= "$type:";
1980 }
1981 $output .= RESET if ($color);
1982 $output .= ' ' . $msg . "\n";
1983
1984 if ($showfile) {
1985 my @lines = split("\n", $output, -1);
1986 splice(@lines, 1, 1);
1987 $output = join("\n", @lines);
1988 }
1989 $output = (split('\n', $output))[0] . "\n" if ($terse);
1990
1991 push(our @report, $output);
1992
1993 return 1;
1994}
1995
1996sub report_dump {
1997 our @report;
1998}
1999
2000sub fixup_current_range {
2001 my ($lineRef, $offset, $length) = @_;
2002
2003 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2004 my $o = $1;
2005 my $l = $2;
2006 my $no = $o + $offset;
2007 my $nl = $l + $length;
2008 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2009 }
2010}
2011
2012sub fix_inserted_deleted_lines {
2013 my ($linesRef, $insertedRef, $deletedRef) = @_;
2014
2015 my $range_last_linenr = 0;
2016 my $delta_offset = 0;
2017
2018 my $old_linenr = 0;
2019 my $new_linenr = 0;
2020
2021 my $next_insert = 0;
2022 my $next_delete = 0;
2023
2024 my @lines = ();
2025
2026 my $inserted = @{$insertedRef}[$next_insert++];
2027 my $deleted = @{$deletedRef}[$next_delete++];
2028
2029 foreach my $old_line (@{$linesRef}) {
2030 my $save_line = 1;
2031 my $line = $old_line; #don't modify the array
2032 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2033 $delta_offset = 0;
2034 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2035 $range_last_linenr = $new_linenr;
2036 fixup_current_range(\$line, $delta_offset, 0);
2037 }
2038
2039 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2040 $deleted = @{$deletedRef}[$next_delete++];
2041 $save_line = 0;
2042 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2043 }
2044
2045 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2046 push(@lines, ${$inserted}{'LINE'});
2047 $inserted = @{$insertedRef}[$next_insert++];
2048 $new_linenr++;
2049 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2050 }
2051
2052 if ($save_line) {
2053 push(@lines, $line);
2054 $new_linenr++;
2055 }
2056
2057 $old_linenr++;
2058 }
2059
2060 return @lines;
2061}
2062
2063sub fix_insert_line {
2064 my ($linenr, $line) = @_;
2065
2066 my $inserted = {
2067 LINENR => $linenr,
2068 LINE => $line,
2069 };
2070 push(@fixed_inserted, $inserted);
2071}
2072
2073sub fix_delete_line {
2074 my ($linenr, $line) = @_;
2075
2076 my $deleted = {
2077 LINENR => $linenr,
2078 LINE => $line,
2079 };
2080
2081 push(@fixed_deleted, $deleted);
2082}
2083
2084sub ERROR {
2085 my ($type, $msg) = @_;
2086
2087 if (report("ERROR", $type, $msg)) {
2088 our $clean = 0;
2089 our $cnt_error++;
2090 return 1;
2091 }
2092 return 0;
2093}
2094sub WARN {
2095 my ($type, $msg) = @_;
2096
2097 if (report("WARNING", $type, $msg)) {
2098 our $clean = 0;
2099 our $cnt_warn++;
2100 return 1;
2101 }
2102 return 0;
2103}
2104sub CHK {
2105 my ($type, $msg) = @_;
2106
2107 if ($check && report("CHECK", $type, $msg)) {
2108 our $clean = 0;
2109 our $cnt_chk++;
2110 return 1;
2111 }
2112 return 0;
2113}
2114
2115sub check_absolute_file {
2116 my ($absolute, $herecurr) = @_;
2117 my $file = $absolute;
2118
2119 ##print "absolute<$absolute>\n";
2120
2121 # See if any suffix of this path is a path within the tree.
2122 while ($file =~ s@^[^/]*/@@) {
2123 if (-f "$root/$file") {
2124 ##print "file<$file>\n";
2125 last;
2126 }
2127 }
2128 if (! -f _) {
2129 return 0;
2130 }
2131
2132 # It is, so see if the prefix is acceptable.
2133 my $prefix = $absolute;
2134 substr($prefix, -length($file)) = '';
2135
2136 ##print "prefix<$prefix>\n";
2137 if ($prefix ne ".../") {
2138 WARN("USE_RELATIVE_PATH",
2139 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2140 }
2141}
2142
2143sub trim {
2144 my ($string) = @_;
2145
2146 $string =~ s/^\s+|\s+$//g;
2147
2148 return $string;
2149}
2150
2151sub ltrim {
2152 my ($string) = @_;
2153
2154 $string =~ s/^\s+//;
2155
2156 return $string;
2157}
2158
2159sub rtrim {
2160 my ($string) = @_;
2161
2162 $string =~ s/\s+$//;
2163
2164 return $string;
2165}
2166
2167sub string_find_replace {
2168 my ($string, $find, $replace) = @_;
2169
2170 $string =~ s/$find/$replace/g;
2171
2172 return $string;
2173}
2174
2175sub tabify {
2176 my ($leading) = @_;
2177
2178 my $source_indent = 8;
2179 my $max_spaces_before_tab = $source_indent - 1;
2180 my $spaces_to_tab = " " x $source_indent;
2181
2182 #convert leading spaces to tabs
2183 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2184 #Remove spaces before a tab
2185 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2186
2187 return "$leading";
2188}
2189
2190sub pos_last_openparen {
2191 my ($line) = @_;
2192
2193 my $pos = 0;
2194
2195 my $opens = $line =~ tr/\(/\(/;
2196 my $closes = $line =~ tr/\)/\)/;
2197
2198 my $last_openparen = 0;
2199
2200 if (($opens == 0) || ($closes >= $opens)) {
2201 return -1;
2202 }
2203
2204 my $len = length($line);
2205
2206 for ($pos = 0; $pos < $len; $pos++) {
2207 my $string = substr($line, $pos);
2208 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2209 $pos += length($1) - 1;
2210 } elsif (substr($line, $pos, 1) eq '(') {
2211 $last_openparen = $pos;
2212 } elsif (index($string, '(') == -1) {
2213 last;
2214 }
2215 }
2216
2217 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2218}
2219
2220sub process {
2221 my $filename = shift;
2222
2223 my $linenr=0;
2224 my $prevline="";
2225 my $prevrawline="";
2226 my $stashline="";
2227 my $stashrawline="";
2228
2229 my $length;
2230 my $indent;
2231 my $previndent=0;
2232 my $stashindent=0;
2233
2234 our $clean = 1;
2235 my $signoff = 0;
2236 my $is_patch = 0;
2237 my $in_header_lines = $file ? 0 : 1;
2238 my $in_commit_log = 0; #Scanning lines before patch
2239 my $has_commit_log = 0; #Encountered lines before patch
2240 my $commit_log_possible_stack_dump = 0;
2241 my $commit_log_long_line = 0;
2242 my $commit_log_has_diff = 0;
2243 my $reported_maintainer_file = 0;
2244 my $non_utf8_charset = 0;
2245
2246 my $last_blank_line = 0;
2247 my $last_coalesced_string_linenr = -1;
2248
2249 our @report = ();
2250 our $cnt_lines = 0;
2251 our $cnt_error = 0;
2252 our $cnt_warn = 0;
2253 our $cnt_chk = 0;
2254
2255 # Trace the real file/line as we go.
2256 my $realfile = '';
2257 my $realline = 0;
2258 my $realcnt = 0;
2259 my $here = '';
2260 my $context_function; #undef'd unless there's a known function
2261 my $in_comment = 0;
2262 my $comment_edge = 0;
2263 my $first_line = 0;
2264 my $p1_prefix = '';
2265
2266 my $prev_values = 'E';
2267
2268 # suppression flags
2269 my %suppress_ifbraces;
2270 my %suppress_whiletrailers;
2271 my %suppress_export;
2272 my $suppress_statement = 0;
2273
2274 my %signatures = ();
2275
2276 # Pre-scan the patch sanitizing the lines.
2277 # Pre-scan the patch looking for any __setup documentation.
2278 #
2279 my @setup_docs = ();
2280 my $setup_docs = 0;
2281
2282 my $camelcase_file_seeded = 0;
2283
2284 my $checklicenseline = 1;
2285
2286 sanitise_line_reset();
2287 my $line;
2288 foreach my $rawline (@rawlines) {
2289 $linenr++;
2290 $line = $rawline;
2291
2292 push(@fixed, $rawline) if ($fix);
2293
2294 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2295 $setup_docs = 0;
2296 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2297 $setup_docs = 1;
2298 }
2299 #next;
2300 }
2301 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2302 $realline=$1-1;
2303 if (defined $2) {
2304 $realcnt=$3+1;
2305 } else {
2306 $realcnt=1+1;
2307 }
2308 $in_comment = 0;
2309
2310 # Guestimate if this is a continuing comment. Run
2311 # the context looking for a comment "edge". If this
2312 # edge is a close comment then we must be in a comment
2313 # at context start.
2314 my $edge;
2315 my $cnt = $realcnt;
2316 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2317 next if (defined $rawlines[$ln - 1] &&
2318 $rawlines[$ln - 1] =~ /^-/);
2319 $cnt--;
2320 #print "RAW<$rawlines[$ln - 1]>\n";
2321 last if (!defined $rawlines[$ln - 1]);
2322 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2323 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2324 ($edge) = $1;
2325 last;
2326 }
2327 }
2328 if (defined $edge && $edge eq '*/') {
2329 $in_comment = 1;
2330 }
2331
2332 # Guestimate if this is a continuing comment. If this
2333 # is the start of a diff block and this line starts
2334 # ' *' then it is very likely a comment.
2335 if (!defined $edge &&
2336 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2337 {
2338 $in_comment = 1;
2339 }
2340
2341 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2342 sanitise_line_reset($in_comment);
2343
2344 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2345 # Standardise the strings and chars within the input to
2346 # simplify matching -- only bother with positive lines.
2347 $line = sanitise_line($rawline);
2348 }
2349 push(@lines, $line);
2350
2351 if ($realcnt > 1) {
2352 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2353 } else {
2354 $realcnt = 0;
2355 }
2356
2357 #print "==>$rawline\n";
2358 #print "-->$line\n";
2359
2360 if ($setup_docs && $line =~ /^\+/) {
2361 push(@setup_docs, $line);
2362 }
2363 }
2364
2365 $prefix = '';
2366
2367 $realcnt = 0;
2368 $linenr = 0;
2369 $fixlinenr = -1;
2370 foreach my $line (@lines) {
2371 $linenr++;
2372 $fixlinenr++;
2373 my $sline = $line; #copy of $line
2374 $sline =~ s/$;/ /g; #with comments as spaces
2375
2376 my $rawline = $rawlines[$linenr - 1];
2377
2378#extract the line range in the file after the patch is applied
2379 if (!$in_commit_log &&
2380 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2381 my $context = $4;
2382 $is_patch = 1;
2383 $first_line = $linenr + 1;
2384 $realline=$1-1;
2385 if (defined $2) {
2386 $realcnt=$3+1;
2387 } else {
2388 $realcnt=1+1;
2389 }
2390 annotate_reset();
2391 $prev_values = 'E';
2392
2393 %suppress_ifbraces = ();
2394 %suppress_whiletrailers = ();
2395 %suppress_export = ();
2396 $suppress_statement = 0;
2397 if ($context =~ /\b(\w+)\s*\(/) {
2398 $context_function = $1;
2399 } else {
2400 undef $context_function;
2401 }
2402 next;
2403
2404# track the line number as we move through the hunk, note that
2405# new versions of GNU diff omit the leading space on completely
2406# blank context lines so we need to count that too.
2407 } elsif ($line =~ /^( |\+|$)/) {
2408 $realline++;
2409 $realcnt-- if ($realcnt != 0);
2410
2411 # Measure the line length and indent.
2412 ($length, $indent) = line_stats($rawline);
2413
2414 # Track the previous line.
2415 ($prevline, $stashline) = ($stashline, $line);
2416 ($previndent, $stashindent) = ($stashindent, $indent);
2417 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2418
2419 #warn "line<$line>\n";
2420
2421 } elsif ($realcnt == 1) {
2422 $realcnt--;
2423 }
2424
2425 my $hunk_line = ($realcnt != 0);
2426
2427 $here = "#$linenr: " if (!$file);
2428 $here = "#$realline: " if ($file);
2429
2430 my $found_file = 0;
2431 # extract the filename as it passes
2432 if ($line =~ /^diff --git.*?(\S+)$/) {
2433 $realfile = $1;
2434 $realfile =~ s@^([^/]*)/@@ if (!$file);
2435 $in_commit_log = 0;
2436 $found_file = 1;
2437 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2438 $realfile = $1;
2439 $realfile =~ s@^([^/]*)/@@ if (!$file);
2440 $in_commit_log = 0;
2441
2442 $p1_prefix = $1;
2443 if (!$file && $tree && $p1_prefix ne '' &&
2444 -e "$root/$p1_prefix") {
2445 WARN("PATCH_PREFIX",
2446 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2447 }
2448
2449 if ($realfile =~ m@^include/asm/@) {
2450 ERROR("MODIFIED_INCLUDE_ASM",
2451 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2452 }
2453 $found_file = 1;
2454 }
2455
2456#make up the handle for any error we report on this line
2457 if ($showfile) {
2458 $prefix = "$realfile:$realline: "
2459 } elsif ($emacs) {
2460 if ($file) {
2461 $prefix = "$filename:$realline: ";
2462 } else {
2463 $prefix = "$filename:$linenr: ";
2464 }
2465 }
2466
2467 if ($found_file) {
2468 if (is_maintained_obsolete($realfile)) {
2469 WARN("OBSOLETE",
2470 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2471 }
2472 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2473 $check = 1;
2474 } else {
2475 $check = $check_orig;
2476 }
2477 $checklicenseline = 1;
2478 next;
2479 }
2480
2481 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2482
2483 my $hereline = "$here\n$rawline\n";
2484 my $herecurr = "$here\n$rawline\n";
2485 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2486
2487 $cnt_lines++ if ($realcnt != 0);
2488
2489# Check if the commit log has what seems like a diff which can confuse patch
2490 if ($in_commit_log && !$commit_log_has_diff &&
2491 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2492 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2493 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2494 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2495 ERROR("DIFF_IN_COMMIT_MSG",
2496 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2497 $commit_log_has_diff = 1;
2498 }
2499
2500# Check for incorrect file permissions
2501 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2502 my $permhere = $here . "FILE: $realfile\n";
2503 if ($realfile !~ m@scripts/@ &&
2504 $realfile !~ /\.(py|pl|awk|sh)$/) {
2505 ERROR("EXECUTE_PERMISSIONS",
2506 "do not set execute permissions for source files\n" . $permhere);
2507 }
2508 }
2509
2510# Check the patch for a signoff:
2511 if ($line =~ /^\s*signed-off-by:/i) {
2512 $signoff++;
2513 $in_commit_log = 0;
2514 }
2515
2516# Check if MAINTAINERS is being updated. If so, there's probably no need to
2517# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2518 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2519 $reported_maintainer_file = 1;
2520 }
2521
2522# Check signature styles
2523 if (!$in_header_lines &&
2524 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2525 my $space_before = $1;
2526 my $sign_off = $2;
2527 my $space_after = $3;
2528 my $email = $4;
2529 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2530
2531 if ($sign_off !~ /$signature_tags/) {
2532 WARN("BAD_SIGN_OFF",
2533 "Non-standard signature: $sign_off\n" . $herecurr);
2534 }
2535 if (defined $space_before && $space_before ne "") {
2536 if (WARN("BAD_SIGN_OFF",
2537 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2538 $fix) {
2539 $fixed[$fixlinenr] =
2540 "$ucfirst_sign_off $email";
2541 }
2542 }
2543 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2544 if (WARN("BAD_SIGN_OFF",
2545 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2546 $fix) {
2547 $fixed[$fixlinenr] =
2548 "$ucfirst_sign_off $email";
2549 }
2550
2551 }
2552 if (!defined $space_after || $space_after ne " ") {
2553 if (WARN("BAD_SIGN_OFF",
2554 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2555 $fix) {
2556 $fixed[$fixlinenr] =
2557 "$ucfirst_sign_off $email";
2558 }
2559 }
2560
2561 my ($email_name, $email_address, $comment) = parse_email($email);
2562 my $suggested_email = format_email(($email_name, $email_address));
2563 if ($suggested_email eq "") {
2564 ERROR("BAD_SIGN_OFF",
2565 "Unrecognized email address: '$email'\n" . $herecurr);
2566 } else {
2567 my $dequoted = $suggested_email;
2568 $dequoted =~ s/^"//;
2569 $dequoted =~ s/" </ </;
2570 # Don't force email to have quotes
2571 # Allow just an angle bracketed address
2572 if ("$dequoted$comment" ne $email &&
2573 "<$email_address>$comment" ne $email &&
2574 "$suggested_email$comment" ne $email) {
2575 WARN("BAD_SIGN_OFF",
2576 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2577 }
2578 }
2579
2580# Check for duplicate signatures
2581 my $sig_nospace = $line;
2582 $sig_nospace =~ s/\s//g;
2583 $sig_nospace = lc($sig_nospace);
2584 if (defined $signatures{$sig_nospace}) {
2585 WARN("BAD_SIGN_OFF",
2586 "Duplicate signature\n" . $herecurr);
2587 } else {
2588 $signatures{$sig_nospace} = 1;
2589 }
2590 }
2591
2592# Check email subject for common tools that don't need to be mentioned
2593 if ($in_header_lines &&
2594 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2595 WARN("EMAIL_SUBJECT",
2596 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2597 }
2598
2599# Check for old stable address
2600 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2601 ERROR("STABLE_ADDRESS",
2602 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2603 }
2604
2605# Check for unwanted Gerrit info
2606 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2607 ERROR("GERRIT_CHANGE_ID",
2608 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2609 }
2610
2611# Check if the commit log is in a possible stack dump
2612 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2613 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2614 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2615 # timestamp
2616 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2617 # stack dump address
2618 $commit_log_possible_stack_dump = 1;
2619 }
2620
2621# Check for line lengths > 75 in commit log, warn once
2622 if ($in_commit_log && !$commit_log_long_line &&
2623 length($line) > 75 &&
2624 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2625 # file delta changes
2626 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2627 # filename then :
2628 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2629 # A Fixes: or Link: line
2630 $commit_log_possible_stack_dump)) {
2631 WARN("COMMIT_LOG_LONG_LINE",
2632 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2633 $commit_log_long_line = 1;
2634 }
2635
2636# Reset possible stack dump if a blank line is found
2637 if ($in_commit_log && $commit_log_possible_stack_dump &&
2638 $line =~ /^\s*$/) {
2639 $commit_log_possible_stack_dump = 0;
2640 }
2641
2642# Check for git id commit length and improperly formed commit descriptions
2643 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2644 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2645 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2646 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2647 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2648 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2649 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2650 my $init_char = "c";
2651 my $orig_commit = "";
2652 my $short = 1;
2653 my $long = 0;
2654 my $case = 1;
2655 my $space = 1;
2656 my $hasdesc = 0;
2657 my $hasparens = 0;
2658 my $id = '0123456789ab';
2659 my $orig_desc = "commit description";
2660 my $description = "";
2661
2662 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2663 $init_char = $1;
2664 $orig_commit = lc($2);
2665 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2666 $orig_commit = lc($1);
2667 }
2668
2669 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2670 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2671 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2672 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2673 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2674 $orig_desc = $1;
2675 $hasparens = 1;
2676 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2677 defined $rawlines[$linenr] &&
2678 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2679 $orig_desc = $1;
2680 $hasparens = 1;
2681 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2682 defined $rawlines[$linenr] &&
2683 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2684 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2685 $orig_desc = $1;
2686 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2687 $orig_desc .= " " . $1;
2688 $hasparens = 1;
2689 }
2690
2691 ($id, $description) = git_commit_info($orig_commit,
2692 $id, $orig_desc);
2693
2694 if (defined($id) &&
2695 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2696 ERROR("GIT_COMMIT_ID",
2697 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2698 }
2699 }
2700
2701# Check for added, moved or deleted files
2702 if (!$reported_maintainer_file && !$in_commit_log &&
2703 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2704 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2705 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2706 (defined($1) || defined($2))))) {
2707 $is_patch = 1;
2708 $reported_maintainer_file = 1;
2709 WARN("FILE_PATH_CHANGES",
2710 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2711 }
2712
2713# Check for wrappage within a valid hunk of the file
2714 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2715 ERROR("CORRUPTED_PATCH",
2716 "patch seems to be corrupt (line wrapped?)\n" .
2717 $herecurr) if (!$emitted_corrupt++);
2718 }
2719
2720# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2721 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2722 $rawline !~ m/^$UTF8*$/) {
2723 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2724
2725 my $blank = copy_spacing($rawline);
2726 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2727 my $hereptr = "$hereline$ptr\n";
2728
2729 CHK("INVALID_UTF8",
2730 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2731 }
2732
2733# Check if it's the start of a commit log
2734# (not a header line and we haven't seen the patch filename)
2735 if ($in_header_lines && $realfile =~ /^$/ &&
2736 !($rawline =~ /^\s+(?:\S|$)/ ||
2737 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2738 $in_header_lines = 0;
2739 $in_commit_log = 1;
2740 $has_commit_log = 1;
2741 }
2742
2743# Check if there is UTF-8 in a commit log when a mail header has explicitly
2744# declined it, i.e defined some charset where it is missing.
2745 if ($in_header_lines &&
2746 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2747 $1 !~ /utf-8/i) {
2748 $non_utf8_charset = 1;
2749 }
2750
2751 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2752 $rawline =~ /$NON_ASCII_UTF8/) {
2753 WARN("UTF8_BEFORE_PATCH",
2754 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2755 }
2756
2757# Check for absolute kernel paths in commit message
2758 if ($tree && $in_commit_log) {
2759 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2760 my $file = $1;
2761
2762 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2763 check_absolute_file($1, $herecurr)) {
2764 #
2765 } else {
2766 check_absolute_file($file, $herecurr);
2767 }
2768 }
2769 }
2770
2771# Check for various typo / spelling mistakes
2772 if (defined($misspellings) &&
2773 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2774 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2775 my $typo = $1;
2776 my $typo_fix = $spelling_fix{lc($typo)};
2777 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2778 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2779 my $msg_level = \&WARN;
2780 $msg_level = \&CHK if ($file);
2781 if (&{$msg_level}("TYPO_SPELLING",
2782 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2783 $fix) {
2784 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2785 }
2786 }
2787 }
2788
2789# ignore non-hunk lines and lines being removed
2790 next if (!$hunk_line || $line =~ /^-/);
2791
2792#trailing whitespace
2793 if ($line =~ /^\+.*\015/) {
2794 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2795 if (ERROR("DOS_LINE_ENDINGS",
2796 "DOS line endings\n" . $herevet) &&
2797 $fix) {
2798 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2799 }
2800 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2801 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2802 if (ERROR("TRAILING_WHITESPACE",
2803 "trailing whitespace\n" . $herevet) &&
2804 $fix) {
2805 $fixed[$fixlinenr] =~ s/\s+$//;
2806 }
2807
2808 $rpt_cleaners = 1;
2809 }
2810
2811# Check for FSF mailing addresses.
2812 if ($rawline =~ /\bwrite to the Free/i ||
2813 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2814 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2815 $rawline =~ /\b51\s+Franklin\s+St/i) {
2816 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2817 my $msg_level = \&ERROR;
2818 $msg_level = \&CHK if ($file);
2819 &{$msg_level}("FSF_MAILING_ADDRESS",
2820 "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)
2821 }
2822
2823# check for Kconfig help text having a real description
2824# Only applies when adding the entry originally, after that we do not have
2825# sufficient context to determine whether it is indeed long enough.
2826 if ($realfile =~ /Kconfig/ &&
2827 # 'choice' is usually the last thing on the line (though
2828 # Kconfig supports named choices), so use a word boundary
2829 # (\b) rather than a whitespace character (\s)
2830 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
2831 my $length = 0;
2832 my $cnt = $realcnt;
2833 my $ln = $linenr + 1;
2834 my $f;
2835 my $is_start = 0;
2836 my $is_end = 0;
2837 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2838 $f = $lines[$ln - 1];
2839 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2840 $is_end = $lines[$ln - 1] =~ /^\+/;
2841
2842 next if ($f =~ /^-/);
2843 last if (!$file && $f =~ /^\@\@/);
2844
2845 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
2846 $is_start = 1;
2847 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2848 if ($lines[$ln - 1] =~ "---help---") {
2849 WARN("CONFIG_DESCRIPTION",
2850 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2851 }
2852 $length = -1;
2853 }
2854
2855 $f =~ s/^.//;
2856 $f =~ s/#.*//;
2857 $f =~ s/^\s+//;
2858 next if ($f =~ /^$/);
2859
2860 # This only checks context lines in the patch
2861 # and so hopefully shouldn't trigger false
2862 # positives, even though some of these are
2863 # common words in help texts
2864 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2865 if|endif|menu|endmenu|source)\b/x) {
2866 $is_end = 1;
2867 last;
2868 }
2869 $length++;
2870 }
2871 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2872 WARN("CONFIG_DESCRIPTION",
2873 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2874 }
2875 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2876 }
2877
2878# check for MAINTAINERS entries that don't have the right form
2879 if ($realfile =~ /^MAINTAINERS$/ &&
2880 $rawline =~ /^\+[A-Z]:/ &&
2881 $rawline !~ /^\+[A-Z]:\t\S/) {
2882 if (WARN("MAINTAINERS_STYLE",
2883 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2884 $fix) {
2885 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2886 }
2887 }
2888
2889# discourage the use of boolean for type definition attributes of Kconfig options
2890 if ($realfile =~ /Kconfig/ &&
2891 $line =~ /^\+\s*\bboolean\b/) {
2892 WARN("CONFIG_TYPE_BOOLEAN",
2893 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2894 }
2895
2896 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2897 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2898 my $flag = $1;
2899 my $replacement = {
2900 'EXTRA_AFLAGS' => 'asflags-y',
2901 'EXTRA_CFLAGS' => 'ccflags-y',
2902 'EXTRA_CPPFLAGS' => 'cppflags-y',
2903 'EXTRA_LDFLAGS' => 'ldflags-y',
2904 };
2905
2906 WARN("DEPRECATED_VARIABLE",
2907 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2908 }
2909
2910# check for DT compatible documentation
2911 if (defined $root &&
2912 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2913 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2914
2915 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2916
2917 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2918 my $vp_file = $dt_path . "vendor-prefixes.txt";
2919
2920 foreach my $compat (@compats) {
2921 my $compat2 = $compat;
2922 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2923 my $compat3 = $compat;
2924 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2925 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2926 if ( $? >> 8 ) {
2927 WARN("UNDOCUMENTED_DT_STRING",
2928 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2929 }
2930
2931 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2932 my $vendor = $1;
2933 `grep -Eq "^$vendor\\b" $vp_file`;
2934 if ( $? >> 8 ) {
2935 WARN("UNDOCUMENTED_DT_STRING",
2936 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2937 }
2938 }
2939 }
2940
2941# check for using SPDX license tag at beginning of files
2942 if ($realline == $checklicenseline) {
2943 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2944 $checklicenseline = 2;
2945 } elsif ($rawline =~ /^\+/) {
2946 my $comment = "";
2947 if ($realfile =~ /\.(h|s|S)$/) {
2948 $comment = '/*';
2949 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2950 $comment = '//';
2951 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2952 $comment = '#';
2953 } elsif ($realfile =~ /\.rst$/) {
2954 $comment = '..';
2955 }
2956
2957 if ($comment !~ /^$/ &&
2958 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2959 WARN("SPDX_LICENSE_TAG",
2960 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2961 }
2962 }
2963 }
2964
2965# check we are in a valid source file if not then ignore this hunk
2966 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
2967
2968# line length limit (with some exclusions)
2969#
2970# There are a few types of lines that may extend beyond $max_line_length:
2971# logging functions like pr_info that end in a string
2972# lines with a single string
2973# #defines that are a single string
2974# lines with an RFC3986 like URL
2975#
2976# There are 3 different line length message types:
2977# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
2978# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2979# LONG_LINE all other lines longer than $max_line_length
2980#
2981# if LONG_LINE is ignored, the other 2 types are also ignored
2982#
2983
2984 if ($line =~ /^\+/ && $length > $max_line_length) {
2985 my $msg_type = "LONG_LINE";
2986
2987 # Check the allowed long line types first
2988
2989 # logging functions that end in a string that starts
2990 # before $max_line_length
2991 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2992 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2993 $msg_type = "";
2994
2995 # lines with only strings (w/ possible termination)
2996 # #defines with only strings
2997 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2998 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2999 $msg_type = "";
3000
3001 # More special cases
3002 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3003 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3004 $msg_type = "";
3005
3006 # URL ($rawline is used in case the URL is in a comment)
3007 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3008 $msg_type = "";
3009
3010 # Otherwise set the alternate message types
3011
3012 # a comment starts before $max_line_length
3013 } elsif ($line =~ /($;[\s$;]*)$/ &&
3014 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3015 $msg_type = "LONG_LINE_COMMENT"
3016
3017 # a quoted string starts before $max_line_length
3018 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3019 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3020 $msg_type = "LONG_LINE_STRING"
3021 }
3022
3023 if ($msg_type ne "" &&
3024 (show_type("LONG_LINE") || show_type($msg_type))) {
3025 WARN($msg_type,
3026 "line over $max_line_length characters\n" . $herecurr);
3027 }
3028 }
3029
3030# check for adding lines without a newline.
3031 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3032 WARN("MISSING_EOF_NEWLINE",
3033 "adding a line without newline at end of file\n" . $herecurr);
3034 }
3035
3036# check we are in a valid source file C or perl if not then ignore this hunk
3037 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3038
3039# at the beginning of a line any tabs must come first and anything
3040# more than 8 must use tabs.
3041 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3042 $rawline =~ /^\+\s* \s*/) {
3043 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3044 $rpt_cleaners = 1;
3045 if (ERROR("CODE_INDENT",
3046 "code indent should use tabs where possible\n" . $herevet) &&
3047 $fix) {
3048 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3049 }
3050 }
3051
3052# check for space before tabs.
3053 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3054 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3055 if (WARN("SPACE_BEFORE_TAB",
3056 "please, no space before tabs\n" . $herevet) &&
3057 $fix) {
3058 while ($fixed[$fixlinenr] =~
3059 s/(^\+.*) {8,8}\t/$1\t\t/) {}
3060 while ($fixed[$fixlinenr] =~
3061 s/(^\+.*) +\t/$1\t/) {}
3062 }
3063 }
3064
3065# check for assignments on the start of a line
3066 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3067 CHK("ASSIGNMENT_CONTINUATIONS",
3068 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3069 }
3070
3071# check for && or || at the start of a line
3072 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3073 CHK("LOGICAL_CONTINUATIONS",
3074 "Logical continuations should be on the previous line\n" . $hereprev);
3075 }
3076
3077# check indentation starts on a tab stop
3078 if ($^V && $^V ge 5.10.0 &&
3079 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3080 my $indent = length($1);
3081 if ($indent % 8) {
3082 if (WARN("TABSTOP",
3083 "Statements should start on a tabstop\n" . $herecurr) &&
3084 $fix) {
3085 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3086 }
3087 }
3088 }
3089
3090# check multi-line statement indentation matches previous line
3091 if ($^V && $^V ge 5.10.0 &&
3092 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3093 $prevline =~ /^\+(\t*)(.*)$/;
3094 my $oldindent = $1;
3095 my $rest = $2;
3096
3097 my $pos = pos_last_openparen($rest);
3098 if ($pos >= 0) {
3099 $line =~ /^(\+| )([ \t]*)/;
3100 my $newindent = $2;
3101
3102 my $goodtabindent = $oldindent .
3103 "\t" x ($pos / 8) .
3104 " " x ($pos % 8);
3105 my $goodspaceindent = $oldindent . " " x $pos;
3106
3107 if ($newindent ne $goodtabindent &&
3108 $newindent ne $goodspaceindent) {
3109
3110 if (CHK("PARENTHESIS_ALIGNMENT",
3111 "Alignment should match open parenthesis\n" . $hereprev) &&
3112 $fix && $line =~ /^\+/) {
3113 $fixed[$fixlinenr] =~
3114 s/^\+[ \t]*/\+$goodtabindent/;
3115 }
3116 }
3117 }
3118 }
3119
3120# check for space after cast like "(int) foo" or "(struct foo) bar"
3121# avoid checking a few false positives:
3122# "sizeof(<type>)" or "__alignof__(<type>)"
3123# function pointer declarations like "(*foo)(int) = bar;"
3124# structure definitions like "(struct foo) { 0 };"
3125# multiline macros that define functions
3126# known attributes or the __attribute__ keyword
3127 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3128 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3129 if (CHK("SPACING",
3130 "No space is necessary after a cast\n" . $herecurr) &&
3131 $fix) {
3132 $fixed[$fixlinenr] =~
3133 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3134 }
3135 }
3136
3137# Block comment styles
3138# Networking with an initial /*
3139 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3140 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3141 $rawline =~ /^\+[ \t]*\*/ &&
3142 $realline > 2) {
3143 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3144 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3145 }
3146
3147# Block comments use * on subsequent lines
3148 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3149 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3150 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3151 $rawline =~ /^\+/ && #line is new
3152 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3153 WARN("BLOCK_COMMENT_STYLE",
3154 "Block comments use * on subsequent lines\n" . $hereprev);
3155 }
3156
3157# Block comments use */ on trailing lines
3158 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3159 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3160 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3161 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3162 WARN("BLOCK_COMMENT_STYLE",
3163 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3164 }
3165
3166# Block comment * alignment
3167 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3168 $line =~ /^\+[ \t]*$;/ && #leading comment
3169 $rawline =~ /^\+[ \t]*\*/ && #leading *
3170 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3171 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3172 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3173 my $oldindent;
3174 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3175 if (defined($1)) {
3176 $oldindent = expand_tabs($1);
3177 } else {
3178 $prevrawline =~ m@^\+(.*/?)\*@;
3179 $oldindent = expand_tabs($1);
3180 }
3181 $rawline =~ m@^\+([ \t]*)\*@;
3182 my $newindent = $1;
3183 $newindent = expand_tabs($newindent);
3184 if (length($oldindent) ne length($newindent)) {
3185 WARN("BLOCK_COMMENT_STYLE",
3186 "Block comments should align the * on each line\n" . $hereprev);
3187 }
3188 }
3189
3190# check for missing blank lines after struct/union declarations
3191# with exceptions for various attributes and macros
3192 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3193 $line =~ /^\+/ &&
3194 !($line =~ /^\+\s*$/ ||
3195 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3196 $line =~ /^\+\s*MODULE_/i ||
3197 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3198 $line =~ /^\+[a-z_]*init/ ||
3199 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3200 $line =~ /^\+\s*DECLARE/ ||
3201 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3202 $line =~ /^\+\s*__setup/)) {
3203 if (CHK("LINE_SPACING",
3204 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3205 $fix) {
3206 fix_insert_line($fixlinenr, "\+");
3207 }
3208 }
3209
3210# check for multiple consecutive blank lines
3211 if ($prevline =~ /^[\+ ]\s*$/ &&
3212 $line =~ /^\+\s*$/ &&
3213 $last_blank_line != ($linenr - 1)) {
3214 if (CHK("LINE_SPACING",
3215 "Please don't use multiple blank lines\n" . $hereprev) &&
3216 $fix) {
3217 fix_delete_line($fixlinenr, $rawline);
3218 }
3219
3220 $last_blank_line = $linenr;
3221 }
3222
3223# check for missing blank lines after declarations
3224 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3225 # actual declarations
3226 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3227 # function pointer declarations
3228 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3229 # foo bar; where foo is some local typedef or #define
3230 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3231 # known declaration macros
3232 $prevline =~ /^\+\s+$declaration_macros/) &&
3233 # for "else if" which can look like "$Ident $Ident"
3234 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3235 # other possible extensions of declaration lines
3236 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3237 # not starting a section or a macro "\" extended line
3238 $prevline =~ /(?:\{\s*|\\)$/) &&
3239 # looks like a declaration
3240 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3241 # function pointer declarations
3242 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3243 # foo bar; where foo is some local typedef or #define
3244 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3245 # known declaration macros
3246 $sline =~ /^\+\s+$declaration_macros/ ||
3247 # start of struct or union or enum
3248 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
3249 # start or end of block or continuation of declaration
3250 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3251 # bitfield continuation
3252 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3253 # other possible extensions of declaration lines
3254 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3255 # indentation of previous and current line are the same
3256 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3257 if (WARN("LINE_SPACING",
3258 "Missing a blank line after declarations\n" . $hereprev) &&
3259 $fix) {
3260 fix_insert_line($fixlinenr, "\+");
3261 }
3262 }
3263
3264# check for spaces at the beginning of a line.
3265# Exceptions:
3266# 1) within comments
3267# 2) indented preprocessor commands
3268# 3) hanging labels
3269 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3270 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3271 if (WARN("LEADING_SPACE",
3272 "please, no spaces at the start of a line\n" . $herevet) &&
3273 $fix) {
3274 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3275 }
3276 }
3277
3278# check we are in a valid C source file if not then ignore this hunk
3279 next if ($realfile !~ /\.(h|c)$/);
3280
3281# check for unusual line ending [ or (
3282 if ($line =~ /^\+.*([\[\(])\s*$/) {
3283 CHK("OPEN_ENDED_LINE",
3284 "Lines should not end with a '$1'\n" . $herecurr);
3285 }
3286
3287# check if this appears to be the start function declaration, save the name
3288 if ($sline =~ /^\+\{\s*$/ &&
3289 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3290 $context_function = $1;
3291 }
3292
3293# check if this appears to be the end of function declaration
3294 if ($sline =~ /^\+\}\s*$/) {
3295 undef $context_function;
3296 }
3297
3298# check indentation of any line with a bare else
3299# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3300# if the previous line is a break or return and is indented 1 tab more...
3301 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3302 my $tabs = length($1) + 1;
3303 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3304 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3305 defined $lines[$linenr] &&
3306 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3307 WARN("UNNECESSARY_ELSE",
3308 "else is not generally useful after a break or return\n" . $hereprev);
3309 }
3310 }
3311
3312# check indentation of a line with a break;
3313# if the previous line is a goto or return and is indented the same # of tabs
3314 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3315 my $tabs = $1;
3316 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3317 WARN("UNNECESSARY_BREAK",
3318 "break is not useful after a goto or return\n" . $hereprev);
3319 }
3320 }
3321
3322# check for RCS/CVS revision markers
3323 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3324 WARN("CVS_KEYWORD",
3325 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3326 }
3327
3328# check for old HOTPLUG __dev<foo> section markings
3329 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3330 WARN("HOTPLUG_SECTION",
3331 "Using $1 is unnecessary\n" . $herecurr);
3332 }
3333
3334# Check for potential 'bare' types
3335 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3336 $realline_next);
3337#print "LINE<$line>\n";
3338 if ($linenr > $suppress_statement &&
3339 $realcnt && $sline =~ /.\s*\S/) {
3340 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3341 ctx_statement_block($linenr, $realcnt, 0);
3342 $stat =~ s/\n./\n /g;
3343 $cond =~ s/\n./\n /g;
3344
3345#print "linenr<$linenr> <$stat>\n";
3346 # If this statement has no statement boundaries within
3347 # it there is no point in retrying a statement scan
3348 # until we hit end of it.
3349 my $frag = $stat; $frag =~ s/;+\s*$//;
3350 if ($frag !~ /(?:{|;)/) {
3351#print "skip<$line_nr_next>\n";
3352 $suppress_statement = $line_nr_next;
3353 }
3354
3355 # Find the real next line.
3356 $realline_next = $line_nr_next;
3357 if (defined $realline_next &&
3358 (!defined $lines[$realline_next - 1] ||
3359 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3360 $realline_next++;
3361 }
3362
3363 my $s = $stat;
3364 $s =~ s/{.*$//s;
3365
3366 # Ignore goto labels.
3367 if ($s =~ /$Ident:\*$/s) {
3368
3369 # Ignore functions being called
3370 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3371
3372 } elsif ($s =~ /^.\s*else\b/s) {
3373
3374 # declarations always start with types
3375 } 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) {
3376 my $type = $1;
3377 $type =~ s/\s+/ /g;
3378 possible($type, "A:" . $s);
3379
3380 # definitions in global scope can only start with types
3381 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3382 possible($1, "B:" . $s);
3383 }
3384
3385 # any (foo ... *) is a pointer cast, and foo is a type
3386 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3387 possible($1, "C:" . $s);
3388 }
3389
3390 # Check for any sort of function declaration.
3391 # int foo(something bar, other baz);
3392 # void (*store_gdt)(x86_descr_ptr *);
3393 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3394 my ($name_len) = length($1);
3395
3396 my $ctx = $s;
3397 substr($ctx, 0, $name_len + 1, '');
3398 $ctx =~ s/\)[^\)]*$//;
3399
3400 for my $arg (split(/\s*,\s*/, $ctx)) {
3401 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3402
3403 possible($1, "D:" . $s);
3404 }
3405 }
3406 }
3407
3408 }
3409
3410#
3411# Checks which may be anchored in the context.
3412#
3413
3414# Check for switch () and associated case and default
3415# statements should be at the same indent.
3416 if ($line=~/\bswitch\s*\(.*\)/) {
3417 my $err = '';
3418 my $sep = '';
3419 my @ctx = ctx_block_outer($linenr, $realcnt);
3420 shift(@ctx);
3421 for my $ctx (@ctx) {
3422 my ($clen, $cindent) = line_stats($ctx);
3423 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3424 $indent != $cindent) {
3425 $err .= "$sep$ctx\n";
3426 $sep = '';
3427 } else {
3428 $sep = "[...]\n";
3429 }
3430 }
3431 if ($err ne '') {
3432 ERROR("SWITCH_CASE_INDENT_LEVEL",
3433 "switch and case should be at the same indent\n$hereline$err");
3434 }
3435 }
3436
3437# if/while/etc brace do not go on next line, unless defining a do while loop,
3438# or if that brace on the next line is for something else
3439 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3440 my $pre_ctx = "$1$2";
3441
3442 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3443
3444 if ($line =~ /^\+\t{6,}/) {
3445 WARN("DEEP_INDENTATION",
3446 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3447 }
3448
3449 my $ctx_cnt = $realcnt - $#ctx - 1;
3450 my $ctx = join("\n", @ctx);
3451
3452 my $ctx_ln = $linenr;
3453 my $ctx_skip = $realcnt;
3454
3455 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3456 defined $lines[$ctx_ln - 1] &&
3457 $lines[$ctx_ln - 1] =~ /^-/)) {
3458 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3459 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3460 $ctx_ln++;
3461 }
3462
3463 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3464 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3465
3466 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3467 ERROR("OPEN_BRACE",
3468 "that open brace { should be on the previous line\n" .
3469 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3470 }
3471 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3472 $ctx =~ /\)\s*\;\s*$/ &&
3473 defined $lines[$ctx_ln - 1])
3474 {
3475 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3476 if ($nindent > $indent) {
3477 WARN("TRAILING_SEMICOLON",
3478 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3479 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3480 }
3481 }
3482 }
3483
3484# Check relative indent for conditionals and blocks.
3485 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3486 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3487 ctx_statement_block($linenr, $realcnt, 0)
3488 if (!defined $stat);
3489 my ($s, $c) = ($stat, $cond);
3490
3491 substr($s, 0, length($c), '');
3492
3493 # remove inline comments
3494 $s =~ s/$;/ /g;
3495 $c =~ s/$;/ /g;
3496
3497 # Find out how long the conditional actually is.
3498 my @newlines = ($c =~ /\n/gs);
3499 my $cond_lines = 1 + $#newlines;
3500
3501 # Make sure we remove the line prefixes as we have
3502 # none on the first line, and are going to readd them
3503 # where necessary.
3504 $s =~ s/\n./\n/gs;
3505 while ($s =~ /\n\s+\\\n/) {
3506 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3507 }
3508
3509 # We want to check the first line inside the block
3510 # starting at the end of the conditional, so remove:
3511 # 1) any blank line termination
3512 # 2) any opening brace { on end of the line
3513 # 3) any do (...) {
3514 my $continuation = 0;
3515 my $check = 0;
3516 $s =~ s/^.*\bdo\b//;
3517 $s =~ s/^\s*{//;
3518 if ($s =~ s/^\s*\\//) {
3519 $continuation = 1;
3520 }
3521 if ($s =~ s/^\s*?\n//) {
3522 $check = 1;
3523 $cond_lines++;
3524 }
3525
3526 # Also ignore a loop construct at the end of a
3527 # preprocessor statement.
3528 if (($prevline =~ /^.\s*#\s*define\s/ ||
3529 $prevline =~ /\\\s*$/) && $continuation == 0) {
3530 $check = 0;
3531 }
3532
3533 my $cond_ptr = -1;
3534 $continuation = 0;
3535 while ($cond_ptr != $cond_lines) {
3536 $cond_ptr = $cond_lines;
3537
3538 # If we see an #else/#elif then the code
3539 # is not linear.
3540 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3541 $check = 0;
3542 }
3543
3544 # Ignore:
3545 # 1) blank lines, they should be at 0,
3546 # 2) preprocessor lines, and
3547 # 3) labels.
3548 if ($continuation ||
3549 $s =~ /^\s*?\n/ ||
3550 $s =~ /^\s*#\s*?/ ||
3551 $s =~ /^\s*$Ident\s*:/) {
3552 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3553 if ($s =~ s/^.*?\n//) {
3554 $cond_lines++;
3555 }
3556 }
3557 }
3558
3559 my (undef, $sindent) = line_stats("+" . $s);
3560 my $stat_real = raw_line($linenr, $cond_lines);
3561
3562 # Check if either of these lines are modified, else
3563 # this is not this patch's fault.
3564 if (!defined($stat_real) ||
3565 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3566 $check = 0;
3567 }
3568 if (defined($stat_real) && $cond_lines > 1) {
3569 $stat_real = "[...]\n$stat_real";
3570 }
3571
3572 #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";
3573
3574 if ($check && $s ne '' &&
3575 (($sindent % 8) != 0 ||
3576 ($sindent < $indent) ||
3577 ($sindent == $indent &&
3578 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3579 ($sindent > $indent + 8))) {
3580 WARN("SUSPECT_CODE_INDENT",
3581 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3582 }
3583 }
3584
3585 # Track the 'values' across context and added lines.
3586 my $opline = $line; $opline =~ s/^./ /;
3587 my ($curr_values, $curr_vars) =
3588 annotate_values($opline . "\n", $prev_values);
3589 $curr_values = $prev_values . $curr_values;
3590 if ($dbg_values) {
3591 my $outline = $opline; $outline =~ s/\t/ /g;
3592 print "$linenr > .$outline\n";
3593 print "$linenr > $curr_values\n";
3594 print "$linenr > $curr_vars\n";
3595 }
3596 $prev_values = substr($curr_values, -1);
3597
3598#ignore lines not being added
3599 next if ($line =~ /^[^\+]/);
3600
3601# check for dereferences that span multiple lines
3602 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3603 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3604 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3605 my $ref = $1;
3606 $line =~ /^.\s*($Lval)/;
3607 $ref .= $1;
3608 $ref =~ s/\s//g;
3609 WARN("MULTILINE_DEREFERENCE",
3610 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3611 }
3612
3613# check for declarations of signed or unsigned without int
3614 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3615 my $type = $1;
3616 my $var = $2;
3617 $var = "" if (!defined $var);
3618 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3619 my $sign = $1;
3620 my $pointer = $2;
3621
3622 $pointer = "" if (!defined $pointer);
3623
3624 if (WARN("UNSPECIFIED_INT",
3625 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3626 $fix) {
3627 my $decl = trim($sign) . " int ";
3628 my $comp_pointer = $pointer;
3629 $comp_pointer =~ s/\s//g;
3630 $decl .= $comp_pointer;
3631 $decl = rtrim($decl) if ($var eq "");
3632 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3633 }
3634 }
3635 }
3636
3637# TEST: allow direct testing of the type matcher.
3638 if ($dbg_type) {
3639 if ($line =~ /^.\s*$Declare\s*$/) {
3640 ERROR("TEST_TYPE",
3641 "TEST: is type\n" . $herecurr);
3642 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3643 ERROR("TEST_NOT_TYPE",
3644 "TEST: is not type ($1 is)\n". $herecurr);
3645 }
3646 next;
3647 }
3648# TEST: allow direct testing of the attribute matcher.
3649 if ($dbg_attr) {
3650 if ($line =~ /^.\s*$Modifier\s*$/) {
3651 ERROR("TEST_ATTR",
3652 "TEST: is attr\n" . $herecurr);
3653 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3654 ERROR("TEST_NOT_ATTR",
3655 "TEST: is not attr ($1 is)\n". $herecurr);
3656 }
3657 next;
3658 }
3659
3660# check for initialisation to aggregates open brace on the next line
3661 if ($line =~ /^.\s*{/ &&
3662 $prevline =~ /(?:^|[^=])=\s*$/) {
3663 if (ERROR("OPEN_BRACE",
3664 "that open brace { should be on the previous line\n" . $hereprev) &&
3665 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3666 fix_delete_line($fixlinenr - 1, $prevrawline);
3667 fix_delete_line($fixlinenr, $rawline);
3668 my $fixedline = $prevrawline;
3669 $fixedline =~ s/\s*=\s*$/ = {/;
3670 fix_insert_line($fixlinenr, $fixedline);
3671 $fixedline = $line;
3672 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3673 fix_insert_line($fixlinenr, $fixedline);
3674 }
3675 }
3676
3677#
3678# Checks which are anchored on the added line.
3679#
3680
3681# check for malformed paths in #include statements (uses RAW line)
3682 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3683 my $path = $1;
3684 if ($path =~ m{//}) {
3685 ERROR("MALFORMED_INCLUDE",
3686 "malformed #include filename\n" . $herecurr);
3687 }
3688 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3689 ERROR("UAPI_INCLUDE",
3690 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3691 }
3692 }
3693
3694# no C99 // comments
3695 if ($line =~ m{//}) {
3696 if (ERROR("C99_COMMENTS",
3697 "do not use C99 // comments\n" . $herecurr) &&
3698 $fix) {
3699 my $line = $fixed[$fixlinenr];
3700 if ($line =~ /\/\/(.*)$/) {
3701 my $comment = trim($1);
3702 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3703 }
3704 }
3705 }
3706 # Remove C99 comments.
3707 $line =~ s@//.*@@;
3708 $opline =~ s@//.*@@;
3709
3710# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3711# the whole statement.
3712#print "APW <$lines[$realline_next - 1]>\n";
3713 if (defined $realline_next &&
3714 exists $lines[$realline_next - 1] &&
3715 !defined $suppress_export{$realline_next} &&
3716 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3717 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3718 # Handle definitions which produce identifiers with
3719 # a prefix:
3720 # XXX(foo);
3721 # EXPORT_SYMBOL(something_foo);
3722 my $name = $1;
3723 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3724 $name =~ /^${Ident}_$2/) {
3725#print "FOO C name<$name>\n";
3726 $suppress_export{$realline_next} = 1;
3727
3728 } elsif ($stat !~ /(?:
3729 \n.}\s*$|
3730 ^.DEFINE_$Ident\(\Q$name\E\)|
3731 ^.DECLARE_$Ident\(\Q$name\E\)|
3732 ^.LIST_HEAD\(\Q$name\E\)|
3733 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3734 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3735 )/x) {
3736#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3737 $suppress_export{$realline_next} = 2;
3738 } else {
3739 $suppress_export{$realline_next} = 1;
3740 }
3741 }
3742 if (!defined $suppress_export{$linenr} &&
3743 $prevline =~ /^.\s*$/ &&
3744 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3745 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3746#print "FOO B <$lines[$linenr - 1]>\n";
3747 $suppress_export{$linenr} = 2;
3748 }
3749 if (defined $suppress_export{$linenr} &&
3750 $suppress_export{$linenr} == 2) {
3751 WARN("EXPORT_SYMBOL",
3752 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3753 }
3754
3755# check for global initialisers.
3756 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3757 if (ERROR("GLOBAL_INITIALISERS",
3758 "do not initialise globals to $1\n" . $herecurr) &&
3759 $fix) {
3760 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3761 }
3762 }
3763# check for static initialisers.
3764 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3765 if (ERROR("INITIALISED_STATIC",
3766 "do not initialise statics to $1\n" .
3767 $herecurr) &&
3768 $fix) {
3769 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3770 }
3771 }
3772
3773# check for misordered declarations of char/short/int/long with signed/unsigned
3774 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3775 my $tmp = trim($1);
3776 WARN("MISORDERED_TYPE",
3777 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3778 }
3779
3780# check for static const char * arrays.
3781 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3782 WARN("STATIC_CONST_CHAR_ARRAY",
3783 "static const char * array should probably be static const char * const\n" .
3784 $herecurr);
3785 }
3786
3787# check for static char foo[] = "bar" declarations.
3788 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3789 WARN("STATIC_CONST_CHAR_ARRAY",
3790 "static char array declaration should probably be static const char\n" .
3791 $herecurr);
3792 }
3793
3794# check for const <foo> const where <foo> is not a pointer or array type
3795 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3796 my $found = $1;
3797 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3798 WARN("CONST_CONST",
3799 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3800 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3801 WARN("CONST_CONST",
3802 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3803 }
3804 }
3805
3806# check for non-global char *foo[] = {"bar", ...} declarations.
3807 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3808 WARN("STATIC_CONST_CHAR_ARRAY",
3809 "char * array declaration might be better as static const\n" .
3810 $herecurr);
3811 }
3812
3813# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3814 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3815 my $array = $1;
3816 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3817 my $array_div = $1;
3818 if (WARN("ARRAY_SIZE",
3819 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3820 $fix) {
3821 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3822 }
3823 }
3824 }
3825
3826# check for function declarations without arguments like "int foo()"
3827 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3828 if (ERROR("FUNCTION_WITHOUT_ARGS",
3829 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3830 $fix) {
3831 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3832 }
3833 }
3834
3835# check for new typedefs, only function parameters and sparse annotations
3836# make sense.
3837 if ($line =~ /\btypedef\s/ &&
3838 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3839 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3840 $line !~ /\b$typeTypedefs\b/ &&
3841 $line !~ /\b__bitwise\b/) {
3842 WARN("NEW_TYPEDEFS",
3843 "do not add new typedefs\n" . $herecurr);
3844 }
3845
3846# * goes on variable not on type
3847 # (char*[ const])
3848 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3849 #print "AA<$1>\n";
3850 my ($ident, $from, $to) = ($1, $2, $2);
3851
3852 # Should start with a space.
3853 $to =~ s/^(\S)/ $1/;
3854 # Should not end with a space.
3855 $to =~ s/\s+$//;
3856 # '*'s should not have spaces between.
3857 while ($to =~ s/\*\s+\*/\*\*/) {
3858 }
3859
3860## print "1: from<$from> to<$to> ident<$ident>\n";
3861 if ($from ne $to) {
3862 if (ERROR("POINTER_LOCATION",
3863 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3864 $fix) {
3865 my $sub_from = $ident;
3866 my $sub_to = $ident;
3867 $sub_to =~ s/\Q$from\E/$to/;
3868 $fixed[$fixlinenr] =~
3869 s@\Q$sub_from\E@$sub_to@;
3870 }
3871 }
3872 }
3873 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3874 #print "BB<$1>\n";
3875 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3876
3877 # Should start with a space.
3878 $to =~ s/^(\S)/ $1/;
3879 # Should not end with a space.
3880 $to =~ s/\s+$//;
3881 # '*'s should not have spaces between.
3882 while ($to =~ s/\*\s+\*/\*\*/) {
3883 }
3884 # Modifiers should have spaces.
3885 $to =~ s/(\b$Modifier$)/$1 /;
3886
3887## print "2: from<$from> to<$to> ident<$ident>\n";
3888 if ($from ne $to && $ident !~ /^$Modifier$/) {
3889 if (ERROR("POINTER_LOCATION",
3890 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3891 $fix) {
3892
3893 my $sub_from = $match;
3894 my $sub_to = $match;
3895 $sub_to =~ s/\Q$from\E/$to/;
3896 $fixed[$fixlinenr] =~
3897 s@\Q$sub_from\E@$sub_to@;
3898 }
3899 }
3900 }
3901
3902# avoid BUG() or BUG_ON()
3903 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3904 my $msg_level = \&WARN;
3905 $msg_level = \&CHK if ($file);
3906 &{$msg_level}("AVOID_BUG",
3907 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3908 }
3909
3910# avoid LINUX_VERSION_CODE
3911 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3912 WARN("LINUX_VERSION_CODE",
3913 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3914 }
3915
3916# check for uses of printk_ratelimit
3917 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3918 WARN("PRINTK_RATELIMITED",
3919 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3920 }
3921
3922# printk should use KERN_* levels
3923 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3924 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3925 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
3926 }
3927
3928 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3929 my $orig = $1;
3930 my $level = lc($orig);
3931 $level = "warn" if ($level eq "warning");
3932 my $level2 = $level;
3933 $level2 = "dbg" if ($level eq "debug");
3934 WARN("PREFER_PR_LEVEL",
3935 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3936 }
3937
3938 if ($line =~ /\bpr_warning\s*\(/) {
3939 if (WARN("PREFER_PR_LEVEL",
3940 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3941 $fix) {
3942 $fixed[$fixlinenr] =~
3943 s/\bpr_warning\b/pr_warn/;
3944 }
3945 }
3946
3947 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3948 my $orig = $1;
3949 my $level = lc($orig);
3950 $level = "warn" if ($level eq "warning");
3951 $level = "dbg" if ($level eq "debug");
3952 WARN("PREFER_DEV_LEVEL",
3953 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3954 }
3955
3956# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3957# number of false positives, but assembly files are not checked, so at
3958# least the arch entry code will not trigger this warning.
3959 if ($line =~ /\bENOSYS\b/) {
3960 WARN("ENOSYS",
3961 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3962 }
3963
3964# function brace can't be on same line, except for #defines of do while,
3965# or if closed on same line
3966 if ($^V && $^V ge 5.10.0 &&
3967 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3968 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3969 $sline !~ /}/) {
3970 if (ERROR("OPEN_BRACE",
3971 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
3972 $fix) {
3973 fix_delete_line($fixlinenr, $rawline);
3974 my $fixed_line = $rawline;
3975 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3976 my $line1 = $1;
3977 my $line2 = $2;
3978 fix_insert_line($fixlinenr, ltrim($line1));
3979 fix_insert_line($fixlinenr, "\+{");
3980 if ($line2 !~ /^\s*$/) {
3981 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3982 }
3983 }
3984 }
3985
3986# open braces for enum, union and struct go on the same line.
3987 if ($line =~ /^.\s*{/ &&
3988 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3989 if (ERROR("OPEN_BRACE",
3990 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3991 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3992 fix_delete_line($fixlinenr - 1, $prevrawline);
3993 fix_delete_line($fixlinenr, $rawline);
3994 my $fixedline = rtrim($prevrawline) . " {";
3995 fix_insert_line($fixlinenr, $fixedline);
3996 $fixedline = $rawline;
3997 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
3998 if ($fixedline !~ /^\+\s*$/) {
3999 fix_insert_line($fixlinenr, $fixedline);
4000 }
4001 }
4002 }
4003
4004# missing space after union, struct or enum definition
4005 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4006 if (WARN("SPACING",
4007 "missing space after $1 definition\n" . $herecurr) &&
4008 $fix) {
4009 $fixed[$fixlinenr] =~
4010 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4011 }
4012 }
4013
4014# Function pointer declarations
4015# check spacing between type, funcptr, and args
4016# canonical declaration is "type (*funcptr)(args...)"
4017 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4018 my $declare = $1;
4019 my $pre_pointer_space = $2;
4020 my $post_pointer_space = $3;
4021 my $funcname = $4;
4022 my $post_funcname_space = $5;
4023 my $pre_args_space = $6;
4024
4025# the $Declare variable will capture all spaces after the type
4026# so check it for a missing trailing missing space but pointer return types
4027# don't need a space so don't warn for those.
4028 my $post_declare_space = "";
4029 if ($declare =~ /(\s+)$/) {
4030 $post_declare_space = $1;
4031 $declare = rtrim($declare);
4032 }
4033 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4034 WARN("SPACING",
4035 "missing space after return type\n" . $herecurr);
4036 $post_declare_space = " ";
4037 }
4038
4039# unnecessary space "type (*funcptr)(args...)"
4040# This test is not currently implemented because these declarations are
4041# equivalent to
4042# int foo(int bar, ...)
4043# and this is form shouldn't/doesn't generate a checkpatch warning.
4044#
4045# elsif ($declare =~ /\s{2,}$/) {
4046# WARN("SPACING",
4047# "Multiple spaces after return type\n" . $herecurr);
4048# }
4049
4050# unnecessary space "type ( *funcptr)(args...)"
4051 if (defined $pre_pointer_space &&
4052 $pre_pointer_space =~ /^\s/) {
4053 WARN("SPACING",
4054 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4055 }
4056
4057# unnecessary space "type (* funcptr)(args...)"
4058 if (defined $post_pointer_space &&
4059 $post_pointer_space =~ /^\s/) {
4060 WARN("SPACING",
4061 "Unnecessary space before function pointer name\n" . $herecurr);
4062 }
4063
4064# unnecessary space "type (*funcptr )(args...)"
4065 if (defined $post_funcname_space &&
4066 $post_funcname_space =~ /^\s/) {
4067 WARN("SPACING",
4068 "Unnecessary space after function pointer name\n" . $herecurr);
4069 }
4070
4071# unnecessary space "type (*funcptr) (args...)"
4072 if (defined $pre_args_space &&
4073 $pre_args_space =~ /^\s/) {
4074 WARN("SPACING",
4075 "Unnecessary space before function pointer arguments\n" . $herecurr);
4076 }
4077
4078 if (show_type("SPACING") && $fix) {
4079 $fixed[$fixlinenr] =~
4080 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4081 }
4082 }
4083
4084# check for spacing round square brackets; allowed:
4085# 1. with a type on the left -- int [] a;
4086# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4087# 3. inside a curly brace -- = { [0...10] = 5 }
4088 while ($line =~ /(.*?\s)\[/g) {
4089 my ($where, $prefix) = ($-[1], $1);
4090 if ($prefix !~ /$Type\s+$/ &&
4091 ($where != 0 || $prefix !~ /^.\s+$/) &&
4092 $prefix !~ /[{,:]\s+$/) {
4093 if (ERROR("BRACKET_SPACE",
4094 "space prohibited before open square bracket '['\n" . $herecurr) &&
4095 $fix) {
4096 $fixed[$fixlinenr] =~
4097 s/^(\+.*?)\s+\[/$1\[/;
4098 }
4099 }
4100 }
4101
4102# check for spaces between functions and their parentheses.
4103 while ($line =~ /($Ident)\s+\(/g) {
4104 my $name = $1;
4105 my $ctx_before = substr($line, 0, $-[1]);
4106 my $ctx = "$ctx_before$name";
4107
4108 # Ignore those directives where spaces _are_ permitted.
4109 if ($name =~ /^(?:
4110 if|for|while|switch|return|case|
4111 volatile|__volatile__|
4112 __attribute__|format|__extension__|
4113 asm|__asm__)$/x)
4114 {
4115 # cpp #define statements have non-optional spaces, ie
4116 # if there is a space between the name and the open
4117 # parenthesis it is simply not a parameter group.
4118 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4119
4120 # cpp #elif statement condition may start with a (
4121 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4122
4123 # If this whole things ends with a type its most
4124 # likely a typedef for a function.
4125 } elsif ($ctx =~ /$Type$/) {
4126
4127 } else {
4128 if (WARN("SPACING",
4129 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4130 $fix) {
4131 $fixed[$fixlinenr] =~
4132 s/\b$name\s+\(/$name\(/;
4133 }
4134 }
4135 }
4136
4137# Check operator spacing.
4138 if (!($line=~/\#\s*include/)) {
4139 my $fixed_line = "";
4140 my $line_fixed = 0;
4141
4142 my $ops = qr{
4143 <<=|>>=|<=|>=|==|!=|
4144 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4145 =>|->|<<|>>|<|>|=|!|~|
4146 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4147 \?:|\?|:
4148 }x;
4149 my @elements = split(/($ops|;)/, $opline);
4150
4151## print("element count: <" . $#elements . ">\n");
4152## foreach my $el (@elements) {
4153## print("el: <$el>\n");
4154## }
4155
4156 my @fix_elements = ();
4157 my $off = 0;
4158
4159 foreach my $el (@elements) {
4160 push(@fix_elements, substr($rawline, $off, length($el)));
4161 $off += length($el);
4162 }
4163
4164 $off = 0;
4165
4166 my $blank = copy_spacing($opline);
4167 my $last_after = -1;
4168
4169 for (my $n = 0; $n < $#elements; $n += 2) {
4170
4171 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4172
4173## print("n: <$n> good: <$good>\n");
4174
4175 $off += length($elements[$n]);
4176
4177 # Pick up the preceding and succeeding characters.
4178 my $ca = substr($opline, 0, $off);
4179 my $cc = '';
4180 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4181 $cc = substr($opline, $off + length($elements[$n + 1]));
4182 }
4183 my $cb = "$ca$;$cc";
4184
4185 my $a = '';
4186 $a = 'V' if ($elements[$n] ne '');
4187 $a = 'W' if ($elements[$n] =~ /\s$/);
4188 $a = 'C' if ($elements[$n] =~ /$;$/);
4189 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4190 $a = 'O' if ($elements[$n] eq '');
4191 $a = 'E' if ($ca =~ /^\s*$/);
4192
4193 my $op = $elements[$n + 1];
4194
4195 my $c = '';
4196 if (defined $elements[$n + 2]) {
4197 $c = 'V' if ($elements[$n + 2] ne '');
4198 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4199 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4200 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4201 $c = 'O' if ($elements[$n + 2] eq '');
4202 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4203 } else {
4204 $c = 'E';
4205 }
4206
4207 my $ctx = "${a}x${c}";
4208
4209 my $at = "(ctx:$ctx)";
4210
4211 my $ptr = substr($blank, 0, $off) . "^";
4212 my $hereptr = "$hereline$ptr\n";
4213
4214 # Pull out the value of this operator.
4215 my $op_type = substr($curr_values, $off + 1, 1);
4216
4217 # Get the full operator variant.
4218 my $opv = $op . substr($curr_vars, $off, 1);
4219
4220 # Ignore operators passed as parameters.
4221 if ($op_type ne 'V' &&
4222 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4223
4224# # Ignore comments
4225# } elsif ($op =~ /^$;+$/) {
4226
4227 # ; should have either the end of line or a space or \ after it
4228 } elsif ($op eq ';') {
4229 if ($ctx !~ /.x[WEBC]/ &&
4230 $cc !~ /^\\/ && $cc !~ /^;/) {
4231 if (ERROR("SPACING",
4232 "space required after that '$op' $at\n" . $hereptr)) {
4233 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4234 $line_fixed = 1;
4235 }
4236 }
4237
4238 # // is a comment
4239 } elsif ($op eq '//') {
4240
4241 # : when part of a bitfield
4242 } elsif ($opv eq ':B') {
4243 # skip the bitfield test for now
4244
4245 # No spaces for:
4246 # ->
4247 } elsif ($op eq '->') {
4248 if ($ctx =~ /Wx.|.xW/) {
4249 if (ERROR("SPACING",
4250 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4251 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4252 if (defined $fix_elements[$n + 2]) {
4253 $fix_elements[$n + 2] =~ s/^\s+//;
4254 }
4255 $line_fixed = 1;
4256 }
4257 }
4258
4259 # , must not have a space before and must have a space on the right.
4260 } elsif ($op eq ',') {
4261 my $rtrim_before = 0;
4262 my $space_after = 0;
4263 if ($ctx =~ /Wx./) {
4264 if (ERROR("SPACING",
4265 "space prohibited before that '$op' $at\n" . $hereptr)) {
4266 $line_fixed = 1;
4267 $rtrim_before = 1;
4268 }
4269 }
4270 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4271 if (ERROR("SPACING",
4272 "space required after that '$op' $at\n" . $hereptr)) {
4273 $line_fixed = 1;
4274 $last_after = $n;
4275 $space_after = 1;
4276 }
4277 }
4278 if ($rtrim_before || $space_after) {
4279 if ($rtrim_before) {
4280 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4281 } else {
4282 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4283 }
4284 if ($space_after) {
4285 $good .= " ";
4286 }
4287 }
4288
4289 # '*' as part of a type definition -- reported already.
4290 } elsif ($opv eq '*_') {
4291 #warn "'*' is part of type\n";
4292
4293 # unary operators should have a space before and
4294 # none after. May be left adjacent to another
4295 # unary operator, or a cast
4296 } elsif ($op eq '!' || $op eq '~' ||
4297 $opv eq '*U' || $opv eq '-U' ||
4298 $opv eq '&U' || $opv eq '&&U') {
4299 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4300 if (ERROR("SPACING",
4301 "space required before that '$op' $at\n" . $hereptr)) {
4302 if ($n != $last_after + 2) {
4303 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4304 $line_fixed = 1;
4305 }
4306 }
4307 }
4308 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4309 # A unary '*' may be const
4310
4311 } elsif ($ctx =~ /.xW/) {
4312 if (ERROR("SPACING",
4313 "space prohibited after that '$op' $at\n" . $hereptr)) {
4314 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4315 if (defined $fix_elements[$n + 2]) {
4316 $fix_elements[$n + 2] =~ s/^\s+//;
4317 }
4318 $line_fixed = 1;
4319 }
4320 }
4321
4322 # unary ++ and unary -- are allowed no space on one side.
4323 } elsif ($op eq '++' or $op eq '--') {
4324 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4325 if (ERROR("SPACING",
4326 "space required one side of that '$op' $at\n" . $hereptr)) {
4327 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4328 $line_fixed = 1;
4329 }
4330 }
4331 if ($ctx =~ /Wx[BE]/ ||
4332 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4333 if (ERROR("SPACING",
4334 "space prohibited before that '$op' $at\n" . $hereptr)) {
4335 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4336 $line_fixed = 1;
4337 }
4338 }
4339 if ($ctx =~ /ExW/) {
4340 if (ERROR("SPACING",
4341 "space prohibited after that '$op' $at\n" . $hereptr)) {
4342 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4343 if (defined $fix_elements[$n + 2]) {
4344 $fix_elements[$n + 2] =~ s/^\s+//;
4345 }
4346 $line_fixed = 1;
4347 }
4348 }
4349
4350 # << and >> may either have or not have spaces both sides
4351 } elsif ($op eq '<<' or $op eq '>>' or
4352 $op eq '&' or $op eq '^' or $op eq '|' or
4353 $op eq '+' or $op eq '-' or
4354 $op eq '*' or $op eq '/' or
4355 $op eq '%')
4356 {
4357 if ($check) {
4358 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4359 if (CHK("SPACING",
4360 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4361 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4362 $fix_elements[$n + 2] =~ s/^\s+//;
4363 $line_fixed = 1;
4364 }
4365 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4366 if (CHK("SPACING",
4367 "space preferred before that '$op' $at\n" . $hereptr)) {
4368 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4369 $line_fixed = 1;
4370 }
4371 }
4372 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4373 if (ERROR("SPACING",
4374 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4375 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4376 if (defined $fix_elements[$n + 2]) {
4377 $fix_elements[$n + 2] =~ s/^\s+//;
4378 }
4379 $line_fixed = 1;
4380 }
4381 }
4382
4383 # A colon needs no spaces before when it is
4384 # terminating a case value or a label.
4385 } elsif ($opv eq ':C' || $opv eq ':L') {
4386 if ($ctx =~ /Wx./) {
4387 if (ERROR("SPACING",
4388 "space prohibited before that '$op' $at\n" . $hereptr)) {
4389 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4390 $line_fixed = 1;
4391 }
4392 }
4393
4394 # All the others need spaces both sides.
4395 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4396 my $ok = 0;
4397
4398 # Ignore email addresses <foo@bar>
4399 if (($op eq '<' &&
4400 $cc =~ /^\S+\@\S+>/) ||
4401 ($op eq '>' &&
4402 $ca =~ /<\S+\@\S+$/))
4403 {
4404 $ok = 1;
4405 }
4406
4407 # for asm volatile statements
4408 # ignore a colon with another
4409 # colon immediately before or after
4410 if (($op eq ':') &&
4411 ($ca =~ /:$/ || $cc =~ /^:/)) {
4412 $ok = 1;
4413 }
4414
4415 # messages are ERROR, but ?: are CHK
4416 if ($ok == 0) {
4417 my $msg_level = \&ERROR;
4418 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4419
4420 if (&{$msg_level}("SPACING",
4421 "spaces required around that '$op' $at\n" . $hereptr)) {
4422 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4423 if (defined $fix_elements[$n + 2]) {
4424 $fix_elements[$n + 2] =~ s/^\s+//;
4425 }
4426 $line_fixed = 1;
4427 }
4428 }
4429 }
4430 $off += length($elements[$n + 1]);
4431
4432## print("n: <$n> GOOD: <$good>\n");
4433
4434 $fixed_line = $fixed_line . $good;
4435 }
4436
4437 if (($#elements % 2) == 0) {
4438 $fixed_line = $fixed_line . $fix_elements[$#elements];
4439 }
4440
4441 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4442 $fixed[$fixlinenr] = $fixed_line;
4443 }
4444
4445
4446 }
4447
4448# check for whitespace before a non-naked semicolon
4449 if ($line =~ /^\+.*\S\s+;\s*$/) {
4450 if (WARN("SPACING",
4451 "space prohibited before semicolon\n" . $herecurr) &&
4452 $fix) {
4453 1 while $fixed[$fixlinenr] =~
4454 s/^(\+.*\S)\s+;/$1;/;
4455 }
4456 }
4457
4458# check for multiple assignments
4459 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4460 CHK("MULTIPLE_ASSIGNMENTS",
4461 "multiple assignments should be avoided\n" . $herecurr);
4462 }
4463
4464## # check for multiple declarations, allowing for a function declaration
4465## # continuation.
4466## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4467## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4468##
4469## # Remove any bracketed sections to ensure we do not
4470## # falsly report the parameters of functions.
4471## my $ln = $line;
4472## while ($ln =~ s/\([^\(\)]*\)//g) {
4473## }
4474## if ($ln =~ /,/) {
4475## WARN("MULTIPLE_DECLARATION",
4476## "declaring multiple variables together should be avoided\n" . $herecurr);
4477## }
4478## }
4479
4480#need space before brace following if, while, etc
4481 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4482 $line =~ /do\{/) {
4483 if (ERROR("SPACING",
4484 "space required before the open brace '{'\n" . $herecurr) &&
4485 $fix) {
4486 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
4487 }
4488 }
4489
4490## # check for blank lines before declarations
4491## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4492## $prevrawline =~ /^.\s*$/) {
4493## WARN("SPACING",
4494## "No blank lines before declarations\n" . $hereprev);
4495## }
4496##
4497
4498# closing brace should have a space following it when it has anything
4499# on the line
4500 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4501 if (ERROR("SPACING",
4502 "space required after that close brace '}'\n" . $herecurr) &&
4503 $fix) {
4504 $fixed[$fixlinenr] =~
4505 s/}((?!(?:,|;|\)))\S)/} $1/;
4506 }
4507 }
4508
4509# check spacing on square brackets
4510 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4511 if (ERROR("SPACING",
4512 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4513 $fix) {
4514 $fixed[$fixlinenr] =~
4515 s/\[\s+/\[/;
4516 }
4517 }
4518 if ($line =~ /\s\]/) {
4519 if (ERROR("SPACING",
4520 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4521 $fix) {
4522 $fixed[$fixlinenr] =~
4523 s/\s+\]/\]/;
4524 }
4525 }
4526
4527# check spacing on parentheses
4528 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4529 $line !~ /for\s*\(\s+;/) {
4530 if (ERROR("SPACING",
4531 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4532 $fix) {
4533 $fixed[$fixlinenr] =~
4534 s/\(\s+/\(/;
4535 }
4536 }
4537 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4538 $line !~ /for\s*\(.*;\s+\)/ &&
4539 $line !~ /:\s+\)/) {
4540 if (ERROR("SPACING",
4541 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4542 $fix) {
4543 $fixed[$fixlinenr] =~
4544 s/\s+\)/\)/;
4545 }
4546 }
4547
4548# check unnecessary parentheses around addressof/dereference single $Lvals
4549# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4550
4551 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4552 my $var = $1;
4553 if (CHK("UNNECESSARY_PARENTHESES",
4554 "Unnecessary parentheses around $var\n" . $herecurr) &&
4555 $fix) {
4556 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4557 }
4558 }
4559
4560# check for unnecessary parentheses around function pointer uses
4561# ie: (foo->bar)(); should be foo->bar();
4562# but not "if (foo->bar) (" to avoid some false positives
4563 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4564 my $var = $2;
4565 if (CHK("UNNECESSARY_PARENTHESES",
4566 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4567 $fix) {
4568 my $var2 = deparenthesize($var);
4569 $var2 =~ s/\s//g;
4570 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4571 }
4572 }
4573
4574# check for unnecessary parentheses around comparisons in if uses
4575# when !drivers/staging or command-line uses --strict
4576 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4577 $^V && $^V ge 5.10.0 && defined($stat) &&
4578 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4579 my $if_stat = $1;
4580 my $test = substr($2, 1, -1);
4581 my $herectx;
4582 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4583 my $match = $1;
4584 # avoid parentheses around potential macro args
4585 next if ($match =~ /^\s*\w+\s*$/);
4586 if (!defined($herectx)) {
4587 $herectx = $here . "\n";
4588 my $cnt = statement_rawlines($if_stat);
4589 for (my $n = 0; $n < $cnt; $n++) {
4590 my $rl = raw_line($linenr, $n);
4591 $herectx .= $rl . "\n";
4592 last if $rl =~ /^[ \+].*\{/;
4593 }
4594 }
4595 CHK("UNNECESSARY_PARENTHESES",
4596 "Unnecessary parentheses around '$match'\n" . $herectx);
4597 }
4598 }
4599
4600#goto labels aren't indented, allow a single space however
4601 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4602 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4603 if (WARN("INDENTED_LABEL",
4604 "labels should not be indented\n" . $herecurr) &&
4605 $fix) {
4606 $fixed[$fixlinenr] =~
4607 s/^(.)\s+/$1/;
4608 }
4609 }
4610
4611# return is not a function
4612 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4613 my $spacing = $1;
4614 if ($^V && $^V ge 5.10.0 &&
4615 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4616 my $value = $1;
4617 $value = deparenthesize($value);
4618 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4619 ERROR("RETURN_PARENTHESES",
4620 "return is not a function, parentheses are not required\n" . $herecurr);
4621 }
4622 } elsif ($spacing !~ /\s+/) {
4623 ERROR("SPACING",
4624 "space required before the open parenthesis '('\n" . $herecurr);
4625 }
4626 }
4627
4628# unnecessary return in a void function
4629# at end-of-function, with the previous line a single leading tab, then return;
4630# and the line before that not a goto label target like "out:"
4631 if ($sline =~ /^[ \+]}\s*$/ &&
4632 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4633 $linenr >= 3 &&
4634 $lines[$linenr - 3] =~ /^[ +]/ &&
4635 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4636 WARN("RETURN_VOID",
4637 "void function return statements are not generally useful\n" . $hereprev);
4638 }
4639
4640# if statements using unnecessary parentheses - ie: if ((foo == bar))
4641 if ($^V && $^V ge 5.10.0 &&
4642 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4643 my $openparens = $1;
4644 my $count = $openparens =~ tr@\(@\(@;
4645 my $msg = "";
4646 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4647 my $comp = $4; #Not $1 because of $LvalOrFunc
4648 $msg = " - maybe == should be = ?" if ($comp eq "==");
4649 WARN("UNNECESSARY_PARENTHESES",
4650 "Unnecessary parentheses$msg\n" . $herecurr);
4651 }
4652 }
4653
4654# comparisons with a constant or upper case identifier on the left
4655# avoid cases like "foo + BAR < baz"
4656# only fix matches surrounded by parentheses to avoid incorrect
4657# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4658 if ($^V && $^V ge 5.10.0 &&
4659 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4660 my $lead = $1;
4661 my $const = $2;
4662 my $comp = $3;
4663 my $to = $4;
4664 my $newcomp = $comp;
4665 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4666 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4667 WARN("CONSTANT_COMPARISON",
4668 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4669 $fix) {
4670 if ($comp eq "<") {
4671 $newcomp = ">";
4672 } elsif ($comp eq "<=") {
4673 $newcomp = ">=";
4674 } elsif ($comp eq ">") {
4675 $newcomp = "<";
4676 } elsif ($comp eq ">=") {
4677 $newcomp = "<=";
4678 }
4679 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4680 }
4681 }
4682
4683# Return of what appears to be an errno should normally be negative
4684 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4685 my $name = $1;
4686 if ($name ne 'EOF' && $name ne 'ERROR') {
4687 WARN("USE_NEGATIVE_ERRNO",
4688 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4689 }
4690 }
4691
4692# Need a space before open parenthesis after if, while etc
4693 if ($line =~ /\b(if|while|for|switch)\(/) {
4694 if (ERROR("SPACING",
4695 "space required before the open parenthesis '('\n" . $herecurr) &&
4696 $fix) {
4697 $fixed[$fixlinenr] =~
4698 s/\b(if|while|for|switch)\(/$1 \(/;
4699 }
4700 }
4701
4702# Check for illegal assignment in if conditional -- and check for trailing
4703# statements after the conditional.
4704 if ($line =~ /do\s*(?!{)/) {
4705 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4706 ctx_statement_block($linenr, $realcnt, 0)
4707 if (!defined $stat);
4708 my ($stat_next) = ctx_statement_block($line_nr_next,
4709 $remain_next, $off_next);
4710 $stat_next =~ s/\n./\n /g;
4711 ##print "stat<$stat> stat_next<$stat_next>\n";
4712
4713 if ($stat_next =~ /^\s*while\b/) {
4714 # If the statement carries leading newlines,
4715 # then count those as offsets.
4716 my ($whitespace) =
4717 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4718 my $offset =
4719 statement_rawlines($whitespace) - 1;
4720
4721 $suppress_whiletrailers{$line_nr_next +
4722 $offset} = 1;
4723 }
4724 }
4725 if (!defined $suppress_whiletrailers{$linenr} &&
4726 defined($stat) && defined($cond) &&
4727 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4728 my ($s, $c) = ($stat, $cond);
4729
4730 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4731 ERROR("ASSIGN_IN_IF",
4732 "do not use assignment in if condition\n" . $herecurr);
4733 }
4734
4735 # Find out what is on the end of the line after the
4736 # conditional.
4737 substr($s, 0, length($c), '');
4738 $s =~ s/\n.*//g;
4739 $s =~ s/$;//g; # Remove any comments
4740 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4741 $c !~ /}\s*while\s*/)
4742 {
4743 # Find out how long the conditional actually is.
4744 my @newlines = ($c =~ /\n/gs);
4745 my $cond_lines = 1 + $#newlines;
4746 my $stat_real = '';
4747
4748 $stat_real = raw_line($linenr, $cond_lines)
4749 . "\n" if ($cond_lines);
4750 if (defined($stat_real) && $cond_lines > 1) {
4751 $stat_real = "[...]\n$stat_real";
4752 }
4753
4754 ERROR("TRAILING_STATEMENTS",
4755 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4756 }
4757 }
4758
4759# Check for bitwise tests written as boolean
4760 if ($line =~ /
4761 (?:
4762 (?:\[|\(|\&\&|\|\|)
4763 \s*0[xX][0-9]+\s*
4764 (?:\&\&|\|\|)
4765 |
4766 (?:\&\&|\|\|)
4767 \s*0[xX][0-9]+\s*
4768 (?:\&\&|\|\||\)|\])
4769 )/x)
4770 {
4771 WARN("HEXADECIMAL_BOOLEAN_TEST",
4772 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4773 }
4774
4775# if and else should not have general statements after it
4776 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4777 my $s = $1;
4778 $s =~ s/$;//g; # Remove any comments
4779 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4780 ERROR("TRAILING_STATEMENTS",
4781 "trailing statements should be on next line\n" . $herecurr);
4782 }
4783 }
4784# if should not continue a brace
4785 if ($line =~ /}\s*if\b/) {
4786 ERROR("TRAILING_STATEMENTS",
4787 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4788 $herecurr);
4789 }
4790# case and default should not have general statements after them
4791 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4792 $line !~ /\G(?:
4793 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4794 \s*return\s+
4795 )/xg)
4796 {
4797 ERROR("TRAILING_STATEMENTS",
4798 "trailing statements should be on next line\n" . $herecurr);
4799 }
4800
4801 # Check for }<nl>else {, these must be at the same
4802 # indent level to be relevant to each other.
4803 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4804 $previndent == $indent) {
4805 if (ERROR("ELSE_AFTER_BRACE",
4806 "else should follow close brace '}'\n" . $hereprev) &&
4807 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4808 fix_delete_line($fixlinenr - 1, $prevrawline);
4809 fix_delete_line($fixlinenr, $rawline);
4810 my $fixedline = $prevrawline;
4811 $fixedline =~ s/}\s*$//;
4812 if ($fixedline !~ /^\+\s*$/) {
4813 fix_insert_line($fixlinenr, $fixedline);
4814 }
4815 $fixedline = $rawline;
4816 $fixedline =~ s/^(.\s*)else/$1} else/;
4817 fix_insert_line($fixlinenr, $fixedline);
4818 }
4819 }
4820
4821 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4822 $previndent == $indent) {
4823 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4824
4825 # Find out what is on the end of the line after the
4826 # conditional.
4827 substr($s, 0, length($c), '');
4828 $s =~ s/\n.*//g;
4829
4830 if ($s =~ /^\s*;/) {
4831 if (ERROR("WHILE_AFTER_BRACE",
4832 "while should follow close brace '}'\n" . $hereprev) &&
4833 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4834 fix_delete_line($fixlinenr - 1, $prevrawline);
4835 fix_delete_line($fixlinenr, $rawline);
4836 my $fixedline = $prevrawline;
4837 my $trailing = $rawline;
4838 $trailing =~ s/^\+//;
4839 $trailing = trim($trailing);
4840 $fixedline =~ s/}\s*$/} $trailing/;
4841 fix_insert_line($fixlinenr, $fixedline);
4842 }
4843 }
4844 }
4845
4846#Specific variable tests
4847 while ($line =~ m{($Constant|$Lval)}g) {
4848 my $var = $1;
4849
4850#gcc binary extension
4851 if ($var =~ /^$Binary$/) {
4852 if (WARN("GCC_BINARY_CONSTANT",
4853 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4854 $fix) {
4855 my $hexval = sprintf("0x%x", oct($var));
4856 $fixed[$fixlinenr] =~
4857 s/\b$var\b/$hexval/;
4858 }
4859 }
4860
4861#CamelCase
4862 if ($var !~ /^$Constant$/ &&
4863 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4864#Ignore Page<foo> variants
4865 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4866#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4867 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4868#Ignore some three character SI units explicitly, like MiB and KHz
4869 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4870 while ($var =~ m{($Ident)}g) {
4871 my $word = $1;
4872 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4873 if ($check) {
4874 seed_camelcase_includes();
4875 if (!$file && !$camelcase_file_seeded) {
4876 seed_camelcase_file($realfile);
4877 $camelcase_file_seeded = 1;
4878 }
4879 }
4880 if (!defined $camelcase{$word}) {
4881 $camelcase{$word} = 1;
4882 CHK("CAMELCASE",
4883 "Avoid CamelCase: <$word>\n" . $herecurr);
4884 }
4885 }
4886 }
4887 }
4888
4889#no spaces allowed after \ in define
4890 if ($line =~ /\#\s*define.*\\\s+$/) {
4891 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4892 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4893 $fix) {
4894 $fixed[$fixlinenr] =~ s/\s+$//;
4895 }
4896 }
4897
4898# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4899# itself <asm/foo.h> (uses RAW line)
4900 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4901 my $file = "$1.h";
4902 my $checkfile = "include/linux/$file";
4903 if (-f "$root/$checkfile" &&
4904 $realfile ne $checkfile &&
4905 $1 !~ /$allowed_asm_includes/)
4906 {
4907 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4908 if ($asminclude > 0) {
4909 if ($realfile =~ m{^arch/}) {
4910 CHK("ARCH_INCLUDE_LINUX",
4911 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4912 } else {
4913 WARN("INCLUDE_LINUX",
4914 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4915 }
4916 }
4917 }
4918 }
4919
4920# multi-statement macros should be enclosed in a do while loop, grab the
4921# first statement and ensure its the whole macro if its not enclosed
4922# in a known good container
4923 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4924 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4925 my $ln = $linenr;
4926 my $cnt = $realcnt;
4927 my ($off, $dstat, $dcond, $rest);
4928 my $ctx = '';
4929 my $has_flow_statement = 0;
4930 my $has_arg_concat = 0;
4931 ($dstat, $dcond, $ln, $cnt, $off) =
4932 ctx_statement_block($linenr, $realcnt, 0);
4933 $ctx = $dstat;
4934 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4935 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4936
4937 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4938 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4939
4940 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4941 my $define_args = $1;
4942 my $define_stmt = $dstat;
4943 my @def_args = ();
4944
4945 if (defined $define_args && $define_args ne "") {
4946 $define_args = substr($define_args, 1, length($define_args) - 2);
4947 $define_args =~ s/\s*//g;
4948 @def_args = split(",", $define_args);
4949 }
4950
4951 $dstat =~ s/$;//g;
4952 $dstat =~ s/\\\n.//g;
4953 $dstat =~ s/^\s*//s;
4954 $dstat =~ s/\s*$//s;
4955
4956 # Flatten any parentheses and braces
4957 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4958 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4959 $dstat =~ s/.\[[^\[\]]*\]/1/)
4960 {
4961 }
4962
4963 # Flatten any obvious string concatentation.
4964 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4965 $dstat =~ s/$Ident\s*($String)/$1/)
4966 {
4967 }
4968
4969 # Make asm volatile uses seem like a generic function
4970 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4971
4972 my $exceptions = qr{
4973 $Declare|
4974 module_param_named|
4975 MODULE_PARM_DESC|
4976 DECLARE_PER_CPU|
4977 DEFINE_PER_CPU|
4978 __typeof__\(|
4979 union|
4980 struct|
4981 \.$Ident\s*=\s*|
4982 ^\"|\"$|
4983 ^\[
4984 }x;
4985 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4986
4987 $ctx =~ s/\n*$//;
4988 my $stmt_cnt = statement_rawlines($ctx);
4989 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
4990
4991 if ($dstat ne '' &&
4992 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4993 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4994 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4995 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4996 $dstat !~ /$exceptions/ &&
4997 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4998 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4999 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5000 $dstat !~ /^for\s*$Constant$/ && # for (...)
5001 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5002 $dstat !~ /^do\s*{/ && # do {...
5003 $dstat !~ /^\(\{/ && # ({...
5004 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5005 {
5006 if ($dstat =~ /^\s*if\b/) {
5007 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5008 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5009 } elsif ($dstat =~ /;/) {
5010 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5011 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5012 } else {
5013 ERROR("COMPLEX_MACRO",
5014 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5015 }
5016
5017 }
5018
5019 # Make $define_stmt single line, comment-free, etc
5020 my @stmt_array = split('\n', $define_stmt);
5021 my $first = 1;
5022 $define_stmt = "";
5023 foreach my $l (@stmt_array) {
5024 $l =~ s/\\$//;
5025 if ($first) {
5026 $define_stmt = $l;
5027 $first = 0;
5028 } elsif ($l =~ /^[\+ ]/) {
5029 $define_stmt .= substr($l, 1);
5030 }
5031 }
5032 $define_stmt =~ s/$;//g;
5033 $define_stmt =~ s/\s+/ /g;
5034 $define_stmt = trim($define_stmt);
5035
5036# check if any macro arguments are reused (ignore '...' and 'type')
5037 foreach my $arg (@def_args) {
5038 next if ($arg =~ /\.\.\./);
5039 next if ($arg =~ /^type$/i);
5040 my $tmp_stmt = $define_stmt;
5041 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5042 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5043 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5044 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5045 if ($use_cnt > 1) {
5046 CHK("MACRO_ARG_REUSE",
5047 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5048 }
5049# check if any macro arguments may have other precedence issues
5050 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5051 ((defined($1) && $1 ne ',') ||
5052 (defined($2) && $2 ne ','))) {
5053 CHK("MACRO_ARG_PRECEDENCE",
5054 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5055 }
5056 }
5057
5058# check for macros with flow control, but without ## concatenation
5059# ## concatenation is commonly a macro that defines a function so ignore those
5060 if ($has_flow_statement && !$has_arg_concat) {
5061 my $cnt = statement_rawlines($ctx);
5062 my $herectx = get_stat_here($linenr, $cnt, $here);
5063
5064 WARN("MACRO_WITH_FLOW_CONTROL",
5065 "Macros with flow control statements should be avoided\n" . "$herectx");
5066 }
5067
5068# check for line continuations outside of #defines, preprocessor #, and asm
5069
5070 } else {
5071 if ($prevline !~ /^..*\\$/ &&
5072 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5073 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5074 $line =~ /^\+.*\\$/) {
5075 WARN("LINE_CONTINUATIONS",
5076 "Avoid unnecessary line continuations\n" . $herecurr);
5077 }
5078 }
5079
5080# do {} while (0) macro tests:
5081# single-statement macros do not need to be enclosed in do while (0) loop,
5082# macro should not end with a semicolon
5083 if ($^V && $^V ge 5.10.0 &&
5084 $realfile !~ m@/vmlinux.lds.h$@ &&
5085 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5086 my $ln = $linenr;
5087 my $cnt = $realcnt;
5088 my ($off, $dstat, $dcond, $rest);
5089 my $ctx = '';
5090 ($dstat, $dcond, $ln, $cnt, $off) =
5091 ctx_statement_block($linenr, $realcnt, 0);
5092 $ctx = $dstat;
5093
5094 $dstat =~ s/\\\n.//g;
5095 $dstat =~ s/$;/ /g;
5096
5097 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5098 my $stmts = $2;
5099 my $semis = $3;
5100
5101 $ctx =~ s/\n*$//;
5102 my $cnt = statement_rawlines($ctx);
5103 my $herectx = get_stat_here($linenr, $cnt, $here);
5104
5105 if (($stmts =~ tr/;/;/) == 1 &&
5106 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5107 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5108 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5109 }
5110 if (defined $semis && $semis ne "") {
5111 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5112 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5113 }
5114 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5115 $ctx =~ s/\n*$//;
5116 my $cnt = statement_rawlines($ctx);
5117 my $herectx = get_stat_here($linenr, $cnt, $here);
5118
5119 WARN("TRAILING_SEMICOLON",
5120 "macros should not use a trailing semicolon\n" . "$herectx");
5121 }
5122 }
5123
5124# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5125# all assignments may have only one of the following with an assignment:
5126# .
5127# ALIGN(...)
5128# VMLINUX_SYMBOL(...)
5129 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
5130 WARN("MISSING_VMLINUX_SYMBOL",
5131 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
5132 }
5133
5134# check for redundant bracing round if etc
5135 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5136 my ($level, $endln, @chunks) =
5137 ctx_statement_full($linenr, $realcnt, 1);
5138 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5139 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5140 if ($#chunks > 0 && $level == 0) {
5141 my @allowed = ();
5142 my $allow = 0;
5143 my $seen = 0;
5144 my $herectx = $here . "\n";
5145 my $ln = $linenr - 1;
5146 for my $chunk (@chunks) {
5147 my ($cond, $block) = @{$chunk};
5148
5149 # If the condition carries leading newlines, then count those as offsets.
5150 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5151 my $offset = statement_rawlines($whitespace) - 1;
5152
5153 $allowed[$allow] = 0;
5154 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5155
5156 # We have looked at and allowed this specific line.
5157 $suppress_ifbraces{$ln + $offset} = 1;
5158
5159 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5160 $ln += statement_rawlines($block) - 1;
5161
5162 substr($block, 0, length($cond), '');
5163
5164 $seen++ if ($block =~ /^\s*{/);
5165
5166 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5167 if (statement_lines($cond) > 1) {
5168 #print "APW: ALLOWED: cond<$cond>\n";
5169 $allowed[$allow] = 1;
5170 }
5171 if ($block =~/\b(?:if|for|while)\b/) {
5172 #print "APW: ALLOWED: block<$block>\n";
5173 $allowed[$allow] = 1;
5174 }
5175 if (statement_block_size($block) > 1) {
5176 #print "APW: ALLOWED: lines block<$block>\n";
5177 $allowed[$allow] = 1;
5178 }
5179 $allow++;
5180 }
5181 if ($seen) {
5182 my $sum_allowed = 0;
5183 foreach (@allowed) {
5184 $sum_allowed += $_;
5185 }
5186 if ($sum_allowed == 0) {
5187 WARN("BRACES",
5188 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5189 } elsif ($sum_allowed != $allow &&
5190 $seen != $allow) {
5191 CHK("BRACES",
5192 "braces {} should be used on all arms of this statement\n" . $herectx);
5193 }
5194 }
5195 }
5196 }
5197 if (!defined $suppress_ifbraces{$linenr - 1} &&
5198 $line =~ /\b(if|while|for|else)\b/) {
5199 my $allowed = 0;
5200
5201 # Check the pre-context.
5202 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5203 #print "APW: ALLOWED: pre<$1>\n";
5204 $allowed = 1;
5205 }
5206
5207 my ($level, $endln, @chunks) =
5208 ctx_statement_full($linenr, $realcnt, $-[0]);
5209
5210 # Check the condition.
5211 my ($cond, $block) = @{$chunks[0]};
5212 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5213 if (defined $cond) {
5214 substr($block, 0, length($cond), '');
5215 }
5216 if (statement_lines($cond) > 1) {
5217 #print "APW: ALLOWED: cond<$cond>\n";
5218 $allowed = 1;
5219 }
5220 if ($block =~/\b(?:if|for|while)\b/) {
5221 #print "APW: ALLOWED: block<$block>\n";
5222 $allowed = 1;
5223 }
5224 if (statement_block_size($block) > 1) {
5225 #print "APW: ALLOWED: lines block<$block>\n";
5226 $allowed = 1;
5227 }
5228 # Check the post-context.
5229 if (defined $chunks[1]) {
5230 my ($cond, $block) = @{$chunks[1]};
5231 if (defined $cond) {
5232 substr($block, 0, length($cond), '');
5233 }
5234 if ($block =~ /^\s*\{/) {
5235 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5236 $allowed = 1;
5237 }
5238 }
5239 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5240 my $cnt = statement_rawlines($block);
5241 my $herectx = get_stat_here($linenr, $cnt, $here);
5242
5243 WARN("BRACES",
5244 "braces {} are not necessary for single statement blocks\n" . $herectx);
5245 }
5246 }
5247
5248# check for single line unbalanced braces
5249 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5250 $sline =~ /^.\s*else\s*\{\s*$/) {
5251 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5252 }
5253
5254# check for unnecessary blank lines around braces
5255 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5256 if (CHK("BRACES",
5257 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5258 $fix && $prevrawline =~ /^\+/) {
5259 fix_delete_line($fixlinenr - 1, $prevrawline);
5260 }
5261 }
5262 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5263 if (CHK("BRACES",
5264 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5265 $fix) {
5266 fix_delete_line($fixlinenr, $rawline);
5267 }
5268 }
5269
5270# no volatiles please
5271 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5272 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5273 WARN("VOLATILE",
5274 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5275 }
5276
5277# Check for user-visible strings broken across lines, which breaks the ability
5278# to grep for the string. Make exceptions when the previous string ends in a
5279# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5280# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5281 if ($line =~ /^\+\s*$String/ &&
5282 $prevline =~ /"\s*$/ &&
5283 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5284 if (WARN("SPLIT_STRING",
5285 "quoted string split across lines\n" . $hereprev) &&
5286 $fix &&
5287 $prevrawline =~ /^\+.*"\s*$/ &&
5288 $last_coalesced_string_linenr != $linenr - 1) {
5289 my $extracted_string = get_quoted_string($line, $rawline);
5290 my $comma_close = "";
5291 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5292 $comma_close = $1;
5293 }
5294
5295 fix_delete_line($fixlinenr - 1, $prevrawline);
5296 fix_delete_line($fixlinenr, $rawline);
5297 my $fixedline = $prevrawline;
5298 $fixedline =~ s/"\s*$//;
5299 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5300 fix_insert_line($fixlinenr - 1, $fixedline);
5301 $fixedline = $rawline;
5302 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5303 if ($fixedline !~ /\+\s*$/) {
5304 fix_insert_line($fixlinenr, $fixedline);
5305 }
5306 $last_coalesced_string_linenr = $linenr;
5307 }
5308 }
5309
5310# check for missing a space in a string concatenation
5311 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5312 WARN('MISSING_SPACE',
5313 "break quoted strings at a space character\n" . $hereprev);
5314 }
5315
5316# check for an embedded function name in a string when the function is known
5317# This does not work very well for -f --file checking as it depends on patch
5318# context providing the function name or a single line form for in-file
5319# function declarations
5320 if ($line =~ /^\+.*$String/ &&
5321 defined($context_function) &&
5322 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5323 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5324 WARN("EMBEDDED_FUNCTION_NAME",
5325 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5326 }
5327
5328# check for spaces before a quoted newline
5329 if ($rawline =~ /^.*\".*\s\\n/) {
5330 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5331 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5332 $fix) {
5333 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5334 }
5335
5336 }
5337
5338# concatenated string without spaces between elements
5339 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5340 CHK("CONCATENATED_STRING",
5341 "Concatenated strings should use spaces between elements\n" . $herecurr);
5342 }
5343
5344# uncoalesced string fragments
5345 if ($line =~ /$String\s*"/) {
5346 WARN("STRING_FRAGMENTS",
5347 "Consecutive strings are generally better as a single string\n" . $herecurr);
5348 }
5349
5350# check for non-standard and hex prefixed decimal printf formats
5351 my $show_L = 1; #don't show the same defect twice
5352 my $show_Z = 1;
5353 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5354 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5355 $string =~ s/%%/__/g;
5356 # check for %L
5357 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5358 WARN("PRINTF_L",
5359 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5360 $show_L = 0;
5361 }
5362 # check for %Z
5363 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5364 WARN("PRINTF_Z",
5365 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5366 $show_Z = 0;
5367 }
5368 # check for 0x<decimal>
5369 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5370 ERROR("PRINTF_0XDECIMAL",
5371 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5372 }
5373 }
5374
5375# check for line continuations in quoted strings with odd counts of "
5376 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5377 WARN("LINE_CONTINUATIONS",
5378 "Avoid line continuations in quoted strings\n" . $herecurr);
5379 }
5380
5381# warn about #if 0
5382 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5383 CHK("REDUNDANT_CODE",
5384 "if this code is redundant consider removing it\n" .
5385 $herecurr);
5386 }
5387
5388# check for needless "if (<foo>) fn(<foo>)" uses
5389 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5390 my $tested = quotemeta($1);
5391 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5392 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5393 my $func = $1;
5394 if (WARN('NEEDLESS_IF',
5395 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5396 $fix) {
5397 my $do_fix = 1;
5398 my $leading_tabs = "";
5399 my $new_leading_tabs = "";
5400 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5401 $leading_tabs = $1;
5402 } else {
5403 $do_fix = 0;
5404 }
5405 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5406 $new_leading_tabs = $1;
5407 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5408 $do_fix = 0;
5409 }
5410 } else {
5411 $do_fix = 0;
5412 }
5413 if ($do_fix) {
5414 fix_delete_line($fixlinenr - 1, $prevrawline);
5415 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5416 }
5417 }
5418 }
5419 }
5420
5421# check for unnecessary "Out of Memory" messages
5422 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5423 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5424 (defined $1 || defined $3) &&
5425 $linenr > 3) {
5426 my $testval = $2;
5427 my $testline = $lines[$linenr - 3];
5428
5429 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5430# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5431
5432 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5433 WARN("OOM_MESSAGE",
5434 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5435 }
5436 }
5437
5438# check for logging functions with KERN_<LEVEL>
5439 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5440 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5441 my $level = $1;
5442 if (WARN("UNNECESSARY_KERN_LEVEL",
5443 "Possible unnecessary $level\n" . $herecurr) &&
5444 $fix) {
5445 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5446 }
5447 }
5448
5449# check for logging continuations
5450 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5451 WARN("LOGGING_CONTINUATION",
5452 "Avoid logging continuation uses where feasible\n" . $herecurr);
5453 }
5454
5455# check for mask then right shift without a parentheses
5456 if ($^V && $^V ge 5.10.0 &&
5457 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5458 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5459 WARN("MASK_THEN_SHIFT",
5460 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5461 }
5462
5463# check for pointer comparisons to NULL
5464 if ($^V && $^V ge 5.10.0) {
5465 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5466 my $val = $1;
5467 my $equal = "!";
5468 $equal = "" if ($4 eq "!=");
5469 if (CHK("COMPARISON_TO_NULL",
5470 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5471 $fix) {
5472 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5473 }
5474 }
5475 }
5476
5477# check for bad placement of section $InitAttribute (e.g.: __initdata)
5478 if ($line =~ /(\b$InitAttribute\b)/) {
5479 my $attr = $1;
5480 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5481 my $ptr = $1;
5482 my $var = $2;
5483 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5484 ERROR("MISPLACED_INIT",
5485 "$attr should be placed after $var\n" . $herecurr)) ||
5486 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5487 WARN("MISPLACED_INIT",
5488 "$attr should be placed after $var\n" . $herecurr))) &&
5489 $fix) {
5490 $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;
5491 }
5492 }
5493 }
5494
5495# check for $InitAttributeData (ie: __initdata) with const
5496 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5497 my $attr = $1;
5498 $attr =~ /($InitAttributePrefix)(.*)/;
5499 my $attr_prefix = $1;
5500 my $attr_type = $2;
5501 if (ERROR("INIT_ATTRIBUTE",
5502 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5503 $fix) {
5504 $fixed[$fixlinenr] =~
5505 s/$InitAttributeData/${attr_prefix}initconst/;
5506 }
5507 }
5508
5509# check for $InitAttributeConst (ie: __initconst) without const
5510 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5511 my $attr = $1;
5512 if (ERROR("INIT_ATTRIBUTE",
5513 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5514 $fix) {
5515 my $lead = $fixed[$fixlinenr] =~
5516 /(^\+\s*(?:static\s+))/;
5517 $lead = rtrim($1);
5518 $lead = "$lead " if ($lead !~ /^\+$/);
5519 $lead = "${lead}const ";
5520 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5521 }
5522 }
5523
5524# check for __read_mostly with const non-pointer (should just be const)
5525 if ($line =~ /\b__read_mostly\b/ &&
5526 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5527 if (ERROR("CONST_READ_MOSTLY",
5528 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5529 $fix) {
5530 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5531 }
5532 }
5533
5534# don't use __constant_<foo> functions outside of include/uapi/
5535 if ($realfile !~ m@^include/uapi/@ &&
5536 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5537 my $constant_func = $1;
5538 my $func = $constant_func;
5539 $func =~ s/^__constant_//;
5540 if (WARN("CONSTANT_CONVERSION",
5541 "$constant_func should be $func\n" . $herecurr) &&
5542 $fix) {
5543 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5544 }
5545 }
5546
5547# prefer usleep_range over udelay
5548 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5549 my $delay = $1;
5550 # ignore udelay's < 10, however
5551 if (! ($delay < 10) ) {
5552 CHK("USLEEP_RANGE",
5553 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5554 }
5555 if ($delay > 2000) {
5556 WARN("LONG_UDELAY",
5557 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5558 }
5559 }
5560
5561# warn about unexpectedly long msleep's
5562 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5563 if ($1 < 20) {
5564 WARN("MSLEEP",
5565 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5566 }
5567 }
5568
5569# check for comparisons of jiffies
5570 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5571 WARN("JIFFIES_COMPARISON",
5572 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5573 }
5574
5575# check for comparisons of get_jiffies_64()
5576 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5577 WARN("JIFFIES_COMPARISON",
5578 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5579 }
5580
5581# warn about #ifdefs in C files
5582# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5583# print "#ifdef in C files should be avoided\n";
5584# print "$herecurr";
5585# $clean = 0;
5586# }
5587
5588# warn about spacing in #ifdefs
5589 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5590 if (ERROR("SPACING",
5591 "exactly one space required after that #$1\n" . $herecurr) &&
5592 $fix) {
5593 $fixed[$fixlinenr] =~
5594 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5595 }
5596
5597 }
5598
5599# check for spinlock_t definitions without a comment.
5600 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5601 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5602 my $which = $1;
5603 if (!ctx_has_comment($first_line, $linenr)) {
5604 CHK("UNCOMMENTED_DEFINITION",
5605 "$1 definition without comment\n" . $herecurr);
5606 }
5607 }
5608# check for memory barriers without a comment.
5609
5610 my $barriers = qr{
5611 mb|
5612 rmb|
5613 wmb|
5614 read_barrier_depends
5615 }x;
5616 my $barrier_stems = qr{
5617 mb__before_atomic|
5618 mb__after_atomic|
5619 store_release|
5620 load_acquire|
5621 store_mb|
5622 (?:$barriers)
5623 }x;
5624 my $all_barriers = qr{
5625 (?:$barriers)|
5626 smp_(?:$barrier_stems)|
5627 virt_(?:$barrier_stems)
5628 }x;
5629
5630 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5631 if (!ctx_has_comment($first_line, $linenr)) {
5632 WARN("MEMORY_BARRIER",
5633 "memory barrier without comment\n" . $herecurr);
5634 }
5635 }
5636
5637 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5638
5639 if ($realfile !~ m@^include/asm-generic/@ &&
5640 $realfile !~ m@/barrier\.h$@ &&
5641 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5642 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5643 WARN("MEMORY_BARRIER",
5644 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5645 }
5646
5647# check for waitqueue_active without a comment.
5648 if ($line =~ /\bwaitqueue_active\s*\(/) {
5649 if (!ctx_has_comment($first_line, $linenr)) {
5650 WARN("WAITQUEUE_ACTIVE",
5651 "waitqueue_active without comment\n" . $herecurr);
5652 }
5653 }
5654
5655# check for smp_read_barrier_depends and read_barrier_depends
5656 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5657 WARN("READ_BARRIER_DEPENDS",
5658 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5659 }
5660
5661# check of hardware specific defines
5662 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5663 CHK("ARCH_DEFINES",
5664 "architecture specific defines should be avoided\n" . $herecurr);
5665 }
5666
5667# check that the storage class is not after a type
5668 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5669 WARN("STORAGE_CLASS",
5670 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5671 }
5672# Check that the storage class is at the beginning of a declaration
5673 if ($line =~ /\b$Storage\b/ &&
5674 $line !~ /^.\s*$Storage/ &&
5675 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5676 $1 !~ /[\,\)]\s*$/) {
5677 WARN("STORAGE_CLASS",
5678 "storage class should be at the beginning of the declaration\n" . $herecurr);
5679 }
5680
5681# check the location of the inline attribute, that it is between
5682# storage class and type.
5683 if ($line =~ /\b$Type\s+$Inline\b/ ||
5684 $line =~ /\b$Inline\s+$Storage\b/) {
5685 ERROR("INLINE_LOCATION",
5686 "inline keyword should sit between storage class and type\n" . $herecurr);
5687 }
5688
5689# Check for __inline__ and __inline, prefer inline
5690 if ($realfile !~ m@\binclude/uapi/@ &&
5691 $line =~ /\b(__inline__|__inline)\b/) {
5692 if (WARN("INLINE",
5693 "plain inline is preferred over $1\n" . $herecurr) &&
5694 $fix) {
5695 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5696
5697 }
5698 }
5699
5700# Check for __attribute__ packed, prefer __packed
5701 if ($realfile !~ m@\binclude/uapi/@ &&
5702 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5703 WARN("PREFER_PACKED",
5704 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5705 }
5706
5707# Check for __attribute__ aligned, prefer __aligned
5708 if ($realfile !~ m@\binclude/uapi/@ &&
5709 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5710 WARN("PREFER_ALIGNED",
5711 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5712 }
5713
5714# Check for __attribute__ format(printf, prefer __printf
5715 if ($realfile !~ m@\binclude/uapi/@ &&
5716 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5717 if (WARN("PREFER_PRINTF",
5718 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5719 $fix) {
5720 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5721
5722 }
5723 }
5724
5725# Check for __attribute__ format(scanf, prefer __scanf
5726 if ($realfile !~ m@\binclude/uapi/@ &&
5727 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5728 if (WARN("PREFER_SCANF",
5729 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5730 $fix) {
5731 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5732 }
5733 }
5734
5735# Check for __attribute__ weak, or __weak declarations (may have link issues)
5736 if ($^V && $^V ge 5.10.0 &&
5737 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5738 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5739 $line =~ /\b__weak\b/)) {
5740 ERROR("WEAK_DECLARATION",
5741 "Using weak declarations can have unintended link defects\n" . $herecurr);
5742 }
5743
5744# check for c99 types like uint8_t used outside of uapi/ and tools/
5745 if ($realfile !~ m@\binclude/uapi/@ &&
5746 $realfile !~ m@\btools/@ &&
5747 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5748 my $type = $1;
5749 if ($type =~ /\b($typeC99Typedefs)\b/) {
5750 $type = $1;
5751 my $kernel_type = 'u';
5752 $kernel_type = 's' if ($type =~ /^_*[si]/);
5753 $type =~ /(\d+)/;
5754 $kernel_type .= $1;
5755 if (CHK("PREFER_KERNEL_TYPES",
5756 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5757 $fix) {
5758 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5759 }
5760 }
5761 }
5762
5763# check for cast of C90 native int or longer types constants
5764 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5765 my $cast = $1;
5766 my $const = $2;
5767 if (WARN("TYPECAST_INT_CONSTANT",
5768 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5769 $fix) {
5770 my $suffix = "";
5771 my $newconst = $const;
5772 $newconst =~ s/${Int_type}$//;
5773 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5774 if ($cast =~ /\blong\s+long\b/) {
5775 $suffix .= 'LL';
5776 } elsif ($cast =~ /\blong\b/) {
5777 $suffix .= 'L';
5778 }
5779 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5780 }
5781 }
5782
5783# check for sizeof(&)
5784 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5785 WARN("SIZEOF_ADDRESS",
5786 "sizeof(& should be avoided\n" . $herecurr);
5787 }
5788
5789# check for sizeof without parenthesis
5790 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5791 if (WARN("SIZEOF_PARENTHESIS",
5792 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5793 $fix) {
5794 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5795 }
5796 }
5797
5798# check for struct spinlock declarations
5799 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5800 WARN("USE_SPINLOCK_T",
5801 "struct spinlock should be spinlock_t\n" . $herecurr);
5802 }
5803
5804# check for seq_printf uses that could be seq_puts
5805 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5806 my $fmt = get_quoted_string($line, $rawline);
5807 $fmt =~ s/%%//g;
5808 if ($fmt !~ /%/) {
5809 if (WARN("PREFER_SEQ_PUTS",
5810 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5811 $fix) {
5812 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5813 }
5814 }
5815 }
5816
5817# check for vsprintf extension %p<foo> misuses
5818 if ($^V && $^V ge 5.10.0 &&
5819 defined $stat &&
5820 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5821 $1 !~ /^_*volatile_*$/) {
5822 my $specifier;
5823 my $extension;
5824 my $bad_specifier = "";
5825 my $stat_real;
5826
5827 my $lc = $stat =~ tr@\n@@;
5828 $lc = $lc + $linenr;
5829 for (my $count = $linenr; $count <= $lc; $count++) {
5830 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5831 $fmt =~ s/%%//g;
5832
5833 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5834 $specifier = $1;
5835 $extension = $2;
5836 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5837 $bad_specifier = $specifier;
5838 last;
5839 }
5840 if ($extension eq "x" && !defined($stat_real)) {
5841 if (!defined($stat_real)) {
5842 $stat_real = get_stat_real($linenr, $lc);
5843 }
5844 WARN("VSPRINTF_SPECIFIER_PX",
5845 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5846 }
5847 }
5848 if ($bad_specifier ne "") {
5849 my $stat_real = get_stat_real($linenr, $lc);
5850 my $ext_type = "Invalid";
5851 my $use = "";
5852 if ($bad_specifier =~ /p[Ff]/) {
5853 $ext_type = "Deprecated";
5854 $use = " - use %pS instead";
5855 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5856 }
5857
5858 WARN("VSPRINTF_POINTER_EXTENSION",
5859 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5860 }
5861 }
5862 }
5863
5864# Check for misused memsets
5865 if ($^V && $^V ge 5.10.0 &&
5866 defined $stat &&
5867 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5868
5869 my $ms_addr = $2;
5870 my $ms_val = $7;
5871 my $ms_size = $12;
5872
5873 if ($ms_size =~ /^(0x|)0$/i) {
5874 ERROR("MEMSET",
5875 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5876 } elsif ($ms_size =~ /^(0x|)1$/i) {
5877 WARN("MEMSET",
5878 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5879 }
5880 }
5881
5882# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5883# if ($^V && $^V ge 5.10.0 &&
5884# defined $stat &&
5885# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5886# if (WARN("PREFER_ETHER_ADDR_COPY",
5887# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5888# $fix) {
5889# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5890# }
5891# }
5892
5893# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5894# if ($^V && $^V ge 5.10.0 &&
5895# defined $stat &&
5896# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5897# WARN("PREFER_ETHER_ADDR_EQUAL",
5898# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5899# }
5900
5901# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5902# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5903# if ($^V && $^V ge 5.10.0 &&
5904# defined $stat &&
5905# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5906#
5907# my $ms_val = $7;
5908#
5909# if ($ms_val =~ /^(?:0x|)0+$/i) {
5910# if (WARN("PREFER_ETH_ZERO_ADDR",
5911# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5912# $fix) {
5913# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5914# }
5915# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5916# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5917# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5918# $fix) {
5919# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5920# }
5921# }
5922# }
5923
5924# typecasts on min/max could be min_t/max_t
5925 if ($^V && $^V ge 5.10.0 &&
5926 defined $stat &&
5927 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5928 if (defined $2 || defined $7) {
5929 my $call = $1;
5930 my $cast1 = deparenthesize($2);
5931 my $arg1 = $3;
5932 my $cast2 = deparenthesize($7);
5933 my $arg2 = $8;
5934 my $cast;
5935
5936 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5937 $cast = "$cast1 or $cast2";
5938 } elsif ($cast1 ne "") {
5939 $cast = $cast1;
5940 } else {
5941 $cast = $cast2;
5942 }
5943 WARN("MINMAX",
5944 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5945 }
5946 }
5947
5948# check usleep_range arguments
5949 if ($^V && $^V ge 5.10.0 &&
5950 defined $stat &&
5951 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5952 my $min = $1;
5953 my $max = $7;
5954 if ($min eq $max) {
5955 WARN("USLEEP_RANGE",
5956 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5957 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5958 $min > $max) {
5959 WARN("USLEEP_RANGE",
5960 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5961 }
5962 }
5963
5964# check for naked sscanf
5965 if ($^V && $^V ge 5.10.0 &&
5966 defined $stat &&
5967 $line =~ /\bsscanf\b/ &&
5968 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5969 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5970 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5971 my $lc = $stat =~ tr@\n@@;
5972 $lc = $lc + $linenr;
5973 my $stat_real = get_stat_real($linenr, $lc);
5974 WARN("NAKED_SSCANF",
5975 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5976 }
5977
5978# check for simple sscanf that should be kstrto<foo>
5979 if ($^V && $^V ge 5.10.0 &&
5980 defined $stat &&
5981 $line =~ /\bsscanf\b/) {
5982 my $lc = $stat =~ tr@\n@@;
5983 $lc = $lc + $linenr;
5984 my $stat_real = get_stat_real($linenr, $lc);
5985 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5986 my $format = $6;
5987 my $count = $format =~ tr@%@%@;
5988 if ($count == 1 &&
5989 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5990 WARN("SSCANF_TO_KSTRTO",
5991 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5992 }
5993 }
5994 }
5995
5996# check for new externs in .h files.
5997 if ($realfile =~ /\.h$/ &&
5998 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5999 if (CHK("AVOID_EXTERNS",
6000 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6001 $fix) {
6002 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6003 }
6004 }
6005
6006# check for new externs in .c files.
6007 if ($realfile =~ /\.c$/ && defined $stat &&
6008 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6009 {
6010 my $function_name = $1;
6011 my $paren_space = $2;
6012
6013 my $s = $stat;
6014 if (defined $cond) {
6015 substr($s, 0, length($cond), '');
6016 }
6017 if ($s =~ /^\s*;/ &&
6018 $function_name ne 'uninitialized_var')
6019 {
6020 WARN("AVOID_EXTERNS",
6021 "externs should be avoided in .c files\n" . $herecurr);
6022 }
6023
6024 if ($paren_space =~ /\n/) {
6025 WARN("FUNCTION_ARGUMENTS",
6026 "arguments for function declarations should follow identifier\n" . $herecurr);
6027 }
6028
6029 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6030 $stat =~ /^.\s*extern\s+/)
6031 {
6032 WARN("AVOID_EXTERNS",
6033 "externs should be avoided in .c files\n" . $herecurr);
6034 }
6035
6036# check for function declarations that have arguments without identifier names
6037 if (defined $stat &&
6038 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6039 $1 ne "void") {
6040 my $args = trim($1);
6041 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6042 my $arg = trim($1);
6043 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6044 WARN("FUNCTION_ARGUMENTS",
6045 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6046 }
6047 }
6048 }
6049
6050# check for function definitions
6051 if ($^V && $^V ge 5.10.0 &&
6052 defined $stat &&
6053 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6054 $context_function = $1;
6055
6056# check for multiline function definition with misplaced open brace
6057 my $ok = 0;
6058 my $cnt = statement_rawlines($stat);
6059 my $herectx = $here . "\n";
6060 for (my $n = 0; $n < $cnt; $n++) {
6061 my $rl = raw_line($linenr, $n);
6062 $herectx .= $rl . "\n";
6063 $ok = 1 if ($rl =~ /^[ \+]\{/);
6064 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6065 last if $rl =~ /^[ \+].*\{/;
6066 }
6067 if (!$ok) {
6068 ERROR("OPEN_BRACE",
6069 "open brace '{' following function definitions go on the next line\n" . $herectx);
6070 }
6071 }
6072
6073# checks for new __setup's
6074 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6075 my $name = $1;
6076
6077 if (!grep(/$name/, @setup_docs)) {
6078 CHK("UNDOCUMENTED_SETUP",
6079 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6080 }
6081 }
6082
6083# check for pointless casting of kmalloc return
6084 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
6085 WARN("UNNECESSARY_CASTS",
6086 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6087 }
6088
6089# alloc style
6090# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6091 if ($^V && $^V ge 5.10.0 &&
6092 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6093 CHK("ALLOC_SIZEOF_STRUCT",
6094 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6095 }
6096
6097# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6098 if ($^V && $^V ge 5.10.0 &&
6099 defined $stat &&
6100 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6101 my $oldfunc = $3;
6102 my $a1 = $4;
6103 my $a2 = $10;
6104 my $newfunc = "kmalloc_array";
6105 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6106 my $r1 = $a1;
6107 my $r2 = $a2;
6108 if ($a1 =~ /^sizeof\s*\S/) {
6109 $r1 = $a2;
6110 $r2 = $a1;
6111 }
6112 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6113 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6114 my $cnt = statement_rawlines($stat);
6115 my $herectx = get_stat_here($linenr, $cnt, $here);
6116
6117 if (WARN("ALLOC_WITH_MULTIPLY",
6118 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6119 $cnt == 1 &&
6120 $fix) {
6121 $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;
6122 }
6123 }
6124 }
6125
6126# check for krealloc arg reuse
6127 if ($^V && $^V ge 5.10.0 &&
6128 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6129 WARN("KREALLOC_ARG_REUSE",
6130 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6131 }
6132
6133# check for alloc argument mismatch
6134 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6135 WARN("ALLOC_ARRAY_ARGS",
6136 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6137 }
6138
6139# check for multiple semicolons
6140 if ($line =~ /;\s*;\s*$/) {
6141 if (WARN("ONE_SEMICOLON",
6142 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6143 $fix) {
6144 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6145 }
6146 }
6147
6148# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6149 if ($realfile !~ m@^include/uapi/@ &&
6150 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6151 my $ull = "";
6152 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6153 if (CHK("BIT_MACRO",
6154 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6155 $fix) {
6156 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6157 }
6158 }
6159
6160# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6161 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6162 my $config = $1;
6163 if (WARN("PREFER_IS_ENABLED",
6164 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6165 $fix) {
6166 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6167 }
6168 }
6169
6170# check for case / default statements not preceded by break/fallthrough/switch
6171 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6172 my $has_break = 0;
6173 my $has_statement = 0;
6174 my $count = 0;
6175 my $prevline = $linenr;
6176 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6177 $prevline--;
6178 my $rline = $rawlines[$prevline - 1];
6179 my $fline = $lines[$prevline - 1];
6180 last if ($fline =~ /^\@\@/);
6181 next if ($fline =~ /^\-/);
6182 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6183 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6184 next if ($fline =~ /^.[\s$;]*$/);
6185 $has_statement = 1;
6186 $count++;
6187 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6188 }
6189 if (!$has_break && $has_statement) {
6190 WARN("MISSING_BREAK",
6191 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6192 }
6193 }
6194
6195# check for switch/default statements without a break;
6196 if ($^V && $^V ge 5.10.0 &&
6197 defined $stat &&
6198 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6199 my $cnt = statement_rawlines($stat);
6200 my $herectx = get_stat_here($linenr, $cnt, $here);
6201
6202 WARN("DEFAULT_NO_BREAK",
6203 "switch default: should use break\n" . $herectx);
6204 }
6205
6206# check for gcc specific __FUNCTION__
6207 if ($line =~ /\b__FUNCTION__\b/) {
6208 if (WARN("USE_FUNC",
6209 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6210 $fix) {
6211 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6212 }
6213 }
6214
6215# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6216 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6217 ERROR("DATE_TIME",
6218 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6219 }
6220
6221# check for use of yield()
6222 if ($line =~ /\byield\s*\(\s*\)/) {
6223 WARN("YIELD",
6224 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6225 }
6226
6227# check for comparisons against true and false
6228 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6229 my $lead = $1;
6230 my $arg = $2;
6231 my $test = $3;
6232 my $otype = $4;
6233 my $trail = $5;
6234 my $op = "!";
6235
6236 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6237
6238 my $type = lc($otype);
6239 if ($type =~ /^(?:true|false)$/) {
6240 if (("$test" eq "==" && "$type" eq "true") ||
6241 ("$test" eq "!=" && "$type" eq "false")) {
6242 $op = "";
6243 }
6244
6245 CHK("BOOL_COMPARISON",
6246 "Using comparison to $otype is error prone\n" . $herecurr);
6247
6248## maybe suggesting a correct construct would better
6249## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6250
6251 }
6252 }
6253
6254# check for bool bitfields
6255 if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) {
6256 WARN("BOOL_BITFIELD",
6257 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6258 }
6259
6260# check for semaphores initialized locked
6261 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6262 WARN("CONSIDER_COMPLETION",
6263 "consider using a completion\n" . $herecurr);
6264 }
6265
6266# recommend kstrto* over simple_strto* and strict_strto*
6267 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6268 WARN("CONSIDER_KSTRTO",
6269 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6270 }
6271
6272# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6273 if ($line =~ /^.\s*__initcall\s*\(/) {
6274 WARN("USE_DEVICE_INITCALL",
6275 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6276 }
6277
6278# check for various structs that are normally const (ops, kgdb, device_tree)
6279# and avoid what seem like struct definitions 'struct foo {'
6280 if ($line !~ /\bconst\b/ &&
6281 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6282 WARN("CONST_STRUCT",
6283 "struct $1 should normally be const\n" . $herecurr);
6284 }
6285
6286# use of NR_CPUS is usually wrong
6287# ignore definitions of NR_CPUS and usage to define arrays as likely right
6288 if ($line =~ /\bNR_CPUS\b/ &&
6289 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6290 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6291 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6292 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6293 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6294 {
6295 WARN("NR_CPUS",
6296 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6297 }
6298
6299# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6300 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6301 ERROR("DEFINE_ARCH_HAS",
6302 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6303 }
6304
6305# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6306 if ($^V && $^V ge 5.10.0 &&
6307 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6308 WARN("LIKELY_MISUSE",
6309 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6310 }
6311
6312# whine mightly about in_atomic
6313 if ($line =~ /\bin_atomic\s*\(/) {
6314 if ($realfile =~ m@^drivers/@) {
6315 ERROR("IN_ATOMIC",
6316 "do not use in_atomic in drivers\n" . $herecurr);
6317 } elsif ($realfile !~ m@^kernel/@) {
6318 WARN("IN_ATOMIC",
6319 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6320 }
6321 }
6322
6323# check for mutex_trylock_recursive usage
6324 if ($line =~ /mutex_trylock_recursive/) {
6325 ERROR("LOCKING",
6326 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6327 }
6328
6329# check for lockdep_set_novalidate_class
6330 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6331 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6332 if ($realfile !~ m@^kernel/lockdep@ &&
6333 $realfile !~ m@^include/linux/lockdep@ &&
6334 $realfile !~ m@^drivers/base/core@) {
6335 ERROR("LOCKDEP",
6336 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6337 }
6338 }
6339
6340 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6341 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6342 WARN("EXPORTED_WORLD_WRITABLE",
6343 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6344 }
6345
6346# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6347# and whether or not function naming is typical and if
6348# DEVICE_ATTR permissions uses are unusual too
6349 if ($^V && $^V ge 5.10.0 &&
6350 defined $stat &&
6351 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6352 my $var = $1;
6353 my $perms = $2;
6354 my $show = $3;
6355 my $store = $4;
6356 my $octal_perms = perms_to_octal($perms);
6357 if ($show =~ /^${var}_show$/ &&
6358 $store =~ /^${var}_store$/ &&
6359 $octal_perms eq "0644") {
6360 if (WARN("DEVICE_ATTR_RW",
6361 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6362 $fix) {
6363 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6364 }
6365 } elsif ($show =~ /^${var}_show$/ &&
6366 $store =~ /^NULL$/ &&
6367 $octal_perms eq "0444") {
6368 if (WARN("DEVICE_ATTR_RO",
6369 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6370 $fix) {
6371 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6372 }
6373 } elsif ($show =~ /^NULL$/ &&
6374 $store =~ /^${var}_store$/ &&
6375 $octal_perms eq "0200") {
6376 if (WARN("DEVICE_ATTR_WO",
6377 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6378 $fix) {
6379 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6380 }
6381 } elsif ($octal_perms eq "0644" ||
6382 $octal_perms eq "0444" ||
6383 $octal_perms eq "0200") {
6384 my $newshow = "$show";
6385 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6386 my $newstore = $store;
6387 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6388 my $rename = "";
6389 if ($show ne $newshow) {
6390 $rename .= " '$show' to '$newshow'";
6391 }
6392 if ($store ne $newstore) {
6393 $rename .= " '$store' to '$newstore'";
6394 }
6395 WARN("DEVICE_ATTR_FUNCTIONS",
6396 "Consider renaming function(s)$rename\n" . $herecurr);
6397 } else {
6398 WARN("DEVICE_ATTR_PERMS",
6399 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6400 }
6401 }
6402
6403# Mode permission misuses where it seems decimal should be octal
6404# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6405# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6406# specific definition of not visible in sysfs.
6407# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6408# use the default permissions
6409 if ($^V && $^V ge 5.10.0 &&
6410 defined $stat &&
6411 $line =~ /$mode_perms_search/) {
6412 foreach my $entry (@mode_permission_funcs) {
6413 my $func = $entry->[0];
6414 my $arg_pos = $entry->[1];
6415
6416 my $lc = $stat =~ tr@\n@@;
6417 $lc = $lc + $linenr;
6418 my $stat_real = get_stat_real($linenr, $lc);
6419
6420 my $skip_args = "";
6421 if ($arg_pos > 1) {
6422 $arg_pos--;
6423 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6424 }
6425 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6426 if ($stat =~ /$test/) {
6427 my $val = $1;
6428 $val = $6 if ($skip_args ne "");
6429 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6430 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6431 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6432 ERROR("NON_OCTAL_PERMISSIONS",
6433 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6434 }
6435 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6436 ERROR("EXPORTED_WORLD_WRITABLE",
6437 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6438 }
6439 }
6440 }
6441 }
6442
6443# check for uses of S_<PERMS> that could be octal for readability
6444 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6445 my $oval = $1;
6446 my $octal = perms_to_octal($oval);
6447 if (WARN("SYMBOLIC_PERMS",
6448 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6449 $fix) {
6450 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6451 }
6452 }
6453
6454# validate content of MODULE_LICENSE against list from include/linux/module.h
6455 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6456 my $extracted_string = get_quoted_string($line, $rawline);
6457 my $valid_licenses = qr{
6458 GPL|
6459 GPL\ v2|
6460 GPL\ and\ additional\ rights|
6461 Dual\ BSD/GPL|
6462 Dual\ MIT/GPL|
6463 Dual\ MPL/GPL|
6464 Proprietary
6465 }x;
6466 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6467 WARN("MODULE_LICENSE",
6468 "unknown module license " . $extracted_string . "\n" . $herecurr);
6469 }
6470 }
6471 }
6472
6473 # If we have no input at all, then there is nothing to report on
6474 # so just keep quiet.
6475 if ($#rawlines == -1) {
6476 exit(0);
6477 }
6478
6479 # In mailback mode only produce a report in the negative, for
6480 # things that appear to be patches.
6481 if ($mailback && ($clean == 1 || !$is_patch)) {
6482 exit(0);
6483 }
6484
6485 # This is not a patch, and we are are in 'no-patch' mode so
6486 # just keep quiet.
6487 if (!$chk_patch && !$is_patch) {
6488 exit(0);
6489 }
6490
6491 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6492 ERROR("NOT_UNIFIED_DIFF",
6493 "Does not appear to be a unified-diff format patch\n");
6494 }
6495 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
6496 ERROR("MISSING_SIGN_OFF",
6497 "Missing Signed-off-by: line(s)\n");
6498 }
6499
6500 print report_dump();
6501 if ($summary && !($clean == 1 && $quiet == 1)) {
6502 print "$filename " if ($summary_file);
6503 print "total: $cnt_error errors, $cnt_warn warnings, " .
6504 (($check)? "$cnt_chk checks, " : "") .
6505 "$cnt_lines lines checked\n";
6506 }
6507
6508 if ($quiet == 0) {
6509 # If there were any defects found and not already fixing them
6510 if (!$clean and !$fix) {
6511 print << "EOM"
6512
6513NOTE: For some of the reported defects, checkpatch may be able to
6514 mechanically convert to the typical style using --fix or --fix-inplace.
6515EOM
6516 }
6517 # If there were whitespace errors which cleanpatch can fix
6518 # then suggest that.
6519 if ($rpt_cleaners) {
6520 $rpt_cleaners = 0;
6521 print << "EOM"
6522
6523NOTE: Whitespace errors detected.
6524 You may wish to use scripts/cleanpatch or scripts/cleanfile
6525EOM
6526 }
6527 }
6528
6529 if ($clean == 0 && $fix &&
6530 ("@rawlines" ne "@fixed" ||
6531 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6532 my $newfile = $filename;
6533 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6534 my $linecount = 0;
6535 my $f;
6536
6537 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6538
6539 open($f, '>', $newfile)
6540 or die "$P: Can't open $newfile for write\n";
6541 foreach my $fixed_line (@fixed) {
6542 $linecount++;
6543 if ($file) {
6544 if ($linecount > 3) {
6545 $fixed_line =~ s/^\+//;
6546 print $f $fixed_line . "\n";
6547 }
6548 } else {
6549 print $f $fixed_line . "\n";
6550 }
6551 }
6552 close($f);
6553
6554 if (!$quiet) {
6555 print << "EOM";
6556
6557Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6558
6559Do _NOT_ trust the results written to this file.
6560Do _NOT_ submit these changes without inspecting them for correctness.
6561
6562This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6563No warranties, expressed or implied...
6564EOM
6565 }
6566 }
6567
6568 if ($quiet == 0) {
6569 print "\n";
6570 if ($clean == 1) {
6571 print "$vname has no obvious style problems and is ready for submission.\n";
6572 } else {
6573 print "$vname has style problems, please review.\n";
6574 }
6575 }
6576 return $clean;
6577}
1#!/usr/bin/perl -w
2# (c) 2001, Dave Jones. (the file handling bit)
3# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
9use POSIX;
10use File::Basename;
11use Cwd 'abs_path';
12use Term::ANSIColor qw(:constants);
13
14my $P = $0;
15my $D = dirname(abs_path($P));
16
17my $V = '0.32';
18
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
25my $tst_only;
26my $emacs = 0;
27my $terse = 0;
28my $showfile = 0;
29my $file = 0;
30my $check = 0;
31my $check_orig = 0;
32my $summary = 1;
33my $mailback = 0;
34my $summary_file = 0;
35my $show_types = 0;
36my $fix = 0;
37my $fix_inplace = 0;
38my $root;
39my %debug;
40my %camelcase = ();
41my %use_type = ();
42my @use = ();
43my %ignore_type = ();
44my @ignore = ();
45my $help = 0;
46my $configuration_file = ".checkpatch.conf";
47my $max_line_length = 80;
48my $ignore_perl_version = 0;
49my $minimum_perl_version = 5.10.0;
50my $min_conf_desc_length = 4;
51my $spelling_file = "$D/spelling.txt";
52my $codespell = 0;
53my $codespellfile = "/usr/share/codespell/dictionary.txt";
54my $color = 1;
55
56sub help {
57 my ($exitcode) = @_;
58
59 print << "EOM";
60Usage: $P [OPTION]... [FILE]...
61Version: $V
62
63Options:
64 -q, --quiet quiet
65 --no-tree run without a kernel tree
66 --no-signoff do not check for 'Signed-off-by' line
67 --patch treat FILE as patchfile (default)
68 --emacs emacs compile window format
69 --terse one line per report
70 --showfile emit diffed file position, not input file position
71 -f, --file treat FILE as regular source file
72 --subjective, --strict enable more subjective tests
73 --types TYPE(,TYPE2...) show only these comma separated message types
74 --ignore TYPE(,TYPE2...) ignore various comma separated message types
75 --max-line-length=n set the maximum line length, if exceeded, warn
76 --min-conf-desc-length=n set the min description length, if shorter, warn
77 --show-types show the message "types" in the output
78 --root=PATH PATH to the kernel tree root
79 --no-summary suppress the per-file summary
80 --mailback only produce a report in case of warnings/errors
81 --summary-file include the filename in summary
82 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
83 'values', 'possible', 'type', and 'attr' (default
84 is all off)
85 --test-only=WORD report only warnings/errors containing WORD
86 literally
87 --fix EXPERIMENTAL - may create horrible results
88 If correctable single-line errors exist, create
89 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
90 with potential errors corrected to the preferred
91 checkpatch style
92 --fix-inplace EXPERIMENTAL - may create horrible results
93 Is the same as --fix, but overwrites the input
94 file. It's your fault if there's no backup or git
95 --ignore-perl-version override checking of perl version. expect
96 runtime errors.
97 --codespell Use the codespell dictionary for spelling/typos
98 (default:/usr/share/codespell/dictionary.txt)
99 --codespellfile Use this codespell dictionary
100 --color Use colors when output is STDOUT (default: on)
101 -h, --help, --version display this help and exit
102
103When FILE is - read standard input.
104EOM
105
106 exit($exitcode);
107}
108
109my $conf = which_conf($configuration_file);
110if (-f $conf) {
111 my @conf_args;
112 open(my $conffile, '<', "$conf")
113 or warn "$P: Can't find a readable $configuration_file file $!\n";
114
115 while (<$conffile>) {
116 my $line = $_;
117
118 $line =~ s/\s*\n?$//g;
119 $line =~ s/^\s*//g;
120 $line =~ s/\s+/ /g;
121
122 next if ($line =~ m/^\s*#/);
123 next if ($line =~ m/^\s*$/);
124
125 my @words = split(" ", $line);
126 foreach my $word (@words) {
127 last if ($word =~ m/^#/);
128 push (@conf_args, $word);
129 }
130 }
131 close($conffile);
132 unshift(@ARGV, @conf_args) if @conf_args;
133}
134
135GetOptions(
136 'q|quiet+' => \$quiet,
137 'tree!' => \$tree,
138 'signoff!' => \$chk_signoff,
139 'patch!' => \$chk_patch,
140 'emacs!' => \$emacs,
141 'terse!' => \$terse,
142 'showfile!' => \$showfile,
143 'f|file!' => \$file,
144 'subjective!' => \$check,
145 'strict!' => \$check,
146 'ignore=s' => \@ignore,
147 'types=s' => \@use,
148 'show-types!' => \$show_types,
149 'max-line-length=i' => \$max_line_length,
150 'min-conf-desc-length=i' => \$min_conf_desc_length,
151 'root=s' => \$root,
152 'summary!' => \$summary,
153 'mailback!' => \$mailback,
154 'summary-file!' => \$summary_file,
155 'fix!' => \$fix,
156 'fix-inplace!' => \$fix_inplace,
157 'ignore-perl-version!' => \$ignore_perl_version,
158 'debug=s' => \%debug,
159 'test-only=s' => \$tst_only,
160 'codespell!' => \$codespell,
161 'codespellfile=s' => \$codespellfile,
162 'color!' => \$color,
163 'h|help' => \$help,
164 'version' => \$help
165) or help(1);
166
167help(0) if ($help);
168
169$fix = 1 if ($fix_inplace);
170$check_orig = $check;
171
172my $exit = 0;
173
174if ($^V && $^V lt $minimum_perl_version) {
175 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
176 if (!$ignore_perl_version) {
177 exit(1);
178 }
179}
180
181if ($#ARGV < 0) {
182 print "$P: no input files\n";
183 exit(1);
184}
185
186sub hash_save_array_words {
187 my ($hashRef, $arrayRef) = @_;
188
189 my @array = split(/,/, join(',', @$arrayRef));
190 foreach my $word (@array) {
191 $word =~ s/\s*\n?$//g;
192 $word =~ s/^\s*//g;
193 $word =~ s/\s+/ /g;
194 $word =~ tr/[a-z]/[A-Z]/;
195
196 next if ($word =~ m/^\s*#/);
197 next if ($word =~ m/^\s*$/);
198
199 $hashRef->{$word}++;
200 }
201}
202
203sub hash_show_words {
204 my ($hashRef, $prefix) = @_;
205
206 if (keys %$hashRef) {
207 print "\nNOTE: $prefix message types:";
208 foreach my $word (sort keys %$hashRef) {
209 print " $word";
210 }
211 print "\n";
212 }
213}
214
215hash_save_array_words(\%ignore_type, \@ignore);
216hash_save_array_words(\%use_type, \@use);
217
218my $dbg_values = 0;
219my $dbg_possible = 0;
220my $dbg_type = 0;
221my $dbg_attr = 0;
222for my $key (keys %debug) {
223 ## no critic
224 eval "\${dbg_$key} = '$debug{$key}';";
225 die "$@" if ($@);
226}
227
228my $rpt_cleaners = 0;
229
230if ($terse) {
231 $emacs = 1;
232 $quiet++;
233}
234
235if ($tree) {
236 if (defined $root) {
237 if (!top_of_kernel_tree($root)) {
238 die "$P: $root: --root does not point at a valid tree\n";
239 }
240 } else {
241 if (top_of_kernel_tree('.')) {
242 $root = '.';
243 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
244 top_of_kernel_tree($1)) {
245 $root = $1;
246 }
247 }
248
249 if (!defined $root) {
250 print "Must be run from the top-level dir. of a kernel tree\n";
251 exit(2);
252 }
253}
254
255my $emitted_corrupt = 0;
256
257our $Ident = qr{
258 [A-Za-z_][A-Za-z\d_]*
259 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
260 }x;
261our $Storage = qr{extern|static|asmlinkage};
262our $Sparse = qr{
263 __user|
264 __kernel|
265 __force|
266 __iomem|
267 __pmem|
268 __must_check|
269 __init_refok|
270 __kprobes|
271 __ref|
272 __rcu|
273 __private
274 }x;
275our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
276our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
277our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
278our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
279our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
280
281# Notes to $Attribute:
282# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
283our $Attribute = qr{
284 const|
285 __percpu|
286 __nocast|
287 __safe|
288 __bitwise__|
289 __packed__|
290 __packed2__|
291 __naked|
292 __maybe_unused|
293 __always_unused|
294 __noreturn|
295 __used|
296 __cold|
297 __pure|
298 __noclone|
299 __deprecated|
300 __read_mostly|
301 __kprobes|
302 $InitAttribute|
303 ____cacheline_aligned|
304 ____cacheline_aligned_in_smp|
305 ____cacheline_internodealigned_in_smp|
306 __weak
307 }x;
308our $Modifier;
309our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
310our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
311our $Lval = qr{$Ident(?:$Member)*};
312
313our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
314our $Binary = qr{(?i)0b[01]+$Int_type?};
315our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
316our $Int = qr{[0-9]+$Int_type?};
317our $Octal = qr{0[0-7]+$Int_type?};
318our $String = qr{"[X\t]*"};
319our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
320our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
321our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
322our $Float = qr{$Float_hex|$Float_dec|$Float_int};
323our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
324our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
325our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
326our $Arithmetic = qr{\+|-|\*|\/|%};
327our $Operators = qr{
328 <=|>=|==|!=|
329 =>|->|<<|>>|<|>|!|~|
330 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
331 }x;
332
333our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
334
335our $BasicType;
336our $NonptrType;
337our $NonptrTypeMisordered;
338our $NonptrTypeWithAttr;
339our $Type;
340our $TypeMisordered;
341our $Declare;
342our $DeclareMisordered;
343
344our $NON_ASCII_UTF8 = qr{
345 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
346 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
347 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
348 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
349 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
350 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
351 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
352}x;
353
354our $UTF8 = qr{
355 [\x09\x0A\x0D\x20-\x7E] # ASCII
356 | $NON_ASCII_UTF8
357}x;
358
359our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
360our $typeOtherOSTypedefs = qr{(?x:
361 u_(?:char|short|int|long) | # bsd
362 u(?:nchar|short|int|long) # sysv
363)};
364our $typeKernelTypedefs = qr{(?x:
365 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
366 atomic_t
367)};
368our $typeTypedefs = qr{(?x:
369 $typeC99Typedefs\b|
370 $typeOtherOSTypedefs\b|
371 $typeKernelTypedefs\b
372)};
373
374our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
375
376our $logFunctions = qr{(?x:
377 printk(?:_ratelimited|_once|)|
378 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
379 WARN(?:_RATELIMIT|_ONCE|)|
380 panic|
381 MODULE_[A-Z_]+|
382 seq_vprintf|seq_printf|seq_puts
383)};
384
385our $signature_tags = qr{(?xi:
386 Signed-off-by:|
387 Acked-by:|
388 Tested-by:|
389 Reviewed-by:|
390 Reported-by:|
391 Suggested-by:|
392 To:|
393 Cc:
394)};
395
396our @typeListMisordered = (
397 qr{char\s+(?:un)?signed},
398 qr{int\s+(?:(?:un)?signed\s+)?short\s},
399 qr{int\s+short(?:\s+(?:un)?signed)},
400 qr{short\s+int(?:\s+(?:un)?signed)},
401 qr{(?:un)?signed\s+int\s+short},
402 qr{short\s+(?:un)?signed},
403 qr{long\s+int\s+(?:un)?signed},
404 qr{int\s+long\s+(?:un)?signed},
405 qr{long\s+(?:un)?signed\s+int},
406 qr{int\s+(?:un)?signed\s+long},
407 qr{int\s+(?:un)?signed},
408 qr{int\s+long\s+long\s+(?:un)?signed},
409 qr{long\s+long\s+int\s+(?:un)?signed},
410 qr{long\s+long\s+(?:un)?signed\s+int},
411 qr{long\s+long\s+(?:un)?signed},
412 qr{long\s+(?:un)?signed},
413);
414
415our @typeList = (
416 qr{void},
417 qr{(?:(?:un)?signed\s+)?char},
418 qr{(?:(?:un)?signed\s+)?short\s+int},
419 qr{(?:(?:un)?signed\s+)?short},
420 qr{(?:(?:un)?signed\s+)?int},
421 qr{(?:(?:un)?signed\s+)?long\s+int},
422 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
423 qr{(?:(?:un)?signed\s+)?long\s+long},
424 qr{(?:(?:un)?signed\s+)?long},
425 qr{(?:un)?signed},
426 qr{float},
427 qr{double},
428 qr{bool},
429 qr{struct\s+$Ident},
430 qr{union\s+$Ident},
431 qr{enum\s+$Ident},
432 qr{${Ident}_t},
433 qr{${Ident}_handler},
434 qr{${Ident}_handler_fn},
435 @typeListMisordered,
436);
437
438our $C90_int_types = qr{(?x:
439 long\s+long\s+int\s+(?:un)?signed|
440 long\s+long\s+(?:un)?signed\s+int|
441 long\s+long\s+(?:un)?signed|
442 (?:(?:un)?signed\s+)?long\s+long\s+int|
443 (?:(?:un)?signed\s+)?long\s+long|
444 int\s+long\s+long\s+(?:un)?signed|
445 int\s+(?:(?:un)?signed\s+)?long\s+long|
446
447 long\s+int\s+(?:un)?signed|
448 long\s+(?:un)?signed\s+int|
449 long\s+(?:un)?signed|
450 (?:(?:un)?signed\s+)?long\s+int|
451 (?:(?:un)?signed\s+)?long|
452 int\s+long\s+(?:un)?signed|
453 int\s+(?:(?:un)?signed\s+)?long|
454
455 int\s+(?:un)?signed|
456 (?:(?:un)?signed\s+)?int
457)};
458
459our @typeListFile = ();
460our @typeListWithAttr = (
461 @typeList,
462 qr{struct\s+$InitAttribute\s+$Ident},
463 qr{union\s+$InitAttribute\s+$Ident},
464);
465
466our @modifierList = (
467 qr{fastcall},
468);
469our @modifierListFile = ();
470
471our @mode_permission_funcs = (
472 ["module_param", 3],
473 ["module_param_(?:array|named|string)", 4],
474 ["module_param_array_named", 5],
475 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
476 ["proc_create(?:_data|)", 2],
477 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
478);
479
480#Create a search pattern for all these functions to speed up a loop below
481our $mode_perms_search = "";
482foreach my $entry (@mode_permission_funcs) {
483 $mode_perms_search .= '|' if ($mode_perms_search ne "");
484 $mode_perms_search .= $entry->[0];
485}
486
487our $mode_perms_world_writable = qr{
488 S_IWUGO |
489 S_IWOTH |
490 S_IRWXUGO |
491 S_IALLUGO |
492 0[0-7][0-7][2367]
493}x;
494
495our $allowed_asm_includes = qr{(?x:
496 irq|
497 memory|
498 time|
499 reboot
500)};
501# memory.h: ARM has a custom one
502
503# Load common spelling mistakes and build regular expression list.
504my $misspellings;
505my %spelling_fix;
506
507if (open(my $spelling, '<', $spelling_file)) {
508 while (<$spelling>) {
509 my $line = $_;
510
511 $line =~ s/\s*\n?$//g;
512 $line =~ s/^\s*//g;
513
514 next if ($line =~ m/^\s*#/);
515 next if ($line =~ m/^\s*$/);
516
517 my ($suspect, $fix) = split(/\|\|/, $line);
518
519 $spelling_fix{$suspect} = $fix;
520 }
521 close($spelling);
522} else {
523 warn "No typos will be found - file '$spelling_file': $!\n";
524}
525
526if ($codespell) {
527 if (open(my $spelling, '<', $codespellfile)) {
528 while (<$spelling>) {
529 my $line = $_;
530
531 $line =~ s/\s*\n?$//g;
532 $line =~ s/^\s*//g;
533
534 next if ($line =~ m/^\s*#/);
535 next if ($line =~ m/^\s*$/);
536 next if ($line =~ m/, disabled/i);
537
538 $line =~ s/,.*$//;
539
540 my ($suspect, $fix) = split(/->/, $line);
541
542 $spelling_fix{$suspect} = $fix;
543 }
544 close($spelling);
545 } else {
546 warn "No codespell typos will be found - file '$codespellfile': $!\n";
547 }
548}
549
550$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
551
552sub build_types {
553 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
554 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
555 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
556 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
557 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
558 $BasicType = qr{
559 (?:$typeTypedefs\b)|
560 (?:${all}\b)
561 }x;
562 $NonptrType = qr{
563 (?:$Modifier\s+|const\s+)*
564 (?:
565 (?:typeof|__typeof__)\s*\([^\)]*\)|
566 (?:$typeTypedefs\b)|
567 (?:${all}\b)
568 )
569 (?:\s+$Modifier|\s+const)*
570 }x;
571 $NonptrTypeMisordered = qr{
572 (?:$Modifier\s+|const\s+)*
573 (?:
574 (?:${Misordered}\b)
575 )
576 (?:\s+$Modifier|\s+const)*
577 }x;
578 $NonptrTypeWithAttr = qr{
579 (?:$Modifier\s+|const\s+)*
580 (?:
581 (?:typeof|__typeof__)\s*\([^\)]*\)|
582 (?:$typeTypedefs\b)|
583 (?:${allWithAttr}\b)
584 )
585 (?:\s+$Modifier|\s+const)*
586 }x;
587 $Type = qr{
588 $NonptrType
589 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
590 (?:\s+$Inline|\s+$Modifier)*
591 }x;
592 $TypeMisordered = qr{
593 $NonptrTypeMisordered
594 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
595 (?:\s+$Inline|\s+$Modifier)*
596 }x;
597 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
598 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
599}
600build_types();
601
602our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
603
604# Using $balanced_parens, $LvalOrFunc, or $FuncArg
605# requires at least perl version v5.10.0
606# Any use must be runtime checked with $^V
607
608our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
609our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
610our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
611
612our $declaration_macros = qr{(?x:
613 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
614 (?:$Storage\s+)?LIST_HEAD\s*\(|
615 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
616)};
617
618sub deparenthesize {
619 my ($string) = @_;
620 return "" if (!defined($string));
621
622 while ($string =~ /^\s*\(.*\)\s*$/) {
623 $string =~ s@^\s*\(\s*@@;
624 $string =~ s@\s*\)\s*$@@;
625 }
626
627 $string =~ s@\s+@ @g;
628
629 return $string;
630}
631
632sub seed_camelcase_file {
633 my ($file) = @_;
634
635 return if (!(-f $file));
636
637 local $/;
638
639 open(my $include_file, '<', "$file")
640 or warn "$P: Can't read '$file' $!\n";
641 my $text = <$include_file>;
642 close($include_file);
643
644 my @lines = split('\n', $text);
645
646 foreach my $line (@lines) {
647 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
648 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
649 $camelcase{$1} = 1;
650 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
651 $camelcase{$1} = 1;
652 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
653 $camelcase{$1} = 1;
654 }
655 }
656}
657
658my $camelcase_seeded = 0;
659sub seed_camelcase_includes {
660 return if ($camelcase_seeded);
661
662 my $files;
663 my $camelcase_cache = "";
664 my @include_files = ();
665
666 $camelcase_seeded = 1;
667
668 if (-e ".git") {
669 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
670 chomp $git_last_include_commit;
671 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
672 } else {
673 my $last_mod_date = 0;
674 $files = `find $root/include -name "*.h"`;
675 @include_files = split('\n', $files);
676 foreach my $file (@include_files) {
677 my $date = POSIX::strftime("%Y%m%d%H%M",
678 localtime((stat $file)[9]));
679 $last_mod_date = $date if ($last_mod_date < $date);
680 }
681 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
682 }
683
684 if ($camelcase_cache ne "" && -f $camelcase_cache) {
685 open(my $camelcase_file, '<', "$camelcase_cache")
686 or warn "$P: Can't read '$camelcase_cache' $!\n";
687 while (<$camelcase_file>) {
688 chomp;
689 $camelcase{$_} = 1;
690 }
691 close($camelcase_file);
692
693 return;
694 }
695
696 if (-e ".git") {
697 $files = `git ls-files "include/*.h"`;
698 @include_files = split('\n', $files);
699 }
700
701 foreach my $file (@include_files) {
702 seed_camelcase_file($file);
703 }
704
705 if ($camelcase_cache ne "") {
706 unlink glob ".checkpatch-camelcase.*";
707 open(my $camelcase_file, '>', "$camelcase_cache")
708 or warn "$P: Can't write '$camelcase_cache' $!\n";
709 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
710 print $camelcase_file ("$_\n");
711 }
712 close($camelcase_file);
713 }
714}
715
716sub git_commit_info {
717 my ($commit, $id, $desc) = @_;
718
719 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
720
721 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
722 $output =~ s/^\s*//gm;
723 my @lines = split("\n", $output);
724
725 return ($id, $desc) if ($#lines < 0);
726
727 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
728# Maybe one day convert this block of bash into something that returns
729# all matching commit ids, but it's very slow...
730#
731# echo "checking commits $1..."
732# git rev-list --remotes | grep -i "^$1" |
733# while read line ; do
734# git log --format='%H %s' -1 $line |
735# echo "commit $(cut -c 1-12,41-)"
736# done
737 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
738 } else {
739 $id = substr($lines[0], 0, 12);
740 $desc = substr($lines[0], 41);
741 }
742
743 return ($id, $desc);
744}
745
746$chk_signoff = 0 if ($file);
747
748my @rawlines = ();
749my @lines = ();
750my @fixed = ();
751my @fixed_inserted = ();
752my @fixed_deleted = ();
753my $fixlinenr = -1;
754
755my $vname;
756for my $filename (@ARGV) {
757 my $FILE;
758 if ($file) {
759 open($FILE, '-|', "diff -u /dev/null $filename") ||
760 die "$P: $filename: diff failed - $!\n";
761 } elsif ($filename eq '-') {
762 open($FILE, '<&STDIN');
763 } else {
764 open($FILE, '<', "$filename") ||
765 die "$P: $filename: open failed - $!\n";
766 }
767 if ($filename eq '-') {
768 $vname = 'Your patch';
769 } else {
770 $vname = $filename;
771 }
772 while (<$FILE>) {
773 chomp;
774 push(@rawlines, $_);
775 }
776 close($FILE);
777
778 if ($#ARGV > 0 && $quiet == 0) {
779 print '-' x length($vname) . "\n";
780 print "$vname\n";
781 print '-' x length($vname) . "\n";
782 }
783
784 if (!process($filename)) {
785 $exit = 1;
786 }
787 @rawlines = ();
788 @lines = ();
789 @fixed = ();
790 @fixed_inserted = ();
791 @fixed_deleted = ();
792 $fixlinenr = -1;
793 @modifierListFile = ();
794 @typeListFile = ();
795 build_types();
796}
797
798if (!$quiet) {
799 hash_show_words(\%use_type, "Used");
800 hash_show_words(\%ignore_type, "Ignored");
801
802 if ($^V lt 5.10.0) {
803 print << "EOM"
804
805NOTE: perl $^V is not modern enough to detect all possible issues.
806 An upgrade to at least perl v5.10.0 is suggested.
807EOM
808 }
809 if ($exit) {
810 print << "EOM"
811
812NOTE: If any of the errors are false positives, please report
813 them to the maintainer, see CHECKPATCH in MAINTAINERS.
814EOM
815 }
816}
817
818exit($exit);
819
820sub top_of_kernel_tree {
821 my ($root) = @_;
822
823 my @tree_check = (
824 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
825 "README", "Documentation", "arch", "include", "drivers",
826 "fs", "init", "ipc", "kernel", "lib", "scripts",
827 );
828
829 foreach my $check (@tree_check) {
830 if (! -e $root . '/' . $check) {
831 return 0;
832 }
833 }
834 return 1;
835}
836
837sub parse_email {
838 my ($formatted_email) = @_;
839
840 my $name = "";
841 my $address = "";
842 my $comment = "";
843
844 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
845 $name = $1;
846 $address = $2;
847 $comment = $3 if defined $3;
848 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
849 $address = $1;
850 $comment = $2 if defined $2;
851 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
852 $address = $1;
853 $comment = $2 if defined $2;
854 $formatted_email =~ s/$address.*$//;
855 $name = $formatted_email;
856 $name = trim($name);
857 $name =~ s/^\"|\"$//g;
858 # If there's a name left after stripping spaces and
859 # leading quotes, and the address doesn't have both
860 # leading and trailing angle brackets, the address
861 # is invalid. ie:
862 # "joe smith joe@smith.com" bad
863 # "joe smith <joe@smith.com" bad
864 if ($name ne "" && $address !~ /^<[^>]+>$/) {
865 $name = "";
866 $address = "";
867 $comment = "";
868 }
869 }
870
871 $name = trim($name);
872 $name =~ s/^\"|\"$//g;
873 $address = trim($address);
874 $address =~ s/^\<|\>$//g;
875
876 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
877 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
878 $name = "\"$name\"";
879 }
880
881 return ($name, $address, $comment);
882}
883
884sub format_email {
885 my ($name, $address) = @_;
886
887 my $formatted_email;
888
889 $name = trim($name);
890 $name =~ s/^\"|\"$//g;
891 $address = trim($address);
892
893 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
894 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
895 $name = "\"$name\"";
896 }
897
898 if ("$name" eq "") {
899 $formatted_email = "$address";
900 } else {
901 $formatted_email = "$name <$address>";
902 }
903
904 return $formatted_email;
905}
906
907sub which {
908 my ($bin) = @_;
909
910 foreach my $path (split(/:/, $ENV{PATH})) {
911 if (-e "$path/$bin") {
912 return "$path/$bin";
913 }
914 }
915
916 return "";
917}
918
919sub which_conf {
920 my ($conf) = @_;
921
922 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
923 if (-e "$path/$conf") {
924 return "$path/$conf";
925 }
926 }
927
928 return "";
929}
930
931sub expand_tabs {
932 my ($str) = @_;
933
934 my $res = '';
935 my $n = 0;
936 for my $c (split(//, $str)) {
937 if ($c eq "\t") {
938 $res .= ' ';
939 $n++;
940 for (; ($n % 8) != 0; $n++) {
941 $res .= ' ';
942 }
943 next;
944 }
945 $res .= $c;
946 $n++;
947 }
948
949 return $res;
950}
951sub copy_spacing {
952 (my $res = shift) =~ tr/\t/ /c;
953 return $res;
954}
955
956sub line_stats {
957 my ($line) = @_;
958
959 # Drop the diff line leader and expand tabs
960 $line =~ s/^.//;
961 $line = expand_tabs($line);
962
963 # Pick the indent from the front of the line.
964 my ($white) = ($line =~ /^(\s*)/);
965
966 return (length($line), length($white));
967}
968
969my $sanitise_quote = '';
970
971sub sanitise_line_reset {
972 my ($in_comment) = @_;
973
974 if ($in_comment) {
975 $sanitise_quote = '*/';
976 } else {
977 $sanitise_quote = '';
978 }
979}
980sub sanitise_line {
981 my ($line) = @_;
982
983 my $res = '';
984 my $l = '';
985
986 my $qlen = 0;
987 my $off = 0;
988 my $c;
989
990 # Always copy over the diff marker.
991 $res = substr($line, 0, 1);
992
993 for ($off = 1; $off < length($line); $off++) {
994 $c = substr($line, $off, 1);
995
996 # Comments we are wacking completly including the begin
997 # and end, all to $;.
998 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
999 $sanitise_quote = '*/';
1000
1001 substr($res, $off, 2, "$;$;");
1002 $off++;
1003 next;
1004 }
1005 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1006 $sanitise_quote = '';
1007 substr($res, $off, 2, "$;$;");
1008 $off++;
1009 next;
1010 }
1011 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1012 $sanitise_quote = '//';
1013
1014 substr($res, $off, 2, $sanitise_quote);
1015 $off++;
1016 next;
1017 }
1018
1019 # A \ in a string means ignore the next character.
1020 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1021 $c eq "\\") {
1022 substr($res, $off, 2, 'XX');
1023 $off++;
1024 next;
1025 }
1026 # Regular quotes.
1027 if ($c eq "'" || $c eq '"') {
1028 if ($sanitise_quote eq '') {
1029 $sanitise_quote = $c;
1030
1031 substr($res, $off, 1, $c);
1032 next;
1033 } elsif ($sanitise_quote eq $c) {
1034 $sanitise_quote = '';
1035 }
1036 }
1037
1038 #print "c<$c> SQ<$sanitise_quote>\n";
1039 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1040 substr($res, $off, 1, $;);
1041 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1042 substr($res, $off, 1, $;);
1043 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1044 substr($res, $off, 1, 'X');
1045 } else {
1046 substr($res, $off, 1, $c);
1047 }
1048 }
1049
1050 if ($sanitise_quote eq '//') {
1051 $sanitise_quote = '';
1052 }
1053
1054 # The pathname on a #include may be surrounded by '<' and '>'.
1055 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1056 my $clean = 'X' x length($1);
1057 $res =~ s@\<.*\>@<$clean>@;
1058
1059 # The whole of a #error is a string.
1060 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1061 my $clean = 'X' x length($1);
1062 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1063 }
1064
1065 return $res;
1066}
1067
1068sub get_quoted_string {
1069 my ($line, $rawline) = @_;
1070
1071 return "" if ($line !~ m/($String)/g);
1072 return substr($rawline, $-[0], $+[0] - $-[0]);
1073}
1074
1075sub ctx_statement_block {
1076 my ($linenr, $remain, $off) = @_;
1077 my $line = $linenr - 1;
1078 my $blk = '';
1079 my $soff = $off;
1080 my $coff = $off - 1;
1081 my $coff_set = 0;
1082
1083 my $loff = 0;
1084
1085 my $type = '';
1086 my $level = 0;
1087 my @stack = ();
1088 my $p;
1089 my $c;
1090 my $len = 0;
1091
1092 my $remainder;
1093 while (1) {
1094 @stack = (['', 0]) if ($#stack == -1);
1095
1096 #warn "CSB: blk<$blk> remain<$remain>\n";
1097 # If we are about to drop off the end, pull in more
1098 # context.
1099 if ($off >= $len) {
1100 for (; $remain > 0; $line++) {
1101 last if (!defined $lines[$line]);
1102 next if ($lines[$line] =~ /^-/);
1103 $remain--;
1104 $loff = $len;
1105 $blk .= $lines[$line] . "\n";
1106 $len = length($blk);
1107 $line++;
1108 last;
1109 }
1110 # Bail if there is no further context.
1111 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1112 if ($off >= $len) {
1113 last;
1114 }
1115 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1116 $level++;
1117 $type = '#';
1118 }
1119 }
1120 $p = $c;
1121 $c = substr($blk, $off, 1);
1122 $remainder = substr($blk, $off);
1123
1124 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1125
1126 # Handle nested #if/#else.
1127 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1128 push(@stack, [ $type, $level ]);
1129 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1130 ($type, $level) = @{$stack[$#stack - 1]};
1131 } elsif ($remainder =~ /^#\s*endif\b/) {
1132 ($type, $level) = @{pop(@stack)};
1133 }
1134
1135 # Statement ends at the ';' or a close '}' at the
1136 # outermost level.
1137 if ($level == 0 && $c eq ';') {
1138 last;
1139 }
1140
1141 # An else is really a conditional as long as its not else if
1142 if ($level == 0 && $coff_set == 0 &&
1143 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1144 $remainder =~ /^(else)(?:\s|{)/ &&
1145 $remainder !~ /^else\s+if\b/) {
1146 $coff = $off + length($1) - 1;
1147 $coff_set = 1;
1148 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1149 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1150 }
1151
1152 if (($type eq '' || $type eq '(') && $c eq '(') {
1153 $level++;
1154 $type = '(';
1155 }
1156 if ($type eq '(' && $c eq ')') {
1157 $level--;
1158 $type = ($level != 0)? '(' : '';
1159
1160 if ($level == 0 && $coff < $soff) {
1161 $coff = $off;
1162 $coff_set = 1;
1163 #warn "CSB: mark coff<$coff>\n";
1164 }
1165 }
1166 if (($type eq '' || $type eq '{') && $c eq '{') {
1167 $level++;
1168 $type = '{';
1169 }
1170 if ($type eq '{' && $c eq '}') {
1171 $level--;
1172 $type = ($level != 0)? '{' : '';
1173
1174 if ($level == 0) {
1175 if (substr($blk, $off + 1, 1) eq ';') {
1176 $off++;
1177 }
1178 last;
1179 }
1180 }
1181 # Preprocessor commands end at the newline unless escaped.
1182 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1183 $level--;
1184 $type = '';
1185 $off++;
1186 last;
1187 }
1188 $off++;
1189 }
1190 # We are truly at the end, so shuffle to the next line.
1191 if ($off == $len) {
1192 $loff = $len + 1;
1193 $line++;
1194 $remain--;
1195 }
1196
1197 my $statement = substr($blk, $soff, $off - $soff + 1);
1198 my $condition = substr($blk, $soff, $coff - $soff + 1);
1199
1200 #warn "STATEMENT<$statement>\n";
1201 #warn "CONDITION<$condition>\n";
1202
1203 #print "coff<$coff> soff<$off> loff<$loff>\n";
1204
1205 return ($statement, $condition,
1206 $line, $remain + 1, $off - $loff + 1, $level);
1207}
1208
1209sub statement_lines {
1210 my ($stmt) = @_;
1211
1212 # Strip the diff line prefixes and rip blank lines at start and end.
1213 $stmt =~ s/(^|\n)./$1/g;
1214 $stmt =~ s/^\s*//;
1215 $stmt =~ s/\s*$//;
1216
1217 my @stmt_lines = ($stmt =~ /\n/g);
1218
1219 return $#stmt_lines + 2;
1220}
1221
1222sub statement_rawlines {
1223 my ($stmt) = @_;
1224
1225 my @stmt_lines = ($stmt =~ /\n/g);
1226
1227 return $#stmt_lines + 2;
1228}
1229
1230sub statement_block_size {
1231 my ($stmt) = @_;
1232
1233 $stmt =~ s/(^|\n)./$1/g;
1234 $stmt =~ s/^\s*{//;
1235 $stmt =~ s/}\s*$//;
1236 $stmt =~ s/^\s*//;
1237 $stmt =~ s/\s*$//;
1238
1239 my @stmt_lines = ($stmt =~ /\n/g);
1240 my @stmt_statements = ($stmt =~ /;/g);
1241
1242 my $stmt_lines = $#stmt_lines + 2;
1243 my $stmt_statements = $#stmt_statements + 1;
1244
1245 if ($stmt_lines > $stmt_statements) {
1246 return $stmt_lines;
1247 } else {
1248 return $stmt_statements;
1249 }
1250}
1251
1252sub ctx_statement_full {
1253 my ($linenr, $remain, $off) = @_;
1254 my ($statement, $condition, $level);
1255
1256 my (@chunks);
1257
1258 # Grab the first conditional/block pair.
1259 ($statement, $condition, $linenr, $remain, $off, $level) =
1260 ctx_statement_block($linenr, $remain, $off);
1261 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1262 push(@chunks, [ $condition, $statement ]);
1263 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1264 return ($level, $linenr, @chunks);
1265 }
1266
1267 # Pull in the following conditional/block pairs and see if they
1268 # could continue the statement.
1269 for (;;) {
1270 ($statement, $condition, $linenr, $remain, $off, $level) =
1271 ctx_statement_block($linenr, $remain, $off);
1272 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1273 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1274 #print "C: push\n";
1275 push(@chunks, [ $condition, $statement ]);
1276 }
1277
1278 return ($level, $linenr, @chunks);
1279}
1280
1281sub ctx_block_get {
1282 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1283 my $line;
1284 my $start = $linenr - 1;
1285 my $blk = '';
1286 my @o;
1287 my @c;
1288 my @res = ();
1289
1290 my $level = 0;
1291 my @stack = ($level);
1292 for ($line = $start; $remain > 0; $line++) {
1293 next if ($rawlines[$line] =~ /^-/);
1294 $remain--;
1295
1296 $blk .= $rawlines[$line];
1297
1298 # Handle nested #if/#else.
1299 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1300 push(@stack, $level);
1301 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1302 $level = $stack[$#stack - 1];
1303 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1304 $level = pop(@stack);
1305 }
1306
1307 foreach my $c (split(//, $lines[$line])) {
1308 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1309 if ($off > 0) {
1310 $off--;
1311 next;
1312 }
1313
1314 if ($c eq $close && $level > 0) {
1315 $level--;
1316 last if ($level == 0);
1317 } elsif ($c eq $open) {
1318 $level++;
1319 }
1320 }
1321
1322 if (!$outer || $level <= 1) {
1323 push(@res, $rawlines[$line]);
1324 }
1325
1326 last if ($level == 0);
1327 }
1328
1329 return ($level, @res);
1330}
1331sub ctx_block_outer {
1332 my ($linenr, $remain) = @_;
1333
1334 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1335 return @r;
1336}
1337sub ctx_block {
1338 my ($linenr, $remain) = @_;
1339
1340 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1341 return @r;
1342}
1343sub ctx_statement {
1344 my ($linenr, $remain, $off) = @_;
1345
1346 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1347 return @r;
1348}
1349sub ctx_block_level {
1350 my ($linenr, $remain) = @_;
1351
1352 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1353}
1354sub ctx_statement_level {
1355 my ($linenr, $remain, $off) = @_;
1356
1357 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1358}
1359
1360sub ctx_locate_comment {
1361 my ($first_line, $end_line) = @_;
1362
1363 # Catch a comment on the end of the line itself.
1364 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1365 return $current_comment if (defined $current_comment);
1366
1367 # Look through the context and try and figure out if there is a
1368 # comment.
1369 my $in_comment = 0;
1370 $current_comment = '';
1371 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1372 my $line = $rawlines[$linenr - 1];
1373 #warn " $line\n";
1374 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1375 $in_comment = 1;
1376 }
1377 if ($line =~ m@/\*@) {
1378 $in_comment = 1;
1379 }
1380 if (!$in_comment && $current_comment ne '') {
1381 $current_comment = '';
1382 }
1383 $current_comment .= $line . "\n" if ($in_comment);
1384 if ($line =~ m@\*/@) {
1385 $in_comment = 0;
1386 }
1387 }
1388
1389 chomp($current_comment);
1390 return($current_comment);
1391}
1392sub ctx_has_comment {
1393 my ($first_line, $end_line) = @_;
1394 my $cmt = ctx_locate_comment($first_line, $end_line);
1395
1396 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1397 ##print "CMMT: $cmt\n";
1398
1399 return ($cmt ne '');
1400}
1401
1402sub raw_line {
1403 my ($linenr, $cnt) = @_;
1404
1405 my $offset = $linenr - 1;
1406 $cnt++;
1407
1408 my $line;
1409 while ($cnt) {
1410 $line = $rawlines[$offset++];
1411 next if (defined($line) && $line =~ /^-/);
1412 $cnt--;
1413 }
1414
1415 return $line;
1416}
1417
1418sub cat_vet {
1419 my ($vet) = @_;
1420 my ($res, $coded);
1421
1422 $res = '';
1423 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1424 $res .= $1;
1425 if ($2 ne '') {
1426 $coded = sprintf("^%c", unpack('C', $2) + 64);
1427 $res .= $coded;
1428 }
1429 }
1430 $res =~ s/$/\$/;
1431
1432 return $res;
1433}
1434
1435my $av_preprocessor = 0;
1436my $av_pending;
1437my @av_paren_type;
1438my $av_pend_colon;
1439
1440sub annotate_reset {
1441 $av_preprocessor = 0;
1442 $av_pending = '_';
1443 @av_paren_type = ('E');
1444 $av_pend_colon = 'O';
1445}
1446
1447sub annotate_values {
1448 my ($stream, $type) = @_;
1449
1450 my $res;
1451 my $var = '_' x length($stream);
1452 my $cur = $stream;
1453
1454 print "$stream\n" if ($dbg_values > 1);
1455
1456 while (length($cur)) {
1457 @av_paren_type = ('E') if ($#av_paren_type < 0);
1458 print " <" . join('', @av_paren_type) .
1459 "> <$type> <$av_pending>" if ($dbg_values > 1);
1460 if ($cur =~ /^(\s+)/o) {
1461 print "WS($1)\n" if ($dbg_values > 1);
1462 if ($1 =~ /\n/ && $av_preprocessor) {
1463 $type = pop(@av_paren_type);
1464 $av_preprocessor = 0;
1465 }
1466
1467 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1468 print "CAST($1)\n" if ($dbg_values > 1);
1469 push(@av_paren_type, $type);
1470 $type = 'c';
1471
1472 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1473 print "DECLARE($1)\n" if ($dbg_values > 1);
1474 $type = 'T';
1475
1476 } elsif ($cur =~ /^($Modifier)\s*/) {
1477 print "MODIFIER($1)\n" if ($dbg_values > 1);
1478 $type = 'T';
1479
1480 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1481 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1482 $av_preprocessor = 1;
1483 push(@av_paren_type, $type);
1484 if ($2 ne '') {
1485 $av_pending = 'N';
1486 }
1487 $type = 'E';
1488
1489 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1490 print "UNDEF($1)\n" if ($dbg_values > 1);
1491 $av_preprocessor = 1;
1492 push(@av_paren_type, $type);
1493
1494 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1495 print "PRE_START($1)\n" if ($dbg_values > 1);
1496 $av_preprocessor = 1;
1497
1498 push(@av_paren_type, $type);
1499 push(@av_paren_type, $type);
1500 $type = 'E';
1501
1502 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1503 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1504 $av_preprocessor = 1;
1505
1506 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1507
1508 $type = 'E';
1509
1510 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1511 print "PRE_END($1)\n" if ($dbg_values > 1);
1512
1513 $av_preprocessor = 1;
1514
1515 # Assume all arms of the conditional end as this
1516 # one does, and continue as if the #endif was not here.
1517 pop(@av_paren_type);
1518 push(@av_paren_type, $type);
1519 $type = 'E';
1520
1521 } elsif ($cur =~ /^(\\\n)/o) {
1522 print "PRECONT($1)\n" if ($dbg_values > 1);
1523
1524 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1525 print "ATTR($1)\n" if ($dbg_values > 1);
1526 $av_pending = $type;
1527 $type = 'N';
1528
1529 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1530 print "SIZEOF($1)\n" if ($dbg_values > 1);
1531 if (defined $2) {
1532 $av_pending = 'V';
1533 }
1534 $type = 'N';
1535
1536 } elsif ($cur =~ /^(if|while|for)\b/o) {
1537 print "COND($1)\n" if ($dbg_values > 1);
1538 $av_pending = 'E';
1539 $type = 'N';
1540
1541 } elsif ($cur =~/^(case)/o) {
1542 print "CASE($1)\n" if ($dbg_values > 1);
1543 $av_pend_colon = 'C';
1544 $type = 'N';
1545
1546 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1547 print "KEYWORD($1)\n" if ($dbg_values > 1);
1548 $type = 'N';
1549
1550 } elsif ($cur =~ /^(\()/o) {
1551 print "PAREN('$1')\n" if ($dbg_values > 1);
1552 push(@av_paren_type, $av_pending);
1553 $av_pending = '_';
1554 $type = 'N';
1555
1556 } elsif ($cur =~ /^(\))/o) {
1557 my $new_type = pop(@av_paren_type);
1558 if ($new_type ne '_') {
1559 $type = $new_type;
1560 print "PAREN('$1') -> $type\n"
1561 if ($dbg_values > 1);
1562 } else {
1563 print "PAREN('$1')\n" if ($dbg_values > 1);
1564 }
1565
1566 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1567 print "FUNC($1)\n" if ($dbg_values > 1);
1568 $type = 'V';
1569 $av_pending = 'V';
1570
1571 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1572 if (defined $2 && $type eq 'C' || $type eq 'T') {
1573 $av_pend_colon = 'B';
1574 } elsif ($type eq 'E') {
1575 $av_pend_colon = 'L';
1576 }
1577 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1578 $type = 'V';
1579
1580 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1581 print "IDENT($1)\n" if ($dbg_values > 1);
1582 $type = 'V';
1583
1584 } elsif ($cur =~ /^($Assignment)/o) {
1585 print "ASSIGN($1)\n" if ($dbg_values > 1);
1586 $type = 'N';
1587
1588 } elsif ($cur =~/^(;|{|})/) {
1589 print "END($1)\n" if ($dbg_values > 1);
1590 $type = 'E';
1591 $av_pend_colon = 'O';
1592
1593 } elsif ($cur =~/^(,)/) {
1594 print "COMMA($1)\n" if ($dbg_values > 1);
1595 $type = 'C';
1596
1597 } elsif ($cur =~ /^(\?)/o) {
1598 print "QUESTION($1)\n" if ($dbg_values > 1);
1599 $type = 'N';
1600
1601 } elsif ($cur =~ /^(:)/o) {
1602 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1603
1604 substr($var, length($res), 1, $av_pend_colon);
1605 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1606 $type = 'E';
1607 } else {
1608 $type = 'N';
1609 }
1610 $av_pend_colon = 'O';
1611
1612 } elsif ($cur =~ /^(\[)/o) {
1613 print "CLOSE($1)\n" if ($dbg_values > 1);
1614 $type = 'N';
1615
1616 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1617 my $variant;
1618
1619 print "OPV($1)\n" if ($dbg_values > 1);
1620 if ($type eq 'V') {
1621 $variant = 'B';
1622 } else {
1623 $variant = 'U';
1624 }
1625
1626 substr($var, length($res), 1, $variant);
1627 $type = 'N';
1628
1629 } elsif ($cur =~ /^($Operators)/o) {
1630 print "OP($1)\n" if ($dbg_values > 1);
1631 if ($1 ne '++' && $1 ne '--') {
1632 $type = 'N';
1633 }
1634
1635 } elsif ($cur =~ /(^.)/o) {
1636 print "C($1)\n" if ($dbg_values > 1);
1637 }
1638 if (defined $1) {
1639 $cur = substr($cur, length($1));
1640 $res .= $type x length($1);
1641 }
1642 }
1643
1644 return ($res, $var);
1645}
1646
1647sub possible {
1648 my ($possible, $line) = @_;
1649 my $notPermitted = qr{(?:
1650 ^(?:
1651 $Modifier|
1652 $Storage|
1653 $Type|
1654 DEFINE_\S+
1655 )$|
1656 ^(?:
1657 goto|
1658 return|
1659 case|
1660 else|
1661 asm|__asm__|
1662 do|
1663 \#|
1664 \#\#|
1665 )(?:\s|$)|
1666 ^(?:typedef|struct|enum)\b
1667 )}x;
1668 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1669 if ($possible !~ $notPermitted) {
1670 # Check for modifiers.
1671 $possible =~ s/\s*$Storage\s*//g;
1672 $possible =~ s/\s*$Sparse\s*//g;
1673 if ($possible =~ /^\s*$/) {
1674
1675 } elsif ($possible =~ /\s/) {
1676 $possible =~ s/\s*$Type\s*//g;
1677 for my $modifier (split(' ', $possible)) {
1678 if ($modifier !~ $notPermitted) {
1679 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1680 push(@modifierListFile, $modifier);
1681 }
1682 }
1683
1684 } else {
1685 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1686 push(@typeListFile, $possible);
1687 }
1688 build_types();
1689 } else {
1690 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1691 }
1692}
1693
1694my $prefix = '';
1695
1696sub show_type {
1697 my ($type) = @_;
1698
1699 return defined $use_type{$type} if (scalar keys %use_type > 0);
1700
1701 return !defined $ignore_type{$type};
1702}
1703
1704sub report {
1705 my ($level, $type, $msg) = @_;
1706
1707 if (!show_type($type) ||
1708 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
1709 return 0;
1710 }
1711 my $output = '';
1712 if (-t STDOUT && $color) {
1713 if ($level eq 'ERROR') {
1714 $output .= RED;
1715 } elsif ($level eq 'WARNING') {
1716 $output .= YELLOW;
1717 } else {
1718 $output .= GREEN;
1719 }
1720 }
1721 $output .= $prefix . $level . ':';
1722 if ($show_types) {
1723 $output .= BLUE if (-t STDOUT && $color);
1724 $output .= "$type:";
1725 }
1726 $output .= RESET if (-t STDOUT && $color);
1727 $output .= ' ' . $msg . "\n";
1728
1729 if ($showfile) {
1730 my @lines = split("\n", $output, -1);
1731 splice(@lines, 1, 1);
1732 $output = join("\n", @lines);
1733 }
1734 $output = (split('\n', $output))[0] . "\n" if ($terse);
1735
1736 push(our @report, $output);
1737
1738 return 1;
1739}
1740
1741sub report_dump {
1742 our @report;
1743}
1744
1745sub fixup_current_range {
1746 my ($lineRef, $offset, $length) = @_;
1747
1748 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1749 my $o = $1;
1750 my $l = $2;
1751 my $no = $o + $offset;
1752 my $nl = $l + $length;
1753 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1754 }
1755}
1756
1757sub fix_inserted_deleted_lines {
1758 my ($linesRef, $insertedRef, $deletedRef) = @_;
1759
1760 my $range_last_linenr = 0;
1761 my $delta_offset = 0;
1762
1763 my $old_linenr = 0;
1764 my $new_linenr = 0;
1765
1766 my $next_insert = 0;
1767 my $next_delete = 0;
1768
1769 my @lines = ();
1770
1771 my $inserted = @{$insertedRef}[$next_insert++];
1772 my $deleted = @{$deletedRef}[$next_delete++];
1773
1774 foreach my $old_line (@{$linesRef}) {
1775 my $save_line = 1;
1776 my $line = $old_line; #don't modify the array
1777 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
1778 $delta_offset = 0;
1779 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1780 $range_last_linenr = $new_linenr;
1781 fixup_current_range(\$line, $delta_offset, 0);
1782 }
1783
1784 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1785 $deleted = @{$deletedRef}[$next_delete++];
1786 $save_line = 0;
1787 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1788 }
1789
1790 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1791 push(@lines, ${$inserted}{'LINE'});
1792 $inserted = @{$insertedRef}[$next_insert++];
1793 $new_linenr++;
1794 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1795 }
1796
1797 if ($save_line) {
1798 push(@lines, $line);
1799 $new_linenr++;
1800 }
1801
1802 $old_linenr++;
1803 }
1804
1805 return @lines;
1806}
1807
1808sub fix_insert_line {
1809 my ($linenr, $line) = @_;
1810
1811 my $inserted = {
1812 LINENR => $linenr,
1813 LINE => $line,
1814 };
1815 push(@fixed_inserted, $inserted);
1816}
1817
1818sub fix_delete_line {
1819 my ($linenr, $line) = @_;
1820
1821 my $deleted = {
1822 LINENR => $linenr,
1823 LINE => $line,
1824 };
1825
1826 push(@fixed_deleted, $deleted);
1827}
1828
1829sub ERROR {
1830 my ($type, $msg) = @_;
1831
1832 if (report("ERROR", $type, $msg)) {
1833 our $clean = 0;
1834 our $cnt_error++;
1835 return 1;
1836 }
1837 return 0;
1838}
1839sub WARN {
1840 my ($type, $msg) = @_;
1841
1842 if (report("WARNING", $type, $msg)) {
1843 our $clean = 0;
1844 our $cnt_warn++;
1845 return 1;
1846 }
1847 return 0;
1848}
1849sub CHK {
1850 my ($type, $msg) = @_;
1851
1852 if ($check && report("CHECK", $type, $msg)) {
1853 our $clean = 0;
1854 our $cnt_chk++;
1855 return 1;
1856 }
1857 return 0;
1858}
1859
1860sub check_absolute_file {
1861 my ($absolute, $herecurr) = @_;
1862 my $file = $absolute;
1863
1864 ##print "absolute<$absolute>\n";
1865
1866 # See if any suffix of this path is a path within the tree.
1867 while ($file =~ s@^[^/]*/@@) {
1868 if (-f "$root/$file") {
1869 ##print "file<$file>\n";
1870 last;
1871 }
1872 }
1873 if (! -f _) {
1874 return 0;
1875 }
1876
1877 # It is, so see if the prefix is acceptable.
1878 my $prefix = $absolute;
1879 substr($prefix, -length($file)) = '';
1880
1881 ##print "prefix<$prefix>\n";
1882 if ($prefix ne ".../") {
1883 WARN("USE_RELATIVE_PATH",
1884 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1885 }
1886}
1887
1888sub trim {
1889 my ($string) = @_;
1890
1891 $string =~ s/^\s+|\s+$//g;
1892
1893 return $string;
1894}
1895
1896sub ltrim {
1897 my ($string) = @_;
1898
1899 $string =~ s/^\s+//;
1900
1901 return $string;
1902}
1903
1904sub rtrim {
1905 my ($string) = @_;
1906
1907 $string =~ s/\s+$//;
1908
1909 return $string;
1910}
1911
1912sub string_find_replace {
1913 my ($string, $find, $replace) = @_;
1914
1915 $string =~ s/$find/$replace/g;
1916
1917 return $string;
1918}
1919
1920sub tabify {
1921 my ($leading) = @_;
1922
1923 my $source_indent = 8;
1924 my $max_spaces_before_tab = $source_indent - 1;
1925 my $spaces_to_tab = " " x $source_indent;
1926
1927 #convert leading spaces to tabs
1928 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1929 #Remove spaces before a tab
1930 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1931
1932 return "$leading";
1933}
1934
1935sub pos_last_openparen {
1936 my ($line) = @_;
1937
1938 my $pos = 0;
1939
1940 my $opens = $line =~ tr/\(/\(/;
1941 my $closes = $line =~ tr/\)/\)/;
1942
1943 my $last_openparen = 0;
1944
1945 if (($opens == 0) || ($closes >= $opens)) {
1946 return -1;
1947 }
1948
1949 my $len = length($line);
1950
1951 for ($pos = 0; $pos < $len; $pos++) {
1952 my $string = substr($line, $pos);
1953 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1954 $pos += length($1) - 1;
1955 } elsif (substr($line, $pos, 1) eq '(') {
1956 $last_openparen = $pos;
1957 } elsif (index($string, '(') == -1) {
1958 last;
1959 }
1960 }
1961
1962 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
1963}
1964
1965sub process {
1966 my $filename = shift;
1967
1968 my $linenr=0;
1969 my $prevline="";
1970 my $prevrawline="";
1971 my $stashline="";
1972 my $stashrawline="";
1973
1974 my $length;
1975 my $indent;
1976 my $previndent=0;
1977 my $stashindent=0;
1978
1979 our $clean = 1;
1980 my $signoff = 0;
1981 my $is_patch = 0;
1982 my $in_header_lines = $file ? 0 : 1;
1983 my $in_commit_log = 0; #Scanning lines before patch
1984 my $commit_log_possible_stack_dump = 0;
1985 my $commit_log_long_line = 0;
1986 my $commit_log_has_diff = 0;
1987 my $reported_maintainer_file = 0;
1988 my $non_utf8_charset = 0;
1989
1990 my $last_blank_line = 0;
1991 my $last_coalesced_string_linenr = -1;
1992
1993 our @report = ();
1994 our $cnt_lines = 0;
1995 our $cnt_error = 0;
1996 our $cnt_warn = 0;
1997 our $cnt_chk = 0;
1998
1999 # Trace the real file/line as we go.
2000 my $realfile = '';
2001 my $realline = 0;
2002 my $realcnt = 0;
2003 my $here = '';
2004 my $in_comment = 0;
2005 my $comment_edge = 0;
2006 my $first_line = 0;
2007 my $p1_prefix = '';
2008
2009 my $prev_values = 'E';
2010
2011 # suppression flags
2012 my %suppress_ifbraces;
2013 my %suppress_whiletrailers;
2014 my %suppress_export;
2015 my $suppress_statement = 0;
2016
2017 my %signatures = ();
2018
2019 # Pre-scan the patch sanitizing the lines.
2020 # Pre-scan the patch looking for any __setup documentation.
2021 #
2022 my @setup_docs = ();
2023 my $setup_docs = 0;
2024
2025 my $camelcase_file_seeded = 0;
2026
2027 sanitise_line_reset();
2028 my $line;
2029 foreach my $rawline (@rawlines) {
2030 $linenr++;
2031 $line = $rawline;
2032
2033 push(@fixed, $rawline) if ($fix);
2034
2035 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2036 $setup_docs = 0;
2037 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2038 $setup_docs = 1;
2039 }
2040 #next;
2041 }
2042 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2043 $realline=$1-1;
2044 if (defined $2) {
2045 $realcnt=$3+1;
2046 } else {
2047 $realcnt=1+1;
2048 }
2049 $in_comment = 0;
2050
2051 # Guestimate if this is a continuing comment. Run
2052 # the context looking for a comment "edge". If this
2053 # edge is a close comment then we must be in a comment
2054 # at context start.
2055 my $edge;
2056 my $cnt = $realcnt;
2057 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2058 next if (defined $rawlines[$ln - 1] &&
2059 $rawlines[$ln - 1] =~ /^-/);
2060 $cnt--;
2061 #print "RAW<$rawlines[$ln - 1]>\n";
2062 last if (!defined $rawlines[$ln - 1]);
2063 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2064 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2065 ($edge) = $1;
2066 last;
2067 }
2068 }
2069 if (defined $edge && $edge eq '*/') {
2070 $in_comment = 1;
2071 }
2072
2073 # Guestimate if this is a continuing comment. If this
2074 # is the start of a diff block and this line starts
2075 # ' *' then it is very likely a comment.
2076 if (!defined $edge &&
2077 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2078 {
2079 $in_comment = 1;
2080 }
2081
2082 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2083 sanitise_line_reset($in_comment);
2084
2085 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2086 # Standardise the strings and chars within the input to
2087 # simplify matching -- only bother with positive lines.
2088 $line = sanitise_line($rawline);
2089 }
2090 push(@lines, $line);
2091
2092 if ($realcnt > 1) {
2093 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2094 } else {
2095 $realcnt = 0;
2096 }
2097
2098 #print "==>$rawline\n";
2099 #print "-->$line\n";
2100
2101 if ($setup_docs && $line =~ /^\+/) {
2102 push(@setup_docs, $line);
2103 }
2104 }
2105
2106 $prefix = '';
2107
2108 $realcnt = 0;
2109 $linenr = 0;
2110 $fixlinenr = -1;
2111 foreach my $line (@lines) {
2112 $linenr++;
2113 $fixlinenr++;
2114 my $sline = $line; #copy of $line
2115 $sline =~ s/$;/ /g; #with comments as spaces
2116
2117 my $rawline = $rawlines[$linenr - 1];
2118
2119#extract the line range in the file after the patch is applied
2120 if (!$in_commit_log &&
2121 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2122 $is_patch = 1;
2123 $first_line = $linenr + 1;
2124 $realline=$1-1;
2125 if (defined $2) {
2126 $realcnt=$3+1;
2127 } else {
2128 $realcnt=1+1;
2129 }
2130 annotate_reset();
2131 $prev_values = 'E';
2132
2133 %suppress_ifbraces = ();
2134 %suppress_whiletrailers = ();
2135 %suppress_export = ();
2136 $suppress_statement = 0;
2137 next;
2138
2139# track the line number as we move through the hunk, note that
2140# new versions of GNU diff omit the leading space on completely
2141# blank context lines so we need to count that too.
2142 } elsif ($line =~ /^( |\+|$)/) {
2143 $realline++;
2144 $realcnt-- if ($realcnt != 0);
2145
2146 # Measure the line length and indent.
2147 ($length, $indent) = line_stats($rawline);
2148
2149 # Track the previous line.
2150 ($prevline, $stashline) = ($stashline, $line);
2151 ($previndent, $stashindent) = ($stashindent, $indent);
2152 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2153
2154 #warn "line<$line>\n";
2155
2156 } elsif ($realcnt == 1) {
2157 $realcnt--;
2158 }
2159
2160 my $hunk_line = ($realcnt != 0);
2161
2162 $here = "#$linenr: " if (!$file);
2163 $here = "#$realline: " if ($file);
2164
2165 my $found_file = 0;
2166 # extract the filename as it passes
2167 if ($line =~ /^diff --git.*?(\S+)$/) {
2168 $realfile = $1;
2169 $realfile =~ s@^([^/]*)/@@ if (!$file);
2170 $in_commit_log = 0;
2171 $found_file = 1;
2172 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2173 $realfile = $1;
2174 $realfile =~ s@^([^/]*)/@@ if (!$file);
2175 $in_commit_log = 0;
2176
2177 $p1_prefix = $1;
2178 if (!$file && $tree && $p1_prefix ne '' &&
2179 -e "$root/$p1_prefix") {
2180 WARN("PATCH_PREFIX",
2181 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2182 }
2183
2184 if ($realfile =~ m@^include/asm/@) {
2185 ERROR("MODIFIED_INCLUDE_ASM",
2186 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2187 }
2188 $found_file = 1;
2189 }
2190
2191#make up the handle for any error we report on this line
2192 if ($showfile) {
2193 $prefix = "$realfile:$realline: "
2194 } elsif ($emacs) {
2195 if ($file) {
2196 $prefix = "$filename:$realline: ";
2197 } else {
2198 $prefix = "$filename:$linenr: ";
2199 }
2200 }
2201
2202 if ($found_file) {
2203 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2204 $check = 1;
2205 } else {
2206 $check = $check_orig;
2207 }
2208 next;
2209 }
2210
2211 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2212
2213 my $hereline = "$here\n$rawline\n";
2214 my $herecurr = "$here\n$rawline\n";
2215 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2216
2217 $cnt_lines++ if ($realcnt != 0);
2218
2219# Check if the commit log has what seems like a diff which can confuse patch
2220 if ($in_commit_log && !$commit_log_has_diff &&
2221 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2222 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2223 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2224 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2225 ERROR("DIFF_IN_COMMIT_MSG",
2226 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2227 $commit_log_has_diff = 1;
2228 }
2229
2230# Check for incorrect file permissions
2231 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2232 my $permhere = $here . "FILE: $realfile\n";
2233 if ($realfile !~ m@scripts/@ &&
2234 $realfile !~ /\.(py|pl|awk|sh)$/) {
2235 ERROR("EXECUTE_PERMISSIONS",
2236 "do not set execute permissions for source files\n" . $permhere);
2237 }
2238 }
2239
2240# Check the patch for a signoff:
2241 if ($line =~ /^\s*signed-off-by:/i) {
2242 $signoff++;
2243 $in_commit_log = 0;
2244 }
2245
2246# Check if MAINTAINERS is being updated. If so, there's probably no need to
2247# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2248 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2249 $reported_maintainer_file = 1;
2250 }
2251
2252# Check signature styles
2253 if (!$in_header_lines &&
2254 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2255 my $space_before = $1;
2256 my $sign_off = $2;
2257 my $space_after = $3;
2258 my $email = $4;
2259 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2260
2261 if ($sign_off !~ /$signature_tags/) {
2262 WARN("BAD_SIGN_OFF",
2263 "Non-standard signature: $sign_off\n" . $herecurr);
2264 }
2265 if (defined $space_before && $space_before ne "") {
2266 if (WARN("BAD_SIGN_OFF",
2267 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2268 $fix) {
2269 $fixed[$fixlinenr] =
2270 "$ucfirst_sign_off $email";
2271 }
2272 }
2273 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2274 if (WARN("BAD_SIGN_OFF",
2275 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2276 $fix) {
2277 $fixed[$fixlinenr] =
2278 "$ucfirst_sign_off $email";
2279 }
2280
2281 }
2282 if (!defined $space_after || $space_after ne " ") {
2283 if (WARN("BAD_SIGN_OFF",
2284 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2285 $fix) {
2286 $fixed[$fixlinenr] =
2287 "$ucfirst_sign_off $email";
2288 }
2289 }
2290
2291 my ($email_name, $email_address, $comment) = parse_email($email);
2292 my $suggested_email = format_email(($email_name, $email_address));
2293 if ($suggested_email eq "") {
2294 ERROR("BAD_SIGN_OFF",
2295 "Unrecognized email address: '$email'\n" . $herecurr);
2296 } else {
2297 my $dequoted = $suggested_email;
2298 $dequoted =~ s/^"//;
2299 $dequoted =~ s/" </ </;
2300 # Don't force email to have quotes
2301 # Allow just an angle bracketed address
2302 if ("$dequoted$comment" ne $email &&
2303 "<$email_address>$comment" ne $email &&
2304 "$suggested_email$comment" ne $email) {
2305 WARN("BAD_SIGN_OFF",
2306 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2307 }
2308 }
2309
2310# Check for duplicate signatures
2311 my $sig_nospace = $line;
2312 $sig_nospace =~ s/\s//g;
2313 $sig_nospace = lc($sig_nospace);
2314 if (defined $signatures{$sig_nospace}) {
2315 WARN("BAD_SIGN_OFF",
2316 "Duplicate signature\n" . $herecurr);
2317 } else {
2318 $signatures{$sig_nospace} = 1;
2319 }
2320 }
2321
2322# Check email subject for common tools that don't need to be mentioned
2323 if ($in_header_lines &&
2324 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2325 WARN("EMAIL_SUBJECT",
2326 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2327 }
2328
2329# Check for old stable address
2330 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2331 ERROR("STABLE_ADDRESS",
2332 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2333 }
2334
2335# Check for unwanted Gerrit info
2336 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2337 ERROR("GERRIT_CHANGE_ID",
2338 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2339 }
2340
2341# Check if the commit log is in a possible stack dump
2342 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2343 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2344 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2345 # timestamp
2346 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2347 # stack dump address
2348 $commit_log_possible_stack_dump = 1;
2349 }
2350
2351# Check for line lengths > 75 in commit log, warn once
2352 if ($in_commit_log && !$commit_log_long_line &&
2353 length($line) > 75 &&
2354 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2355 # file delta changes
2356 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2357 # filename then :
2358 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2359 # A Fixes: or Link: line
2360 $commit_log_possible_stack_dump)) {
2361 WARN("COMMIT_LOG_LONG_LINE",
2362 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2363 $commit_log_long_line = 1;
2364 }
2365
2366# Reset possible stack dump if a blank line is found
2367 if ($in_commit_log && $commit_log_possible_stack_dump &&
2368 $line =~ /^\s*$/) {
2369 $commit_log_possible_stack_dump = 0;
2370 }
2371
2372# Check for git id commit length and improperly formed commit descriptions
2373 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2374 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2375 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2376 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2377 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2378 my $init_char = "c";
2379 my $orig_commit = "";
2380 my $short = 1;
2381 my $long = 0;
2382 my $case = 1;
2383 my $space = 1;
2384 my $hasdesc = 0;
2385 my $hasparens = 0;
2386 my $id = '0123456789ab';
2387 my $orig_desc = "commit description";
2388 my $description = "";
2389
2390 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2391 $init_char = $1;
2392 $orig_commit = lc($2);
2393 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2394 $orig_commit = lc($1);
2395 }
2396
2397 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2398 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2399 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2400 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2401 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2402 $orig_desc = $1;
2403 $hasparens = 1;
2404 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2405 defined $rawlines[$linenr] &&
2406 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2407 $orig_desc = $1;
2408 $hasparens = 1;
2409 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2410 defined $rawlines[$linenr] &&
2411 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2412 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2413 $orig_desc = $1;
2414 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2415 $orig_desc .= " " . $1;
2416 $hasparens = 1;
2417 }
2418
2419 ($id, $description) = git_commit_info($orig_commit,
2420 $id, $orig_desc);
2421
2422 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
2423 ERROR("GIT_COMMIT_ID",
2424 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2425 }
2426 }
2427
2428# Check for added, moved or deleted files
2429 if (!$reported_maintainer_file && !$in_commit_log &&
2430 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2431 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2432 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2433 (defined($1) || defined($2))))) {
2434 $reported_maintainer_file = 1;
2435 WARN("FILE_PATH_CHANGES",
2436 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2437 }
2438
2439# Check for wrappage within a valid hunk of the file
2440 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2441 ERROR("CORRUPTED_PATCH",
2442 "patch seems to be corrupt (line wrapped?)\n" .
2443 $herecurr) if (!$emitted_corrupt++);
2444 }
2445
2446# Check for absolute kernel paths.
2447 if ($tree) {
2448 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2449 my $file = $1;
2450
2451 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2452 check_absolute_file($1, $herecurr)) {
2453 #
2454 } else {
2455 check_absolute_file($file, $herecurr);
2456 }
2457 }
2458 }
2459
2460# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2461 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2462 $rawline !~ m/^$UTF8*$/) {
2463 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2464
2465 my $blank = copy_spacing($rawline);
2466 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2467 my $hereptr = "$hereline$ptr\n";
2468
2469 CHK("INVALID_UTF8",
2470 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2471 }
2472
2473# Check if it's the start of a commit log
2474# (not a header line and we haven't seen the patch filename)
2475 if ($in_header_lines && $realfile =~ /^$/ &&
2476 !($rawline =~ /^\s+\S/ ||
2477 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
2478 $in_header_lines = 0;
2479 $in_commit_log = 1;
2480 }
2481
2482# Check if there is UTF-8 in a commit log when a mail header has explicitly
2483# declined it, i.e defined some charset where it is missing.
2484 if ($in_header_lines &&
2485 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2486 $1 !~ /utf-8/i) {
2487 $non_utf8_charset = 1;
2488 }
2489
2490 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2491 $rawline =~ /$NON_ASCII_UTF8/) {
2492 WARN("UTF8_BEFORE_PATCH",
2493 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2494 }
2495
2496# Check for various typo / spelling mistakes
2497 if (defined($misspellings) &&
2498 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2499 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2500 my $typo = $1;
2501 my $typo_fix = $spelling_fix{lc($typo)};
2502 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2503 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2504 my $msg_type = \&WARN;
2505 $msg_type = \&CHK if ($file);
2506 if (&{$msg_type}("TYPO_SPELLING",
2507 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2508 $fix) {
2509 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2510 }
2511 }
2512 }
2513
2514# ignore non-hunk lines and lines being removed
2515 next if (!$hunk_line || $line =~ /^-/);
2516
2517#trailing whitespace
2518 if ($line =~ /^\+.*\015/) {
2519 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2520 if (ERROR("DOS_LINE_ENDINGS",
2521 "DOS line endings\n" . $herevet) &&
2522 $fix) {
2523 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2524 }
2525 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2526 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2527 if (ERROR("TRAILING_WHITESPACE",
2528 "trailing whitespace\n" . $herevet) &&
2529 $fix) {
2530 $fixed[$fixlinenr] =~ s/\s+$//;
2531 }
2532
2533 $rpt_cleaners = 1;
2534 }
2535
2536# Check for FSF mailing addresses.
2537 if ($rawline =~ /\bwrite to the Free/i ||
2538 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2539 $rawline =~ /\b51\s+Franklin\s+St/i) {
2540 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2541 my $msg_type = \&ERROR;
2542 $msg_type = \&CHK if ($file);
2543 &{$msg_type}("FSF_MAILING_ADDRESS",
2544 "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)
2545 }
2546
2547# check for Kconfig help text having a real description
2548# Only applies when adding the entry originally, after that we do not have
2549# sufficient context to determine whether it is indeed long enough.
2550 if ($realfile =~ /Kconfig/ &&
2551 $line =~ /^\+\s*config\s+/) {
2552 my $length = 0;
2553 my $cnt = $realcnt;
2554 my $ln = $linenr + 1;
2555 my $f;
2556 my $is_start = 0;
2557 my $is_end = 0;
2558 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2559 $f = $lines[$ln - 1];
2560 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2561 $is_end = $lines[$ln - 1] =~ /^\+/;
2562
2563 next if ($f =~ /^-/);
2564 last if (!$file && $f =~ /^\@\@/);
2565
2566 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
2567 $is_start = 1;
2568 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
2569 $length = -1;
2570 }
2571
2572 $f =~ s/^.//;
2573 $f =~ s/#.*//;
2574 $f =~ s/^\s+//;
2575 next if ($f =~ /^$/);
2576 if ($f =~ /^\s*config\s/) {
2577 $is_end = 1;
2578 last;
2579 }
2580 $length++;
2581 }
2582 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2583 WARN("CONFIG_DESCRIPTION",
2584 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2585 }
2586 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2587 }
2588
2589# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2590 if ($realfile =~ /Kconfig/ &&
2591 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2592 WARN("CONFIG_EXPERIMENTAL",
2593 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2594 }
2595
2596# discourage the use of boolean for type definition attributes of Kconfig options
2597 if ($realfile =~ /Kconfig/ &&
2598 $line =~ /^\+\s*\bboolean\b/) {
2599 WARN("CONFIG_TYPE_BOOLEAN",
2600 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2601 }
2602
2603 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2604 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2605 my $flag = $1;
2606 my $replacement = {
2607 'EXTRA_AFLAGS' => 'asflags-y',
2608 'EXTRA_CFLAGS' => 'ccflags-y',
2609 'EXTRA_CPPFLAGS' => 'cppflags-y',
2610 'EXTRA_LDFLAGS' => 'ldflags-y',
2611 };
2612
2613 WARN("DEPRECATED_VARIABLE",
2614 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2615 }
2616
2617# check for DT compatible documentation
2618 if (defined $root &&
2619 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2620 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2621
2622 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2623
2624 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2625 my $vp_file = $dt_path . "vendor-prefixes.txt";
2626
2627 foreach my $compat (@compats) {
2628 my $compat2 = $compat;
2629 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2630 my $compat3 = $compat;
2631 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2632 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
2633 if ( $? >> 8 ) {
2634 WARN("UNDOCUMENTED_DT_STRING",
2635 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2636 }
2637
2638 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2639 my $vendor = $1;
2640 `grep -Eq "^$vendor\\b" $vp_file`;
2641 if ( $? >> 8 ) {
2642 WARN("UNDOCUMENTED_DT_STRING",
2643 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2644 }
2645 }
2646 }
2647
2648# check we are in a valid source file if not then ignore this hunk
2649 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
2650
2651# line length limit (with some exclusions)
2652#
2653# There are a few types of lines that may extend beyond $max_line_length:
2654# logging functions like pr_info that end in a string
2655# lines with a single string
2656# #defines that are a single string
2657#
2658# There are 3 different line length message types:
2659# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2660# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2661# LONG_LINE all other lines longer than $max_line_length
2662#
2663# if LONG_LINE is ignored, the other 2 types are also ignored
2664#
2665
2666 if ($line =~ /^\+/ && $length > $max_line_length) {
2667 my $msg_type = "LONG_LINE";
2668
2669 # Check the allowed long line types first
2670
2671 # logging functions that end in a string that starts
2672 # before $max_line_length
2673 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2674 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2675 $msg_type = "";
2676
2677 # lines with only strings (w/ possible termination)
2678 # #defines with only strings
2679 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2680 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2681 $msg_type = "";
2682
2683 # Otherwise set the alternate message types
2684
2685 # a comment starts before $max_line_length
2686 } elsif ($line =~ /($;[\s$;]*)$/ &&
2687 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2688 $msg_type = "LONG_LINE_COMMENT"
2689
2690 # a quoted string starts before $max_line_length
2691 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2692 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2693 $msg_type = "LONG_LINE_STRING"
2694 }
2695
2696 if ($msg_type ne "" &&
2697 (show_type("LONG_LINE") || show_type($msg_type))) {
2698 WARN($msg_type,
2699 "line over $max_line_length characters\n" . $herecurr);
2700 }
2701 }
2702
2703# check for adding lines without a newline.
2704 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2705 WARN("MISSING_EOF_NEWLINE",
2706 "adding a line without newline at end of file\n" . $herecurr);
2707 }
2708
2709# Blackfin: use hi/lo macros
2710 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2711 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2712 my $herevet = "$here\n" . cat_vet($line) . "\n";
2713 ERROR("LO_MACRO",
2714 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
2715 }
2716 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2717 my $herevet = "$here\n" . cat_vet($line) . "\n";
2718 ERROR("HI_MACRO",
2719 "use the HI() macro, not (... >> 16)\n" . $herevet);
2720 }
2721 }
2722
2723# check we are in a valid source file C or perl if not then ignore this hunk
2724 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
2725
2726# at the beginning of a line any tabs must come first and anything
2727# more than 8 must use tabs.
2728 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2729 $rawline =~ /^\+\s* \s*/) {
2730 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2731 $rpt_cleaners = 1;
2732 if (ERROR("CODE_INDENT",
2733 "code indent should use tabs where possible\n" . $herevet) &&
2734 $fix) {
2735 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2736 }
2737 }
2738
2739# check for space before tabs.
2740 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2741 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2742 if (WARN("SPACE_BEFORE_TAB",
2743 "please, no space before tabs\n" . $herevet) &&
2744 $fix) {
2745 while ($fixed[$fixlinenr] =~
2746 s/(^\+.*) {8,8}\t/$1\t\t/) {}
2747 while ($fixed[$fixlinenr] =~
2748 s/(^\+.*) +\t/$1\t/) {}
2749 }
2750 }
2751
2752# check for && or || at the start of a line
2753 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2754 CHK("LOGICAL_CONTINUATIONS",
2755 "Logical continuations should be on the previous line\n" . $hereprev);
2756 }
2757
2758# check multi-line statement indentation matches previous line
2759 if ($^V && $^V ge 5.10.0 &&
2760 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2761 $prevline =~ /^\+(\t*)(.*)$/;
2762 my $oldindent = $1;
2763 my $rest = $2;
2764
2765 my $pos = pos_last_openparen($rest);
2766 if ($pos >= 0) {
2767 $line =~ /^(\+| )([ \t]*)/;
2768 my $newindent = $2;
2769
2770 my $goodtabindent = $oldindent .
2771 "\t" x ($pos / 8) .
2772 " " x ($pos % 8);
2773 my $goodspaceindent = $oldindent . " " x $pos;
2774
2775 if ($newindent ne $goodtabindent &&
2776 $newindent ne $goodspaceindent) {
2777
2778 if (CHK("PARENTHESIS_ALIGNMENT",
2779 "Alignment should match open parenthesis\n" . $hereprev) &&
2780 $fix && $line =~ /^\+/) {
2781 $fixed[$fixlinenr] =~
2782 s/^\+[ \t]*/\+$goodtabindent/;
2783 }
2784 }
2785 }
2786 }
2787
2788# check for space after cast like "(int) foo" or "(struct foo) bar"
2789# avoid checking a few false positives:
2790# "sizeof(<type>)" or "__alignof__(<type>)"
2791# function pointer declarations like "(*foo)(int) = bar;"
2792# structure definitions like "(struct foo) { 0 };"
2793# multiline macros that define functions
2794# known attributes or the __attribute__ keyword
2795 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2796 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
2797 if (CHK("SPACING",
2798 "No space is necessary after a cast\n" . $herecurr) &&
2799 $fix) {
2800 $fixed[$fixlinenr] =~
2801 s/(\(\s*$Type\s*\))[ \t]+/$1/;
2802 }
2803 }
2804
2805# Block comment styles
2806# Networking with an initial /*
2807 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2808 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2809 $rawline =~ /^\+[ \t]*\*/ &&
2810 $realline > 2) {
2811 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2812 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2813 }
2814
2815# Block comments use * on subsequent lines
2816 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2817 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
2818 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2819 $rawline =~ /^\+/ && #line is new
2820 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2821 WARN("BLOCK_COMMENT_STYLE",
2822 "Block comments use * on subsequent lines\n" . $hereprev);
2823 }
2824
2825# Block comments use */ on trailing lines
2826 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2827 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2828 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2829 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
2830 WARN("BLOCK_COMMENT_STYLE",
2831 "Block comments use a trailing */ on a separate line\n" . $herecurr);
2832 }
2833
2834# check for missing blank lines after struct/union declarations
2835# with exceptions for various attributes and macros
2836 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2837 $line =~ /^\+/ &&
2838 !($line =~ /^\+\s*$/ ||
2839 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2840 $line =~ /^\+\s*MODULE_/i ||
2841 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2842 $line =~ /^\+[a-z_]*init/ ||
2843 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2844 $line =~ /^\+\s*DECLARE/ ||
2845 $line =~ /^\+\s*__setup/)) {
2846 if (CHK("LINE_SPACING",
2847 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2848 $fix) {
2849 fix_insert_line($fixlinenr, "\+");
2850 }
2851 }
2852
2853# check for multiple consecutive blank lines
2854 if ($prevline =~ /^[\+ ]\s*$/ &&
2855 $line =~ /^\+\s*$/ &&
2856 $last_blank_line != ($linenr - 1)) {
2857 if (CHK("LINE_SPACING",
2858 "Please don't use multiple blank lines\n" . $hereprev) &&
2859 $fix) {
2860 fix_delete_line($fixlinenr, $rawline);
2861 }
2862
2863 $last_blank_line = $linenr;
2864 }
2865
2866# check for missing blank lines after declarations
2867 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2868 # actual declarations
2869 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2870 # function pointer declarations
2871 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2872 # foo bar; where foo is some local typedef or #define
2873 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2874 # known declaration macros
2875 $prevline =~ /^\+\s+$declaration_macros/) &&
2876 # for "else if" which can look like "$Ident $Ident"
2877 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2878 # other possible extensions of declaration lines
2879 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2880 # not starting a section or a macro "\" extended line
2881 $prevline =~ /(?:\{\s*|\\)$/) &&
2882 # looks like a declaration
2883 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2884 # function pointer declarations
2885 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
2886 # foo bar; where foo is some local typedef or #define
2887 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2888 # known declaration macros
2889 $sline =~ /^\+\s+$declaration_macros/ ||
2890 # start of struct or union or enum
2891 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2892 # start or end of block or continuation of declaration
2893 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2894 # bitfield continuation
2895 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2896 # other possible extensions of declaration lines
2897 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2898 # indentation of previous and current line are the same
2899 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
2900 if (WARN("LINE_SPACING",
2901 "Missing a blank line after declarations\n" . $hereprev) &&
2902 $fix) {
2903 fix_insert_line($fixlinenr, "\+");
2904 }
2905 }
2906
2907# check for spaces at the beginning of a line.
2908# Exceptions:
2909# 1) within comments
2910# 2) indented preprocessor commands
2911# 3) hanging labels
2912 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
2913 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2914 if (WARN("LEADING_SPACE",
2915 "please, no spaces at the start of a line\n" . $herevet) &&
2916 $fix) {
2917 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2918 }
2919 }
2920
2921# check we are in a valid C source file if not then ignore this hunk
2922 next if ($realfile !~ /\.(h|c)$/);
2923
2924# check indentation of any line with a bare else
2925# (but not if it is a multiple line "if (foo) return bar; else return baz;")
2926# if the previous line is a break or return and is indented 1 tab more...
2927 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2928 my $tabs = length($1) + 1;
2929 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2930 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2931 defined $lines[$linenr] &&
2932 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
2933 WARN("UNNECESSARY_ELSE",
2934 "else is not generally useful after a break or return\n" . $hereprev);
2935 }
2936 }
2937
2938# check indentation of a line with a break;
2939# if the previous line is a goto or return and is indented the same # of tabs
2940 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2941 my $tabs = $1;
2942 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2943 WARN("UNNECESSARY_BREAK",
2944 "break is not useful after a goto or return\n" . $hereprev);
2945 }
2946 }
2947
2948# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2949 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2950 WARN("CONFIG_EXPERIMENTAL",
2951 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2952 }
2953
2954# check for RCS/CVS revision markers
2955 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
2956 WARN("CVS_KEYWORD",
2957 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
2958 }
2959
2960# Blackfin: don't use __builtin_bfin_[cs]sync
2961 if ($line =~ /__builtin_bfin_csync/) {
2962 my $herevet = "$here\n" . cat_vet($line) . "\n";
2963 ERROR("CSYNC",
2964 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
2965 }
2966 if ($line =~ /__builtin_bfin_ssync/) {
2967 my $herevet = "$here\n" . cat_vet($line) . "\n";
2968 ERROR("SSYNC",
2969 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
2970 }
2971
2972# check for old HOTPLUG __dev<foo> section markings
2973 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2974 WARN("HOTPLUG_SECTION",
2975 "Using $1 is unnecessary\n" . $herecurr);
2976 }
2977
2978# Check for potential 'bare' types
2979 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2980 $realline_next);
2981#print "LINE<$line>\n";
2982 if ($linenr >= $suppress_statement &&
2983 $realcnt && $sline =~ /.\s*\S/) {
2984 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2985 ctx_statement_block($linenr, $realcnt, 0);
2986 $stat =~ s/\n./\n /g;
2987 $cond =~ s/\n./\n /g;
2988
2989#print "linenr<$linenr> <$stat>\n";
2990 # If this statement has no statement boundaries within
2991 # it there is no point in retrying a statement scan
2992 # until we hit end of it.
2993 my $frag = $stat; $frag =~ s/;+\s*$//;
2994 if ($frag !~ /(?:{|;)/) {
2995#print "skip<$line_nr_next>\n";
2996 $suppress_statement = $line_nr_next;
2997 }
2998
2999 # Find the real next line.
3000 $realline_next = $line_nr_next;
3001 if (defined $realline_next &&
3002 (!defined $lines[$realline_next - 1] ||
3003 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3004 $realline_next++;
3005 }
3006
3007 my $s = $stat;
3008 $s =~ s/{.*$//s;
3009
3010 # Ignore goto labels.
3011 if ($s =~ /$Ident:\*$/s) {
3012
3013 # Ignore functions being called
3014 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3015
3016 } elsif ($s =~ /^.\s*else\b/s) {
3017
3018 # declarations always start with types
3019 } 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) {
3020 my $type = $1;
3021 $type =~ s/\s+/ /g;
3022 possible($type, "A:" . $s);
3023
3024 # definitions in global scope can only start with types
3025 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3026 possible($1, "B:" . $s);
3027 }
3028
3029 # any (foo ... *) is a pointer cast, and foo is a type
3030 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3031 possible($1, "C:" . $s);
3032 }
3033
3034 # Check for any sort of function declaration.
3035 # int foo(something bar, other baz);
3036 # void (*store_gdt)(x86_descr_ptr *);
3037 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3038 my ($name_len) = length($1);
3039
3040 my $ctx = $s;
3041 substr($ctx, 0, $name_len + 1, '');
3042 $ctx =~ s/\)[^\)]*$//;
3043
3044 for my $arg (split(/\s*,\s*/, $ctx)) {
3045 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3046
3047 possible($1, "D:" . $s);
3048 }
3049 }
3050 }
3051
3052 }
3053
3054#
3055# Checks which may be anchored in the context.
3056#
3057
3058# Check for switch () and associated case and default
3059# statements should be at the same indent.
3060 if ($line=~/\bswitch\s*\(.*\)/) {
3061 my $err = '';
3062 my $sep = '';
3063 my @ctx = ctx_block_outer($linenr, $realcnt);
3064 shift(@ctx);
3065 for my $ctx (@ctx) {
3066 my ($clen, $cindent) = line_stats($ctx);
3067 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3068 $indent != $cindent) {
3069 $err .= "$sep$ctx\n";
3070 $sep = '';
3071 } else {
3072 $sep = "[...]\n";
3073 }
3074 }
3075 if ($err ne '') {
3076 ERROR("SWITCH_CASE_INDENT_LEVEL",
3077 "switch and case should be at the same indent\n$hereline$err");
3078 }
3079 }
3080
3081# if/while/etc brace do not go on next line, unless defining a do while loop,
3082# or if that brace on the next line is for something else
3083 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3084 my $pre_ctx = "$1$2";
3085
3086 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3087
3088 if ($line =~ /^\+\t{6,}/) {
3089 WARN("DEEP_INDENTATION",
3090 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3091 }
3092
3093 my $ctx_cnt = $realcnt - $#ctx - 1;
3094 my $ctx = join("\n", @ctx);
3095
3096 my $ctx_ln = $linenr;
3097 my $ctx_skip = $realcnt;
3098
3099 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3100 defined $lines[$ctx_ln - 1] &&
3101 $lines[$ctx_ln - 1] =~ /^-/)) {
3102 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3103 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3104 $ctx_ln++;
3105 }
3106
3107 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3108 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3109
3110 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3111 ERROR("OPEN_BRACE",
3112 "that open brace { should be on the previous line\n" .
3113 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3114 }
3115 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3116 $ctx =~ /\)\s*\;\s*$/ &&
3117 defined $lines[$ctx_ln - 1])
3118 {
3119 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3120 if ($nindent > $indent) {
3121 WARN("TRAILING_SEMICOLON",
3122 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3123 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3124 }
3125 }
3126 }
3127
3128# Check relative indent for conditionals and blocks.
3129 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3130 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3131 ctx_statement_block($linenr, $realcnt, 0)
3132 if (!defined $stat);
3133 my ($s, $c) = ($stat, $cond);
3134
3135 substr($s, 0, length($c), '');
3136
3137 # remove inline comments
3138 $s =~ s/$;/ /g;
3139 $c =~ s/$;/ /g;
3140
3141 # Find out how long the conditional actually is.
3142 my @newlines = ($c =~ /\n/gs);
3143 my $cond_lines = 1 + $#newlines;
3144
3145 # Make sure we remove the line prefixes as we have
3146 # none on the first line, and are going to readd them
3147 # where necessary.
3148 $s =~ s/\n./\n/gs;
3149 while ($s =~ /\n\s+\\\n/) {
3150 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3151 }
3152
3153 # We want to check the first line inside the block
3154 # starting at the end of the conditional, so remove:
3155 # 1) any blank line termination
3156 # 2) any opening brace { on end of the line
3157 # 3) any do (...) {
3158 my $continuation = 0;
3159 my $check = 0;
3160 $s =~ s/^.*\bdo\b//;
3161 $s =~ s/^\s*{//;
3162 if ($s =~ s/^\s*\\//) {
3163 $continuation = 1;
3164 }
3165 if ($s =~ s/^\s*?\n//) {
3166 $check = 1;
3167 $cond_lines++;
3168 }
3169
3170 # Also ignore a loop construct at the end of a
3171 # preprocessor statement.
3172 if (($prevline =~ /^.\s*#\s*define\s/ ||
3173 $prevline =~ /\\\s*$/) && $continuation == 0) {
3174 $check = 0;
3175 }
3176
3177 my $cond_ptr = -1;
3178 $continuation = 0;
3179 while ($cond_ptr != $cond_lines) {
3180 $cond_ptr = $cond_lines;
3181
3182 # If we see an #else/#elif then the code
3183 # is not linear.
3184 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3185 $check = 0;
3186 }
3187
3188 # Ignore:
3189 # 1) blank lines, they should be at 0,
3190 # 2) preprocessor lines, and
3191 # 3) labels.
3192 if ($continuation ||
3193 $s =~ /^\s*?\n/ ||
3194 $s =~ /^\s*#\s*?/ ||
3195 $s =~ /^\s*$Ident\s*:/) {
3196 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3197 if ($s =~ s/^.*?\n//) {
3198 $cond_lines++;
3199 }
3200 }
3201 }
3202
3203 my (undef, $sindent) = line_stats("+" . $s);
3204 my $stat_real = raw_line($linenr, $cond_lines);
3205
3206 # Check if either of these lines are modified, else
3207 # this is not this patch's fault.
3208 if (!defined($stat_real) ||
3209 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3210 $check = 0;
3211 }
3212 if (defined($stat_real) && $cond_lines > 1) {
3213 $stat_real = "[...]\n$stat_real";
3214 }
3215
3216 #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";
3217
3218 if ($check && $s ne '' &&
3219 (($sindent % 8) != 0 ||
3220 ($sindent < $indent) ||
3221 ($sindent > $indent + 8))) {
3222 WARN("SUSPECT_CODE_INDENT",
3223 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3224 }
3225 }
3226
3227 # Track the 'values' across context and added lines.
3228 my $opline = $line; $opline =~ s/^./ /;
3229 my ($curr_values, $curr_vars) =
3230 annotate_values($opline . "\n", $prev_values);
3231 $curr_values = $prev_values . $curr_values;
3232 if ($dbg_values) {
3233 my $outline = $opline; $outline =~ s/\t/ /g;
3234 print "$linenr > .$outline\n";
3235 print "$linenr > $curr_values\n";
3236 print "$linenr > $curr_vars\n";
3237 }
3238 $prev_values = substr($curr_values, -1);
3239
3240#ignore lines not being added
3241 next if ($line =~ /^[^\+]/);
3242
3243# check for declarations of signed or unsigned without int
3244 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3245 my $type = $1;
3246 my $var = $2;
3247 $var = "" if (!defined $var);
3248 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3249 my $sign = $1;
3250 my $pointer = $2;
3251
3252 $pointer = "" if (!defined $pointer);
3253
3254 if (WARN("UNSPECIFIED_INT",
3255 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3256 $fix) {
3257 my $decl = trim($sign) . " int ";
3258 my $comp_pointer = $pointer;
3259 $comp_pointer =~ s/\s//g;
3260 $decl .= $comp_pointer;
3261 $decl = rtrim($decl) if ($var eq "");
3262 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3263 }
3264 }
3265 }
3266
3267# TEST: allow direct testing of the type matcher.
3268 if ($dbg_type) {
3269 if ($line =~ /^.\s*$Declare\s*$/) {
3270 ERROR("TEST_TYPE",
3271 "TEST: is type\n" . $herecurr);
3272 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3273 ERROR("TEST_NOT_TYPE",
3274 "TEST: is not type ($1 is)\n". $herecurr);
3275 }
3276 next;
3277 }
3278# TEST: allow direct testing of the attribute matcher.
3279 if ($dbg_attr) {
3280 if ($line =~ /^.\s*$Modifier\s*$/) {
3281 ERROR("TEST_ATTR",
3282 "TEST: is attr\n" . $herecurr);
3283 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3284 ERROR("TEST_NOT_ATTR",
3285 "TEST: is not attr ($1 is)\n". $herecurr);
3286 }
3287 next;
3288 }
3289
3290# check for initialisation to aggregates open brace on the next line
3291 if ($line =~ /^.\s*{/ &&
3292 $prevline =~ /(?:^|[^=])=\s*$/) {
3293 if (ERROR("OPEN_BRACE",
3294 "that open brace { should be on the previous line\n" . $hereprev) &&
3295 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3296 fix_delete_line($fixlinenr - 1, $prevrawline);
3297 fix_delete_line($fixlinenr, $rawline);
3298 my $fixedline = $prevrawline;
3299 $fixedline =~ s/\s*=\s*$/ = {/;
3300 fix_insert_line($fixlinenr, $fixedline);
3301 $fixedline = $line;
3302 $fixedline =~ s/^(.\s*){\s*/$1/;
3303 fix_insert_line($fixlinenr, $fixedline);
3304 }
3305 }
3306
3307#
3308# Checks which are anchored on the added line.
3309#
3310
3311# check for malformed paths in #include statements (uses RAW line)
3312 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3313 my $path = $1;
3314 if ($path =~ m{//}) {
3315 ERROR("MALFORMED_INCLUDE",
3316 "malformed #include filename\n" . $herecurr);
3317 }
3318 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3319 ERROR("UAPI_INCLUDE",
3320 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3321 }
3322 }
3323
3324# no C99 // comments
3325 if ($line =~ m{//}) {
3326 if (ERROR("C99_COMMENTS",
3327 "do not use C99 // comments\n" . $herecurr) &&
3328 $fix) {
3329 my $line = $fixed[$fixlinenr];
3330 if ($line =~ /\/\/(.*)$/) {
3331 my $comment = trim($1);
3332 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3333 }
3334 }
3335 }
3336 # Remove C99 comments.
3337 $line =~ s@//.*@@;
3338 $opline =~ s@//.*@@;
3339
3340# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3341# the whole statement.
3342#print "APW <$lines[$realline_next - 1]>\n";
3343 if (defined $realline_next &&
3344 exists $lines[$realline_next - 1] &&
3345 !defined $suppress_export{$realline_next} &&
3346 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3347 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3348 # Handle definitions which produce identifiers with
3349 # a prefix:
3350 # XXX(foo);
3351 # EXPORT_SYMBOL(something_foo);
3352 my $name = $1;
3353 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3354 $name =~ /^${Ident}_$2/) {
3355#print "FOO C name<$name>\n";
3356 $suppress_export{$realline_next} = 1;
3357
3358 } elsif ($stat !~ /(?:
3359 \n.}\s*$|
3360 ^.DEFINE_$Ident\(\Q$name\E\)|
3361 ^.DECLARE_$Ident\(\Q$name\E\)|
3362 ^.LIST_HEAD\(\Q$name\E\)|
3363 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3364 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3365 )/x) {
3366#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3367 $suppress_export{$realline_next} = 2;
3368 } else {
3369 $suppress_export{$realline_next} = 1;
3370 }
3371 }
3372 if (!defined $suppress_export{$linenr} &&
3373 $prevline =~ /^.\s*$/ &&
3374 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3375 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3376#print "FOO B <$lines[$linenr - 1]>\n";
3377 $suppress_export{$linenr} = 2;
3378 }
3379 if (defined $suppress_export{$linenr} &&
3380 $suppress_export{$linenr} == 2) {
3381 WARN("EXPORT_SYMBOL",
3382 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3383 }
3384
3385# check for global initialisers.
3386 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3387 if (ERROR("GLOBAL_INITIALISERS",
3388 "do not initialise globals to $1\n" . $herecurr) &&
3389 $fix) {
3390 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3391 }
3392 }
3393# check for static initialisers.
3394 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3395 if (ERROR("INITIALISED_STATIC",
3396 "do not initialise statics to $1\n" .
3397 $herecurr) &&
3398 $fix) {
3399 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3400 }
3401 }
3402
3403# check for misordered declarations of char/short/int/long with signed/unsigned
3404 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3405 my $tmp = trim($1);
3406 WARN("MISORDERED_TYPE",
3407 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3408 }
3409
3410# check for static const char * arrays.
3411 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3412 WARN("STATIC_CONST_CHAR_ARRAY",
3413 "static const char * array should probably be static const char * const\n" .
3414 $herecurr);
3415 }
3416
3417# check for static char foo[] = "bar" declarations.
3418 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3419 WARN("STATIC_CONST_CHAR_ARRAY",
3420 "static char array declaration should probably be static const char\n" .
3421 $herecurr);
3422 }
3423
3424# check for const <foo> const where <foo> is not a pointer or array type
3425 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3426 my $found = $1;
3427 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3428 WARN("CONST_CONST",
3429 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3430 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3431 WARN("CONST_CONST",
3432 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3433 }
3434 }
3435
3436# check for non-global char *foo[] = {"bar", ...} declarations.
3437 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3438 WARN("STATIC_CONST_CHAR_ARRAY",
3439 "char * array declaration might be better as static const\n" .
3440 $herecurr);
3441 }
3442
3443# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3444 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3445 my $array = $1;
3446 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3447 my $array_div = $1;
3448 if (WARN("ARRAY_SIZE",
3449 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3450 $fix) {
3451 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3452 }
3453 }
3454 }
3455
3456# check for function declarations without arguments like "int foo()"
3457 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3458 if (ERROR("FUNCTION_WITHOUT_ARGS",
3459 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3460 $fix) {
3461 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
3462 }
3463 }
3464
3465# check for uses of DEFINE_PCI_DEVICE_TABLE
3466 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3467 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3468 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3469 $fix) {
3470 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3471 }
3472 }
3473
3474# check for new typedefs, only function parameters and sparse annotations
3475# make sense.
3476 if ($line =~ /\btypedef\s/ &&
3477 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
3478 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
3479 $line !~ /\b$typeTypedefs\b/ &&
3480 $line !~ /\b__bitwise(?:__|)\b/) {
3481 WARN("NEW_TYPEDEFS",
3482 "do not add new typedefs\n" . $herecurr);
3483 }
3484
3485# * goes on variable not on type
3486 # (char*[ const])
3487 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3488 #print "AA<$1>\n";
3489 my ($ident, $from, $to) = ($1, $2, $2);
3490
3491 # Should start with a space.
3492 $to =~ s/^(\S)/ $1/;
3493 # Should not end with a space.
3494 $to =~ s/\s+$//;
3495 # '*'s should not have spaces between.
3496 while ($to =~ s/\*\s+\*/\*\*/) {
3497 }
3498
3499## print "1: from<$from> to<$to> ident<$ident>\n";
3500 if ($from ne $to) {
3501 if (ERROR("POINTER_LOCATION",
3502 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3503 $fix) {
3504 my $sub_from = $ident;
3505 my $sub_to = $ident;
3506 $sub_to =~ s/\Q$from\E/$to/;
3507 $fixed[$fixlinenr] =~
3508 s@\Q$sub_from\E@$sub_to@;
3509 }
3510 }
3511 }
3512 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3513 #print "BB<$1>\n";
3514 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
3515
3516 # Should start with a space.
3517 $to =~ s/^(\S)/ $1/;
3518 # Should not end with a space.
3519 $to =~ s/\s+$//;
3520 # '*'s should not have spaces between.
3521 while ($to =~ s/\*\s+\*/\*\*/) {
3522 }
3523 # Modifiers should have spaces.
3524 $to =~ s/(\b$Modifier$)/$1 /;
3525
3526## print "2: from<$from> to<$to> ident<$ident>\n";
3527 if ($from ne $to && $ident !~ /^$Modifier$/) {
3528 if (ERROR("POINTER_LOCATION",
3529 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3530 $fix) {
3531
3532 my $sub_from = $match;
3533 my $sub_to = $match;
3534 $sub_to =~ s/\Q$from\E/$to/;
3535 $fixed[$fixlinenr] =~
3536 s@\Q$sub_from\E@$sub_to@;
3537 }
3538 }
3539 }
3540
3541# avoid BUG() or BUG_ON()
3542 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3543 my $msg_type = \&WARN;
3544 $msg_type = \&CHK if ($file);
3545 &{$msg_type}("AVOID_BUG",
3546 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3547 }
3548
3549# avoid LINUX_VERSION_CODE
3550 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
3551 WARN("LINUX_VERSION_CODE",
3552 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3553 }
3554
3555# check for uses of printk_ratelimit
3556 if ($line =~ /\bprintk_ratelimit\s*\(/) {
3557 WARN("PRINTK_RATELIMITED",
3558 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
3559 }
3560
3561# printk should use KERN_* levels. Note that follow on printk's on the
3562# same line do not need a level, so we use the current block context
3563# to try and find and validate the current printk. In summary the current
3564# printk includes all preceding printk's which have no newline on the end.
3565# we assume the first bad printk is the one to report.
3566 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
3567 my $ok = 0;
3568 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3569 #print "CHECK<$lines[$ln - 1]\n";
3570 # we have a preceding printk if it ends
3571 # with "\n" ignore it, else it is to blame
3572 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3573 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3574 $ok = 1;
3575 }
3576 last;
3577 }
3578 }
3579 if ($ok == 0) {
3580 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3581 "printk() should include KERN_ facility level\n" . $herecurr);
3582 }
3583 }
3584
3585 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3586 my $orig = $1;
3587 my $level = lc($orig);
3588 $level = "warn" if ($level eq "warning");
3589 my $level2 = $level;
3590 $level2 = "dbg" if ($level eq "debug");
3591 WARN("PREFER_PR_LEVEL",
3592 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3593 }
3594
3595 if ($line =~ /\bpr_warning\s*\(/) {
3596 if (WARN("PREFER_PR_LEVEL",
3597 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3598 $fix) {
3599 $fixed[$fixlinenr] =~
3600 s/\bpr_warning\b/pr_warn/;
3601 }
3602 }
3603
3604 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3605 my $orig = $1;
3606 my $level = lc($orig);
3607 $level = "warn" if ($level eq "warning");
3608 $level = "dbg" if ($level eq "debug");
3609 WARN("PREFER_DEV_LEVEL",
3610 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3611 }
3612
3613# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3614# number of false positives, but assembly files are not checked, so at
3615# least the arch entry code will not trigger this warning.
3616 if ($line =~ /\bENOSYS\b/) {
3617 WARN("ENOSYS",
3618 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3619 }
3620
3621# function brace can't be on same line, except for #defines of do while,
3622# or if closed on same line
3623 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
3624 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
3625 if (ERROR("OPEN_BRACE",
3626 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3627 $fix) {
3628 fix_delete_line($fixlinenr, $rawline);
3629 my $fixed_line = $rawline;
3630 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3631 my $line1 = $1;
3632 my $line2 = $2;
3633 fix_insert_line($fixlinenr, ltrim($line1));
3634 fix_insert_line($fixlinenr, "\+{");
3635 if ($line2 !~ /^\s*$/) {
3636 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3637 }
3638 }
3639 }
3640
3641# open braces for enum, union and struct go on the same line.
3642 if ($line =~ /^.\s*{/ &&
3643 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
3644 if (ERROR("OPEN_BRACE",
3645 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3646 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3647 fix_delete_line($fixlinenr - 1, $prevrawline);
3648 fix_delete_line($fixlinenr, $rawline);
3649 my $fixedline = rtrim($prevrawline) . " {";
3650 fix_insert_line($fixlinenr, $fixedline);
3651 $fixedline = $rawline;
3652 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3653 if ($fixedline !~ /^\+\s*$/) {
3654 fix_insert_line($fixlinenr, $fixedline);
3655 }
3656 }
3657 }
3658
3659# missing space after union, struct or enum definition
3660 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3661 if (WARN("SPACING",
3662 "missing space after $1 definition\n" . $herecurr) &&
3663 $fix) {
3664 $fixed[$fixlinenr] =~
3665 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3666 }
3667 }
3668
3669# Function pointer declarations
3670# check spacing between type, funcptr, and args
3671# canonical declaration is "type (*funcptr)(args...)"
3672 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
3673 my $declare = $1;
3674 my $pre_pointer_space = $2;
3675 my $post_pointer_space = $3;
3676 my $funcname = $4;
3677 my $post_funcname_space = $5;
3678 my $pre_args_space = $6;
3679
3680# the $Declare variable will capture all spaces after the type
3681# so check it for a missing trailing missing space but pointer return types
3682# don't need a space so don't warn for those.
3683 my $post_declare_space = "";
3684 if ($declare =~ /(\s+)$/) {
3685 $post_declare_space = $1;
3686 $declare = rtrim($declare);
3687 }
3688 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
3689 WARN("SPACING",
3690 "missing space after return type\n" . $herecurr);
3691 $post_declare_space = " ";
3692 }
3693
3694# unnecessary space "type (*funcptr)(args...)"
3695# This test is not currently implemented because these declarations are
3696# equivalent to
3697# int foo(int bar, ...)
3698# and this is form shouldn't/doesn't generate a checkpatch warning.
3699#
3700# elsif ($declare =~ /\s{2,}$/) {
3701# WARN("SPACING",
3702# "Multiple spaces after return type\n" . $herecurr);
3703# }
3704
3705# unnecessary space "type ( *funcptr)(args...)"
3706 if (defined $pre_pointer_space &&
3707 $pre_pointer_space =~ /^\s/) {
3708 WARN("SPACING",
3709 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3710 }
3711
3712# unnecessary space "type (* funcptr)(args...)"
3713 if (defined $post_pointer_space &&
3714 $post_pointer_space =~ /^\s/) {
3715 WARN("SPACING",
3716 "Unnecessary space before function pointer name\n" . $herecurr);
3717 }
3718
3719# unnecessary space "type (*funcptr )(args...)"
3720 if (defined $post_funcname_space &&
3721 $post_funcname_space =~ /^\s/) {
3722 WARN("SPACING",
3723 "Unnecessary space after function pointer name\n" . $herecurr);
3724 }
3725
3726# unnecessary space "type (*funcptr) (args...)"
3727 if (defined $pre_args_space &&
3728 $pre_args_space =~ /^\s/) {
3729 WARN("SPACING",
3730 "Unnecessary space before function pointer arguments\n" . $herecurr);
3731 }
3732
3733 if (show_type("SPACING") && $fix) {
3734 $fixed[$fixlinenr] =~
3735 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3736 }
3737 }
3738
3739# check for spacing round square brackets; allowed:
3740# 1. with a type on the left -- int [] a;
3741# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3742# 3. inside a curly brace -- = { [0...10] = 5 }
3743 while ($line =~ /(.*?\s)\[/g) {
3744 my ($where, $prefix) = ($-[1], $1);
3745 if ($prefix !~ /$Type\s+$/ &&
3746 ($where != 0 || $prefix !~ /^.\s+$/) &&
3747 $prefix !~ /[{,]\s+$/) {
3748 if (ERROR("BRACKET_SPACE",
3749 "space prohibited before open square bracket '['\n" . $herecurr) &&
3750 $fix) {
3751 $fixed[$fixlinenr] =~
3752 s/^(\+.*?)\s+\[/$1\[/;
3753 }
3754 }
3755 }
3756
3757# check for spaces between functions and their parentheses.
3758 while ($line =~ /($Ident)\s+\(/g) {
3759 my $name = $1;
3760 my $ctx_before = substr($line, 0, $-[1]);
3761 my $ctx = "$ctx_before$name";
3762
3763 # Ignore those directives where spaces _are_ permitted.
3764 if ($name =~ /^(?:
3765 if|for|while|switch|return|case|
3766 volatile|__volatile__|
3767 __attribute__|format|__extension__|
3768 asm|__asm__)$/x)
3769 {
3770 # cpp #define statements have non-optional spaces, ie
3771 # if there is a space between the name and the open
3772 # parenthesis it is simply not a parameter group.
3773 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
3774
3775 # cpp #elif statement condition may start with a (
3776 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
3777
3778 # If this whole things ends with a type its most
3779 # likely a typedef for a function.
3780 } elsif ($ctx =~ /$Type$/) {
3781
3782 } else {
3783 if (WARN("SPACING",
3784 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3785 $fix) {
3786 $fixed[$fixlinenr] =~
3787 s/\b$name\s+\(/$name\(/;
3788 }
3789 }
3790 }
3791
3792# Check operator spacing.
3793 if (!($line=~/\#\s*include/)) {
3794 my $fixed_line = "";
3795 my $line_fixed = 0;
3796
3797 my $ops = qr{
3798 <<=|>>=|<=|>=|==|!=|
3799 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3800 =>|->|<<|>>|<|>|=|!|~|
3801 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
3802 \?:|\?|:
3803 }x;
3804 my @elements = split(/($ops|;)/, $opline);
3805
3806## print("element count: <" . $#elements . ">\n");
3807## foreach my $el (@elements) {
3808## print("el: <$el>\n");
3809## }
3810
3811 my @fix_elements = ();
3812 my $off = 0;
3813
3814 foreach my $el (@elements) {
3815 push(@fix_elements, substr($rawline, $off, length($el)));
3816 $off += length($el);
3817 }
3818
3819 $off = 0;
3820
3821 my $blank = copy_spacing($opline);
3822 my $last_after = -1;
3823
3824 for (my $n = 0; $n < $#elements; $n += 2) {
3825
3826 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3827
3828## print("n: <$n> good: <$good>\n");
3829
3830 $off += length($elements[$n]);
3831
3832 # Pick up the preceding and succeeding characters.
3833 my $ca = substr($opline, 0, $off);
3834 my $cc = '';
3835 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3836 $cc = substr($opline, $off + length($elements[$n + 1]));
3837 }
3838 my $cb = "$ca$;$cc";
3839
3840 my $a = '';
3841 $a = 'V' if ($elements[$n] ne '');
3842 $a = 'W' if ($elements[$n] =~ /\s$/);
3843 $a = 'C' if ($elements[$n] =~ /$;$/);
3844 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3845 $a = 'O' if ($elements[$n] eq '');
3846 $a = 'E' if ($ca =~ /^\s*$/);
3847
3848 my $op = $elements[$n + 1];
3849
3850 my $c = '';
3851 if (defined $elements[$n + 2]) {
3852 $c = 'V' if ($elements[$n + 2] ne '');
3853 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
3854 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
3855 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3856 $c = 'O' if ($elements[$n + 2] eq '');
3857 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
3858 } else {
3859 $c = 'E';
3860 }
3861
3862 my $ctx = "${a}x${c}";
3863
3864 my $at = "(ctx:$ctx)";
3865
3866 my $ptr = substr($blank, 0, $off) . "^";
3867 my $hereptr = "$hereline$ptr\n";
3868
3869 # Pull out the value of this operator.
3870 my $op_type = substr($curr_values, $off + 1, 1);
3871
3872 # Get the full operator variant.
3873 my $opv = $op . substr($curr_vars, $off, 1);
3874
3875 # Ignore operators passed as parameters.
3876 if ($op_type ne 'V' &&
3877 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
3878
3879# # Ignore comments
3880# } elsif ($op =~ /^$;+$/) {
3881
3882 # ; should have either the end of line or a space or \ after it
3883 } elsif ($op eq ';') {
3884 if ($ctx !~ /.x[WEBC]/ &&
3885 $cc !~ /^\\/ && $cc !~ /^;/) {
3886 if (ERROR("SPACING",
3887 "space required after that '$op' $at\n" . $hereptr)) {
3888 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3889 $line_fixed = 1;
3890 }
3891 }
3892
3893 # // is a comment
3894 } elsif ($op eq '//') {
3895
3896 # : when part of a bitfield
3897 } elsif ($opv eq ':B') {
3898 # skip the bitfield test for now
3899
3900 # No spaces for:
3901 # ->
3902 } elsif ($op eq '->') {
3903 if ($ctx =~ /Wx.|.xW/) {
3904 if (ERROR("SPACING",
3905 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
3906 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3907 if (defined $fix_elements[$n + 2]) {
3908 $fix_elements[$n + 2] =~ s/^\s+//;
3909 }
3910 $line_fixed = 1;
3911 }
3912 }
3913
3914 # , must not have a space before and must have a space on the right.
3915 } elsif ($op eq ',') {
3916 my $rtrim_before = 0;
3917 my $space_after = 0;
3918 if ($ctx =~ /Wx./) {
3919 if (ERROR("SPACING",
3920 "space prohibited before that '$op' $at\n" . $hereptr)) {
3921 $line_fixed = 1;
3922 $rtrim_before = 1;
3923 }
3924 }
3925 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
3926 if (ERROR("SPACING",
3927 "space required after that '$op' $at\n" . $hereptr)) {
3928 $line_fixed = 1;
3929 $last_after = $n;
3930 $space_after = 1;
3931 }
3932 }
3933 if ($rtrim_before || $space_after) {
3934 if ($rtrim_before) {
3935 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3936 } else {
3937 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3938 }
3939 if ($space_after) {
3940 $good .= " ";
3941 }
3942 }
3943
3944 # '*' as part of a type definition -- reported already.
3945 } elsif ($opv eq '*_') {
3946 #warn "'*' is part of type\n";
3947
3948 # unary operators should have a space before and
3949 # none after. May be left adjacent to another
3950 # unary operator, or a cast
3951 } elsif ($op eq '!' || $op eq '~' ||
3952 $opv eq '*U' || $opv eq '-U' ||
3953 $opv eq '&U' || $opv eq '&&U') {
3954 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
3955 if (ERROR("SPACING",
3956 "space required before that '$op' $at\n" . $hereptr)) {
3957 if ($n != $last_after + 2) {
3958 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3959 $line_fixed = 1;
3960 }
3961 }
3962 }
3963 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
3964 # A unary '*' may be const
3965
3966 } elsif ($ctx =~ /.xW/) {
3967 if (ERROR("SPACING",
3968 "space prohibited after that '$op' $at\n" . $hereptr)) {
3969 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
3970 if (defined $fix_elements[$n + 2]) {
3971 $fix_elements[$n + 2] =~ s/^\s+//;
3972 }
3973 $line_fixed = 1;
3974 }
3975 }
3976
3977 # unary ++ and unary -- are allowed no space on one side.
3978 } elsif ($op eq '++' or $op eq '--') {
3979 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
3980 if (ERROR("SPACING",
3981 "space required one side of that '$op' $at\n" . $hereptr)) {
3982 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
3983 $line_fixed = 1;
3984 }
3985 }
3986 if ($ctx =~ /Wx[BE]/ ||
3987 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
3988 if (ERROR("SPACING",
3989 "space prohibited before that '$op' $at\n" . $hereptr)) {
3990 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3991 $line_fixed = 1;
3992 }
3993 }
3994 if ($ctx =~ /ExW/) {
3995 if (ERROR("SPACING",
3996 "space prohibited after that '$op' $at\n" . $hereptr)) {
3997 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3998 if (defined $fix_elements[$n + 2]) {
3999 $fix_elements[$n + 2] =~ s/^\s+//;
4000 }
4001 $line_fixed = 1;
4002 }
4003 }
4004
4005 # << and >> may either have or not have spaces both sides
4006 } elsif ($op eq '<<' or $op eq '>>' or
4007 $op eq '&' or $op eq '^' or $op eq '|' or
4008 $op eq '+' or $op eq '-' or
4009 $op eq '*' or $op eq '/' or
4010 $op eq '%')
4011 {
4012 if ($check) {
4013 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4014 if (CHK("SPACING",
4015 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4016 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4017 $fix_elements[$n + 2] =~ s/^\s+//;
4018 $line_fixed = 1;
4019 }
4020 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4021 if (CHK("SPACING",
4022 "space preferred before that '$op' $at\n" . $hereptr)) {
4023 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4024 $line_fixed = 1;
4025 }
4026 }
4027 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4028 if (ERROR("SPACING",
4029 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4030 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4031 if (defined $fix_elements[$n + 2]) {
4032 $fix_elements[$n + 2] =~ s/^\s+//;
4033 }
4034 $line_fixed = 1;
4035 }
4036 }
4037
4038 # A colon needs no spaces before when it is
4039 # terminating a case value or a label.
4040 } elsif ($opv eq ':C' || $opv eq ':L') {
4041 if ($ctx =~ /Wx./) {
4042 if (ERROR("SPACING",
4043 "space prohibited before that '$op' $at\n" . $hereptr)) {
4044 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4045 $line_fixed = 1;
4046 }
4047 }
4048
4049 # All the others need spaces both sides.
4050 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4051 my $ok = 0;
4052
4053 # Ignore email addresses <foo@bar>
4054 if (($op eq '<' &&
4055 $cc =~ /^\S+\@\S+>/) ||
4056 ($op eq '>' &&
4057 $ca =~ /<\S+\@\S+$/))
4058 {
4059 $ok = 1;
4060 }
4061
4062 # for asm volatile statements
4063 # ignore a colon with another
4064 # colon immediately before or after
4065 if (($op eq ':') &&
4066 ($ca =~ /:$/ || $cc =~ /^:/)) {
4067 $ok = 1;
4068 }
4069
4070 # messages are ERROR, but ?: are CHK
4071 if ($ok == 0) {
4072 my $msg_type = \&ERROR;
4073 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4074
4075 if (&{$msg_type}("SPACING",
4076 "spaces required around that '$op' $at\n" . $hereptr)) {
4077 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4078 if (defined $fix_elements[$n + 2]) {
4079 $fix_elements[$n + 2] =~ s/^\s+//;
4080 }
4081 $line_fixed = 1;
4082 }
4083 }
4084 }
4085 $off += length($elements[$n + 1]);
4086
4087## print("n: <$n> GOOD: <$good>\n");
4088
4089 $fixed_line = $fixed_line . $good;
4090 }
4091
4092 if (($#elements % 2) == 0) {
4093 $fixed_line = $fixed_line . $fix_elements[$#elements];
4094 }
4095
4096 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4097 $fixed[$fixlinenr] = $fixed_line;
4098 }
4099
4100
4101 }
4102
4103# check for whitespace before a non-naked semicolon
4104 if ($line =~ /^\+.*\S\s+;\s*$/) {
4105 if (WARN("SPACING",
4106 "space prohibited before semicolon\n" . $herecurr) &&
4107 $fix) {
4108 1 while $fixed[$fixlinenr] =~
4109 s/^(\+.*\S)\s+;/$1;/;
4110 }
4111 }
4112
4113# check for multiple assignments
4114 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4115 CHK("MULTIPLE_ASSIGNMENTS",
4116 "multiple assignments should be avoided\n" . $herecurr);
4117 }
4118
4119## # check for multiple declarations, allowing for a function declaration
4120## # continuation.
4121## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4122## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4123##
4124## # Remove any bracketed sections to ensure we do not
4125## # falsly report the parameters of functions.
4126## my $ln = $line;
4127## while ($ln =~ s/\([^\(\)]*\)//g) {
4128## }
4129## if ($ln =~ /,/) {
4130## WARN("MULTIPLE_DECLARATION",
4131## "declaring multiple variables together should be avoided\n" . $herecurr);
4132## }
4133## }
4134
4135#need space before brace following if, while, etc
4136 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4137 $line =~ /do\{/) {
4138 if (ERROR("SPACING",
4139 "space required before the open brace '{'\n" . $herecurr) &&
4140 $fix) {
4141 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
4142 }
4143 }
4144
4145## # check for blank lines before declarations
4146## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4147## $prevrawline =~ /^.\s*$/) {
4148## WARN("SPACING",
4149## "No blank lines before declarations\n" . $hereprev);
4150## }
4151##
4152
4153# closing brace should have a space following it when it has anything
4154# on the line
4155 if ($line =~ /}(?!(?:,|;|\)))\S/) {
4156 if (ERROR("SPACING",
4157 "space required after that close brace '}'\n" . $herecurr) &&
4158 $fix) {
4159 $fixed[$fixlinenr] =~
4160 s/}((?!(?:,|;|\)))\S)/} $1/;
4161 }
4162 }
4163
4164# check spacing on square brackets
4165 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4166 if (ERROR("SPACING",
4167 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4168 $fix) {
4169 $fixed[$fixlinenr] =~
4170 s/\[\s+/\[/;
4171 }
4172 }
4173 if ($line =~ /\s\]/) {
4174 if (ERROR("SPACING",
4175 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4176 $fix) {
4177 $fixed[$fixlinenr] =~
4178 s/\s+\]/\]/;
4179 }
4180 }
4181
4182# check spacing on parentheses
4183 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4184 $line !~ /for\s*\(\s+;/) {
4185 if (ERROR("SPACING",
4186 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4187 $fix) {
4188 $fixed[$fixlinenr] =~
4189 s/\(\s+/\(/;
4190 }
4191 }
4192 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4193 $line !~ /for\s*\(.*;\s+\)/ &&
4194 $line !~ /:\s+\)/) {
4195 if (ERROR("SPACING",
4196 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4197 $fix) {
4198 $fixed[$fixlinenr] =~
4199 s/\s+\)/\)/;
4200 }
4201 }
4202
4203# check unnecessary parentheses around addressof/dereference single $Lvals
4204# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4205
4206 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4207 my $var = $1;
4208 if (CHK("UNNECESSARY_PARENTHESES",
4209 "Unnecessary parentheses around $var\n" . $herecurr) &&
4210 $fix) {
4211 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4212 }
4213 }
4214
4215# check for unnecessary parentheses around function pointer uses
4216# ie: (foo->bar)(); should be foo->bar();
4217# but not "if (foo->bar) (" to avoid some false positives
4218 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4219 my $var = $2;
4220 if (CHK("UNNECESSARY_PARENTHESES",
4221 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4222 $fix) {
4223 my $var2 = deparenthesize($var);
4224 $var2 =~ s/\s//g;
4225 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4226 }
4227 }
4228
4229#goto labels aren't indented, allow a single space however
4230 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4231 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4232 if (WARN("INDENTED_LABEL",
4233 "labels should not be indented\n" . $herecurr) &&
4234 $fix) {
4235 $fixed[$fixlinenr] =~
4236 s/^(.)\s+/$1/;
4237 }
4238 }
4239
4240# return is not a function
4241 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4242 my $spacing = $1;
4243 if ($^V && $^V ge 5.10.0 &&
4244 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4245 my $value = $1;
4246 $value = deparenthesize($value);
4247 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4248 ERROR("RETURN_PARENTHESES",
4249 "return is not a function, parentheses are not required\n" . $herecurr);
4250 }
4251 } elsif ($spacing !~ /\s+/) {
4252 ERROR("SPACING",
4253 "space required before the open parenthesis '('\n" . $herecurr);
4254 }
4255 }
4256
4257# unnecessary return in a void function
4258# at end-of-function, with the previous line a single leading tab, then return;
4259# and the line before that not a goto label target like "out:"
4260 if ($sline =~ /^[ \+]}\s*$/ &&
4261 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4262 $linenr >= 3 &&
4263 $lines[$linenr - 3] =~ /^[ +]/ &&
4264 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4265 WARN("RETURN_VOID",
4266 "void function return statements are not generally useful\n" . $hereprev);
4267 }
4268
4269# if statements using unnecessary parentheses - ie: if ((foo == bar))
4270 if ($^V && $^V ge 5.10.0 &&
4271 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4272 my $openparens = $1;
4273 my $count = $openparens =~ tr@\(@\(@;
4274 my $msg = "";
4275 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4276 my $comp = $4; #Not $1 because of $LvalOrFunc
4277 $msg = " - maybe == should be = ?" if ($comp eq "==");
4278 WARN("UNNECESSARY_PARENTHESES",
4279 "Unnecessary parentheses$msg\n" . $herecurr);
4280 }
4281 }
4282
4283# comparisons with a constant or upper case identifier on the left
4284# avoid cases like "foo + BAR < baz"
4285# only fix matches surrounded by parentheses to avoid incorrect
4286# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4287 if ($^V && $^V ge 5.10.0 &&
4288 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4289 my $lead = $1;
4290 my $const = $2;
4291 my $comp = $3;
4292 my $to = $4;
4293 my $newcomp = $comp;
4294 if ($lead !~ /$Operators\s*$/ &&
4295 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4296 WARN("CONSTANT_COMPARISON",
4297 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4298 $fix) {
4299 if ($comp eq "<") {
4300 $newcomp = ">";
4301 } elsif ($comp eq "<=") {
4302 $newcomp = ">=";
4303 } elsif ($comp eq ">") {
4304 $newcomp = "<";
4305 } elsif ($comp eq ">=") {
4306 $newcomp = "<=";
4307 }
4308 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4309 }
4310 }
4311
4312# Return of what appears to be an errno should normally be negative
4313 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4314 my $name = $1;
4315 if ($name ne 'EOF' && $name ne 'ERROR') {
4316 WARN("USE_NEGATIVE_ERRNO",
4317 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4318 }
4319 }
4320
4321# Need a space before open parenthesis after if, while etc
4322 if ($line =~ /\b(if|while|for|switch)\(/) {
4323 if (ERROR("SPACING",
4324 "space required before the open parenthesis '('\n" . $herecurr) &&
4325 $fix) {
4326 $fixed[$fixlinenr] =~
4327 s/\b(if|while|for|switch)\(/$1 \(/;
4328 }
4329 }
4330
4331# Check for illegal assignment in if conditional -- and check for trailing
4332# statements after the conditional.
4333 if ($line =~ /do\s*(?!{)/) {
4334 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4335 ctx_statement_block($linenr, $realcnt, 0)
4336 if (!defined $stat);
4337 my ($stat_next) = ctx_statement_block($line_nr_next,
4338 $remain_next, $off_next);
4339 $stat_next =~ s/\n./\n /g;
4340 ##print "stat<$stat> stat_next<$stat_next>\n";
4341
4342 if ($stat_next =~ /^\s*while\b/) {
4343 # If the statement carries leading newlines,
4344 # then count those as offsets.
4345 my ($whitespace) =
4346 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4347 my $offset =
4348 statement_rawlines($whitespace) - 1;
4349
4350 $suppress_whiletrailers{$line_nr_next +
4351 $offset} = 1;
4352 }
4353 }
4354 if (!defined $suppress_whiletrailers{$linenr} &&
4355 defined($stat) && defined($cond) &&
4356 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4357 my ($s, $c) = ($stat, $cond);
4358
4359 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4360 ERROR("ASSIGN_IN_IF",
4361 "do not use assignment in if condition\n" . $herecurr);
4362 }
4363
4364 # Find out what is on the end of the line after the
4365 # conditional.
4366 substr($s, 0, length($c), '');
4367 $s =~ s/\n.*//g;
4368 $s =~ s/$;//g; # Remove any comments
4369 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4370 $c !~ /}\s*while\s*/)
4371 {
4372 # Find out how long the conditional actually is.
4373 my @newlines = ($c =~ /\n/gs);
4374 my $cond_lines = 1 + $#newlines;
4375 my $stat_real = '';
4376
4377 $stat_real = raw_line($linenr, $cond_lines)
4378 . "\n" if ($cond_lines);
4379 if (defined($stat_real) && $cond_lines > 1) {
4380 $stat_real = "[...]\n$stat_real";
4381 }
4382
4383 ERROR("TRAILING_STATEMENTS",
4384 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4385 }
4386 }
4387
4388# Check for bitwise tests written as boolean
4389 if ($line =~ /
4390 (?:
4391 (?:\[|\(|\&\&|\|\|)
4392 \s*0[xX][0-9]+\s*
4393 (?:\&\&|\|\|)
4394 |
4395 (?:\&\&|\|\|)
4396 \s*0[xX][0-9]+\s*
4397 (?:\&\&|\|\||\)|\])
4398 )/x)
4399 {
4400 WARN("HEXADECIMAL_BOOLEAN_TEST",
4401 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4402 }
4403
4404# if and else should not have general statements after it
4405 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4406 my $s = $1;
4407 $s =~ s/$;//g; # Remove any comments
4408 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4409 ERROR("TRAILING_STATEMENTS",
4410 "trailing statements should be on next line\n" . $herecurr);
4411 }
4412 }
4413# if should not continue a brace
4414 if ($line =~ /}\s*if\b/) {
4415 ERROR("TRAILING_STATEMENTS",
4416 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4417 $herecurr);
4418 }
4419# case and default should not have general statements after them
4420 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4421 $line !~ /\G(?:
4422 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4423 \s*return\s+
4424 )/xg)
4425 {
4426 ERROR("TRAILING_STATEMENTS",
4427 "trailing statements should be on next line\n" . $herecurr);
4428 }
4429
4430 # Check for }<nl>else {, these must be at the same
4431 # indent level to be relevant to each other.
4432 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4433 $previndent == $indent) {
4434 if (ERROR("ELSE_AFTER_BRACE",
4435 "else should follow close brace '}'\n" . $hereprev) &&
4436 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4437 fix_delete_line($fixlinenr - 1, $prevrawline);
4438 fix_delete_line($fixlinenr, $rawline);
4439 my $fixedline = $prevrawline;
4440 $fixedline =~ s/}\s*$//;
4441 if ($fixedline !~ /^\+\s*$/) {
4442 fix_insert_line($fixlinenr, $fixedline);
4443 }
4444 $fixedline = $rawline;
4445 $fixedline =~ s/^(.\s*)else/$1} else/;
4446 fix_insert_line($fixlinenr, $fixedline);
4447 }
4448 }
4449
4450 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4451 $previndent == $indent) {
4452 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4453
4454 # Find out what is on the end of the line after the
4455 # conditional.
4456 substr($s, 0, length($c), '');
4457 $s =~ s/\n.*//g;
4458
4459 if ($s =~ /^\s*;/) {
4460 if (ERROR("WHILE_AFTER_BRACE",
4461 "while should follow close brace '}'\n" . $hereprev) &&
4462 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4463 fix_delete_line($fixlinenr - 1, $prevrawline);
4464 fix_delete_line($fixlinenr, $rawline);
4465 my $fixedline = $prevrawline;
4466 my $trailing = $rawline;
4467 $trailing =~ s/^\+//;
4468 $trailing = trim($trailing);
4469 $fixedline =~ s/}\s*$/} $trailing/;
4470 fix_insert_line($fixlinenr, $fixedline);
4471 }
4472 }
4473 }
4474
4475#Specific variable tests
4476 while ($line =~ m{($Constant|$Lval)}g) {
4477 my $var = $1;
4478
4479#gcc binary extension
4480 if ($var =~ /^$Binary$/) {
4481 if (WARN("GCC_BINARY_CONSTANT",
4482 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4483 $fix) {
4484 my $hexval = sprintf("0x%x", oct($var));
4485 $fixed[$fixlinenr] =~
4486 s/\b$var\b/$hexval/;
4487 }
4488 }
4489
4490#CamelCase
4491 if ($var !~ /^$Constant$/ &&
4492 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
4493#Ignore Page<foo> variants
4494 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
4495#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4496 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4497#Ignore some three character SI units explicitly, like MiB and KHz
4498 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
4499 while ($var =~ m{($Ident)}g) {
4500 my $word = $1;
4501 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
4502 if ($check) {
4503 seed_camelcase_includes();
4504 if (!$file && !$camelcase_file_seeded) {
4505 seed_camelcase_file($realfile);
4506 $camelcase_file_seeded = 1;
4507 }
4508 }
4509 if (!defined $camelcase{$word}) {
4510 $camelcase{$word} = 1;
4511 CHK("CAMELCASE",
4512 "Avoid CamelCase: <$word>\n" . $herecurr);
4513 }
4514 }
4515 }
4516 }
4517
4518#no spaces allowed after \ in define
4519 if ($line =~ /\#\s*define.*\\\s+$/) {
4520 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4521 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4522 $fix) {
4523 $fixed[$fixlinenr] =~ s/\s+$//;
4524 }
4525 }
4526
4527# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4528# itself <asm/foo.h> (uses RAW line)
4529 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
4530 my $file = "$1.h";
4531 my $checkfile = "include/linux/$file";
4532 if (-f "$root/$checkfile" &&
4533 $realfile ne $checkfile &&
4534 $1 !~ /$allowed_asm_includes/)
4535 {
4536 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4537 if ($asminclude > 0) {
4538 if ($realfile =~ m{^arch/}) {
4539 CHK("ARCH_INCLUDE_LINUX",
4540 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4541 } else {
4542 WARN("INCLUDE_LINUX",
4543 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4544 }
4545 }
4546 }
4547 }
4548
4549# multi-statement macros should be enclosed in a do while loop, grab the
4550# first statement and ensure its the whole macro if its not enclosed
4551# in a known good container
4552 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4553 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
4554 my $ln = $linenr;
4555 my $cnt = $realcnt;
4556 my ($off, $dstat, $dcond, $rest);
4557 my $ctx = '';
4558 my $has_flow_statement = 0;
4559 my $has_arg_concat = 0;
4560 ($dstat, $dcond, $ln, $cnt, $off) =
4561 ctx_statement_block($linenr, $realcnt, 0);
4562 $ctx = $dstat;
4563 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4564 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4565
4566 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4567 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
4568
4569 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
4570 $dstat =~ s/$;//g;
4571 $dstat =~ s/\\\n.//g;
4572 $dstat =~ s/^\s*//s;
4573 $dstat =~ s/\s*$//s;
4574
4575 # Flatten any parentheses and braces
4576 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4577 $dstat =~ s/\{[^\{\}]*\}/1/ ||
4578 $dstat =~ s/.\[[^\[\]]*\]/1/)
4579 {
4580 }
4581
4582 # Flatten any obvious string concatentation.
4583 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4584 $dstat =~ s/$Ident\s*($String)/$1/)
4585 {
4586 }
4587
4588 # Make asm volatile uses seem like a generic function
4589 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4590
4591 my $exceptions = qr{
4592 $Declare|
4593 module_param_named|
4594 MODULE_PARM_DESC|
4595 DECLARE_PER_CPU|
4596 DEFINE_PER_CPU|
4597 __typeof__\(|
4598 union|
4599 struct|
4600 \.$Ident\s*=\s*|
4601 ^\"|\"$|
4602 ^\[
4603 }x;
4604 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4605 if ($dstat ne '' &&
4606 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4607 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
4608 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4609 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
4610 $dstat !~ /$exceptions/ &&
4611 $dstat !~ /^\.$Ident\s*=/ && # .foo =
4612 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
4613 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4614 $dstat !~ /^for\s*$Constant$/ && # for (...)
4615 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4616 $dstat !~ /^do\s*{/ && # do {...
4617 $dstat !~ /^\(\{/ && # ({...
4618 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
4619 {
4620 $ctx =~ s/\n*$//;
4621 my $herectx = $here . "\n";
4622 my $cnt = statement_rawlines($ctx);
4623
4624 for (my $n = 0; $n < $cnt; $n++) {
4625 $herectx .= raw_line($linenr, $n) . "\n";
4626 }
4627
4628 if ($dstat =~ /;/) {
4629 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4630 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4631 } else {
4632 ERROR("COMPLEX_MACRO",
4633 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
4634 }
4635 }
4636
4637# check for macros with flow control, but without ## concatenation
4638# ## concatenation is commonly a macro that defines a function so ignore those
4639 if ($has_flow_statement && !$has_arg_concat) {
4640 my $herectx = $here . "\n";
4641 my $cnt = statement_rawlines($ctx);
4642
4643 for (my $n = 0; $n < $cnt; $n++) {
4644 $herectx .= raw_line($linenr, $n) . "\n";
4645 }
4646 WARN("MACRO_WITH_FLOW_CONTROL",
4647 "Macros with flow control statements should be avoided\n" . "$herectx");
4648 }
4649
4650# check for line continuations outside of #defines, preprocessor #, and asm
4651
4652 } else {
4653 if ($prevline !~ /^..*\\$/ &&
4654 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4655 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
4656 $line =~ /^\+.*\\$/) {
4657 WARN("LINE_CONTINUATIONS",
4658 "Avoid unnecessary line continuations\n" . $herecurr);
4659 }
4660 }
4661
4662# do {} while (0) macro tests:
4663# single-statement macros do not need to be enclosed in do while (0) loop,
4664# macro should not end with a semicolon
4665 if ($^V && $^V ge 5.10.0 &&
4666 $realfile !~ m@/vmlinux.lds.h$@ &&
4667 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4668 my $ln = $linenr;
4669 my $cnt = $realcnt;
4670 my ($off, $dstat, $dcond, $rest);
4671 my $ctx = '';
4672 ($dstat, $dcond, $ln, $cnt, $off) =
4673 ctx_statement_block($linenr, $realcnt, 0);
4674 $ctx = $dstat;
4675
4676 $dstat =~ s/\\\n.//g;
4677 $dstat =~ s/$;/ /g;
4678
4679 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4680 my $stmts = $2;
4681 my $semis = $3;
4682
4683 $ctx =~ s/\n*$//;
4684 my $cnt = statement_rawlines($ctx);
4685 my $herectx = $here . "\n";
4686
4687 for (my $n = 0; $n < $cnt; $n++) {
4688 $herectx .= raw_line($linenr, $n) . "\n";
4689 }
4690
4691 if (($stmts =~ tr/;/;/) == 1 &&
4692 $stmts !~ /^\s*(if|while|for|switch)\b/) {
4693 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4694 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4695 }
4696 if (defined $semis && $semis ne "") {
4697 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4698 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4699 }
4700 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4701 $ctx =~ s/\n*$//;
4702 my $cnt = statement_rawlines($ctx);
4703 my $herectx = $here . "\n";
4704
4705 for (my $n = 0; $n < $cnt; $n++) {
4706 $herectx .= raw_line($linenr, $n) . "\n";
4707 }
4708
4709 WARN("TRAILING_SEMICOLON",
4710 "macros should not use a trailing semicolon\n" . "$herectx");
4711 }
4712 }
4713
4714# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4715# all assignments may have only one of the following with an assignment:
4716# .
4717# ALIGN(...)
4718# VMLINUX_SYMBOL(...)
4719 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
4720 WARN("MISSING_VMLINUX_SYMBOL",
4721 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
4722 }
4723
4724# check for redundant bracing round if etc
4725 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4726 my ($level, $endln, @chunks) =
4727 ctx_statement_full($linenr, $realcnt, 1);
4728 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4729 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4730 if ($#chunks > 0 && $level == 0) {
4731 my @allowed = ();
4732 my $allow = 0;
4733 my $seen = 0;
4734 my $herectx = $here . "\n";
4735 my $ln = $linenr - 1;
4736 for my $chunk (@chunks) {
4737 my ($cond, $block) = @{$chunk};
4738
4739 # If the condition carries leading newlines, then count those as offsets.
4740 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4741 my $offset = statement_rawlines($whitespace) - 1;
4742
4743 $allowed[$allow] = 0;
4744 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4745
4746 # We have looked at and allowed this specific line.
4747 $suppress_ifbraces{$ln + $offset} = 1;
4748
4749 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
4750 $ln += statement_rawlines($block) - 1;
4751
4752 substr($block, 0, length($cond), '');
4753
4754 $seen++ if ($block =~ /^\s*{/);
4755
4756 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4757 if (statement_lines($cond) > 1) {
4758 #print "APW: ALLOWED: cond<$cond>\n";
4759 $allowed[$allow] = 1;
4760 }
4761 if ($block =~/\b(?:if|for|while)\b/) {
4762 #print "APW: ALLOWED: block<$block>\n";
4763 $allowed[$allow] = 1;
4764 }
4765 if (statement_block_size($block) > 1) {
4766 #print "APW: ALLOWED: lines block<$block>\n";
4767 $allowed[$allow] = 1;
4768 }
4769 $allow++;
4770 }
4771 if ($seen) {
4772 my $sum_allowed = 0;
4773 foreach (@allowed) {
4774 $sum_allowed += $_;
4775 }
4776 if ($sum_allowed == 0) {
4777 WARN("BRACES",
4778 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4779 } elsif ($sum_allowed != $allow &&
4780 $seen != $allow) {
4781 CHK("BRACES",
4782 "braces {} should be used on all arms of this statement\n" . $herectx);
4783 }
4784 }
4785 }
4786 }
4787 if (!defined $suppress_ifbraces{$linenr - 1} &&
4788 $line =~ /\b(if|while|for|else)\b/) {
4789 my $allowed = 0;
4790
4791 # Check the pre-context.
4792 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4793 #print "APW: ALLOWED: pre<$1>\n";
4794 $allowed = 1;
4795 }
4796
4797 my ($level, $endln, @chunks) =
4798 ctx_statement_full($linenr, $realcnt, $-[0]);
4799
4800 # Check the condition.
4801 my ($cond, $block) = @{$chunks[0]};
4802 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4803 if (defined $cond) {
4804 substr($block, 0, length($cond), '');
4805 }
4806 if (statement_lines($cond) > 1) {
4807 #print "APW: ALLOWED: cond<$cond>\n";
4808 $allowed = 1;
4809 }
4810 if ($block =~/\b(?:if|for|while)\b/) {
4811 #print "APW: ALLOWED: block<$block>\n";
4812 $allowed = 1;
4813 }
4814 if (statement_block_size($block) > 1) {
4815 #print "APW: ALLOWED: lines block<$block>\n";
4816 $allowed = 1;
4817 }
4818 # Check the post-context.
4819 if (defined $chunks[1]) {
4820 my ($cond, $block) = @{$chunks[1]};
4821 if (defined $cond) {
4822 substr($block, 0, length($cond), '');
4823 }
4824 if ($block =~ /^\s*\{/) {
4825 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4826 $allowed = 1;
4827 }
4828 }
4829 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
4830 my $herectx = $here . "\n";
4831 my $cnt = statement_rawlines($block);
4832
4833 for (my $n = 0; $n < $cnt; $n++) {
4834 $herectx .= raw_line($linenr, $n) . "\n";
4835 }
4836
4837 WARN("BRACES",
4838 "braces {} are not necessary for single statement blocks\n" . $herectx);
4839 }
4840 }
4841
4842# check for unnecessary blank lines around braces
4843 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
4844 if (CHK("BRACES",
4845 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4846 $fix && $prevrawline =~ /^\+/) {
4847 fix_delete_line($fixlinenr - 1, $prevrawline);
4848 }
4849 }
4850 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
4851 if (CHK("BRACES",
4852 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4853 $fix) {
4854 fix_delete_line($fixlinenr, $rawline);
4855 }
4856 }
4857
4858# no volatiles please
4859 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4860 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
4861 WARN("VOLATILE",
4862 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4863 }
4864
4865# Check for user-visible strings broken across lines, which breaks the ability
4866# to grep for the string. Make exceptions when the previous string ends in a
4867# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4868# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4869 if ($line =~ /^\+\s*$String/ &&
4870 $prevline =~ /"\s*$/ &&
4871 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4872 if (WARN("SPLIT_STRING",
4873 "quoted string split across lines\n" . $hereprev) &&
4874 $fix &&
4875 $prevrawline =~ /^\+.*"\s*$/ &&
4876 $last_coalesced_string_linenr != $linenr - 1) {
4877 my $extracted_string = get_quoted_string($line, $rawline);
4878 my $comma_close = "";
4879 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4880 $comma_close = $1;
4881 }
4882
4883 fix_delete_line($fixlinenr - 1, $prevrawline);
4884 fix_delete_line($fixlinenr, $rawline);
4885 my $fixedline = $prevrawline;
4886 $fixedline =~ s/"\s*$//;
4887 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4888 fix_insert_line($fixlinenr - 1, $fixedline);
4889 $fixedline = $rawline;
4890 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4891 if ($fixedline !~ /\+\s*$/) {
4892 fix_insert_line($fixlinenr, $fixedline);
4893 }
4894 $last_coalesced_string_linenr = $linenr;
4895 }
4896 }
4897
4898# check for missing a space in a string concatenation
4899 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4900 WARN('MISSING_SPACE',
4901 "break quoted strings at a space character\n" . $hereprev);
4902 }
4903
4904# check for spaces before a quoted newline
4905 if ($rawline =~ /^.*\".*\s\\n/) {
4906 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4907 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4908 $fix) {
4909 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4910 }
4911
4912 }
4913
4914# concatenated string without spaces between elements
4915 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
4916 CHK("CONCATENATED_STRING",
4917 "Concatenated strings should use spaces between elements\n" . $herecurr);
4918 }
4919
4920# uncoalesced string fragments
4921 if ($line =~ /$String\s*"/) {
4922 WARN("STRING_FRAGMENTS",
4923 "Consecutive strings are generally better as a single string\n" . $herecurr);
4924 }
4925
4926# check for %L{u,d,i} and 0x%[udi] in strings
4927 my $string;
4928 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4929 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4930 $string =~ s/%%/__/g;
4931 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
4932 WARN("PRINTF_L",
4933 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4934 last;
4935 }
4936 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
4937 ERROR("PRINTF_0xDECIMAL",
4938 "Prefixing 0x with decimal output is defective\n" . $herecurr);
4939 }
4940 }
4941
4942# check for line continuations in quoted strings with odd counts of "
4943 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4944 WARN("LINE_CONTINUATIONS",
4945 "Avoid line continuations in quoted strings\n" . $herecurr);
4946 }
4947
4948# warn about #if 0
4949 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
4950 CHK("REDUNDANT_CODE",
4951 "if this code is redundant consider removing it\n" .
4952 $herecurr);
4953 }
4954
4955# check for needless "if (<foo>) fn(<foo>)" uses
4956 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4957 my $tested = quotemeta($1);
4958 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
4959 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4960 my $func = $1;
4961 if (WARN('NEEDLESS_IF',
4962 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
4963 $fix) {
4964 my $do_fix = 1;
4965 my $leading_tabs = "";
4966 my $new_leading_tabs = "";
4967 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
4968 $leading_tabs = $1;
4969 } else {
4970 $do_fix = 0;
4971 }
4972 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
4973 $new_leading_tabs = $1;
4974 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
4975 $do_fix = 0;
4976 }
4977 } else {
4978 $do_fix = 0;
4979 }
4980 if ($do_fix) {
4981 fix_delete_line($fixlinenr - 1, $prevrawline);
4982 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
4983 }
4984 }
4985 }
4986 }
4987
4988# check for unnecessary "Out of Memory" messages
4989 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4990 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4991 (defined $1 || defined $3) &&
4992 $linenr > 3) {
4993 my $testval = $2;
4994 my $testline = $lines[$linenr - 3];
4995
4996 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4997# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4998
4999 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5000 WARN("OOM_MESSAGE",
5001 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5002 }
5003 }
5004
5005# check for logging functions with KERN_<LEVEL>
5006 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5007 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5008 my $level = $1;
5009 if (WARN("UNNECESSARY_KERN_LEVEL",
5010 "Possible unnecessary $level\n" . $herecurr) &&
5011 $fix) {
5012 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5013 }
5014 }
5015
5016# check for mask then right shift without a parentheses
5017 if ($^V && $^V ge 5.10.0 &&
5018 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5019 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5020 WARN("MASK_THEN_SHIFT",
5021 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5022 }
5023
5024# check for pointer comparisons to NULL
5025 if ($^V && $^V ge 5.10.0) {
5026 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5027 my $val = $1;
5028 my $equal = "!";
5029 $equal = "" if ($4 eq "!=");
5030 if (CHK("COMPARISON_TO_NULL",
5031 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5032 $fix) {
5033 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5034 }
5035 }
5036 }
5037
5038# check for bad placement of section $InitAttribute (e.g.: __initdata)
5039 if ($line =~ /(\b$InitAttribute\b)/) {
5040 my $attr = $1;
5041 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5042 my $ptr = $1;
5043 my $var = $2;
5044 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5045 ERROR("MISPLACED_INIT",
5046 "$attr should be placed after $var\n" . $herecurr)) ||
5047 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5048 WARN("MISPLACED_INIT",
5049 "$attr should be placed after $var\n" . $herecurr))) &&
5050 $fix) {
5051 $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;
5052 }
5053 }
5054 }
5055
5056# check for $InitAttributeData (ie: __initdata) with const
5057 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5058 my $attr = $1;
5059 $attr =~ /($InitAttributePrefix)(.*)/;
5060 my $attr_prefix = $1;
5061 my $attr_type = $2;
5062 if (ERROR("INIT_ATTRIBUTE",
5063 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5064 $fix) {
5065 $fixed[$fixlinenr] =~
5066 s/$InitAttributeData/${attr_prefix}initconst/;
5067 }
5068 }
5069
5070# check for $InitAttributeConst (ie: __initconst) without const
5071 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5072 my $attr = $1;
5073 if (ERROR("INIT_ATTRIBUTE",
5074 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5075 $fix) {
5076 my $lead = $fixed[$fixlinenr] =~
5077 /(^\+\s*(?:static\s+))/;
5078 $lead = rtrim($1);
5079 $lead = "$lead " if ($lead !~ /^\+$/);
5080 $lead = "${lead}const ";
5081 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5082 }
5083 }
5084
5085# check for __read_mostly with const non-pointer (should just be const)
5086 if ($line =~ /\b__read_mostly\b/ &&
5087 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5088 if (ERROR("CONST_READ_MOSTLY",
5089 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5090 $fix) {
5091 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5092 }
5093 }
5094
5095# don't use __constant_<foo> functions outside of include/uapi/
5096 if ($realfile !~ m@^include/uapi/@ &&
5097 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5098 my $constant_func = $1;
5099 my $func = $constant_func;
5100 $func =~ s/^__constant_//;
5101 if (WARN("CONSTANT_CONVERSION",
5102 "$constant_func should be $func\n" . $herecurr) &&
5103 $fix) {
5104 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5105 }
5106 }
5107
5108# prefer usleep_range over udelay
5109 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5110 my $delay = $1;
5111 # ignore udelay's < 10, however
5112 if (! ($delay < 10) ) {
5113 CHK("USLEEP_RANGE",
5114 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5115 }
5116 if ($delay > 2000) {
5117 WARN("LONG_UDELAY",
5118 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5119 }
5120 }
5121
5122# warn about unexpectedly long msleep's
5123 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5124 if ($1 < 20) {
5125 WARN("MSLEEP",
5126 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5127 }
5128 }
5129
5130# check for comparisons of jiffies
5131 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5132 WARN("JIFFIES_COMPARISON",
5133 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5134 }
5135
5136# check for comparisons of get_jiffies_64()
5137 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5138 WARN("JIFFIES_COMPARISON",
5139 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5140 }
5141
5142# warn about #ifdefs in C files
5143# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5144# print "#ifdef in C files should be avoided\n";
5145# print "$herecurr";
5146# $clean = 0;
5147# }
5148
5149# warn about spacing in #ifdefs
5150 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5151 if (ERROR("SPACING",
5152 "exactly one space required after that #$1\n" . $herecurr) &&
5153 $fix) {
5154 $fixed[$fixlinenr] =~
5155 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5156 }
5157
5158 }
5159
5160# check for spinlock_t definitions without a comment.
5161 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5162 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5163 my $which = $1;
5164 if (!ctx_has_comment($first_line, $linenr)) {
5165 CHK("UNCOMMENTED_DEFINITION",
5166 "$1 definition without comment\n" . $herecurr);
5167 }
5168 }
5169# check for memory barriers without a comment.
5170
5171 my $barriers = qr{
5172 mb|
5173 rmb|
5174 wmb|
5175 read_barrier_depends
5176 }x;
5177 my $barrier_stems = qr{
5178 mb__before_atomic|
5179 mb__after_atomic|
5180 store_release|
5181 load_acquire|
5182 store_mb|
5183 (?:$barriers)
5184 }x;
5185 my $all_barriers = qr{
5186 (?:$barriers)|
5187 smp_(?:$barrier_stems)|
5188 virt_(?:$barrier_stems)
5189 }x;
5190
5191 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5192 if (!ctx_has_comment($first_line, $linenr)) {
5193 WARN("MEMORY_BARRIER",
5194 "memory barrier without comment\n" . $herecurr);
5195 }
5196 }
5197
5198 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5199
5200 if ($realfile !~ m@^include/asm-generic/@ &&
5201 $realfile !~ m@/barrier\.h$@ &&
5202 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5203 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5204 WARN("MEMORY_BARRIER",
5205 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5206 }
5207
5208# check for waitqueue_active without a comment.
5209 if ($line =~ /\bwaitqueue_active\s*\(/) {
5210 if (!ctx_has_comment($first_line, $linenr)) {
5211 WARN("WAITQUEUE_ACTIVE",
5212 "waitqueue_active without comment\n" . $herecurr);
5213 }
5214 }
5215
5216# Check for expedited grace periods that interrupt non-idle non-nohz
5217# online CPUs. These expedited can therefore degrade real-time response
5218# if used carelessly, and should be avoided where not absolutely
5219# needed. It is always OK to use synchronize_rcu_expedited() and
5220# synchronize_sched_expedited() at boot time (before real-time applications
5221# start) and in error situations where real-time response is compromised in
5222# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5223# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5224# Of course, nothing comes for free, and srcu_read_lock() and
5225# srcu_read_unlock() do contain full memory barriers in payment for
5226# synchronize_srcu_expedited() non-interruption properties.
5227 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5228 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5229 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5230
5231 }
5232
5233# check of hardware specific defines
5234 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5235 CHK("ARCH_DEFINES",
5236 "architecture specific defines should be avoided\n" . $herecurr);
5237 }
5238
5239# Check that the storage class is at the beginning of a declaration
5240 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
5241 WARN("STORAGE_CLASS",
5242 "storage class should be at the beginning of the declaration\n" . $herecurr)
5243 }
5244
5245# check the location of the inline attribute, that it is between
5246# storage class and type.
5247 if ($line =~ /\b$Type\s+$Inline\b/ ||
5248 $line =~ /\b$Inline\s+$Storage\b/) {
5249 ERROR("INLINE_LOCATION",
5250 "inline keyword should sit between storage class and type\n" . $herecurr);
5251 }
5252
5253# Check for __inline__ and __inline, prefer inline
5254 if ($realfile !~ m@\binclude/uapi/@ &&
5255 $line =~ /\b(__inline__|__inline)\b/) {
5256 if (WARN("INLINE",
5257 "plain inline is preferred over $1\n" . $herecurr) &&
5258 $fix) {
5259 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5260
5261 }
5262 }
5263
5264# Check for __attribute__ packed, prefer __packed
5265 if ($realfile !~ m@\binclude/uapi/@ &&
5266 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5267 WARN("PREFER_PACKED",
5268 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5269 }
5270
5271# Check for __attribute__ aligned, prefer __aligned
5272 if ($realfile !~ m@\binclude/uapi/@ &&
5273 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5274 WARN("PREFER_ALIGNED",
5275 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5276 }
5277
5278# Check for __attribute__ format(printf, prefer __printf
5279 if ($realfile !~ m@\binclude/uapi/@ &&
5280 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5281 if (WARN("PREFER_PRINTF",
5282 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5283 $fix) {
5284 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5285
5286 }
5287 }
5288
5289# Check for __attribute__ format(scanf, prefer __scanf
5290 if ($realfile !~ m@\binclude/uapi/@ &&
5291 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5292 if (WARN("PREFER_SCANF",
5293 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5294 $fix) {
5295 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5296 }
5297 }
5298
5299# Check for __attribute__ weak, or __weak declarations (may have link issues)
5300 if ($^V && $^V ge 5.10.0 &&
5301 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5302 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5303 $line =~ /\b__weak\b/)) {
5304 ERROR("WEAK_DECLARATION",
5305 "Using weak declarations can have unintended link defects\n" . $herecurr);
5306 }
5307
5308# check for c99 types like uint8_t used outside of uapi/
5309 if ($realfile !~ m@\binclude/uapi/@ &&
5310 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5311 my $type = $1;
5312 if ($type =~ /\b($typeC99Typedefs)\b/) {
5313 $type = $1;
5314 my $kernel_type = 'u';
5315 $kernel_type = 's' if ($type =~ /^_*[si]/);
5316 $type =~ /(\d+)/;
5317 $kernel_type .= $1;
5318 if (CHK("PREFER_KERNEL_TYPES",
5319 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5320 $fix) {
5321 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5322 }
5323 }
5324 }
5325
5326# check for cast of C90 native int or longer types constants
5327 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5328 my $cast = $1;
5329 my $const = $2;
5330 if (WARN("TYPECAST_INT_CONSTANT",
5331 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5332 $fix) {
5333 my $suffix = "";
5334 my $newconst = $const;
5335 $newconst =~ s/${Int_type}$//;
5336 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5337 if ($cast =~ /\blong\s+long\b/) {
5338 $suffix .= 'LL';
5339 } elsif ($cast =~ /\blong\b/) {
5340 $suffix .= 'L';
5341 }
5342 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5343 }
5344 }
5345
5346# check for sizeof(&)
5347 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5348 WARN("SIZEOF_ADDRESS",
5349 "sizeof(& should be avoided\n" . $herecurr);
5350 }
5351
5352# check for sizeof without parenthesis
5353 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5354 if (WARN("SIZEOF_PARENTHESIS",
5355 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5356 $fix) {
5357 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5358 }
5359 }
5360
5361# check for struct spinlock declarations
5362 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5363 WARN("USE_SPINLOCK_T",
5364 "struct spinlock should be spinlock_t\n" . $herecurr);
5365 }
5366
5367# check for seq_printf uses that could be seq_puts
5368 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5369 my $fmt = get_quoted_string($line, $rawline);
5370 $fmt =~ s/%%//g;
5371 if ($fmt !~ /%/) {
5372 if (WARN("PREFER_SEQ_PUTS",
5373 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5374 $fix) {
5375 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
5376 }
5377 }
5378 }
5379
5380# Check for misused memsets
5381 if ($^V && $^V ge 5.10.0 &&
5382 defined $stat &&
5383 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
5384
5385 my $ms_addr = $2;
5386 my $ms_val = $7;
5387 my $ms_size = $12;
5388
5389 if ($ms_size =~ /^(0x|)0$/i) {
5390 ERROR("MEMSET",
5391 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
5392 } elsif ($ms_size =~ /^(0x|)1$/i) {
5393 WARN("MEMSET",
5394 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5395 }
5396 }
5397
5398# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5399 if ($^V && $^V ge 5.10.0 &&
5400 defined $stat &&
5401 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5402 if (WARN("PREFER_ETHER_ADDR_COPY",
5403 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5404 $fix) {
5405 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5406 }
5407 }
5408
5409# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5410 if ($^V && $^V ge 5.10.0 &&
5411 defined $stat &&
5412 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5413 WARN("PREFER_ETHER_ADDR_EQUAL",
5414 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5415 }
5416
5417# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5418# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5419 if ($^V && $^V ge 5.10.0 &&
5420 defined $stat &&
5421 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5422
5423 my $ms_val = $7;
5424
5425 if ($ms_val =~ /^(?:0x|)0+$/i) {
5426 if (WARN("PREFER_ETH_ZERO_ADDR",
5427 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5428 $fix) {
5429 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5430 }
5431 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5432 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5433 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5434 $fix) {
5435 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5436 }
5437 }
5438 }
5439
5440# typecasts on min/max could be min_t/max_t
5441 if ($^V && $^V ge 5.10.0 &&
5442 defined $stat &&
5443 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
5444 if (defined $2 || defined $7) {
5445 my $call = $1;
5446 my $cast1 = deparenthesize($2);
5447 my $arg1 = $3;
5448 my $cast2 = deparenthesize($7);
5449 my $arg2 = $8;
5450 my $cast;
5451
5452 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
5453 $cast = "$cast1 or $cast2";
5454 } elsif ($cast1 ne "") {
5455 $cast = $cast1;
5456 } else {
5457 $cast = $cast2;
5458 }
5459 WARN("MINMAX",
5460 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
5461 }
5462 }
5463
5464# check usleep_range arguments
5465 if ($^V && $^V ge 5.10.0 &&
5466 defined $stat &&
5467 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5468 my $min = $1;
5469 my $max = $7;
5470 if ($min eq $max) {
5471 WARN("USLEEP_RANGE",
5472 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5473 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5474 $min > $max) {
5475 WARN("USLEEP_RANGE",
5476 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5477 }
5478 }
5479
5480# check for naked sscanf
5481 if ($^V && $^V ge 5.10.0 &&
5482 defined $stat &&
5483 $line =~ /\bsscanf\b/ &&
5484 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5485 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5486 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5487 my $lc = $stat =~ tr@\n@@;
5488 $lc = $lc + $linenr;
5489 my $stat_real = raw_line($linenr, 0);
5490 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5491 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5492 }
5493 WARN("NAKED_SSCANF",
5494 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5495 }
5496
5497# check for simple sscanf that should be kstrto<foo>
5498 if ($^V && $^V ge 5.10.0 &&
5499 defined $stat &&
5500 $line =~ /\bsscanf\b/) {
5501 my $lc = $stat =~ tr@\n@@;
5502 $lc = $lc + $linenr;
5503 my $stat_real = raw_line($linenr, 0);
5504 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5505 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5506 }
5507 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5508 my $format = $6;
5509 my $count = $format =~ tr@%@%@;
5510 if ($count == 1 &&
5511 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5512 WARN("SSCANF_TO_KSTRTO",
5513 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5514 }
5515 }
5516 }
5517
5518# check for new externs in .h files.
5519 if ($realfile =~ /\.h$/ &&
5520 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
5521 if (CHK("AVOID_EXTERNS",
5522 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
5523 $fix) {
5524 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
5525 }
5526 }
5527
5528# check for new externs in .c files.
5529 if ($realfile =~ /\.c$/ && defined $stat &&
5530 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
5531 {
5532 my $function_name = $1;
5533 my $paren_space = $2;
5534
5535 my $s = $stat;
5536 if (defined $cond) {
5537 substr($s, 0, length($cond), '');
5538 }
5539 if ($s =~ /^\s*;/ &&
5540 $function_name ne 'uninitialized_var')
5541 {
5542 WARN("AVOID_EXTERNS",
5543 "externs should be avoided in .c files\n" . $herecurr);
5544 }
5545
5546 if ($paren_space =~ /\n/) {
5547 WARN("FUNCTION_ARGUMENTS",
5548 "arguments for function declarations should follow identifier\n" . $herecurr);
5549 }
5550
5551 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5552 $stat =~ /^.\s*extern\s+/)
5553 {
5554 WARN("AVOID_EXTERNS",
5555 "externs should be avoided in .c files\n" . $herecurr);
5556 }
5557
5558# checks for new __setup's
5559 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5560 my $name = $1;
5561
5562 if (!grep(/$name/, @setup_docs)) {
5563 CHK("UNDOCUMENTED_SETUP",
5564 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
5565 }
5566 }
5567
5568# check for pointless casting of kmalloc return
5569 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
5570 WARN("UNNECESSARY_CASTS",
5571 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5572 }
5573
5574# alloc style
5575# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5576 if ($^V && $^V ge 5.10.0 &&
5577 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5578 CHK("ALLOC_SIZEOF_STRUCT",
5579 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5580 }
5581
5582# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5583 if ($^V && $^V ge 5.10.0 &&
5584 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5585 my $oldfunc = $3;
5586 my $a1 = $4;
5587 my $a2 = $10;
5588 my $newfunc = "kmalloc_array";
5589 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
5590 my $r1 = $a1;
5591 my $r2 = $a2;
5592 if ($a1 =~ /^sizeof\s*\S/) {
5593 $r1 = $a2;
5594 $r2 = $a1;
5595 }
5596 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5597 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
5598 if (WARN("ALLOC_WITH_MULTIPLY",
5599 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5600 $fix) {
5601 $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;
5602
5603 }
5604 }
5605 }
5606
5607# check for krealloc arg reuse
5608 if ($^V && $^V ge 5.10.0 &&
5609 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5610 WARN("KREALLOC_ARG_REUSE",
5611 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5612 }
5613
5614# check for alloc argument mismatch
5615 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5616 WARN("ALLOC_ARRAY_ARGS",
5617 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5618 }
5619
5620# check for multiple semicolons
5621 if ($line =~ /;\s*;\s*$/) {
5622 if (WARN("ONE_SEMICOLON",
5623 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5624 $fix) {
5625 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
5626 }
5627 }
5628
5629# check for #defines like: 1 << <digit> that could be BIT(digit)
5630 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5631 my $ull = "";
5632 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5633 if (CHK("BIT_MACRO",
5634 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5635 $fix) {
5636 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5637 }
5638 }
5639
5640# check for case / default statements not preceded by break/fallthrough/switch
5641 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5642 my $has_break = 0;
5643 my $has_statement = 0;
5644 my $count = 0;
5645 my $prevline = $linenr;
5646 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
5647 $prevline--;
5648 my $rline = $rawlines[$prevline - 1];
5649 my $fline = $lines[$prevline - 1];
5650 last if ($fline =~ /^\@\@/);
5651 next if ($fline =~ /^\-/);
5652 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5653 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5654 next if ($fline =~ /^.[\s$;]*$/);
5655 $has_statement = 1;
5656 $count++;
5657 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5658 }
5659 if (!$has_break && $has_statement) {
5660 WARN("MISSING_BREAK",
5661 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5662 }
5663 }
5664
5665# check for switch/default statements without a break;
5666 if ($^V && $^V ge 5.10.0 &&
5667 defined $stat &&
5668 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5669 my $ctx = '';
5670 my $herectx = $here . "\n";
5671 my $cnt = statement_rawlines($stat);
5672 for (my $n = 0; $n < $cnt; $n++) {
5673 $herectx .= raw_line($linenr, $n) . "\n";
5674 }
5675 WARN("DEFAULT_NO_BREAK",
5676 "switch default: should use break\n" . $herectx);
5677 }
5678
5679# check for gcc specific __FUNCTION__
5680 if ($line =~ /\b__FUNCTION__\b/) {
5681 if (WARN("USE_FUNC",
5682 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5683 $fix) {
5684 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
5685 }
5686 }
5687
5688# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5689 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5690 ERROR("DATE_TIME",
5691 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5692 }
5693
5694# check for use of yield()
5695 if ($line =~ /\byield\s*\(\s*\)/) {
5696 WARN("YIELD",
5697 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5698 }
5699
5700# check for comparisons against true and false
5701 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5702 my $lead = $1;
5703 my $arg = $2;
5704 my $test = $3;
5705 my $otype = $4;
5706 my $trail = $5;
5707 my $op = "!";
5708
5709 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5710
5711 my $type = lc($otype);
5712 if ($type =~ /^(?:true|false)$/) {
5713 if (("$test" eq "==" && "$type" eq "true") ||
5714 ("$test" eq "!=" && "$type" eq "false")) {
5715 $op = "";
5716 }
5717
5718 CHK("BOOL_COMPARISON",
5719 "Using comparison to $otype is error prone\n" . $herecurr);
5720
5721## maybe suggesting a correct construct would better
5722## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5723
5724 }
5725 }
5726
5727# check for semaphores initialized locked
5728 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
5729 WARN("CONSIDER_COMPLETION",
5730 "consider using a completion\n" . $herecurr);
5731 }
5732
5733# recommend kstrto* over simple_strto* and strict_strto*
5734 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
5735 WARN("CONSIDER_KSTRTO",
5736 "$1 is obsolete, use k$3 instead\n" . $herecurr);
5737 }
5738
5739# check for __initcall(), use device_initcall() explicitly or more appropriate function please
5740 if ($line =~ /^.\s*__initcall\s*\(/) {
5741 WARN("USE_DEVICE_INITCALL",
5742 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5743 }
5744
5745# check for various structs that are normally const (ops, kgdb, device_tree)
5746 my $const_structs = qr{
5747 acpi_dock_ops|
5748 address_space_operations|
5749 backlight_ops|
5750 block_device_operations|
5751 dentry_operations|
5752 dev_pm_ops|
5753 dma_map_ops|
5754 extent_io_ops|
5755 file_lock_operations|
5756 file_operations|
5757 hv_ops|
5758 ide_dma_ops|
5759 intel_dvo_dev_ops|
5760 item_operations|
5761 iwl_ops|
5762 kgdb_arch|
5763 kgdb_io|
5764 kset_uevent_ops|
5765 lock_manager_operations|
5766 microcode_ops|
5767 mtrr_ops|
5768 neigh_ops|
5769 nlmsvc_binding|
5770 of_device_id|
5771 pci_raw_ops|
5772 pipe_buf_operations|
5773 platform_hibernation_ops|
5774 platform_suspend_ops|
5775 proto_ops|
5776 rpc_pipe_ops|
5777 seq_operations|
5778 snd_ac97_build_ops|
5779 soc_pcmcia_socket_ops|
5780 stacktrace_ops|
5781 sysfs_ops|
5782 tty_operations|
5783 uart_ops|
5784 usb_mon_operations|
5785 wd_ops}x;
5786 if ($line !~ /\bconst\b/ &&
5787 $line =~ /\bstruct\s+($const_structs)\b/) {
5788 WARN("CONST_STRUCT",
5789 "struct $1 should normally be const\n" .
5790 $herecurr);
5791 }
5792
5793# use of NR_CPUS is usually wrong
5794# ignore definitions of NR_CPUS and usage to define arrays as likely right
5795 if ($line =~ /\bNR_CPUS\b/ &&
5796 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5797 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
5798 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5799 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5800 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
5801 {
5802 WARN("NR_CPUS",
5803 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5804 }
5805
5806# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5807 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5808 ERROR("DEFINE_ARCH_HAS",
5809 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5810 }
5811
5812# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5813 if ($^V && $^V ge 5.10.0 &&
5814 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5815 WARN("LIKELY_MISUSE",
5816 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5817 }
5818
5819# whine mightly about in_atomic
5820 if ($line =~ /\bin_atomic\s*\(/) {
5821 if ($realfile =~ m@^drivers/@) {
5822 ERROR("IN_ATOMIC",
5823 "do not use in_atomic in drivers\n" . $herecurr);
5824 } elsif ($realfile !~ m@^kernel/@) {
5825 WARN("IN_ATOMIC",
5826 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
5827 }
5828 }
5829
5830# check for lockdep_set_novalidate_class
5831 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5832 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5833 if ($realfile !~ m@^kernel/lockdep@ &&
5834 $realfile !~ m@^include/linux/lockdep@ &&
5835 $realfile !~ m@^drivers/base/core@) {
5836 ERROR("LOCKDEP",
5837 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
5838 }
5839 }
5840
5841 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5842 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
5843 WARN("EXPORTED_WORLD_WRITABLE",
5844 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5845 }
5846
5847# Mode permission misuses where it seems decimal should be octal
5848# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5849 if ($^V && $^V ge 5.10.0 &&
5850 $line =~ /$mode_perms_search/) {
5851 foreach my $entry (@mode_permission_funcs) {
5852 my $func = $entry->[0];
5853 my $arg_pos = $entry->[1];
5854
5855 my $skip_args = "";
5856 if ($arg_pos > 1) {
5857 $arg_pos--;
5858 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5859 }
5860 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5861 if ($line =~ /$test/) {
5862 my $val = $1;
5863 $val = $6 if ($skip_args ne "");
5864
5865 if ($val !~ /^0$/ &&
5866 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5867 length($val) ne 4)) {
5868 ERROR("NON_OCTAL_PERMISSIONS",
5869 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5870 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5871 ERROR("EXPORTED_WORLD_WRITABLE",
5872 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5873 }
5874 }
5875 }
5876 }
5877
5878# validate content of MODULE_LICENSE against list from include/linux/module.h
5879 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5880 my $extracted_string = get_quoted_string($line, $rawline);
5881 my $valid_licenses = qr{
5882 GPL|
5883 GPL\ v2|
5884 GPL\ and\ additional\ rights|
5885 Dual\ BSD/GPL|
5886 Dual\ MIT/GPL|
5887 Dual\ MPL/GPL|
5888 Proprietary
5889 }x;
5890 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5891 WARN("MODULE_LICENSE",
5892 "unknown module license " . $extracted_string . "\n" . $herecurr);
5893 }
5894 }
5895 }
5896
5897 # If we have no input at all, then there is nothing to report on
5898 # so just keep quiet.
5899 if ($#rawlines == -1) {
5900 exit(0);
5901 }
5902
5903 # In mailback mode only produce a report in the negative, for
5904 # things that appear to be patches.
5905 if ($mailback && ($clean == 1 || !$is_patch)) {
5906 exit(0);
5907 }
5908
5909 # This is not a patch, and we are are in 'no-patch' mode so
5910 # just keep quiet.
5911 if (!$chk_patch && !$is_patch) {
5912 exit(0);
5913 }
5914
5915 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
5916 ERROR("NOT_UNIFIED_DIFF",
5917 "Does not appear to be a unified-diff format patch\n");
5918 }
5919 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
5920 ERROR("MISSING_SIGN_OFF",
5921 "Missing Signed-off-by: line(s)\n");
5922 }
5923
5924 print report_dump();
5925 if ($summary && !($clean == 1 && $quiet == 1)) {
5926 print "$filename " if ($summary_file);
5927 print "total: $cnt_error errors, $cnt_warn warnings, " .
5928 (($check)? "$cnt_chk checks, " : "") .
5929 "$cnt_lines lines checked\n";
5930 }
5931
5932 if ($quiet == 0) {
5933 # If there were whitespace errors which cleanpatch can fix
5934 # then suggest that.
5935 if ($rpt_cleaners) {
5936 $rpt_cleaners = 0;
5937 print << "EOM"
5938
5939NOTE: Whitespace errors detected.
5940 You may wish to use scripts/cleanpatch or scripts/cleanfile
5941EOM
5942 }
5943 }
5944
5945 if ($clean == 0 && $fix &&
5946 ("@rawlines" ne "@fixed" ||
5947 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
5948 my $newfile = $filename;
5949 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
5950 my $linecount = 0;
5951 my $f;
5952
5953 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5954
5955 open($f, '>', $newfile)
5956 or die "$P: Can't open $newfile for write\n";
5957 foreach my $fixed_line (@fixed) {
5958 $linecount++;
5959 if ($file) {
5960 if ($linecount > 3) {
5961 $fixed_line =~ s/^\+//;
5962 print $f $fixed_line . "\n";
5963 }
5964 } else {
5965 print $f $fixed_line . "\n";
5966 }
5967 }
5968 close($f);
5969
5970 if (!$quiet) {
5971 print << "EOM";
5972
5973Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5974
5975Do _NOT_ trust the results written to this file.
5976Do _NOT_ submit these changes without inspecting them for correctness.
5977
5978This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5979No warranties, expressed or implied...
5980EOM
5981 }
5982 }
5983
5984 if ($quiet == 0) {
5985 print "\n";
5986 if ($clean == 1) {
5987 print "$vname has no obvious style problems and is ready for submission.\n";
5988 } else {
5989 print "$vname has style problems, please review.\n";
5990 }
5991 }
5992 return $clean;
5993}