Loading...
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3#
4# (c) 2001, Dave Jones. (the file handling bit)
5# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8# (c) 2010-2018 Joe Perches <joe@perches.com>
9
10use strict;
11use warnings;
12use POSIX;
13use File::Basename;
14use Cwd 'abs_path';
15use Term::ANSIColor qw(:constants);
16use Encode qw(decode encode);
17
18my $P = $0;
19my $D = dirname(abs_path($P));
20
21my $V = '0.32';
22
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
29my $tst_only;
30my $emacs = 0;
31my $terse = 0;
32my $showfile = 0;
33my $file = 0;
34my $git = 0;
35my %git_commits = ();
36my $check = 0;
37my $check_orig = 0;
38my $summary = 1;
39my $mailback = 0;
40my $summary_file = 0;
41my $show_types = 0;
42my $list_types = 0;
43my $fix = 0;
44my $fix_inplace = 0;
45my $root;
46my %debug;
47my %camelcase = ();
48my %use_type = ();
49my @use = ();
50my %ignore_type = ();
51my @ignore = ();
52my $help = 0;
53my $configuration_file = ".checkpatch.conf";
54my $max_line_length = 80;
55my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
57my $min_conf_desc_length = 4;
58my $spelling_file = "$D/spelling.txt";
59my $codespell = 0;
60my $codespellfile = "/usr/share/codespell/dictionary.txt";
61my $conststructsfile = "$D/const_structs.checkpatch";
62my $typedefsfile = "";
63my $color = "auto";
64my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
65# git output parsing needs US English output, so first set backtick child process LANGUAGE
66my $git_command ='export LANGUAGE=en_US.UTF-8; git';
67
68sub help {
69 my ($exitcode) = @_;
70
71 print << "EOM";
72Usage: $P [OPTION]... [FILE]...
73Version: $V
74
75Options:
76 -q, --quiet quiet
77 --no-tree run without a kernel tree
78 --no-signoff do not check for 'Signed-off-by' line
79 --patch treat FILE as patchfile (default)
80 --emacs emacs compile window format
81 --terse one line per report
82 --showfile emit diffed file position, not input file position
83 -g, --git treat FILE as a single commit or git revision range
84 single git commit with:
85 <rev>
86 <rev>^
87 <rev>~n
88 multiple git commits with:
89 <rev1>..<rev2>
90 <rev1>...<rev2>
91 <rev>-<count>
92 git merges are ignored
93 -f, --file treat FILE as regular source file
94 --subjective, --strict enable more subjective tests
95 --list-types list the possible message types
96 --types TYPE(,TYPE2...) show only these comma separated message types
97 --ignore TYPE(,TYPE2...) ignore various comma separated message types
98 --show-types show the specific message type in the output
99 --max-line-length=n set the maximum line length, if exceeded, warn
100 --min-conf-desc-length=n set the min description length, if shorter, warn
101 --root=PATH PATH to the kernel tree root
102 --no-summary suppress the per-file summary
103 --mailback only produce a report in case of warnings/errors
104 --summary-file include the filename in summary
105 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
106 'values', 'possible', 'type', and 'attr' (default
107 is all off)
108 --test-only=WORD report only warnings/errors containing WORD
109 literally
110 --fix EXPERIMENTAL - may create horrible results
111 If correctable single-line errors exist, create
112 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
113 with potential errors corrected to the preferred
114 checkpatch style
115 --fix-inplace EXPERIMENTAL - may create horrible results
116 Is the same as --fix, but overwrites the input
117 file. It's your fault if there's no backup or git
118 --ignore-perl-version override checking of perl version. expect
119 runtime errors.
120 --codespell Use the codespell dictionary for spelling/typos
121 (default:/usr/share/codespell/dictionary.txt)
122 --codespellfile Use this codespell dictionary
123 --typedefsfile Read additional types from this file
124 --color[=WHEN] Use colors 'always', 'never', or only when output
125 is a terminal ('auto'). Default is 'auto'.
126 -h, --help, --version display this help and exit
127
128When FILE is - read standard input.
129EOM
130
131 exit($exitcode);
132}
133
134sub uniq {
135 my %seen;
136 return grep { !$seen{$_}++ } @_;
137}
138
139sub list_types {
140 my ($exitcode) = @_;
141
142 my $count = 0;
143
144 local $/ = undef;
145
146 open(my $script, '<', abs_path($P)) or
147 die "$P: Can't read '$P' $!\n";
148
149 my $text = <$script>;
150 close($script);
151
152 my @types = ();
153 # Also catch when type or level is passed through a variable
154 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
155 push (@types, $_);
156 }
157 @types = sort(uniq(@types));
158 print("#\tMessage type\n\n");
159 foreach my $type (@types) {
160 print(++$count . "\t" . $type . "\n");
161 }
162
163 exit($exitcode);
164}
165
166my $conf = which_conf($configuration_file);
167if (-f $conf) {
168 my @conf_args;
169 open(my $conffile, '<', "$conf")
170 or warn "$P: Can't find a readable $configuration_file file $!\n";
171
172 while (<$conffile>) {
173 my $line = $_;
174
175 $line =~ s/\s*\n?$//g;
176 $line =~ s/^\s*//g;
177 $line =~ s/\s+/ /g;
178
179 next if ($line =~ m/^\s*#/);
180 next if ($line =~ m/^\s*$/);
181
182 my @words = split(" ", $line);
183 foreach my $word (@words) {
184 last if ($word =~ m/^#/);
185 push (@conf_args, $word);
186 }
187 }
188 close($conffile);
189 unshift(@ARGV, @conf_args) if @conf_args;
190}
191
192# Perl's Getopt::Long allows options to take optional arguments after a space.
193# Prevent --color by itself from consuming other arguments
194foreach (@ARGV) {
195 if ($_ eq "--color" || $_ eq "-color") {
196 $_ = "--color=$color";
197 }
198}
199
200GetOptions(
201 'q|quiet+' => \$quiet,
202 'tree!' => \$tree,
203 'signoff!' => \$chk_signoff,
204 'patch!' => \$chk_patch,
205 'emacs!' => \$emacs,
206 'terse!' => \$terse,
207 'showfile!' => \$showfile,
208 'f|file!' => \$file,
209 'g|git!' => \$git,
210 'subjective!' => \$check,
211 'strict!' => \$check,
212 'ignore=s' => \@ignore,
213 'types=s' => \@use,
214 'show-types!' => \$show_types,
215 'list-types!' => \$list_types,
216 'max-line-length=i' => \$max_line_length,
217 'min-conf-desc-length=i' => \$min_conf_desc_length,
218 'root=s' => \$root,
219 'summary!' => \$summary,
220 'mailback!' => \$mailback,
221 'summary-file!' => \$summary_file,
222 'fix!' => \$fix,
223 'fix-inplace!' => \$fix_inplace,
224 'ignore-perl-version!' => \$ignore_perl_version,
225 'debug=s' => \%debug,
226 'test-only=s' => \$tst_only,
227 'codespell!' => \$codespell,
228 'codespellfile=s' => \$codespellfile,
229 'typedefsfile=s' => \$typedefsfile,
230 'color=s' => \$color,
231 'no-color' => \$color, #keep old behaviors of -nocolor
232 'nocolor' => \$color, #keep old behaviors of -nocolor
233 'h|help' => \$help,
234 'version' => \$help
235) or help(1);
236
237help(0) if ($help);
238
239list_types(0) if ($list_types);
240
241$fix = 1 if ($fix_inplace);
242$check_orig = $check;
243
244my $exit = 0;
245
246my $perl_version_ok = 1;
247if ($^V && $^V lt $minimum_perl_version) {
248 $perl_version_ok = 0;
249 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
250 exit(1) if (!$ignore_perl_version);
251}
252
253#if no filenames are given, push '-' to read patch from stdin
254if ($#ARGV < 0) {
255 push(@ARGV, '-');
256}
257
258if ($color =~ /^[01]$/) {
259 $color = !$color;
260} elsif ($color =~ /^always$/i) {
261 $color = 1;
262} elsif ($color =~ /^never$/i) {
263 $color = 0;
264} elsif ($color =~ /^auto$/i) {
265 $color = (-t STDOUT);
266} else {
267 die "Invalid color mode: $color\n";
268}
269
270sub hash_save_array_words {
271 my ($hashRef, $arrayRef) = @_;
272
273 my @array = split(/,/, join(',', @$arrayRef));
274 foreach my $word (@array) {
275 $word =~ s/\s*\n?$//g;
276 $word =~ s/^\s*//g;
277 $word =~ s/\s+/ /g;
278 $word =~ tr/[a-z]/[A-Z]/;
279
280 next if ($word =~ m/^\s*#/);
281 next if ($word =~ m/^\s*$/);
282
283 $hashRef->{$word}++;
284 }
285}
286
287sub hash_show_words {
288 my ($hashRef, $prefix) = @_;
289
290 if (keys %$hashRef) {
291 print "\nNOTE: $prefix message types:";
292 foreach my $word (sort keys %$hashRef) {
293 print " $word";
294 }
295 print "\n";
296 }
297}
298
299hash_save_array_words(\%ignore_type, \@ignore);
300hash_save_array_words(\%use_type, \@use);
301
302my $dbg_values = 0;
303my $dbg_possible = 0;
304my $dbg_type = 0;
305my $dbg_attr = 0;
306for my $key (keys %debug) {
307 ## no critic
308 eval "\${dbg_$key} = '$debug{$key}';";
309 die "$@" if ($@);
310}
311
312my $rpt_cleaners = 0;
313
314if ($terse) {
315 $emacs = 1;
316 $quiet++;
317}
318
319if ($tree) {
320 if (defined $root) {
321 if (!top_of_kernel_tree($root)) {
322 die "$P: $root: --root does not point at a valid tree\n";
323 }
324 } else {
325 if (top_of_kernel_tree('.')) {
326 $root = '.';
327 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
328 top_of_kernel_tree($1)) {
329 $root = $1;
330 }
331 }
332
333 if (!defined $root) {
334 print "Must be run from the top-level dir. of a kernel tree\n";
335 exit(2);
336 }
337}
338
339my $emitted_corrupt = 0;
340
341our $Ident = qr{
342 [A-Za-z_][A-Za-z\d_]*
343 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
344 }x;
345our $Storage = qr{extern|static|asmlinkage};
346our $Sparse = qr{
347 __user|
348 __kernel|
349 __force|
350 __iomem|
351 __must_check|
352 __kprobes|
353 __ref|
354 __refconst|
355 __refdata|
356 __rcu|
357 __private
358 }x;
359our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
360our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
361our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
362our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
363our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
364
365# Notes to $Attribute:
366# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
367our $Attribute = qr{
368 const|
369 __percpu|
370 __nocast|
371 __safe|
372 __bitwise|
373 __packed__|
374 __packed2__|
375 __naked|
376 __maybe_unused|
377 __always_unused|
378 __noreturn|
379 __used|
380 __cold|
381 __pure|
382 __noclone|
383 __deprecated|
384 __read_mostly|
385 __ro_after_init|
386 __kprobes|
387 $InitAttribute|
388 ____cacheline_aligned|
389 ____cacheline_aligned_in_smp|
390 ____cacheline_internodealigned_in_smp|
391 __weak
392 }x;
393our $Modifier;
394our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
395our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
396our $Lval = qr{$Ident(?:$Member)*};
397
398our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
399our $Binary = qr{(?i)0b[01]+$Int_type?};
400our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
401our $Int = qr{[0-9]+$Int_type?};
402our $Octal = qr{0[0-7]+$Int_type?};
403our $String = qr{"[X\t]*"};
404our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
405our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
406our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
407our $Float = qr{$Float_hex|$Float_dec|$Float_int};
408our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
409our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
410our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
411our $Arithmetic = qr{\+|-|\*|\/|%};
412our $Operators = qr{
413 <=|>=|==|!=|
414 =>|->|<<|>>|<|>|!|~|
415 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
416 }x;
417
418our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
419
420our $BasicType;
421our $NonptrType;
422our $NonptrTypeMisordered;
423our $NonptrTypeWithAttr;
424our $Type;
425our $TypeMisordered;
426our $Declare;
427our $DeclareMisordered;
428
429our $NON_ASCII_UTF8 = qr{
430 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
431 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
432 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
433 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
434 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
435 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
436 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
437}x;
438
439our $UTF8 = qr{
440 [\x09\x0A\x0D\x20-\x7E] # ASCII
441 | $NON_ASCII_UTF8
442}x;
443
444our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
445our $typeOtherOSTypedefs = qr{(?x:
446 u_(?:char|short|int|long) | # bsd
447 u(?:nchar|short|int|long) # sysv
448)};
449our $typeKernelTypedefs = qr{(?x:
450 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
451 atomic_t
452)};
453our $typeTypedefs = qr{(?x:
454 $typeC99Typedefs\b|
455 $typeOtherOSTypedefs\b|
456 $typeKernelTypedefs\b
457)};
458
459our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
460
461our $logFunctions = qr{(?x:
462 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
463 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
464 TP_printk|
465 WARN(?:_RATELIMIT|_ONCE|)|
466 panic|
467 MODULE_[A-Z_]+|
468 seq_vprintf|seq_printf|seq_puts
469)};
470
471our $allocFunctions = qr{(?x:
472 (?:(?:devm_)?
473 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
474 kstrdup(?:_const)? |
475 kmemdup(?:_nul)?) |
476 (?:\w+)?alloc_skb(?:ip_align)? |
477 # dev_alloc_skb/netdev_alloc_skb, et al
478 dma_alloc_coherent
479)};
480
481our $signature_tags = qr{(?xi:
482 Signed-off-by:|
483 Co-developed-by:|
484 Acked-by:|
485 Tested-by:|
486 Reviewed-by:|
487 Reported-by:|
488 Suggested-by:|
489 To:|
490 Cc:
491)};
492
493our @typeListMisordered = (
494 qr{char\s+(?:un)?signed},
495 qr{int\s+(?:(?:un)?signed\s+)?short\s},
496 qr{int\s+short(?:\s+(?:un)?signed)},
497 qr{short\s+int(?:\s+(?:un)?signed)},
498 qr{(?:un)?signed\s+int\s+short},
499 qr{short\s+(?:un)?signed},
500 qr{long\s+int\s+(?:un)?signed},
501 qr{int\s+long\s+(?:un)?signed},
502 qr{long\s+(?:un)?signed\s+int},
503 qr{int\s+(?:un)?signed\s+long},
504 qr{int\s+(?:un)?signed},
505 qr{int\s+long\s+long\s+(?:un)?signed},
506 qr{long\s+long\s+int\s+(?:un)?signed},
507 qr{long\s+long\s+(?:un)?signed\s+int},
508 qr{long\s+long\s+(?:un)?signed},
509 qr{long\s+(?:un)?signed},
510);
511
512our @typeList = (
513 qr{void},
514 qr{(?:(?:un)?signed\s+)?char},
515 qr{(?:(?:un)?signed\s+)?short\s+int},
516 qr{(?:(?:un)?signed\s+)?short},
517 qr{(?:(?:un)?signed\s+)?int},
518 qr{(?:(?:un)?signed\s+)?long\s+int},
519 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
520 qr{(?:(?:un)?signed\s+)?long\s+long},
521 qr{(?:(?:un)?signed\s+)?long},
522 qr{(?:un)?signed},
523 qr{float},
524 qr{double},
525 qr{bool},
526 qr{struct\s+$Ident},
527 qr{union\s+$Ident},
528 qr{enum\s+$Ident},
529 qr{${Ident}_t},
530 qr{${Ident}_handler},
531 qr{${Ident}_handler_fn},
532 @typeListMisordered,
533);
534
535our $C90_int_types = qr{(?x:
536 long\s+long\s+int\s+(?:un)?signed|
537 long\s+long\s+(?:un)?signed\s+int|
538 long\s+long\s+(?:un)?signed|
539 (?:(?:un)?signed\s+)?long\s+long\s+int|
540 (?:(?:un)?signed\s+)?long\s+long|
541 int\s+long\s+long\s+(?:un)?signed|
542 int\s+(?:(?:un)?signed\s+)?long\s+long|
543
544 long\s+int\s+(?:un)?signed|
545 long\s+(?:un)?signed\s+int|
546 long\s+(?:un)?signed|
547 (?:(?:un)?signed\s+)?long\s+int|
548 (?:(?:un)?signed\s+)?long|
549 int\s+long\s+(?:un)?signed|
550 int\s+(?:(?:un)?signed\s+)?long|
551
552 int\s+(?:un)?signed|
553 (?:(?:un)?signed\s+)?int
554)};
555
556our @typeListFile = ();
557our @typeListWithAttr = (
558 @typeList,
559 qr{struct\s+$InitAttribute\s+$Ident},
560 qr{union\s+$InitAttribute\s+$Ident},
561);
562
563our @modifierList = (
564 qr{fastcall},
565);
566our @modifierListFile = ();
567
568our @mode_permission_funcs = (
569 ["module_param", 3],
570 ["module_param_(?:array|named|string)", 4],
571 ["module_param_array_named", 5],
572 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
573 ["proc_create(?:_data|)", 2],
574 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
575 ["IIO_DEV_ATTR_[A-Z_]+", 1],
576 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
577 ["SENSOR_TEMPLATE(?:_2|)", 3],
578 ["__ATTR", 2],
579);
580
581#Create a search pattern for all these functions to speed up a loop below
582our $mode_perms_search = "";
583foreach my $entry (@mode_permission_funcs) {
584 $mode_perms_search .= '|' if ($mode_perms_search ne "");
585 $mode_perms_search .= $entry->[0];
586}
587$mode_perms_search = "(?:${mode_perms_search})";
588
589our %deprecated_apis = (
590 "synchronize_rcu_bh" => "synchronize_rcu",
591 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
592 "call_rcu_bh" => "call_rcu",
593 "rcu_barrier_bh" => "rcu_barrier",
594 "synchronize_sched" => "synchronize_rcu",
595 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
596 "call_rcu_sched" => "call_rcu",
597 "rcu_barrier_sched" => "rcu_barrier",
598 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
599 "cond_synchronize_sched" => "cond_synchronize_rcu",
600);
601
602#Create a search pattern for all these strings to speed up a loop below
603our $deprecated_apis_search = "";
604foreach my $entry (keys %deprecated_apis) {
605 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
606 $deprecated_apis_search .= $entry;
607}
608$deprecated_apis_search = "(?:${deprecated_apis_search})";
609
610our $mode_perms_world_writable = qr{
611 S_IWUGO |
612 S_IWOTH |
613 S_IRWXUGO |
614 S_IALLUGO |
615 0[0-7][0-7][2367]
616}x;
617
618our %mode_permission_string_types = (
619 "S_IRWXU" => 0700,
620 "S_IRUSR" => 0400,
621 "S_IWUSR" => 0200,
622 "S_IXUSR" => 0100,
623 "S_IRWXG" => 0070,
624 "S_IRGRP" => 0040,
625 "S_IWGRP" => 0020,
626 "S_IXGRP" => 0010,
627 "S_IRWXO" => 0007,
628 "S_IROTH" => 0004,
629 "S_IWOTH" => 0002,
630 "S_IXOTH" => 0001,
631 "S_IRWXUGO" => 0777,
632 "S_IRUGO" => 0444,
633 "S_IWUGO" => 0222,
634 "S_IXUGO" => 0111,
635);
636
637#Create a search pattern for all these strings to speed up a loop below
638our $mode_perms_string_search = "";
639foreach my $entry (keys %mode_permission_string_types) {
640 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
641 $mode_perms_string_search .= $entry;
642}
643our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
644our $multi_mode_perms_string_search = qr{
645 ${single_mode_perms_string_search}
646 (?:\s*\|\s*${single_mode_perms_string_search})*
647}x;
648
649sub perms_to_octal {
650 my ($string) = @_;
651
652 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
653
654 my $val = "";
655 my $oval = "";
656 my $to = 0;
657 my $curpos = 0;
658 my $lastpos = 0;
659 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
660 $curpos = pos($string);
661 my $match = $2;
662 my $omatch = $1;
663 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
664 $lastpos = $curpos;
665 $to |= $mode_permission_string_types{$match};
666 $val .= '\s*\|\s*' if ($val ne "");
667 $val .= $match;
668 $oval .= $omatch;
669 }
670 $oval =~ s/^\s*\|\s*//;
671 $oval =~ s/\s*\|\s*$//;
672 return sprintf("%04o", $to);
673}
674
675our $allowed_asm_includes = qr{(?x:
676 irq|
677 memory|
678 time|
679 reboot
680)};
681# memory.h: ARM has a custom one
682
683# Load common spelling mistakes and build regular expression list.
684my $misspellings;
685my %spelling_fix;
686
687if (open(my $spelling, '<', $spelling_file)) {
688 while (<$spelling>) {
689 my $line = $_;
690
691 $line =~ s/\s*\n?$//g;
692 $line =~ s/^\s*//g;
693
694 next if ($line =~ m/^\s*#/);
695 next if ($line =~ m/^\s*$/);
696
697 my ($suspect, $fix) = split(/\|\|/, $line);
698
699 $spelling_fix{$suspect} = $fix;
700 }
701 close($spelling);
702} else {
703 warn "No typos will be found - file '$spelling_file': $!\n";
704}
705
706if ($codespell) {
707 if (open(my $spelling, '<', $codespellfile)) {
708 while (<$spelling>) {
709 my $line = $_;
710
711 $line =~ s/\s*\n?$//g;
712 $line =~ s/^\s*//g;
713
714 next if ($line =~ m/^\s*#/);
715 next if ($line =~ m/^\s*$/);
716 next if ($line =~ m/, disabled/i);
717
718 $line =~ s/,.*$//;
719
720 my ($suspect, $fix) = split(/->/, $line);
721
722 $spelling_fix{$suspect} = $fix;
723 }
724 close($spelling);
725 } else {
726 warn "No codespell typos will be found - file '$codespellfile': $!\n";
727 }
728}
729
730$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
731
732sub read_words {
733 my ($wordsRef, $file) = @_;
734
735 if (open(my $words, '<', $file)) {
736 while (<$words>) {
737 my $line = $_;
738
739 $line =~ s/\s*\n?$//g;
740 $line =~ s/^\s*//g;
741
742 next if ($line =~ m/^\s*#/);
743 next if ($line =~ m/^\s*$/);
744 if ($line =~ /\s/) {
745 print("$file: '$line' invalid - ignored\n");
746 next;
747 }
748
749 $$wordsRef .= '|' if ($$wordsRef ne "");
750 $$wordsRef .= $line;
751 }
752 close($file);
753 return 1;
754 }
755
756 return 0;
757}
758
759my $const_structs = "";
760read_words(\$const_structs, $conststructsfile)
761 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
762
763my $typeOtherTypedefs = "";
764if (length($typedefsfile)) {
765 read_words(\$typeOtherTypedefs, $typedefsfile)
766 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
767}
768$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
769
770sub build_types {
771 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
772 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
773 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
774 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
775 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
776 $BasicType = qr{
777 (?:$typeTypedefs\b)|
778 (?:${all}\b)
779 }x;
780 $NonptrType = qr{
781 (?:$Modifier\s+|const\s+)*
782 (?:
783 (?:typeof|__typeof__)\s*\([^\)]*\)|
784 (?:$typeTypedefs\b)|
785 (?:${all}\b)
786 )
787 (?:\s+$Modifier|\s+const)*
788 }x;
789 $NonptrTypeMisordered = qr{
790 (?:$Modifier\s+|const\s+)*
791 (?:
792 (?:${Misordered}\b)
793 )
794 (?:\s+$Modifier|\s+const)*
795 }x;
796 $NonptrTypeWithAttr = qr{
797 (?:$Modifier\s+|const\s+)*
798 (?:
799 (?:typeof|__typeof__)\s*\([^\)]*\)|
800 (?:$typeTypedefs\b)|
801 (?:${allWithAttr}\b)
802 )
803 (?:\s+$Modifier|\s+const)*
804 }x;
805 $Type = qr{
806 $NonptrType
807 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
808 (?:\s+$Inline|\s+$Modifier)*
809 }x;
810 $TypeMisordered = qr{
811 $NonptrTypeMisordered
812 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
813 (?:\s+$Inline|\s+$Modifier)*
814 }x;
815 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
816 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
817}
818build_types();
819
820our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
821
822# Using $balanced_parens, $LvalOrFunc, or $FuncArg
823# requires at least perl version v5.10.0
824# Any use must be runtime checked with $^V
825
826our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
827our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
828our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
829
830our $declaration_macros = qr{(?x:
831 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
832 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
833 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
834 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
835)};
836
837sub deparenthesize {
838 my ($string) = @_;
839 return "" if (!defined($string));
840
841 while ($string =~ /^\s*\(.*\)\s*$/) {
842 $string =~ s@^\s*\(\s*@@;
843 $string =~ s@\s*\)\s*$@@;
844 }
845
846 $string =~ s@\s+@ @g;
847
848 return $string;
849}
850
851sub seed_camelcase_file {
852 my ($file) = @_;
853
854 return if (!(-f $file));
855
856 local $/;
857
858 open(my $include_file, '<', "$file")
859 or warn "$P: Can't read '$file' $!\n";
860 my $text = <$include_file>;
861 close($include_file);
862
863 my @lines = split('\n', $text);
864
865 foreach my $line (@lines) {
866 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
867 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
868 $camelcase{$1} = 1;
869 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
870 $camelcase{$1} = 1;
871 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
872 $camelcase{$1} = 1;
873 }
874 }
875}
876
877sub is_maintained_obsolete {
878 my ($filename) = @_;
879
880 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
881
882 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
883
884 return $status =~ /obsolete/i;
885}
886
887sub is_SPDX_License_valid {
888 my ($license) = @_;
889
890 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
891
892 my $root_path = abs_path($root);
893 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
894 return 0 if ($status ne "");
895 return 1;
896}
897
898my $camelcase_seeded = 0;
899sub seed_camelcase_includes {
900 return if ($camelcase_seeded);
901
902 my $files;
903 my $camelcase_cache = "";
904 my @include_files = ();
905
906 $camelcase_seeded = 1;
907
908 if (-e ".git") {
909 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
910 chomp $git_last_include_commit;
911 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
912 } else {
913 my $last_mod_date = 0;
914 $files = `find $root/include -name "*.h"`;
915 @include_files = split('\n', $files);
916 foreach my $file (@include_files) {
917 my $date = POSIX::strftime("%Y%m%d%H%M",
918 localtime((stat $file)[9]));
919 $last_mod_date = $date if ($last_mod_date < $date);
920 }
921 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
922 }
923
924 if ($camelcase_cache ne "" && -f $camelcase_cache) {
925 open(my $camelcase_file, '<', "$camelcase_cache")
926 or warn "$P: Can't read '$camelcase_cache' $!\n";
927 while (<$camelcase_file>) {
928 chomp;
929 $camelcase{$_} = 1;
930 }
931 close($camelcase_file);
932
933 return;
934 }
935
936 if (-e ".git") {
937 $files = `${git_command} ls-files "include/*.h"`;
938 @include_files = split('\n', $files);
939 }
940
941 foreach my $file (@include_files) {
942 seed_camelcase_file($file);
943 }
944
945 if ($camelcase_cache ne "") {
946 unlink glob ".checkpatch-camelcase.*";
947 open(my $camelcase_file, '>', "$camelcase_cache")
948 or warn "$P: Can't write '$camelcase_cache' $!\n";
949 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
950 print $camelcase_file ("$_\n");
951 }
952 close($camelcase_file);
953 }
954}
955
956sub git_commit_info {
957 my ($commit, $id, $desc) = @_;
958
959 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
960
961 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
962 $output =~ s/^\s*//gm;
963 my @lines = split("\n", $output);
964
965 return ($id, $desc) if ($#lines < 0);
966
967 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
968# Maybe one day convert this block of bash into something that returns
969# all matching commit ids, but it's very slow...
970#
971# echo "checking commits $1..."
972# git rev-list --remotes | grep -i "^$1" |
973# while read line ; do
974# git log --format='%H %s' -1 $line |
975# echo "commit $(cut -c 1-12,41-)"
976# done
977 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
978 $id = undef;
979 } else {
980 $id = substr($lines[0], 0, 12);
981 $desc = substr($lines[0], 41);
982 }
983
984 return ($id, $desc);
985}
986
987$chk_signoff = 0 if ($file);
988
989my @rawlines = ();
990my @lines = ();
991my @fixed = ();
992my @fixed_inserted = ();
993my @fixed_deleted = ();
994my $fixlinenr = -1;
995
996# If input is git commits, extract all commits from the commit expressions.
997# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
998die "$P: No git repository found\n" if ($git && !-e ".git");
999
1000if ($git) {
1001 my @commits = ();
1002 foreach my $commit_expr (@ARGV) {
1003 my $git_range;
1004 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1005 $git_range = "-$2 $1";
1006 } elsif ($commit_expr =~ m/\.\./) {
1007 $git_range = "$commit_expr";
1008 } else {
1009 $git_range = "-1 $commit_expr";
1010 }
1011 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1012 foreach my $line (split(/\n/, $lines)) {
1013 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1014 next if (!defined($1) || !defined($2));
1015 my $sha1 = $1;
1016 my $subject = $2;
1017 unshift(@commits, $sha1);
1018 $git_commits{$sha1} = $subject;
1019 }
1020 }
1021 die "$P: no git commits after extraction!\n" if (@commits == 0);
1022 @ARGV = @commits;
1023}
1024
1025my $vname;
1026$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1027for my $filename (@ARGV) {
1028 my $FILE;
1029 if ($git) {
1030 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1031 die "$P: $filename: git format-patch failed - $!\n";
1032 } elsif ($file) {
1033 open($FILE, '-|', "diff -u /dev/null $filename") ||
1034 die "$P: $filename: diff failed - $!\n";
1035 } elsif ($filename eq '-') {
1036 open($FILE, '<&STDIN');
1037 } else {
1038 open($FILE, '<', "$filename") ||
1039 die "$P: $filename: open failed - $!\n";
1040 }
1041 if ($filename eq '-') {
1042 $vname = 'Your patch';
1043 } elsif ($git) {
1044 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1045 } else {
1046 $vname = $filename;
1047 }
1048 while (<$FILE>) {
1049 chomp;
1050 push(@rawlines, $_);
1051 }
1052 close($FILE);
1053
1054 if ($#ARGV > 0 && $quiet == 0) {
1055 print '-' x length($vname) . "\n";
1056 print "$vname\n";
1057 print '-' x length($vname) . "\n";
1058 }
1059
1060 if (!process($filename)) {
1061 $exit = 1;
1062 }
1063 @rawlines = ();
1064 @lines = ();
1065 @fixed = ();
1066 @fixed_inserted = ();
1067 @fixed_deleted = ();
1068 $fixlinenr = -1;
1069 @modifierListFile = ();
1070 @typeListFile = ();
1071 build_types();
1072}
1073
1074if (!$quiet) {
1075 hash_show_words(\%use_type, "Used");
1076 hash_show_words(\%ignore_type, "Ignored");
1077
1078 if (!$perl_version_ok) {
1079 print << "EOM"
1080
1081NOTE: perl $^V is not modern enough to detect all possible issues.
1082 An upgrade to at least perl $minimum_perl_version is suggested.
1083EOM
1084 }
1085 if ($exit) {
1086 print << "EOM"
1087
1088NOTE: If any of the errors are false positives, please report
1089 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1090EOM
1091 }
1092}
1093
1094exit($exit);
1095
1096sub top_of_kernel_tree {
1097 my ($root) = @_;
1098
1099 my @tree_check = (
1100 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1101 "README", "Documentation", "arch", "include", "drivers",
1102 "fs", "init", "ipc", "kernel", "lib", "scripts",
1103 );
1104
1105 foreach my $check (@tree_check) {
1106 if (! -e $root . '/' . $check) {
1107 return 0;
1108 }
1109 }
1110 return 1;
1111}
1112
1113sub parse_email {
1114 my ($formatted_email) = @_;
1115
1116 my $name = "";
1117 my $address = "";
1118 my $comment = "";
1119
1120 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1121 $name = $1;
1122 $address = $2;
1123 $comment = $3 if defined $3;
1124 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1125 $address = $1;
1126 $comment = $2 if defined $2;
1127 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1128 $address = $1;
1129 $comment = $2 if defined $2;
1130 $formatted_email =~ s/\Q$address\E.*$//;
1131 $name = $formatted_email;
1132 $name = trim($name);
1133 $name =~ s/^\"|\"$//g;
1134 # If there's a name left after stripping spaces and
1135 # leading quotes, and the address doesn't have both
1136 # leading and trailing angle brackets, the address
1137 # is invalid. ie:
1138 # "joe smith joe@smith.com" bad
1139 # "joe smith <joe@smith.com" bad
1140 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1141 $name = "";
1142 $address = "";
1143 $comment = "";
1144 }
1145 }
1146
1147 $name = trim($name);
1148 $name =~ s/^\"|\"$//g;
1149 $address = trim($address);
1150 $address =~ s/^\<|\>$//g;
1151
1152 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1153 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1154 $name = "\"$name\"";
1155 }
1156
1157 return ($name, $address, $comment);
1158}
1159
1160sub format_email {
1161 my ($name, $address) = @_;
1162
1163 my $formatted_email;
1164
1165 $name = trim($name);
1166 $name =~ s/^\"|\"$//g;
1167 $address = trim($address);
1168
1169 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1170 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1171 $name = "\"$name\"";
1172 }
1173
1174 if ("$name" eq "") {
1175 $formatted_email = "$address";
1176 } else {
1177 $formatted_email = "$name <$address>";
1178 }
1179
1180 return $formatted_email;
1181}
1182
1183sub which {
1184 my ($bin) = @_;
1185
1186 foreach my $path (split(/:/, $ENV{PATH})) {
1187 if (-e "$path/$bin") {
1188 return "$path/$bin";
1189 }
1190 }
1191
1192 return "";
1193}
1194
1195sub which_conf {
1196 my ($conf) = @_;
1197
1198 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1199 if (-e "$path/$conf") {
1200 return "$path/$conf";
1201 }
1202 }
1203
1204 return "";
1205}
1206
1207sub expand_tabs {
1208 my ($str) = @_;
1209
1210 my $res = '';
1211 my $n = 0;
1212 for my $c (split(//, $str)) {
1213 if ($c eq "\t") {
1214 $res .= ' ';
1215 $n++;
1216 for (; ($n % 8) != 0; $n++) {
1217 $res .= ' ';
1218 }
1219 next;
1220 }
1221 $res .= $c;
1222 $n++;
1223 }
1224
1225 return $res;
1226}
1227sub copy_spacing {
1228 (my $res = shift) =~ tr/\t/ /c;
1229 return $res;
1230}
1231
1232sub line_stats {
1233 my ($line) = @_;
1234
1235 # Drop the diff line leader and expand tabs
1236 $line =~ s/^.//;
1237 $line = expand_tabs($line);
1238
1239 # Pick the indent from the front of the line.
1240 my ($white) = ($line =~ /^(\s*)/);
1241
1242 return (length($line), length($white));
1243}
1244
1245my $sanitise_quote = '';
1246
1247sub sanitise_line_reset {
1248 my ($in_comment) = @_;
1249
1250 if ($in_comment) {
1251 $sanitise_quote = '*/';
1252 } else {
1253 $sanitise_quote = '';
1254 }
1255}
1256sub sanitise_line {
1257 my ($line) = @_;
1258
1259 my $res = '';
1260 my $l = '';
1261
1262 my $qlen = 0;
1263 my $off = 0;
1264 my $c;
1265
1266 # Always copy over the diff marker.
1267 $res = substr($line, 0, 1);
1268
1269 for ($off = 1; $off < length($line); $off++) {
1270 $c = substr($line, $off, 1);
1271
1272 # Comments we are whacking completely including the begin
1273 # and end, all to $;.
1274 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1275 $sanitise_quote = '*/';
1276
1277 substr($res, $off, 2, "$;$;");
1278 $off++;
1279 next;
1280 }
1281 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1282 $sanitise_quote = '';
1283 substr($res, $off, 2, "$;$;");
1284 $off++;
1285 next;
1286 }
1287 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1288 $sanitise_quote = '//';
1289
1290 substr($res, $off, 2, $sanitise_quote);
1291 $off++;
1292 next;
1293 }
1294
1295 # A \ in a string means ignore the next character.
1296 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1297 $c eq "\\") {
1298 substr($res, $off, 2, 'XX');
1299 $off++;
1300 next;
1301 }
1302 # Regular quotes.
1303 if ($c eq "'" || $c eq '"') {
1304 if ($sanitise_quote eq '') {
1305 $sanitise_quote = $c;
1306
1307 substr($res, $off, 1, $c);
1308 next;
1309 } elsif ($sanitise_quote eq $c) {
1310 $sanitise_quote = '';
1311 }
1312 }
1313
1314 #print "c<$c> SQ<$sanitise_quote>\n";
1315 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1316 substr($res, $off, 1, $;);
1317 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1318 substr($res, $off, 1, $;);
1319 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1320 substr($res, $off, 1, 'X');
1321 } else {
1322 substr($res, $off, 1, $c);
1323 }
1324 }
1325
1326 if ($sanitise_quote eq '//') {
1327 $sanitise_quote = '';
1328 }
1329
1330 # The pathname on a #include may be surrounded by '<' and '>'.
1331 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1332 my $clean = 'X' x length($1);
1333 $res =~ s@\<.*\>@<$clean>@;
1334
1335 # The whole of a #error is a string.
1336 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1337 my $clean = 'X' x length($1);
1338 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1339 }
1340
1341 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1342 my $match = $1;
1343 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1344 }
1345
1346 return $res;
1347}
1348
1349sub get_quoted_string {
1350 my ($line, $rawline) = @_;
1351
1352 return "" if (!defined($line) || !defined($rawline));
1353 return "" if ($line !~ m/($String)/g);
1354 return substr($rawline, $-[0], $+[0] - $-[0]);
1355}
1356
1357sub ctx_statement_block {
1358 my ($linenr, $remain, $off) = @_;
1359 my $line = $linenr - 1;
1360 my $blk = '';
1361 my $soff = $off;
1362 my $coff = $off - 1;
1363 my $coff_set = 0;
1364
1365 my $loff = 0;
1366
1367 my $type = '';
1368 my $level = 0;
1369 my @stack = ();
1370 my $p;
1371 my $c;
1372 my $len = 0;
1373
1374 my $remainder;
1375 while (1) {
1376 @stack = (['', 0]) if ($#stack == -1);
1377
1378 #warn "CSB: blk<$blk> remain<$remain>\n";
1379 # If we are about to drop off the end, pull in more
1380 # context.
1381 if ($off >= $len) {
1382 for (; $remain > 0; $line++) {
1383 last if (!defined $lines[$line]);
1384 next if ($lines[$line] =~ /^-/);
1385 $remain--;
1386 $loff = $len;
1387 $blk .= $lines[$line] . "\n";
1388 $len = length($blk);
1389 $line++;
1390 last;
1391 }
1392 # Bail if there is no further context.
1393 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1394 if ($off >= $len) {
1395 last;
1396 }
1397 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1398 $level++;
1399 $type = '#';
1400 }
1401 }
1402 $p = $c;
1403 $c = substr($blk, $off, 1);
1404 $remainder = substr($blk, $off);
1405
1406 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1407
1408 # Handle nested #if/#else.
1409 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1410 push(@stack, [ $type, $level ]);
1411 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1412 ($type, $level) = @{$stack[$#stack - 1]};
1413 } elsif ($remainder =~ /^#\s*endif\b/) {
1414 ($type, $level) = @{pop(@stack)};
1415 }
1416
1417 # Statement ends at the ';' or a close '}' at the
1418 # outermost level.
1419 if ($level == 0 && $c eq ';') {
1420 last;
1421 }
1422
1423 # An else is really a conditional as long as its not else if
1424 if ($level == 0 && $coff_set == 0 &&
1425 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1426 $remainder =~ /^(else)(?:\s|{)/ &&
1427 $remainder !~ /^else\s+if\b/) {
1428 $coff = $off + length($1) - 1;
1429 $coff_set = 1;
1430 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1431 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1432 }
1433
1434 if (($type eq '' || $type eq '(') && $c eq '(') {
1435 $level++;
1436 $type = '(';
1437 }
1438 if ($type eq '(' && $c eq ')') {
1439 $level--;
1440 $type = ($level != 0)? '(' : '';
1441
1442 if ($level == 0 && $coff < $soff) {
1443 $coff = $off;
1444 $coff_set = 1;
1445 #warn "CSB: mark coff<$coff>\n";
1446 }
1447 }
1448 if (($type eq '' || $type eq '{') && $c eq '{') {
1449 $level++;
1450 $type = '{';
1451 }
1452 if ($type eq '{' && $c eq '}') {
1453 $level--;
1454 $type = ($level != 0)? '{' : '';
1455
1456 if ($level == 0) {
1457 if (substr($blk, $off + 1, 1) eq ';') {
1458 $off++;
1459 }
1460 last;
1461 }
1462 }
1463 # Preprocessor commands end at the newline unless escaped.
1464 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1465 $level--;
1466 $type = '';
1467 $off++;
1468 last;
1469 }
1470 $off++;
1471 }
1472 # We are truly at the end, so shuffle to the next line.
1473 if ($off == $len) {
1474 $loff = $len + 1;
1475 $line++;
1476 $remain--;
1477 }
1478
1479 my $statement = substr($blk, $soff, $off - $soff + 1);
1480 my $condition = substr($blk, $soff, $coff - $soff + 1);
1481
1482 #warn "STATEMENT<$statement>\n";
1483 #warn "CONDITION<$condition>\n";
1484
1485 #print "coff<$coff> soff<$off> loff<$loff>\n";
1486
1487 return ($statement, $condition,
1488 $line, $remain + 1, $off - $loff + 1, $level);
1489}
1490
1491sub statement_lines {
1492 my ($stmt) = @_;
1493
1494 # Strip the diff line prefixes and rip blank lines at start and end.
1495 $stmt =~ s/(^|\n)./$1/g;
1496 $stmt =~ s/^\s*//;
1497 $stmt =~ s/\s*$//;
1498
1499 my @stmt_lines = ($stmt =~ /\n/g);
1500
1501 return $#stmt_lines + 2;
1502}
1503
1504sub statement_rawlines {
1505 my ($stmt) = @_;
1506
1507 my @stmt_lines = ($stmt =~ /\n/g);
1508
1509 return $#stmt_lines + 2;
1510}
1511
1512sub statement_block_size {
1513 my ($stmt) = @_;
1514
1515 $stmt =~ s/(^|\n)./$1/g;
1516 $stmt =~ s/^\s*{//;
1517 $stmt =~ s/}\s*$//;
1518 $stmt =~ s/^\s*//;
1519 $stmt =~ s/\s*$//;
1520
1521 my @stmt_lines = ($stmt =~ /\n/g);
1522 my @stmt_statements = ($stmt =~ /;/g);
1523
1524 my $stmt_lines = $#stmt_lines + 2;
1525 my $stmt_statements = $#stmt_statements + 1;
1526
1527 if ($stmt_lines > $stmt_statements) {
1528 return $stmt_lines;
1529 } else {
1530 return $stmt_statements;
1531 }
1532}
1533
1534sub ctx_statement_full {
1535 my ($linenr, $remain, $off) = @_;
1536 my ($statement, $condition, $level);
1537
1538 my (@chunks);
1539
1540 # Grab the first conditional/block pair.
1541 ($statement, $condition, $linenr, $remain, $off, $level) =
1542 ctx_statement_block($linenr, $remain, $off);
1543 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1544 push(@chunks, [ $condition, $statement ]);
1545 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1546 return ($level, $linenr, @chunks);
1547 }
1548
1549 # Pull in the following conditional/block pairs and see if they
1550 # could continue the statement.
1551 for (;;) {
1552 ($statement, $condition, $linenr, $remain, $off, $level) =
1553 ctx_statement_block($linenr, $remain, $off);
1554 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1555 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1556 #print "C: push\n";
1557 push(@chunks, [ $condition, $statement ]);
1558 }
1559
1560 return ($level, $linenr, @chunks);
1561}
1562
1563sub ctx_block_get {
1564 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1565 my $line;
1566 my $start = $linenr - 1;
1567 my $blk = '';
1568 my @o;
1569 my @c;
1570 my @res = ();
1571
1572 my $level = 0;
1573 my @stack = ($level);
1574 for ($line = $start; $remain > 0; $line++) {
1575 next if ($rawlines[$line] =~ /^-/);
1576 $remain--;
1577
1578 $blk .= $rawlines[$line];
1579
1580 # Handle nested #if/#else.
1581 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1582 push(@stack, $level);
1583 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1584 $level = $stack[$#stack - 1];
1585 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1586 $level = pop(@stack);
1587 }
1588
1589 foreach my $c (split(//, $lines[$line])) {
1590 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1591 if ($off > 0) {
1592 $off--;
1593 next;
1594 }
1595
1596 if ($c eq $close && $level > 0) {
1597 $level--;
1598 last if ($level == 0);
1599 } elsif ($c eq $open) {
1600 $level++;
1601 }
1602 }
1603
1604 if (!$outer || $level <= 1) {
1605 push(@res, $rawlines[$line]);
1606 }
1607
1608 last if ($level == 0);
1609 }
1610
1611 return ($level, @res);
1612}
1613sub ctx_block_outer {
1614 my ($linenr, $remain) = @_;
1615
1616 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1617 return @r;
1618}
1619sub ctx_block {
1620 my ($linenr, $remain) = @_;
1621
1622 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1623 return @r;
1624}
1625sub ctx_statement {
1626 my ($linenr, $remain, $off) = @_;
1627
1628 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1629 return @r;
1630}
1631sub ctx_block_level {
1632 my ($linenr, $remain) = @_;
1633
1634 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1635}
1636sub ctx_statement_level {
1637 my ($linenr, $remain, $off) = @_;
1638
1639 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1640}
1641
1642sub ctx_locate_comment {
1643 my ($first_line, $end_line) = @_;
1644
1645 # Catch a comment on the end of the line itself.
1646 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1647 return $current_comment if (defined $current_comment);
1648
1649 # Look through the context and try and figure out if there is a
1650 # comment.
1651 my $in_comment = 0;
1652 $current_comment = '';
1653 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1654 my $line = $rawlines[$linenr - 1];
1655 #warn " $line\n";
1656 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1657 $in_comment = 1;
1658 }
1659 if ($line =~ m@/\*@) {
1660 $in_comment = 1;
1661 }
1662 if (!$in_comment && $current_comment ne '') {
1663 $current_comment = '';
1664 }
1665 $current_comment .= $line . "\n" if ($in_comment);
1666 if ($line =~ m@\*/@) {
1667 $in_comment = 0;
1668 }
1669 }
1670
1671 chomp($current_comment);
1672 return($current_comment);
1673}
1674sub ctx_has_comment {
1675 my ($first_line, $end_line) = @_;
1676 my $cmt = ctx_locate_comment($first_line, $end_line);
1677
1678 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1679 ##print "CMMT: $cmt\n";
1680
1681 return ($cmt ne '');
1682}
1683
1684sub raw_line {
1685 my ($linenr, $cnt) = @_;
1686
1687 my $offset = $linenr - 1;
1688 $cnt++;
1689
1690 my $line;
1691 while ($cnt) {
1692 $line = $rawlines[$offset++];
1693 next if (defined($line) && $line =~ /^-/);
1694 $cnt--;
1695 }
1696
1697 return $line;
1698}
1699
1700sub get_stat_real {
1701 my ($linenr, $lc) = @_;
1702
1703 my $stat_real = raw_line($linenr, 0);
1704 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1705 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1706 }
1707
1708 return $stat_real;
1709}
1710
1711sub get_stat_here {
1712 my ($linenr, $cnt, $here) = @_;
1713
1714 my $herectx = $here . "\n";
1715 for (my $n = 0; $n < $cnt; $n++) {
1716 $herectx .= raw_line($linenr, $n) . "\n";
1717 }
1718
1719 return $herectx;
1720}
1721
1722sub cat_vet {
1723 my ($vet) = @_;
1724 my ($res, $coded);
1725
1726 $res = '';
1727 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1728 $res .= $1;
1729 if ($2 ne '') {
1730 $coded = sprintf("^%c", unpack('C', $2) + 64);
1731 $res .= $coded;
1732 }
1733 }
1734 $res =~ s/$/\$/;
1735
1736 return $res;
1737}
1738
1739my $av_preprocessor = 0;
1740my $av_pending;
1741my @av_paren_type;
1742my $av_pend_colon;
1743
1744sub annotate_reset {
1745 $av_preprocessor = 0;
1746 $av_pending = '_';
1747 @av_paren_type = ('E');
1748 $av_pend_colon = 'O';
1749}
1750
1751sub annotate_values {
1752 my ($stream, $type) = @_;
1753
1754 my $res;
1755 my $var = '_' x length($stream);
1756 my $cur = $stream;
1757
1758 print "$stream\n" if ($dbg_values > 1);
1759
1760 while (length($cur)) {
1761 @av_paren_type = ('E') if ($#av_paren_type < 0);
1762 print " <" . join('', @av_paren_type) .
1763 "> <$type> <$av_pending>" if ($dbg_values > 1);
1764 if ($cur =~ /^(\s+)/o) {
1765 print "WS($1)\n" if ($dbg_values > 1);
1766 if ($1 =~ /\n/ && $av_preprocessor) {
1767 $type = pop(@av_paren_type);
1768 $av_preprocessor = 0;
1769 }
1770
1771 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1772 print "CAST($1)\n" if ($dbg_values > 1);
1773 push(@av_paren_type, $type);
1774 $type = 'c';
1775
1776 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1777 print "DECLARE($1)\n" if ($dbg_values > 1);
1778 $type = 'T';
1779
1780 } elsif ($cur =~ /^($Modifier)\s*/) {
1781 print "MODIFIER($1)\n" if ($dbg_values > 1);
1782 $type = 'T';
1783
1784 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1785 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1786 $av_preprocessor = 1;
1787 push(@av_paren_type, $type);
1788 if ($2 ne '') {
1789 $av_pending = 'N';
1790 }
1791 $type = 'E';
1792
1793 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1794 print "UNDEF($1)\n" if ($dbg_values > 1);
1795 $av_preprocessor = 1;
1796 push(@av_paren_type, $type);
1797
1798 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1799 print "PRE_START($1)\n" if ($dbg_values > 1);
1800 $av_preprocessor = 1;
1801
1802 push(@av_paren_type, $type);
1803 push(@av_paren_type, $type);
1804 $type = 'E';
1805
1806 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1807 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1808 $av_preprocessor = 1;
1809
1810 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1811
1812 $type = 'E';
1813
1814 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1815 print "PRE_END($1)\n" if ($dbg_values > 1);
1816
1817 $av_preprocessor = 1;
1818
1819 # Assume all arms of the conditional end as this
1820 # one does, and continue as if the #endif was not here.
1821 pop(@av_paren_type);
1822 push(@av_paren_type, $type);
1823 $type = 'E';
1824
1825 } elsif ($cur =~ /^(\\\n)/o) {
1826 print "PRECONT($1)\n" if ($dbg_values > 1);
1827
1828 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1829 print "ATTR($1)\n" if ($dbg_values > 1);
1830 $av_pending = $type;
1831 $type = 'N';
1832
1833 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1834 print "SIZEOF($1)\n" if ($dbg_values > 1);
1835 if (defined $2) {
1836 $av_pending = 'V';
1837 }
1838 $type = 'N';
1839
1840 } elsif ($cur =~ /^(if|while|for)\b/o) {
1841 print "COND($1)\n" if ($dbg_values > 1);
1842 $av_pending = 'E';
1843 $type = 'N';
1844
1845 } elsif ($cur =~/^(case)/o) {
1846 print "CASE($1)\n" if ($dbg_values > 1);
1847 $av_pend_colon = 'C';
1848 $type = 'N';
1849
1850 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1851 print "KEYWORD($1)\n" if ($dbg_values > 1);
1852 $type = 'N';
1853
1854 } elsif ($cur =~ /^(\()/o) {
1855 print "PAREN('$1')\n" if ($dbg_values > 1);
1856 push(@av_paren_type, $av_pending);
1857 $av_pending = '_';
1858 $type = 'N';
1859
1860 } elsif ($cur =~ /^(\))/o) {
1861 my $new_type = pop(@av_paren_type);
1862 if ($new_type ne '_') {
1863 $type = $new_type;
1864 print "PAREN('$1') -> $type\n"
1865 if ($dbg_values > 1);
1866 } else {
1867 print "PAREN('$1')\n" if ($dbg_values > 1);
1868 }
1869
1870 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1871 print "FUNC($1)\n" if ($dbg_values > 1);
1872 $type = 'V';
1873 $av_pending = 'V';
1874
1875 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1876 if (defined $2 && $type eq 'C' || $type eq 'T') {
1877 $av_pend_colon = 'B';
1878 } elsif ($type eq 'E') {
1879 $av_pend_colon = 'L';
1880 }
1881 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1882 $type = 'V';
1883
1884 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1885 print "IDENT($1)\n" if ($dbg_values > 1);
1886 $type = 'V';
1887
1888 } elsif ($cur =~ /^($Assignment)/o) {
1889 print "ASSIGN($1)\n" if ($dbg_values > 1);
1890 $type = 'N';
1891
1892 } elsif ($cur =~/^(;|{|})/) {
1893 print "END($1)\n" if ($dbg_values > 1);
1894 $type = 'E';
1895 $av_pend_colon = 'O';
1896
1897 } elsif ($cur =~/^(,)/) {
1898 print "COMMA($1)\n" if ($dbg_values > 1);
1899 $type = 'C';
1900
1901 } elsif ($cur =~ /^(\?)/o) {
1902 print "QUESTION($1)\n" if ($dbg_values > 1);
1903 $type = 'N';
1904
1905 } elsif ($cur =~ /^(:)/o) {
1906 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1907
1908 substr($var, length($res), 1, $av_pend_colon);
1909 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1910 $type = 'E';
1911 } else {
1912 $type = 'N';
1913 }
1914 $av_pend_colon = 'O';
1915
1916 } elsif ($cur =~ /^(\[)/o) {
1917 print "CLOSE($1)\n" if ($dbg_values > 1);
1918 $type = 'N';
1919
1920 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1921 my $variant;
1922
1923 print "OPV($1)\n" if ($dbg_values > 1);
1924 if ($type eq 'V') {
1925 $variant = 'B';
1926 } else {
1927 $variant = 'U';
1928 }
1929
1930 substr($var, length($res), 1, $variant);
1931 $type = 'N';
1932
1933 } elsif ($cur =~ /^($Operators)/o) {
1934 print "OP($1)\n" if ($dbg_values > 1);
1935 if ($1 ne '++' && $1 ne '--') {
1936 $type = 'N';
1937 }
1938
1939 } elsif ($cur =~ /(^.)/o) {
1940 print "C($1)\n" if ($dbg_values > 1);
1941 }
1942 if (defined $1) {
1943 $cur = substr($cur, length($1));
1944 $res .= $type x length($1);
1945 }
1946 }
1947
1948 return ($res, $var);
1949}
1950
1951sub possible {
1952 my ($possible, $line) = @_;
1953 my $notPermitted = qr{(?:
1954 ^(?:
1955 $Modifier|
1956 $Storage|
1957 $Type|
1958 DEFINE_\S+
1959 )$|
1960 ^(?:
1961 goto|
1962 return|
1963 case|
1964 else|
1965 asm|__asm__|
1966 do|
1967 \#|
1968 \#\#|
1969 )(?:\s|$)|
1970 ^(?:typedef|struct|enum)\b
1971 )}x;
1972 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1973 if ($possible !~ $notPermitted) {
1974 # Check for modifiers.
1975 $possible =~ s/\s*$Storage\s*//g;
1976 $possible =~ s/\s*$Sparse\s*//g;
1977 if ($possible =~ /^\s*$/) {
1978
1979 } elsif ($possible =~ /\s/) {
1980 $possible =~ s/\s*$Type\s*//g;
1981 for my $modifier (split(' ', $possible)) {
1982 if ($modifier !~ $notPermitted) {
1983 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1984 push(@modifierListFile, $modifier);
1985 }
1986 }
1987
1988 } else {
1989 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1990 push(@typeListFile, $possible);
1991 }
1992 build_types();
1993 } else {
1994 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1995 }
1996}
1997
1998my $prefix = '';
1999
2000sub show_type {
2001 my ($type) = @_;
2002
2003 $type =~ tr/[a-z]/[A-Z]/;
2004
2005 return defined $use_type{$type} if (scalar keys %use_type > 0);
2006
2007 return !defined $ignore_type{$type};
2008}
2009
2010sub report {
2011 my ($level, $type, $msg) = @_;
2012
2013 if (!show_type($type) ||
2014 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2015 return 0;
2016 }
2017 my $output = '';
2018 if ($color) {
2019 if ($level eq 'ERROR') {
2020 $output .= RED;
2021 } elsif ($level eq 'WARNING') {
2022 $output .= YELLOW;
2023 } else {
2024 $output .= GREEN;
2025 }
2026 }
2027 $output .= $prefix . $level . ':';
2028 if ($show_types) {
2029 $output .= BLUE if ($color);
2030 $output .= "$type:";
2031 }
2032 $output .= RESET if ($color);
2033 $output .= ' ' . $msg . "\n";
2034
2035 if ($showfile) {
2036 my @lines = split("\n", $output, -1);
2037 splice(@lines, 1, 1);
2038 $output = join("\n", @lines);
2039 }
2040 $output = (split('\n', $output))[0] . "\n" if ($terse);
2041
2042 push(our @report, $output);
2043
2044 return 1;
2045}
2046
2047sub report_dump {
2048 our @report;
2049}
2050
2051sub fixup_current_range {
2052 my ($lineRef, $offset, $length) = @_;
2053
2054 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2055 my $o = $1;
2056 my $l = $2;
2057 my $no = $o + $offset;
2058 my $nl = $l + $length;
2059 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2060 }
2061}
2062
2063sub fix_inserted_deleted_lines {
2064 my ($linesRef, $insertedRef, $deletedRef) = @_;
2065
2066 my $range_last_linenr = 0;
2067 my $delta_offset = 0;
2068
2069 my $old_linenr = 0;
2070 my $new_linenr = 0;
2071
2072 my $next_insert = 0;
2073 my $next_delete = 0;
2074
2075 my @lines = ();
2076
2077 my $inserted = @{$insertedRef}[$next_insert++];
2078 my $deleted = @{$deletedRef}[$next_delete++];
2079
2080 foreach my $old_line (@{$linesRef}) {
2081 my $save_line = 1;
2082 my $line = $old_line; #don't modify the array
2083 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2084 $delta_offset = 0;
2085 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2086 $range_last_linenr = $new_linenr;
2087 fixup_current_range(\$line, $delta_offset, 0);
2088 }
2089
2090 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2091 $deleted = @{$deletedRef}[$next_delete++];
2092 $save_line = 0;
2093 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2094 }
2095
2096 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2097 push(@lines, ${$inserted}{'LINE'});
2098 $inserted = @{$insertedRef}[$next_insert++];
2099 $new_linenr++;
2100 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2101 }
2102
2103 if ($save_line) {
2104 push(@lines, $line);
2105 $new_linenr++;
2106 }
2107
2108 $old_linenr++;
2109 }
2110
2111 return @lines;
2112}
2113
2114sub fix_insert_line {
2115 my ($linenr, $line) = @_;
2116
2117 my $inserted = {
2118 LINENR => $linenr,
2119 LINE => $line,
2120 };
2121 push(@fixed_inserted, $inserted);
2122}
2123
2124sub fix_delete_line {
2125 my ($linenr, $line) = @_;
2126
2127 my $deleted = {
2128 LINENR => $linenr,
2129 LINE => $line,
2130 };
2131
2132 push(@fixed_deleted, $deleted);
2133}
2134
2135sub ERROR {
2136 my ($type, $msg) = @_;
2137
2138 if (report("ERROR", $type, $msg)) {
2139 our $clean = 0;
2140 our $cnt_error++;
2141 return 1;
2142 }
2143 return 0;
2144}
2145sub WARN {
2146 my ($type, $msg) = @_;
2147
2148 if (report("WARNING", $type, $msg)) {
2149 our $clean = 0;
2150 our $cnt_warn++;
2151 return 1;
2152 }
2153 return 0;
2154}
2155sub CHK {
2156 my ($type, $msg) = @_;
2157
2158 if ($check && report("CHECK", $type, $msg)) {
2159 our $clean = 0;
2160 our $cnt_chk++;
2161 return 1;
2162 }
2163 return 0;
2164}
2165
2166sub check_absolute_file {
2167 my ($absolute, $herecurr) = @_;
2168 my $file = $absolute;
2169
2170 ##print "absolute<$absolute>\n";
2171
2172 # See if any suffix of this path is a path within the tree.
2173 while ($file =~ s@^[^/]*/@@) {
2174 if (-f "$root/$file") {
2175 ##print "file<$file>\n";
2176 last;
2177 }
2178 }
2179 if (! -f _) {
2180 return 0;
2181 }
2182
2183 # It is, so see if the prefix is acceptable.
2184 my $prefix = $absolute;
2185 substr($prefix, -length($file)) = '';
2186
2187 ##print "prefix<$prefix>\n";
2188 if ($prefix ne ".../") {
2189 WARN("USE_RELATIVE_PATH",
2190 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2191 }
2192}
2193
2194sub trim {
2195 my ($string) = @_;
2196
2197 $string =~ s/^\s+|\s+$//g;
2198
2199 return $string;
2200}
2201
2202sub ltrim {
2203 my ($string) = @_;
2204
2205 $string =~ s/^\s+//;
2206
2207 return $string;
2208}
2209
2210sub rtrim {
2211 my ($string) = @_;
2212
2213 $string =~ s/\s+$//;
2214
2215 return $string;
2216}
2217
2218sub string_find_replace {
2219 my ($string, $find, $replace) = @_;
2220
2221 $string =~ s/$find/$replace/g;
2222
2223 return $string;
2224}
2225
2226sub tabify {
2227 my ($leading) = @_;
2228
2229 my $source_indent = 8;
2230 my $max_spaces_before_tab = $source_indent - 1;
2231 my $spaces_to_tab = " " x $source_indent;
2232
2233 #convert leading spaces to tabs
2234 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2235 #Remove spaces before a tab
2236 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2237
2238 return "$leading";
2239}
2240
2241sub pos_last_openparen {
2242 my ($line) = @_;
2243
2244 my $pos = 0;
2245
2246 my $opens = $line =~ tr/\(/\(/;
2247 my $closes = $line =~ tr/\)/\)/;
2248
2249 my $last_openparen = 0;
2250
2251 if (($opens == 0) || ($closes >= $opens)) {
2252 return -1;
2253 }
2254
2255 my $len = length($line);
2256
2257 for ($pos = 0; $pos < $len; $pos++) {
2258 my $string = substr($line, $pos);
2259 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2260 $pos += length($1) - 1;
2261 } elsif (substr($line, $pos, 1) eq '(') {
2262 $last_openparen = $pos;
2263 } elsif (index($string, '(') == -1) {
2264 last;
2265 }
2266 }
2267
2268 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2269}
2270
2271sub process {
2272 my $filename = shift;
2273
2274 my $linenr=0;
2275 my $prevline="";
2276 my $prevrawline="";
2277 my $stashline="";
2278 my $stashrawline="";
2279
2280 my $length;
2281 my $indent;
2282 my $previndent=0;
2283 my $stashindent=0;
2284
2285 our $clean = 1;
2286 my $signoff = 0;
2287 my $author = '';
2288 my $authorsignoff = 0;
2289 my $is_patch = 0;
2290 my $is_binding_patch = -1;
2291 my $in_header_lines = $file ? 0 : 1;
2292 my $in_commit_log = 0; #Scanning lines before patch
2293 my $has_commit_log = 0; #Encountered lines before patch
2294 my $commit_log_lines = 0; #Number of commit log lines
2295 my $commit_log_possible_stack_dump = 0;
2296 my $commit_log_long_line = 0;
2297 my $commit_log_has_diff = 0;
2298 my $reported_maintainer_file = 0;
2299 my $non_utf8_charset = 0;
2300
2301 my $last_blank_line = 0;
2302 my $last_coalesced_string_linenr = -1;
2303
2304 our @report = ();
2305 our $cnt_lines = 0;
2306 our $cnt_error = 0;
2307 our $cnt_warn = 0;
2308 our $cnt_chk = 0;
2309
2310 # Trace the real file/line as we go.
2311 my $realfile = '';
2312 my $realline = 0;
2313 my $realcnt = 0;
2314 my $here = '';
2315 my $context_function; #undef'd unless there's a known function
2316 my $in_comment = 0;
2317 my $comment_edge = 0;
2318 my $first_line = 0;
2319 my $p1_prefix = '';
2320
2321 my $prev_values = 'E';
2322
2323 # suppression flags
2324 my %suppress_ifbraces;
2325 my %suppress_whiletrailers;
2326 my %suppress_export;
2327 my $suppress_statement = 0;
2328
2329 my %signatures = ();
2330
2331 # Pre-scan the patch sanitizing the lines.
2332 # Pre-scan the patch looking for any __setup documentation.
2333 #
2334 my @setup_docs = ();
2335 my $setup_docs = 0;
2336
2337 my $camelcase_file_seeded = 0;
2338
2339 my $checklicenseline = 1;
2340
2341 sanitise_line_reset();
2342 my $line;
2343 foreach my $rawline (@rawlines) {
2344 $linenr++;
2345 $line = $rawline;
2346
2347 push(@fixed, $rawline) if ($fix);
2348
2349 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2350 $setup_docs = 0;
2351 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
2352 $setup_docs = 1;
2353 }
2354 #next;
2355 }
2356 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2357 $realline=$1-1;
2358 if (defined $2) {
2359 $realcnt=$3+1;
2360 } else {
2361 $realcnt=1+1;
2362 }
2363 $in_comment = 0;
2364
2365 # Guestimate if this is a continuing comment. Run
2366 # the context looking for a comment "edge". If this
2367 # edge is a close comment then we must be in a comment
2368 # at context start.
2369 my $edge;
2370 my $cnt = $realcnt;
2371 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2372 next if (defined $rawlines[$ln - 1] &&
2373 $rawlines[$ln - 1] =~ /^-/);
2374 $cnt--;
2375 #print "RAW<$rawlines[$ln - 1]>\n";
2376 last if (!defined $rawlines[$ln - 1]);
2377 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2378 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2379 ($edge) = $1;
2380 last;
2381 }
2382 }
2383 if (defined $edge && $edge eq '*/') {
2384 $in_comment = 1;
2385 }
2386
2387 # Guestimate if this is a continuing comment. If this
2388 # is the start of a diff block and this line starts
2389 # ' *' then it is very likely a comment.
2390 if (!defined $edge &&
2391 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2392 {
2393 $in_comment = 1;
2394 }
2395
2396 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2397 sanitise_line_reset($in_comment);
2398
2399 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2400 # Standardise the strings and chars within the input to
2401 # simplify matching -- only bother with positive lines.
2402 $line = sanitise_line($rawline);
2403 }
2404 push(@lines, $line);
2405
2406 if ($realcnt > 1) {
2407 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2408 } else {
2409 $realcnt = 0;
2410 }
2411
2412 #print "==>$rawline\n";
2413 #print "-->$line\n";
2414
2415 if ($setup_docs && $line =~ /^\+/) {
2416 push(@setup_docs, $line);
2417 }
2418 }
2419
2420 $prefix = '';
2421
2422 $realcnt = 0;
2423 $linenr = 0;
2424 $fixlinenr = -1;
2425 foreach my $line (@lines) {
2426 $linenr++;
2427 $fixlinenr++;
2428 my $sline = $line; #copy of $line
2429 $sline =~ s/$;/ /g; #with comments as spaces
2430
2431 my $rawline = $rawlines[$linenr - 1];
2432
2433# check if it's a mode change, rename or start of a patch
2434 if (!$in_commit_log &&
2435 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2436 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2437 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2438 $is_patch = 1;
2439 }
2440
2441#extract the line range in the file after the patch is applied
2442 if (!$in_commit_log &&
2443 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2444 my $context = $4;
2445 $is_patch = 1;
2446 $first_line = $linenr + 1;
2447 $realline=$1-1;
2448 if (defined $2) {
2449 $realcnt=$3+1;
2450 } else {
2451 $realcnt=1+1;
2452 }
2453 annotate_reset();
2454 $prev_values = 'E';
2455
2456 %suppress_ifbraces = ();
2457 %suppress_whiletrailers = ();
2458 %suppress_export = ();
2459 $suppress_statement = 0;
2460 if ($context =~ /\b(\w+)\s*\(/) {
2461 $context_function = $1;
2462 } else {
2463 undef $context_function;
2464 }
2465 next;
2466
2467# track the line number as we move through the hunk, note that
2468# new versions of GNU diff omit the leading space on completely
2469# blank context lines so we need to count that too.
2470 } elsif ($line =~ /^( |\+|$)/) {
2471 $realline++;
2472 $realcnt-- if ($realcnt != 0);
2473
2474 # Measure the line length and indent.
2475 ($length, $indent) = line_stats($rawline);
2476
2477 # Track the previous line.
2478 ($prevline, $stashline) = ($stashline, $line);
2479 ($previndent, $stashindent) = ($stashindent, $indent);
2480 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2481
2482 #warn "line<$line>\n";
2483
2484 } elsif ($realcnt == 1) {
2485 $realcnt--;
2486 }
2487
2488 my $hunk_line = ($realcnt != 0);
2489
2490 $here = "#$linenr: " if (!$file);
2491 $here = "#$realline: " if ($file);
2492
2493 my $found_file = 0;
2494 # extract the filename as it passes
2495 if ($line =~ /^diff --git.*?(\S+)$/) {
2496 $realfile = $1;
2497 $realfile =~ s@^([^/]*)/@@ if (!$file);
2498 $in_commit_log = 0;
2499 $found_file = 1;
2500 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2501 $realfile = $1;
2502 $realfile =~ s@^([^/]*)/@@ if (!$file);
2503 $in_commit_log = 0;
2504
2505 $p1_prefix = $1;
2506 if (!$file && $tree && $p1_prefix ne '' &&
2507 -e "$root/$p1_prefix") {
2508 WARN("PATCH_PREFIX",
2509 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2510 }
2511
2512 if ($realfile =~ m@^include/asm/@) {
2513 ERROR("MODIFIED_INCLUDE_ASM",
2514 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2515 }
2516 $found_file = 1;
2517 }
2518
2519#make up the handle for any error we report on this line
2520 if ($showfile) {
2521 $prefix = "$realfile:$realline: "
2522 } elsif ($emacs) {
2523 if ($file) {
2524 $prefix = "$filename:$realline: ";
2525 } else {
2526 $prefix = "$filename:$linenr: ";
2527 }
2528 }
2529
2530 if ($found_file) {
2531 if (is_maintained_obsolete($realfile)) {
2532 WARN("OBSOLETE",
2533 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2534 }
2535 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2536 $check = 1;
2537 } else {
2538 $check = $check_orig;
2539 }
2540 $checklicenseline = 1;
2541
2542 if ($realfile !~ /^MAINTAINERS/) {
2543 my $last_binding_patch = $is_binding_patch;
2544
2545 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2546
2547 if (($last_binding_patch != -1) &&
2548 ($last_binding_patch ^ $is_binding_patch)) {
2549 WARN("DT_SPLIT_BINDING_PATCH",
2550 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2551 }
2552 }
2553
2554 next;
2555 }
2556
2557 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2558
2559 my $hereline = "$here\n$rawline\n";
2560 my $herecurr = "$here\n$rawline\n";
2561 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2562
2563 $cnt_lines++ if ($realcnt != 0);
2564
2565# Verify the existence of a commit log if appropriate
2566# 2 is used because a $signature is counted in $commit_log_lines
2567 if ($in_commit_log) {
2568 if ($line !~ /^\s*$/) {
2569 $commit_log_lines++; #could be a $signature
2570 }
2571 } elsif ($has_commit_log && $commit_log_lines < 2) {
2572 WARN("COMMIT_MESSAGE",
2573 "Missing commit description - Add an appropriate one\n");
2574 $commit_log_lines = 2; #warn only once
2575 }
2576
2577# Check if the commit log has what seems like a diff which can confuse patch
2578 if ($in_commit_log && !$commit_log_has_diff &&
2579 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2580 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2581 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2582 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2583 ERROR("DIFF_IN_COMMIT_MSG",
2584 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2585 $commit_log_has_diff = 1;
2586 }
2587
2588# Check for incorrect file permissions
2589 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2590 my $permhere = $here . "FILE: $realfile\n";
2591 if ($realfile !~ m@scripts/@ &&
2592 $realfile !~ /\.(py|pl|awk|sh)$/) {
2593 ERROR("EXECUTE_PERMISSIONS",
2594 "do not set execute permissions for source files\n" . $permhere);
2595 }
2596 }
2597
2598# Check the patch for a From:
2599 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2600 $author = $1;
2601 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2602 $author =~ s/"//g;
2603 }
2604
2605# Check the patch for a signoff:
2606 if ($line =~ /^\s*signed-off-by:/i) {
2607 $signoff++;
2608 $in_commit_log = 0;
2609 if ($author ne '') {
2610 my $l = $line;
2611 $l =~ s/"//g;
2612 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2613 $authorsignoff = 1;
2614 }
2615 }
2616 }
2617
2618# Check if MAINTAINERS is being updated. If so, there's probably no need to
2619# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2620 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2621 $reported_maintainer_file = 1;
2622 }
2623
2624# Check signature styles
2625 if (!$in_header_lines &&
2626 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
2627 my $space_before = $1;
2628 my $sign_off = $2;
2629 my $space_after = $3;
2630 my $email = $4;
2631 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2632
2633 if ($sign_off !~ /$signature_tags/) {
2634 WARN("BAD_SIGN_OFF",
2635 "Non-standard signature: $sign_off\n" . $herecurr);
2636 }
2637 if (defined $space_before && $space_before ne "") {
2638 if (WARN("BAD_SIGN_OFF",
2639 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2640 $fix) {
2641 $fixed[$fixlinenr] =
2642 "$ucfirst_sign_off $email";
2643 }
2644 }
2645 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
2646 if (WARN("BAD_SIGN_OFF",
2647 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2648 $fix) {
2649 $fixed[$fixlinenr] =
2650 "$ucfirst_sign_off $email";
2651 }
2652
2653 }
2654 if (!defined $space_after || $space_after ne " ") {
2655 if (WARN("BAD_SIGN_OFF",
2656 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2657 $fix) {
2658 $fixed[$fixlinenr] =
2659 "$ucfirst_sign_off $email";
2660 }
2661 }
2662
2663 my ($email_name, $email_address, $comment) = parse_email($email);
2664 my $suggested_email = format_email(($email_name, $email_address));
2665 if ($suggested_email eq "") {
2666 ERROR("BAD_SIGN_OFF",
2667 "Unrecognized email address: '$email'\n" . $herecurr);
2668 } else {
2669 my $dequoted = $suggested_email;
2670 $dequoted =~ s/^"//;
2671 $dequoted =~ s/" </ </;
2672 # Don't force email to have quotes
2673 # Allow just an angle bracketed address
2674 if ("$dequoted$comment" ne $email &&
2675 "<$email_address>$comment" ne $email &&
2676 "$suggested_email$comment" ne $email) {
2677 WARN("BAD_SIGN_OFF",
2678 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
2679 }
2680 }
2681
2682# Check for duplicate signatures
2683 my $sig_nospace = $line;
2684 $sig_nospace =~ s/\s//g;
2685 $sig_nospace = lc($sig_nospace);
2686 if (defined $signatures{$sig_nospace}) {
2687 WARN("BAD_SIGN_OFF",
2688 "Duplicate signature\n" . $herecurr);
2689 } else {
2690 $signatures{$sig_nospace} = 1;
2691 }
2692
2693# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2694 if ($sign_off =~ /^co-developed-by:$/i) {
2695 if ($email eq $author) {
2696 WARN("BAD_SIGN_OFF",
2697 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2698 }
2699 if (!defined $lines[$linenr]) {
2700 WARN("BAD_SIGN_OFF",
2701 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2702 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2703 WARN("BAD_SIGN_OFF",
2704 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2705 } elsif ($1 ne $email) {
2706 WARN("BAD_SIGN_OFF",
2707 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2708 }
2709 }
2710 }
2711
2712# Check email subject for common tools that don't need to be mentioned
2713 if ($in_header_lines &&
2714 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2715 WARN("EMAIL_SUBJECT",
2716 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2717 }
2718
2719# Check for unwanted Gerrit info
2720 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2721 ERROR("GERRIT_CHANGE_ID",
2722 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2723 }
2724
2725# Check if the commit log is in a possible stack dump
2726 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2727 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2728 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2729 # timestamp
2730 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2731 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2732 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2733 # stack dump address styles
2734 $commit_log_possible_stack_dump = 1;
2735 }
2736
2737# Check for line lengths > 75 in commit log, warn once
2738 if ($in_commit_log && !$commit_log_long_line &&
2739 length($line) > 75 &&
2740 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2741 # file delta changes
2742 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2743 # filename then :
2744 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2745 # A Fixes: or Link: line
2746 $commit_log_possible_stack_dump)) {
2747 WARN("COMMIT_LOG_LONG_LINE",
2748 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2749 $commit_log_long_line = 1;
2750 }
2751
2752# Reset possible stack dump if a blank line is found
2753 if ($in_commit_log && $commit_log_possible_stack_dump &&
2754 $line =~ /^\s*$/) {
2755 $commit_log_possible_stack_dump = 0;
2756 }
2757
2758# Check for git id commit length and improperly formed commit descriptions
2759 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2760 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
2761 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
2762 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2763 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
2764 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2765 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
2766 my $init_char = "c";
2767 my $orig_commit = "";
2768 my $short = 1;
2769 my $long = 0;
2770 my $case = 1;
2771 my $space = 1;
2772 my $hasdesc = 0;
2773 my $hasparens = 0;
2774 my $id = '0123456789ab';
2775 my $orig_desc = "commit description";
2776 my $description = "";
2777
2778 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2779 $init_char = $1;
2780 $orig_commit = lc($2);
2781 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2782 $orig_commit = lc($1);
2783 }
2784
2785 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2786 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2787 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2788 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2789 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2790 $orig_desc = $1;
2791 $hasparens = 1;
2792 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2793 defined $rawlines[$linenr] &&
2794 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2795 $orig_desc = $1;
2796 $hasparens = 1;
2797 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2798 defined $rawlines[$linenr] &&
2799 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2800 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2801 $orig_desc = $1;
2802 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2803 $orig_desc .= " " . $1;
2804 $hasparens = 1;
2805 }
2806
2807 ($id, $description) = git_commit_info($orig_commit,
2808 $id, $orig_desc);
2809
2810 if (defined($id) &&
2811 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
2812 ERROR("GIT_COMMIT_ID",
2813 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2814 }
2815 }
2816
2817# Check for added, moved or deleted files
2818 if (!$reported_maintainer_file && !$in_commit_log &&
2819 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2820 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2821 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2822 (defined($1) || defined($2))))) {
2823 $is_patch = 1;
2824 $reported_maintainer_file = 1;
2825 WARN("FILE_PATH_CHANGES",
2826 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2827 }
2828
2829# Check for wrappage within a valid hunk of the file
2830 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
2831 ERROR("CORRUPTED_PATCH",
2832 "patch seems to be corrupt (line wrapped?)\n" .
2833 $herecurr) if (!$emitted_corrupt++);
2834 }
2835
2836# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2837 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
2838 $rawline !~ m/^$UTF8*$/) {
2839 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2840
2841 my $blank = copy_spacing($rawline);
2842 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2843 my $hereptr = "$hereline$ptr\n";
2844
2845 CHK("INVALID_UTF8",
2846 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
2847 }
2848
2849# Check if it's the start of a commit log
2850# (not a header line and we haven't seen the patch filename)
2851 if ($in_header_lines && $realfile =~ /^$/ &&
2852 !($rawline =~ /^\s+(?:\S|$)/ ||
2853 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
2854 $in_header_lines = 0;
2855 $in_commit_log = 1;
2856 $has_commit_log = 1;
2857 }
2858
2859# Check if there is UTF-8 in a commit log when a mail header has explicitly
2860# declined it, i.e defined some charset where it is missing.
2861 if ($in_header_lines &&
2862 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2863 $1 !~ /utf-8/i) {
2864 $non_utf8_charset = 1;
2865 }
2866
2867 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
2868 $rawline =~ /$NON_ASCII_UTF8/) {
2869 WARN("UTF8_BEFORE_PATCH",
2870 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2871 }
2872
2873# Check for absolute kernel paths in commit message
2874 if ($tree && $in_commit_log) {
2875 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2876 my $file = $1;
2877
2878 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2879 check_absolute_file($1, $herecurr)) {
2880 #
2881 } else {
2882 check_absolute_file($file, $herecurr);
2883 }
2884 }
2885 }
2886
2887# Check for various typo / spelling mistakes
2888 if (defined($misspellings) &&
2889 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
2890 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
2891 my $typo = $1;
2892 my $typo_fix = $spelling_fix{lc($typo)};
2893 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2894 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2895 my $msg_level = \&WARN;
2896 $msg_level = \&CHK if ($file);
2897 if (&{$msg_level}("TYPO_SPELLING",
2898 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2899 $fix) {
2900 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2901 }
2902 }
2903 }
2904
2905# check for invalid commit id
2906 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2907 my $id;
2908 my $description;
2909 ($id, $description) = git_commit_info($2, undef, undef);
2910 if (!defined($id)) {
2911 WARN("UNKNOWN_COMMIT_ID",
2912 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2913 }
2914 }
2915
2916# ignore non-hunk lines and lines being removed
2917 next if (!$hunk_line || $line =~ /^-/);
2918
2919#trailing whitespace
2920 if ($line =~ /^\+.*\015/) {
2921 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2922 if (ERROR("DOS_LINE_ENDINGS",
2923 "DOS line endings\n" . $herevet) &&
2924 $fix) {
2925 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
2926 }
2927 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2928 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2929 if (ERROR("TRAILING_WHITESPACE",
2930 "trailing whitespace\n" . $herevet) &&
2931 $fix) {
2932 $fixed[$fixlinenr] =~ s/\s+$//;
2933 }
2934
2935 $rpt_cleaners = 1;
2936 }
2937
2938# Check for FSF mailing addresses.
2939 if ($rawline =~ /\bwrite to the Free/i ||
2940 $rawline =~ /\b675\s+Mass\s+Ave/i ||
2941 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2942 $rawline =~ /\b51\s+Franklin\s+St/i) {
2943 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2944 my $msg_level = \&ERROR;
2945 $msg_level = \&CHK if ($file);
2946 &{$msg_level}("FSF_MAILING_ADDRESS",
2947 "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)
2948 }
2949
2950# check for Kconfig help text having a real description
2951# Only applies when adding the entry originally, after that we do not have
2952# sufficient context to determine whether it is indeed long enough.
2953 if ($realfile =~ /Kconfig/ &&
2954 # 'choice' is usually the last thing on the line (though
2955 # Kconfig supports named choices), so use a word boundary
2956 # (\b) rather than a whitespace character (\s)
2957 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
2958 my $length = 0;
2959 my $cnt = $realcnt;
2960 my $ln = $linenr + 1;
2961 my $f;
2962 my $is_start = 0;
2963 my $is_end = 0;
2964 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
2965 $f = $lines[$ln - 1];
2966 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2967 $is_end = $lines[$ln - 1] =~ /^\+/;
2968
2969 next if ($f =~ /^-/);
2970 last if (!$file && $f =~ /^\@\@/);
2971
2972 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
2973 $is_start = 1;
2974 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2975 if ($lines[$ln - 1] =~ "---help---") {
2976 WARN("CONFIG_DESCRIPTION",
2977 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2978 }
2979 $length = -1;
2980 }
2981
2982 $f =~ s/^.//;
2983 $f =~ s/#.*//;
2984 $f =~ s/^\s+//;
2985 next if ($f =~ /^$/);
2986
2987 # This only checks context lines in the patch
2988 # and so hopefully shouldn't trigger false
2989 # positives, even though some of these are
2990 # common words in help texts
2991 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2992 if|endif|menu|endmenu|source)\b/x) {
2993 $is_end = 1;
2994 last;
2995 }
2996 $length++;
2997 }
2998 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2999 WARN("CONFIG_DESCRIPTION",
3000 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3001 }
3002 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3003 }
3004
3005# check for MAINTAINERS entries that don't have the right form
3006 if ($realfile =~ /^MAINTAINERS$/ &&
3007 $rawline =~ /^\+[A-Z]:/ &&
3008 $rawline !~ /^\+[A-Z]:\t\S/) {
3009 if (WARN("MAINTAINERS_STYLE",
3010 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3011 $fix) {
3012 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3013 }
3014 }
3015
3016# discourage the use of boolean for type definition attributes of Kconfig options
3017 if ($realfile =~ /Kconfig/ &&
3018 $line =~ /^\+\s*\bboolean\b/) {
3019 WARN("CONFIG_TYPE_BOOLEAN",
3020 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3021 }
3022
3023 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3024 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3025 my $flag = $1;
3026 my $replacement = {
3027 'EXTRA_AFLAGS' => 'asflags-y',
3028 'EXTRA_CFLAGS' => 'ccflags-y',
3029 'EXTRA_CPPFLAGS' => 'cppflags-y',
3030 'EXTRA_LDFLAGS' => 'ldflags-y',
3031 };
3032
3033 WARN("DEPRECATED_VARIABLE",
3034 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3035 }
3036
3037# check for DT compatible documentation
3038 if (defined $root &&
3039 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3040 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3041
3042 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3043
3044 my $dt_path = $root . "/Documentation/devicetree/bindings/";
3045 my $vp_file = $dt_path . "vendor-prefixes.yaml";
3046
3047 foreach my $compat (@compats) {
3048 my $compat2 = $compat;
3049 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3050 my $compat3 = $compat;
3051 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3052 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3053 if ( $? >> 8 ) {
3054 WARN("UNDOCUMENTED_DT_STRING",
3055 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3056 }
3057
3058 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3059 my $vendor = $1;
3060 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3061 if ( $? >> 8 ) {
3062 WARN("UNDOCUMENTED_DT_STRING",
3063 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3064 }
3065 }
3066 }
3067
3068# check for using SPDX license tag at beginning of files
3069 if ($realline == $checklicenseline) {
3070 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3071 $checklicenseline = 2;
3072 } elsif ($rawline =~ /^\+/) {
3073 my $comment = "";
3074 if ($realfile =~ /\.(h|s|S)$/) {
3075 $comment = '/*';
3076 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3077 $comment = '//';
3078 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
3079 $comment = '#';
3080 } elsif ($realfile =~ /\.rst$/) {
3081 $comment = '..';
3082 }
3083
3084# check SPDX comment style for .[chsS] files
3085 if ($realfile =~ /\.[chsS]$/ &&
3086 $rawline =~ /SPDX-License-Identifier:/ &&
3087 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3088 WARN("SPDX_LICENSE_TAG",
3089 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3090 }
3091
3092 if ($comment !~ /^$/ &&
3093 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3094 WARN("SPDX_LICENSE_TAG",
3095 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3096 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3097 my $spdx_license = $1;
3098 if (!is_SPDX_License_valid($spdx_license)) {
3099 WARN("SPDX_LICENSE_TAG",
3100 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3101 }
3102 }
3103 }
3104 }
3105
3106# check we are in a valid source file if not then ignore this hunk
3107 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
3108
3109# check for using SPDX-License-Identifier on the wrong line number
3110 if ($realline != $checklicenseline &&
3111 $rawline =~ /\bSPDX-License-Identifier:/ &&
3112 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3113 WARN("SPDX_LICENSE_TAG",
3114 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3115 }
3116
3117# line length limit (with some exclusions)
3118#
3119# There are a few types of lines that may extend beyond $max_line_length:
3120# logging functions like pr_info that end in a string
3121# lines with a single string
3122# #defines that are a single string
3123# lines with an RFC3986 like URL
3124#
3125# There are 3 different line length message types:
3126# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3127# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3128# LONG_LINE all other lines longer than $max_line_length
3129#
3130# if LONG_LINE is ignored, the other 2 types are also ignored
3131#
3132
3133 if ($line =~ /^\+/ && $length > $max_line_length) {
3134 my $msg_type = "LONG_LINE";
3135
3136 # Check the allowed long line types first
3137
3138 # logging functions that end in a string that starts
3139 # before $max_line_length
3140 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3141 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3142 $msg_type = "";
3143
3144 # lines with only strings (w/ possible termination)
3145 # #defines with only strings
3146 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3147 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3148 $msg_type = "";
3149
3150 # More special cases
3151 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3152 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3153 $msg_type = "";
3154
3155 # URL ($rawline is used in case the URL is in a comment)
3156 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3157 $msg_type = "";
3158
3159 # Otherwise set the alternate message types
3160
3161 # a comment starts before $max_line_length
3162 } elsif ($line =~ /($;[\s$;]*)$/ &&
3163 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3164 $msg_type = "LONG_LINE_COMMENT"
3165
3166 # a quoted string starts before $max_line_length
3167 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3168 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3169 $msg_type = "LONG_LINE_STRING"
3170 }
3171
3172 if ($msg_type ne "" &&
3173 (show_type("LONG_LINE") || show_type($msg_type))) {
3174 WARN($msg_type,
3175 "line over $max_line_length characters\n" . $herecurr);
3176 }
3177 }
3178
3179# check for adding lines without a newline.
3180 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3181 WARN("MISSING_EOF_NEWLINE",
3182 "adding a line without newline at end of file\n" . $herecurr);
3183 }
3184
3185# check we are in a valid source file C or perl if not then ignore this hunk
3186 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3187
3188# at the beginning of a line any tabs must come first and anything
3189# more than 8 must use tabs.
3190 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3191 $rawline =~ /^\+\s* \s*/) {
3192 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3193 $rpt_cleaners = 1;
3194 if (ERROR("CODE_INDENT",
3195 "code indent should use tabs where possible\n" . $herevet) &&
3196 $fix) {
3197 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3198 }
3199 }
3200
3201# check for space before tabs.
3202 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3203 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3204 if (WARN("SPACE_BEFORE_TAB",
3205 "please, no space before tabs\n" . $herevet) &&
3206 $fix) {
3207 while ($fixed[$fixlinenr] =~
3208 s/(^\+.*) {8,8}\t/$1\t\t/) {}
3209 while ($fixed[$fixlinenr] =~
3210 s/(^\+.*) +\t/$1\t/) {}
3211 }
3212 }
3213
3214# check for assignments on the start of a line
3215 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3216 CHK("ASSIGNMENT_CONTINUATIONS",
3217 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3218 }
3219
3220# check for && or || at the start of a line
3221 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3222 CHK("LOGICAL_CONTINUATIONS",
3223 "Logical continuations should be on the previous line\n" . $hereprev);
3224 }
3225
3226# check indentation starts on a tab stop
3227 if ($perl_version_ok &&
3228 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3229 my $indent = length($1);
3230 if ($indent % 8) {
3231 if (WARN("TABSTOP",
3232 "Statements should start on a tabstop\n" . $herecurr) &&
3233 $fix) {
3234 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3235 }
3236 }
3237 }
3238
3239# check multi-line statement indentation matches previous line
3240 if ($perl_version_ok &&
3241 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3242 $prevline =~ /^\+(\t*)(.*)$/;
3243 my $oldindent = $1;
3244 my $rest = $2;
3245
3246 my $pos = pos_last_openparen($rest);
3247 if ($pos >= 0) {
3248 $line =~ /^(\+| )([ \t]*)/;
3249 my $newindent = $2;
3250
3251 my $goodtabindent = $oldindent .
3252 "\t" x ($pos / 8) .
3253 " " x ($pos % 8);
3254 my $goodspaceindent = $oldindent . " " x $pos;
3255
3256 if ($newindent ne $goodtabindent &&
3257 $newindent ne $goodspaceindent) {
3258
3259 if (CHK("PARENTHESIS_ALIGNMENT",
3260 "Alignment should match open parenthesis\n" . $hereprev) &&
3261 $fix && $line =~ /^\+/) {
3262 $fixed[$fixlinenr] =~
3263 s/^\+[ \t]*/\+$goodtabindent/;
3264 }
3265 }
3266 }
3267 }
3268
3269# check for space after cast like "(int) foo" or "(struct foo) bar"
3270# avoid checking a few false positives:
3271# "sizeof(<type>)" or "__alignof__(<type>)"
3272# function pointer declarations like "(*foo)(int) = bar;"
3273# structure definitions like "(struct foo) { 0 };"
3274# multiline macros that define functions
3275# known attributes or the __attribute__ keyword
3276 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3277 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
3278 if (CHK("SPACING",
3279 "No space is necessary after a cast\n" . $herecurr) &&
3280 $fix) {
3281 $fixed[$fixlinenr] =~
3282 s/(\(\s*$Type\s*\))[ \t]+/$1/;
3283 }
3284 }
3285
3286# Block comment styles
3287# Networking with an initial /*
3288 if ($realfile =~ m@^(drivers/net/|net/)@ &&
3289 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
3290 $rawline =~ /^\+[ \t]*\*/ &&
3291 $realline > 2) {
3292 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3293 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3294 }
3295
3296# Block comments use * on subsequent lines
3297 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3298 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
3299 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
3300 $rawline =~ /^\+/ && #line is new
3301 $rawline !~ /^\+[ \t]*\*/) { #no leading *
3302 WARN("BLOCK_COMMENT_STYLE",
3303 "Block comments use * on subsequent lines\n" . $hereprev);
3304 }
3305
3306# Block comments use */ on trailing lines
3307 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
3308 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3309 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3310 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
3311 WARN("BLOCK_COMMENT_STYLE",
3312 "Block comments use a trailing */ on a separate line\n" . $herecurr);
3313 }
3314
3315# Block comment * alignment
3316 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3317 $line =~ /^\+[ \t]*$;/ && #leading comment
3318 $rawline =~ /^\+[ \t]*\*/ && #leading *
3319 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
3320 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
3321 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3322 my $oldindent;
3323 $prevrawline =~ m@^\+([ \t]*/?)\*@;
3324 if (defined($1)) {
3325 $oldindent = expand_tabs($1);
3326 } else {
3327 $prevrawline =~ m@^\+(.*/?)\*@;
3328 $oldindent = expand_tabs($1);
3329 }
3330 $rawline =~ m@^\+([ \t]*)\*@;
3331 my $newindent = $1;
3332 $newindent = expand_tabs($newindent);
3333 if (length($oldindent) ne length($newindent)) {
3334 WARN("BLOCK_COMMENT_STYLE",
3335 "Block comments should align the * on each line\n" . $hereprev);
3336 }
3337 }
3338
3339# check for missing blank lines after struct/union declarations
3340# with exceptions for various attributes and macros
3341 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3342 $line =~ /^\+/ &&
3343 !($line =~ /^\+\s*$/ ||
3344 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3345 $line =~ /^\+\s*MODULE_/i ||
3346 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3347 $line =~ /^\+[a-z_]*init/ ||
3348 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3349 $line =~ /^\+\s*DECLARE/ ||
3350 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
3351 $line =~ /^\+\s*__setup/)) {
3352 if (CHK("LINE_SPACING",
3353 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3354 $fix) {
3355 fix_insert_line($fixlinenr, "\+");
3356 }
3357 }
3358
3359# check for multiple consecutive blank lines
3360 if ($prevline =~ /^[\+ ]\s*$/ &&
3361 $line =~ /^\+\s*$/ &&
3362 $last_blank_line != ($linenr - 1)) {
3363 if (CHK("LINE_SPACING",
3364 "Please don't use multiple blank lines\n" . $hereprev) &&
3365 $fix) {
3366 fix_delete_line($fixlinenr, $rawline);
3367 }
3368
3369 $last_blank_line = $linenr;
3370 }
3371
3372# check for missing blank lines after declarations
3373 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3374 # actual declarations
3375 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3376 # function pointer declarations
3377 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3378 # foo bar; where foo is some local typedef or #define
3379 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3380 # known declaration macros
3381 $prevline =~ /^\+\s+$declaration_macros/) &&
3382 # for "else if" which can look like "$Ident $Ident"
3383 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3384 # other possible extensions of declaration lines
3385 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3386 # not starting a section or a macro "\" extended line
3387 $prevline =~ /(?:\{\s*|\\)$/) &&
3388 # looks like a declaration
3389 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
3390 # function pointer declarations
3391 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
3392 # foo bar; where foo is some local typedef or #define
3393 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3394 # known declaration macros
3395 $sline =~ /^\+\s+$declaration_macros/ ||
3396 # start of struct or union or enum
3397 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
3398 # start or end of block or continuation of declaration
3399 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3400 # bitfield continuation
3401 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3402 # other possible extensions of declaration lines
3403 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3404 # indentation of previous and current line are the same
3405 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
3406 if (WARN("LINE_SPACING",
3407 "Missing a blank line after declarations\n" . $hereprev) &&
3408 $fix) {
3409 fix_insert_line($fixlinenr, "\+");
3410 }
3411 }
3412
3413# check for spaces at the beginning of a line.
3414# Exceptions:
3415# 1) within comments
3416# 2) indented preprocessor commands
3417# 3) hanging labels
3418 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
3419 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3420 if (WARN("LEADING_SPACE",
3421 "please, no spaces at the start of a line\n" . $herevet) &&
3422 $fix) {
3423 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3424 }
3425 }
3426
3427# check we are in a valid C source file if not then ignore this hunk
3428 next if ($realfile !~ /\.(h|c)$/);
3429
3430# check for unusual line ending [ or (
3431 if ($line =~ /^\+.*([\[\(])\s*$/) {
3432 CHK("OPEN_ENDED_LINE",
3433 "Lines should not end with a '$1'\n" . $herecurr);
3434 }
3435
3436# check if this appears to be the start function declaration, save the name
3437 if ($sline =~ /^\+\{\s*$/ &&
3438 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3439 $context_function = $1;
3440 }
3441
3442# check if this appears to be the end of function declaration
3443 if ($sline =~ /^\+\}\s*$/) {
3444 undef $context_function;
3445 }
3446
3447# check indentation of any line with a bare else
3448# (but not if it is a multiple line "if (foo) return bar; else return baz;")
3449# if the previous line is a break or return and is indented 1 tab more...
3450 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3451 my $tabs = length($1) + 1;
3452 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3453 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3454 defined $lines[$linenr] &&
3455 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
3456 WARN("UNNECESSARY_ELSE",
3457 "else is not generally useful after a break or return\n" . $hereprev);
3458 }
3459 }
3460
3461# check indentation of a line with a break;
3462# if the previous line is a goto or return and is indented the same # of tabs
3463 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3464 my $tabs = $1;
3465 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3466 WARN("UNNECESSARY_BREAK",
3467 "break is not useful after a goto or return\n" . $hereprev);
3468 }
3469 }
3470
3471# check for RCS/CVS revision markers
3472 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
3473 WARN("CVS_KEYWORD",
3474 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
3475 }
3476
3477# check for old HOTPLUG __dev<foo> section markings
3478 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3479 WARN("HOTPLUG_SECTION",
3480 "Using $1 is unnecessary\n" . $herecurr);
3481 }
3482
3483# Check for potential 'bare' types
3484 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3485 $realline_next);
3486#print "LINE<$line>\n";
3487 if ($linenr > $suppress_statement &&
3488 $realcnt && $sline =~ /.\s*\S/) {
3489 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3490 ctx_statement_block($linenr, $realcnt, 0);
3491 $stat =~ s/\n./\n /g;
3492 $cond =~ s/\n./\n /g;
3493
3494#print "linenr<$linenr> <$stat>\n";
3495 # If this statement has no statement boundaries within
3496 # it there is no point in retrying a statement scan
3497 # until we hit end of it.
3498 my $frag = $stat; $frag =~ s/;+\s*$//;
3499 if ($frag !~ /(?:{|;)/) {
3500#print "skip<$line_nr_next>\n";
3501 $suppress_statement = $line_nr_next;
3502 }
3503
3504 # Find the real next line.
3505 $realline_next = $line_nr_next;
3506 if (defined $realline_next &&
3507 (!defined $lines[$realline_next - 1] ||
3508 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3509 $realline_next++;
3510 }
3511
3512 my $s = $stat;
3513 $s =~ s/{.*$//s;
3514
3515 # Ignore goto labels.
3516 if ($s =~ /$Ident:\*$/s) {
3517
3518 # Ignore functions being called
3519 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
3520
3521 } elsif ($s =~ /^.\s*else\b/s) {
3522
3523 # declarations always start with types
3524 } 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) {
3525 my $type = $1;
3526 $type =~ s/\s+/ /g;
3527 possible($type, "A:" . $s);
3528
3529 # definitions in global scope can only start with types
3530 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
3531 possible($1, "B:" . $s);
3532 }
3533
3534 # any (foo ... *) is a pointer cast, and foo is a type
3535 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
3536 possible($1, "C:" . $s);
3537 }
3538
3539 # Check for any sort of function declaration.
3540 # int foo(something bar, other baz);
3541 # void (*store_gdt)(x86_descr_ptr *);
3542 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3543 my ($name_len) = length($1);
3544
3545 my $ctx = $s;
3546 substr($ctx, 0, $name_len + 1, '');
3547 $ctx =~ s/\)[^\)]*$//;
3548
3549 for my $arg (split(/\s*,\s*/, $ctx)) {
3550 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3551
3552 possible($1, "D:" . $s);
3553 }
3554 }
3555 }
3556
3557 }
3558
3559#
3560# Checks which may be anchored in the context.
3561#
3562
3563# Check for switch () and associated case and default
3564# statements should be at the same indent.
3565 if ($line=~/\bswitch\s*\(.*\)/) {
3566 my $err = '';
3567 my $sep = '';
3568 my @ctx = ctx_block_outer($linenr, $realcnt);
3569 shift(@ctx);
3570 for my $ctx (@ctx) {
3571 my ($clen, $cindent) = line_stats($ctx);
3572 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3573 $indent != $cindent) {
3574 $err .= "$sep$ctx\n";
3575 $sep = '';
3576 } else {
3577 $sep = "[...]\n";
3578 }
3579 }
3580 if ($err ne '') {
3581 ERROR("SWITCH_CASE_INDENT_LEVEL",
3582 "switch and case should be at the same indent\n$hereline$err");
3583 }
3584 }
3585
3586# if/while/etc brace do not go on next line, unless defining a do while loop,
3587# or if that brace on the next line is for something else
3588 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3589 my $pre_ctx = "$1$2";
3590
3591 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
3592
3593 if ($line =~ /^\+\t{6,}/) {
3594 WARN("DEEP_INDENTATION",
3595 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3596 }
3597
3598 my $ctx_cnt = $realcnt - $#ctx - 1;
3599 my $ctx = join("\n", @ctx);
3600
3601 my $ctx_ln = $linenr;
3602 my $ctx_skip = $realcnt;
3603
3604 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3605 defined $lines[$ctx_ln - 1] &&
3606 $lines[$ctx_ln - 1] =~ /^-/)) {
3607 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3608 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
3609 $ctx_ln++;
3610 }
3611
3612 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3613 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3614
3615 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
3616 ERROR("OPEN_BRACE",
3617 "that open brace { should be on the previous line\n" .
3618 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3619 }
3620 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3621 $ctx =~ /\)\s*\;\s*$/ &&
3622 defined $lines[$ctx_ln - 1])
3623 {
3624 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3625 if ($nindent > $indent) {
3626 WARN("TRAILING_SEMICOLON",
3627 "trailing semicolon indicates no statements, indent implies otherwise\n" .
3628 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
3629 }
3630 }
3631 }
3632
3633# Check relative indent for conditionals and blocks.
3634 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3635 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3636 ctx_statement_block($linenr, $realcnt, 0)
3637 if (!defined $stat);
3638 my ($s, $c) = ($stat, $cond);
3639
3640 substr($s, 0, length($c), '');
3641
3642 # remove inline comments
3643 $s =~ s/$;/ /g;
3644 $c =~ s/$;/ /g;
3645
3646 # Find out how long the conditional actually is.
3647 my @newlines = ($c =~ /\n/gs);
3648 my $cond_lines = 1 + $#newlines;
3649
3650 # Make sure we remove the line prefixes as we have
3651 # none on the first line, and are going to readd them
3652 # where necessary.
3653 $s =~ s/\n./\n/gs;
3654 while ($s =~ /\n\s+\\\n/) {
3655 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3656 }
3657
3658 # We want to check the first line inside the block
3659 # starting at the end of the conditional, so remove:
3660 # 1) any blank line termination
3661 # 2) any opening brace { on end of the line
3662 # 3) any do (...) {
3663 my $continuation = 0;
3664 my $check = 0;
3665 $s =~ s/^.*\bdo\b//;
3666 $s =~ s/^\s*{//;
3667 if ($s =~ s/^\s*\\//) {
3668 $continuation = 1;
3669 }
3670 if ($s =~ s/^\s*?\n//) {
3671 $check = 1;
3672 $cond_lines++;
3673 }
3674
3675 # Also ignore a loop construct at the end of a
3676 # preprocessor statement.
3677 if (($prevline =~ /^.\s*#\s*define\s/ ||
3678 $prevline =~ /\\\s*$/) && $continuation == 0) {
3679 $check = 0;
3680 }
3681
3682 my $cond_ptr = -1;
3683 $continuation = 0;
3684 while ($cond_ptr != $cond_lines) {
3685 $cond_ptr = $cond_lines;
3686
3687 # If we see an #else/#elif then the code
3688 # is not linear.
3689 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3690 $check = 0;
3691 }
3692
3693 # Ignore:
3694 # 1) blank lines, they should be at 0,
3695 # 2) preprocessor lines, and
3696 # 3) labels.
3697 if ($continuation ||
3698 $s =~ /^\s*?\n/ ||
3699 $s =~ /^\s*#\s*?/ ||
3700 $s =~ /^\s*$Ident\s*:/) {
3701 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
3702 if ($s =~ s/^.*?\n//) {
3703 $cond_lines++;
3704 }
3705 }
3706 }
3707
3708 my (undef, $sindent) = line_stats("+" . $s);
3709 my $stat_real = raw_line($linenr, $cond_lines);
3710
3711 # Check if either of these lines are modified, else
3712 # this is not this patch's fault.
3713 if (!defined($stat_real) ||
3714 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3715 $check = 0;
3716 }
3717 if (defined($stat_real) && $cond_lines > 1) {
3718 $stat_real = "[...]\n$stat_real";
3719 }
3720
3721 #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";
3722
3723 if ($check && $s ne '' &&
3724 (($sindent % 8) != 0 ||
3725 ($sindent < $indent) ||
3726 ($sindent == $indent &&
3727 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
3728 ($sindent > $indent + 8))) {
3729 WARN("SUSPECT_CODE_INDENT",
3730 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3731 }
3732 }
3733
3734 # Track the 'values' across context and added lines.
3735 my $opline = $line; $opline =~ s/^./ /;
3736 my ($curr_values, $curr_vars) =
3737 annotate_values($opline . "\n", $prev_values);
3738 $curr_values = $prev_values . $curr_values;
3739 if ($dbg_values) {
3740 my $outline = $opline; $outline =~ s/\t/ /g;
3741 print "$linenr > .$outline\n";
3742 print "$linenr > $curr_values\n";
3743 print "$linenr > $curr_vars\n";
3744 }
3745 $prev_values = substr($curr_values, -1);
3746
3747#ignore lines not being added
3748 next if ($line =~ /^[^\+]/);
3749
3750# check for dereferences that span multiple lines
3751 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3752 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3753 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3754 my $ref = $1;
3755 $line =~ /^.\s*($Lval)/;
3756 $ref .= $1;
3757 $ref =~ s/\s//g;
3758 WARN("MULTILINE_DEREFERENCE",
3759 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3760 }
3761
3762# check for declarations of signed or unsigned without int
3763 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3764 my $type = $1;
3765 my $var = $2;
3766 $var = "" if (!defined $var);
3767 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
3768 my $sign = $1;
3769 my $pointer = $2;
3770
3771 $pointer = "" if (!defined $pointer);
3772
3773 if (WARN("UNSPECIFIED_INT",
3774 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3775 $fix) {
3776 my $decl = trim($sign) . " int ";
3777 my $comp_pointer = $pointer;
3778 $comp_pointer =~ s/\s//g;
3779 $decl .= $comp_pointer;
3780 $decl = rtrim($decl) if ($var eq "");
3781 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
3782 }
3783 }
3784 }
3785
3786# TEST: allow direct testing of the type matcher.
3787 if ($dbg_type) {
3788 if ($line =~ /^.\s*$Declare\s*$/) {
3789 ERROR("TEST_TYPE",
3790 "TEST: is type\n" . $herecurr);
3791 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
3792 ERROR("TEST_NOT_TYPE",
3793 "TEST: is not type ($1 is)\n". $herecurr);
3794 }
3795 next;
3796 }
3797# TEST: allow direct testing of the attribute matcher.
3798 if ($dbg_attr) {
3799 if ($line =~ /^.\s*$Modifier\s*$/) {
3800 ERROR("TEST_ATTR",
3801 "TEST: is attr\n" . $herecurr);
3802 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
3803 ERROR("TEST_NOT_ATTR",
3804 "TEST: is not attr ($1 is)\n". $herecurr);
3805 }
3806 next;
3807 }
3808
3809# check for initialisation to aggregates open brace on the next line
3810 if ($line =~ /^.\s*{/ &&
3811 $prevline =~ /(?:^|[^=])=\s*$/) {
3812 if (ERROR("OPEN_BRACE",
3813 "that open brace { should be on the previous line\n" . $hereprev) &&
3814 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3815 fix_delete_line($fixlinenr - 1, $prevrawline);
3816 fix_delete_line($fixlinenr, $rawline);
3817 my $fixedline = $prevrawline;
3818 $fixedline =~ s/\s*=\s*$/ = {/;
3819 fix_insert_line($fixlinenr, $fixedline);
3820 $fixedline = $line;
3821 $fixedline =~ s/^(.\s*)\{\s*/$1/;
3822 fix_insert_line($fixlinenr, $fixedline);
3823 }
3824 }
3825
3826#
3827# Checks which are anchored on the added line.
3828#
3829
3830# check for malformed paths in #include statements (uses RAW line)
3831 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
3832 my $path = $1;
3833 if ($path =~ m{//}) {
3834 ERROR("MALFORMED_INCLUDE",
3835 "malformed #include filename\n" . $herecurr);
3836 }
3837 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3838 ERROR("UAPI_INCLUDE",
3839 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
3840 }
3841 }
3842
3843# no C99 // comments
3844 if ($line =~ m{//}) {
3845 if (ERROR("C99_COMMENTS",
3846 "do not use C99 // comments\n" . $herecurr) &&
3847 $fix) {
3848 my $line = $fixed[$fixlinenr];
3849 if ($line =~ /\/\/(.*)$/) {
3850 my $comment = trim($1);
3851 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
3852 }
3853 }
3854 }
3855 # Remove C99 comments.
3856 $line =~ s@//.*@@;
3857 $opline =~ s@//.*@@;
3858
3859# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3860# the whole statement.
3861#print "APW <$lines[$realline_next - 1]>\n";
3862 if (defined $realline_next &&
3863 exists $lines[$realline_next - 1] &&
3864 !defined $suppress_export{$realline_next} &&
3865 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3866 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3867 # Handle definitions which produce identifiers with
3868 # a prefix:
3869 # XXX(foo);
3870 # EXPORT_SYMBOL(something_foo);
3871 my $name = $1;
3872 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
3873 $name =~ /^${Ident}_$2/) {
3874#print "FOO C name<$name>\n";
3875 $suppress_export{$realline_next} = 1;
3876
3877 } elsif ($stat !~ /(?:
3878 \n.}\s*$|
3879 ^.DEFINE_$Ident\(\Q$name\E\)|
3880 ^.DECLARE_$Ident\(\Q$name\E\)|
3881 ^.LIST_HEAD\(\Q$name\E\)|
3882 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3883 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
3884 )/x) {
3885#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3886 $suppress_export{$realline_next} = 2;
3887 } else {
3888 $suppress_export{$realline_next} = 1;
3889 }
3890 }
3891 if (!defined $suppress_export{$linenr} &&
3892 $prevline =~ /^.\s*$/ &&
3893 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3894 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3895#print "FOO B <$lines[$linenr - 1]>\n";
3896 $suppress_export{$linenr} = 2;
3897 }
3898 if (defined $suppress_export{$linenr} &&
3899 $suppress_export{$linenr} == 2) {
3900 WARN("EXPORT_SYMBOL",
3901 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
3902 }
3903
3904# check for global initialisers.
3905 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
3906 if (ERROR("GLOBAL_INITIALISERS",
3907 "do not initialise globals to $1\n" . $herecurr) &&
3908 $fix) {
3909 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
3910 }
3911 }
3912# check for static initialisers.
3913 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
3914 if (ERROR("INITIALISED_STATIC",
3915 "do not initialise statics to $1\n" .
3916 $herecurr) &&
3917 $fix) {
3918 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
3919 }
3920 }
3921
3922# check for misordered declarations of char/short/int/long with signed/unsigned
3923 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3924 my $tmp = trim($1);
3925 WARN("MISORDERED_TYPE",
3926 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3927 }
3928
3929# check for unnecessary <signed> int declarations of short/long/long long
3930 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
3931 my $type = trim($1);
3932 next if ($type !~ /\bint\b/);
3933 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
3934 my $new_type = $type;
3935 $new_type =~ s/\b\s*int\s*\b/ /;
3936 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
3937 $new_type =~ s/^const\s+//;
3938 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
3939 $new_type = "const $new_type" if ($type =~ /^const\b/);
3940 $new_type =~ s/\s+/ /g;
3941 $new_type = trim($new_type);
3942 if (WARN("UNNECESSARY_INT",
3943 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
3944 $fix) {
3945 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
3946 }
3947 }
3948
3949# check for static const char * arrays.
3950 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
3951 WARN("STATIC_CONST_CHAR_ARRAY",
3952 "static const char * array should probably be static const char * const\n" .
3953 $herecurr);
3954 }
3955
3956# check for initialized const char arrays that should be static const
3957 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3958 if (WARN("STATIC_CONST_CHAR_ARRAY",
3959 "const array should probably be static const\n" . $herecurr) &&
3960 $fix) {
3961 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
3962 }
3963 }
3964
3965# check for static char foo[] = "bar" declarations.
3966 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
3967 WARN("STATIC_CONST_CHAR_ARRAY",
3968 "static char array declaration should probably be static const char\n" .
3969 $herecurr);
3970 }
3971
3972# check for const <foo> const where <foo> is not a pointer or array type
3973 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3974 my $found = $1;
3975 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3976 WARN("CONST_CONST",
3977 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3978 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3979 WARN("CONST_CONST",
3980 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3981 }
3982 }
3983
3984# check for non-global char *foo[] = {"bar", ...} declarations.
3985 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3986 WARN("STATIC_CONST_CHAR_ARRAY",
3987 "char * array declaration might be better as static const\n" .
3988 $herecurr);
3989 }
3990
3991# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3992 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3993 my $array = $1;
3994 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3995 my $array_div = $1;
3996 if (WARN("ARRAY_SIZE",
3997 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3998 $fix) {
3999 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4000 }
4001 }
4002 }
4003
4004# check for function declarations without arguments like "int foo()"
4005 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
4006 if (ERROR("FUNCTION_WITHOUT_ARGS",
4007 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4008 $fix) {
4009 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4010 }
4011 }
4012
4013# check for new typedefs, only function parameters and sparse annotations
4014# make sense.
4015 if ($line =~ /\btypedef\s/ &&
4016 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4017 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4018 $line !~ /\b$typeTypedefs\b/ &&
4019 $line !~ /\b__bitwise\b/) {
4020 WARN("NEW_TYPEDEFS",
4021 "do not add new typedefs\n" . $herecurr);
4022 }
4023
4024# * goes on variable not on type
4025 # (char*[ const])
4026 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4027 #print "AA<$1>\n";
4028 my ($ident, $from, $to) = ($1, $2, $2);
4029
4030 # Should start with a space.
4031 $to =~ s/^(\S)/ $1/;
4032 # Should not end with a space.
4033 $to =~ s/\s+$//;
4034 # '*'s should not have spaces between.
4035 while ($to =~ s/\*\s+\*/\*\*/) {
4036 }
4037
4038## print "1: from<$from> to<$to> ident<$ident>\n";
4039 if ($from ne $to) {
4040 if (ERROR("POINTER_LOCATION",
4041 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4042 $fix) {
4043 my $sub_from = $ident;
4044 my $sub_to = $ident;
4045 $sub_to =~ s/\Q$from\E/$to/;
4046 $fixed[$fixlinenr] =~
4047 s@\Q$sub_from\E@$sub_to@;
4048 }
4049 }
4050 }
4051 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4052 #print "BB<$1>\n";
4053 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4054
4055 # Should start with a space.
4056 $to =~ s/^(\S)/ $1/;
4057 # Should not end with a space.
4058 $to =~ s/\s+$//;
4059 # '*'s should not have spaces between.
4060 while ($to =~ s/\*\s+\*/\*\*/) {
4061 }
4062 # Modifiers should have spaces.
4063 $to =~ s/(\b$Modifier$)/$1 /;
4064
4065## print "2: from<$from> to<$to> ident<$ident>\n";
4066 if ($from ne $to && $ident !~ /^$Modifier$/) {
4067 if (ERROR("POINTER_LOCATION",
4068 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4069 $fix) {
4070
4071 my $sub_from = $match;
4072 my $sub_to = $match;
4073 $sub_to =~ s/\Q$from\E/$to/;
4074 $fixed[$fixlinenr] =~
4075 s@\Q$sub_from\E@$sub_to@;
4076 }
4077 }
4078 }
4079
4080# avoid BUG() or BUG_ON()
4081 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
4082 my $msg_level = \&WARN;
4083 $msg_level = \&CHK if ($file);
4084 &{$msg_level}("AVOID_BUG",
4085 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4086 }
4087
4088# avoid LINUX_VERSION_CODE
4089 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4090 WARN("LINUX_VERSION_CODE",
4091 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4092 }
4093
4094# check for uses of printk_ratelimit
4095 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4096 WARN("PRINTK_RATELIMITED",
4097 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4098 }
4099
4100# printk should use KERN_* levels
4101 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4102 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4103 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4104 }
4105
4106 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4107 my $orig = $1;
4108 my $level = lc($orig);
4109 $level = "warn" if ($level eq "warning");
4110 my $level2 = $level;
4111 $level2 = "dbg" if ($level eq "debug");
4112 WARN("PREFER_PR_LEVEL",
4113 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4114 }
4115
4116 if ($line =~ /\bpr_warning\s*\(/) {
4117 if (WARN("PREFER_PR_LEVEL",
4118 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
4119 $fix) {
4120 $fixed[$fixlinenr] =~
4121 s/\bpr_warning\b/pr_warn/;
4122 }
4123 }
4124
4125 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4126 my $orig = $1;
4127 my $level = lc($orig);
4128 $level = "warn" if ($level eq "warning");
4129 $level = "dbg" if ($level eq "debug");
4130 WARN("PREFER_DEV_LEVEL",
4131 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4132 }
4133
4134# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4135# number of false positives, but assembly files are not checked, so at
4136# least the arch entry code will not trigger this warning.
4137 if ($line =~ /\bENOSYS\b/) {
4138 WARN("ENOSYS",
4139 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4140 }
4141
4142# function brace can't be on same line, except for #defines of do while,
4143# or if closed on same line
4144 if ($perl_version_ok &&
4145 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4146 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4147 $sline !~ /}/) {
4148 if (ERROR("OPEN_BRACE",
4149 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4150 $fix) {
4151 fix_delete_line($fixlinenr, $rawline);
4152 my $fixed_line = $rawline;
4153 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4154 my $line1 = $1;
4155 my $line2 = $2;
4156 fix_insert_line($fixlinenr, ltrim($line1));
4157 fix_insert_line($fixlinenr, "\+{");
4158 if ($line2 !~ /^\s*$/) {
4159 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4160 }
4161 }
4162 }
4163
4164# open braces for enum, union and struct go on the same line.
4165 if ($line =~ /^.\s*{/ &&
4166 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4167 if (ERROR("OPEN_BRACE",
4168 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4169 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4170 fix_delete_line($fixlinenr - 1, $prevrawline);
4171 fix_delete_line($fixlinenr, $rawline);
4172 my $fixedline = rtrim($prevrawline) . " {";
4173 fix_insert_line($fixlinenr, $fixedline);
4174 $fixedline = $rawline;
4175 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4176 if ($fixedline !~ /^\+\s*$/) {
4177 fix_insert_line($fixlinenr, $fixedline);
4178 }
4179 }
4180 }
4181
4182# missing space after union, struct or enum definition
4183 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4184 if (WARN("SPACING",
4185 "missing space after $1 definition\n" . $herecurr) &&
4186 $fix) {
4187 $fixed[$fixlinenr] =~
4188 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4189 }
4190 }
4191
4192# Function pointer declarations
4193# check spacing between type, funcptr, and args
4194# canonical declaration is "type (*funcptr)(args...)"
4195 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4196 my $declare = $1;
4197 my $pre_pointer_space = $2;
4198 my $post_pointer_space = $3;
4199 my $funcname = $4;
4200 my $post_funcname_space = $5;
4201 my $pre_args_space = $6;
4202
4203# the $Declare variable will capture all spaces after the type
4204# so check it for a missing trailing missing space but pointer return types
4205# don't need a space so don't warn for those.
4206 my $post_declare_space = "";
4207 if ($declare =~ /(\s+)$/) {
4208 $post_declare_space = $1;
4209 $declare = rtrim($declare);
4210 }
4211 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4212 WARN("SPACING",
4213 "missing space after return type\n" . $herecurr);
4214 $post_declare_space = " ";
4215 }
4216
4217# unnecessary space "type (*funcptr)(args...)"
4218# This test is not currently implemented because these declarations are
4219# equivalent to
4220# int foo(int bar, ...)
4221# and this is form shouldn't/doesn't generate a checkpatch warning.
4222#
4223# elsif ($declare =~ /\s{2,}$/) {
4224# WARN("SPACING",
4225# "Multiple spaces after return type\n" . $herecurr);
4226# }
4227
4228# unnecessary space "type ( *funcptr)(args...)"
4229 if (defined $pre_pointer_space &&
4230 $pre_pointer_space =~ /^\s/) {
4231 WARN("SPACING",
4232 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4233 }
4234
4235# unnecessary space "type (* funcptr)(args...)"
4236 if (defined $post_pointer_space &&
4237 $post_pointer_space =~ /^\s/) {
4238 WARN("SPACING",
4239 "Unnecessary space before function pointer name\n" . $herecurr);
4240 }
4241
4242# unnecessary space "type (*funcptr )(args...)"
4243 if (defined $post_funcname_space &&
4244 $post_funcname_space =~ /^\s/) {
4245 WARN("SPACING",
4246 "Unnecessary space after function pointer name\n" . $herecurr);
4247 }
4248
4249# unnecessary space "type (*funcptr) (args...)"
4250 if (defined $pre_args_space &&
4251 $pre_args_space =~ /^\s/) {
4252 WARN("SPACING",
4253 "Unnecessary space before function pointer arguments\n" . $herecurr);
4254 }
4255
4256 if (show_type("SPACING") && $fix) {
4257 $fixed[$fixlinenr] =~
4258 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4259 }
4260 }
4261
4262# check for spacing round square brackets; allowed:
4263# 1. with a type on the left -- int [] a;
4264# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4265# 3. inside a curly brace -- = { [0...10] = 5 }
4266 while ($line =~ /(.*?\s)\[/g) {
4267 my ($where, $prefix) = ($-[1], $1);
4268 if ($prefix !~ /$Type\s+$/ &&
4269 ($where != 0 || $prefix !~ /^.\s+$/) &&
4270 $prefix !~ /[{,:]\s+$/) {
4271 if (ERROR("BRACKET_SPACE",
4272 "space prohibited before open square bracket '['\n" . $herecurr) &&
4273 $fix) {
4274 $fixed[$fixlinenr] =~
4275 s/^(\+.*?)\s+\[/$1\[/;
4276 }
4277 }
4278 }
4279
4280# check for spaces between functions and their parentheses.
4281 while ($line =~ /($Ident)\s+\(/g) {
4282 my $name = $1;
4283 my $ctx_before = substr($line, 0, $-[1]);
4284 my $ctx = "$ctx_before$name";
4285
4286 # Ignore those directives where spaces _are_ permitted.
4287 if ($name =~ /^(?:
4288 if|for|while|switch|return|case|
4289 volatile|__volatile__|
4290 __attribute__|format|__extension__|
4291 asm|__asm__)$/x)
4292 {
4293 # cpp #define statements have non-optional spaces, ie
4294 # if there is a space between the name and the open
4295 # parenthesis it is simply not a parameter group.
4296 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
4297
4298 # cpp #elif statement condition may start with a (
4299 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
4300
4301 # If this whole things ends with a type its most
4302 # likely a typedef for a function.
4303 } elsif ($ctx =~ /$Type$/) {
4304
4305 } else {
4306 if (WARN("SPACING",
4307 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4308 $fix) {
4309 $fixed[$fixlinenr] =~
4310 s/\b$name\s+\(/$name\(/;
4311 }
4312 }
4313 }
4314
4315# Check operator spacing.
4316 if (!($line=~/\#\s*include/)) {
4317 my $fixed_line = "";
4318 my $line_fixed = 0;
4319
4320 my $ops = qr{
4321 <<=|>>=|<=|>=|==|!=|
4322 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4323 =>|->|<<|>>|<|>|=|!|~|
4324 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
4325 \?:|\?|:
4326 }x;
4327 my @elements = split(/($ops|;)/, $opline);
4328
4329## print("element count: <" . $#elements . ">\n");
4330## foreach my $el (@elements) {
4331## print("el: <$el>\n");
4332## }
4333
4334 my @fix_elements = ();
4335 my $off = 0;
4336
4337 foreach my $el (@elements) {
4338 push(@fix_elements, substr($rawline, $off, length($el)));
4339 $off += length($el);
4340 }
4341
4342 $off = 0;
4343
4344 my $blank = copy_spacing($opline);
4345 my $last_after = -1;
4346
4347 for (my $n = 0; $n < $#elements; $n += 2) {
4348
4349 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4350
4351## print("n: <$n> good: <$good>\n");
4352
4353 $off += length($elements[$n]);
4354
4355 # Pick up the preceding and succeeding characters.
4356 my $ca = substr($opline, 0, $off);
4357 my $cc = '';
4358 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4359 $cc = substr($opline, $off + length($elements[$n + 1]));
4360 }
4361 my $cb = "$ca$;$cc";
4362
4363 my $a = '';
4364 $a = 'V' if ($elements[$n] ne '');
4365 $a = 'W' if ($elements[$n] =~ /\s$/);
4366 $a = 'C' if ($elements[$n] =~ /$;$/);
4367 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4368 $a = 'O' if ($elements[$n] eq '');
4369 $a = 'E' if ($ca =~ /^\s*$/);
4370
4371 my $op = $elements[$n + 1];
4372
4373 my $c = '';
4374 if (defined $elements[$n + 2]) {
4375 $c = 'V' if ($elements[$n + 2] ne '');
4376 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
4377 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
4378 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4379 $c = 'O' if ($elements[$n + 2] eq '');
4380 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
4381 } else {
4382 $c = 'E';
4383 }
4384
4385 my $ctx = "${a}x${c}";
4386
4387 my $at = "(ctx:$ctx)";
4388
4389 my $ptr = substr($blank, 0, $off) . "^";
4390 my $hereptr = "$hereline$ptr\n";
4391
4392 # Pull out the value of this operator.
4393 my $op_type = substr($curr_values, $off + 1, 1);
4394
4395 # Get the full operator variant.
4396 my $opv = $op . substr($curr_vars, $off, 1);
4397
4398 # Ignore operators passed as parameters.
4399 if ($op_type ne 'V' &&
4400 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
4401
4402# # Ignore comments
4403# } elsif ($op =~ /^$;+$/) {
4404
4405 # ; should have either the end of line or a space or \ after it
4406 } elsif ($op eq ';') {
4407 if ($ctx !~ /.x[WEBC]/ &&
4408 $cc !~ /^\\/ && $cc !~ /^;/) {
4409 if (ERROR("SPACING",
4410 "space required after that '$op' $at\n" . $hereptr)) {
4411 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4412 $line_fixed = 1;
4413 }
4414 }
4415
4416 # // is a comment
4417 } elsif ($op eq '//') {
4418
4419 # : when part of a bitfield
4420 } elsif ($opv eq ':B') {
4421 # skip the bitfield test for now
4422
4423 # No spaces for:
4424 # ->
4425 } elsif ($op eq '->') {
4426 if ($ctx =~ /Wx.|.xW/) {
4427 if (ERROR("SPACING",
4428 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
4429 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4430 if (defined $fix_elements[$n + 2]) {
4431 $fix_elements[$n + 2] =~ s/^\s+//;
4432 }
4433 $line_fixed = 1;
4434 }
4435 }
4436
4437 # , must not have a space before and must have a space on the right.
4438 } elsif ($op eq ',') {
4439 my $rtrim_before = 0;
4440 my $space_after = 0;
4441 if ($ctx =~ /Wx./) {
4442 if (ERROR("SPACING",
4443 "space prohibited before that '$op' $at\n" . $hereptr)) {
4444 $line_fixed = 1;
4445 $rtrim_before = 1;
4446 }
4447 }
4448 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
4449 if (ERROR("SPACING",
4450 "space required after that '$op' $at\n" . $hereptr)) {
4451 $line_fixed = 1;
4452 $last_after = $n;
4453 $space_after = 1;
4454 }
4455 }
4456 if ($rtrim_before || $space_after) {
4457 if ($rtrim_before) {
4458 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4459 } else {
4460 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4461 }
4462 if ($space_after) {
4463 $good .= " ";
4464 }
4465 }
4466
4467 # '*' as part of a type definition -- reported already.
4468 } elsif ($opv eq '*_') {
4469 #warn "'*' is part of type\n";
4470
4471 # unary operators should have a space before and
4472 # none after. May be left adjacent to another
4473 # unary operator, or a cast
4474 } elsif ($op eq '!' || $op eq '~' ||
4475 $opv eq '*U' || $opv eq '-U' ||
4476 $opv eq '&U' || $opv eq '&&U') {
4477 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
4478 if (ERROR("SPACING",
4479 "space required before that '$op' $at\n" . $hereptr)) {
4480 if ($n != $last_after + 2) {
4481 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4482 $line_fixed = 1;
4483 }
4484 }
4485 }
4486 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
4487 # A unary '*' may be const
4488
4489 } elsif ($ctx =~ /.xW/) {
4490 if (ERROR("SPACING",
4491 "space prohibited after that '$op' $at\n" . $hereptr)) {
4492 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
4493 if (defined $fix_elements[$n + 2]) {
4494 $fix_elements[$n + 2] =~ s/^\s+//;
4495 }
4496 $line_fixed = 1;
4497 }
4498 }
4499
4500 # unary ++ and unary -- are allowed no space on one side.
4501 } elsif ($op eq '++' or $op eq '--') {
4502 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
4503 if (ERROR("SPACING",
4504 "space required one side of that '$op' $at\n" . $hereptr)) {
4505 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
4506 $line_fixed = 1;
4507 }
4508 }
4509 if ($ctx =~ /Wx[BE]/ ||
4510 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
4511 if (ERROR("SPACING",
4512 "space prohibited before that '$op' $at\n" . $hereptr)) {
4513 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4514 $line_fixed = 1;
4515 }
4516 }
4517 if ($ctx =~ /ExW/) {
4518 if (ERROR("SPACING",
4519 "space prohibited after that '$op' $at\n" . $hereptr)) {
4520 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4521 if (defined $fix_elements[$n + 2]) {
4522 $fix_elements[$n + 2] =~ s/^\s+//;
4523 }
4524 $line_fixed = 1;
4525 }
4526 }
4527
4528 # << and >> may either have or not have spaces both sides
4529 } elsif ($op eq '<<' or $op eq '>>' or
4530 $op eq '&' or $op eq '^' or $op eq '|' or
4531 $op eq '+' or $op eq '-' or
4532 $op eq '*' or $op eq '/' or
4533 $op eq '%')
4534 {
4535 if ($check) {
4536 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4537 if (CHK("SPACING",
4538 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4539 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4540 $fix_elements[$n + 2] =~ s/^\s+//;
4541 $line_fixed = 1;
4542 }
4543 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4544 if (CHK("SPACING",
4545 "space preferred before that '$op' $at\n" . $hereptr)) {
4546 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4547 $line_fixed = 1;
4548 }
4549 }
4550 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
4551 if (ERROR("SPACING",
4552 "need consistent spacing around '$op' $at\n" . $hereptr)) {
4553 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4554 if (defined $fix_elements[$n + 2]) {
4555 $fix_elements[$n + 2] =~ s/^\s+//;
4556 }
4557 $line_fixed = 1;
4558 }
4559 }
4560
4561 # A colon needs no spaces before when it is
4562 # terminating a case value or a label.
4563 } elsif ($opv eq ':C' || $opv eq ':L') {
4564 if ($ctx =~ /Wx./) {
4565 if (ERROR("SPACING",
4566 "space prohibited before that '$op' $at\n" . $hereptr)) {
4567 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4568 $line_fixed = 1;
4569 }
4570 }
4571
4572 # All the others need spaces both sides.
4573 } elsif ($ctx !~ /[EWC]x[CWE]/) {
4574 my $ok = 0;
4575
4576 # Ignore email addresses <foo@bar>
4577 if (($op eq '<' &&
4578 $cc =~ /^\S+\@\S+>/) ||
4579 ($op eq '>' &&
4580 $ca =~ /<\S+\@\S+$/))
4581 {
4582 $ok = 1;
4583 }
4584
4585 # for asm volatile statements
4586 # ignore a colon with another
4587 # colon immediately before or after
4588 if (($op eq ':') &&
4589 ($ca =~ /:$/ || $cc =~ /^:/)) {
4590 $ok = 1;
4591 }
4592
4593 # messages are ERROR, but ?: are CHK
4594 if ($ok == 0) {
4595 my $msg_level = \&ERROR;
4596 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4597
4598 if (&{$msg_level}("SPACING",
4599 "spaces required around that '$op' $at\n" . $hereptr)) {
4600 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4601 if (defined $fix_elements[$n + 2]) {
4602 $fix_elements[$n + 2] =~ s/^\s+//;
4603 }
4604 $line_fixed = 1;
4605 }
4606 }
4607 }
4608 $off += length($elements[$n + 1]);
4609
4610## print("n: <$n> GOOD: <$good>\n");
4611
4612 $fixed_line = $fixed_line . $good;
4613 }
4614
4615 if (($#elements % 2) == 0) {
4616 $fixed_line = $fixed_line . $fix_elements[$#elements];
4617 }
4618
4619 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4620 $fixed[$fixlinenr] = $fixed_line;
4621 }
4622
4623
4624 }
4625
4626# check for whitespace before a non-naked semicolon
4627 if ($line =~ /^\+.*\S\s+;\s*$/) {
4628 if (WARN("SPACING",
4629 "space prohibited before semicolon\n" . $herecurr) &&
4630 $fix) {
4631 1 while $fixed[$fixlinenr] =~
4632 s/^(\+.*\S)\s+;/$1;/;
4633 }
4634 }
4635
4636# check for multiple assignments
4637 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
4638 CHK("MULTIPLE_ASSIGNMENTS",
4639 "multiple assignments should be avoided\n" . $herecurr);
4640 }
4641
4642## # check for multiple declarations, allowing for a function declaration
4643## # continuation.
4644## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4645## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4646##
4647## # Remove any bracketed sections to ensure we do not
4648## # falsly report the parameters of functions.
4649## my $ln = $line;
4650## while ($ln =~ s/\([^\(\)]*\)//g) {
4651## }
4652## if ($ln =~ /,/) {
4653## WARN("MULTIPLE_DECLARATION",
4654## "declaring multiple variables together should be avoided\n" . $herecurr);
4655## }
4656## }
4657
4658#need space before brace following if, while, etc
4659 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
4660 $line =~ /\b(?:else|do)\{/) {
4661 if (ERROR("SPACING",
4662 "space required before the open brace '{'\n" . $herecurr) &&
4663 $fix) {
4664 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
4665 }
4666 }
4667
4668## # check for blank lines before declarations
4669## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4670## $prevrawline =~ /^.\s*$/) {
4671## WARN("SPACING",
4672## "No blank lines before declarations\n" . $hereprev);
4673## }
4674##
4675
4676# closing brace should have a space following it when it has anything
4677# on the line
4678 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
4679 if (ERROR("SPACING",
4680 "space required after that close brace '}'\n" . $herecurr) &&
4681 $fix) {
4682 $fixed[$fixlinenr] =~
4683 s/}((?!(?:,|;|\)))\S)/} $1/;
4684 }
4685 }
4686
4687# check spacing on square brackets
4688 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
4689 if (ERROR("SPACING",
4690 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4691 $fix) {
4692 $fixed[$fixlinenr] =~
4693 s/\[\s+/\[/;
4694 }
4695 }
4696 if ($line =~ /\s\]/) {
4697 if (ERROR("SPACING",
4698 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4699 $fix) {
4700 $fixed[$fixlinenr] =~
4701 s/\s+\]/\]/;
4702 }
4703 }
4704
4705# check spacing on parentheses
4706 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4707 $line !~ /for\s*\(\s+;/) {
4708 if (ERROR("SPACING",
4709 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4710 $fix) {
4711 $fixed[$fixlinenr] =~
4712 s/\(\s+/\(/;
4713 }
4714 }
4715 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
4716 $line !~ /for\s*\(.*;\s+\)/ &&
4717 $line !~ /:\s+\)/) {
4718 if (ERROR("SPACING",
4719 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4720 $fix) {
4721 $fixed[$fixlinenr] =~
4722 s/\s+\)/\)/;
4723 }
4724 }
4725
4726# check unnecessary parentheses around addressof/dereference single $Lvals
4727# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4728
4729 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
4730 my $var = $1;
4731 if (CHK("UNNECESSARY_PARENTHESES",
4732 "Unnecessary parentheses around $var\n" . $herecurr) &&
4733 $fix) {
4734 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4735 }
4736 }
4737
4738# check for unnecessary parentheses around function pointer uses
4739# ie: (foo->bar)(); should be foo->bar();
4740# but not "if (foo->bar) (" to avoid some false positives
4741 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4742 my $var = $2;
4743 if (CHK("UNNECESSARY_PARENTHESES",
4744 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4745 $fix) {
4746 my $var2 = deparenthesize($var);
4747 $var2 =~ s/\s//g;
4748 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4749 }
4750 }
4751
4752# check for unnecessary parentheses around comparisons in if uses
4753# when !drivers/staging or command-line uses --strict
4754 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4755 $perl_version_ok && defined($stat) &&
4756 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4757 my $if_stat = $1;
4758 my $test = substr($2, 1, -1);
4759 my $herectx;
4760 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4761 my $match = $1;
4762 # avoid parentheses around potential macro args
4763 next if ($match =~ /^\s*\w+\s*$/);
4764 if (!defined($herectx)) {
4765 $herectx = $here . "\n";
4766 my $cnt = statement_rawlines($if_stat);
4767 for (my $n = 0; $n < $cnt; $n++) {
4768 my $rl = raw_line($linenr, $n);
4769 $herectx .= $rl . "\n";
4770 last if $rl =~ /^[ \+].*\{/;
4771 }
4772 }
4773 CHK("UNNECESSARY_PARENTHESES",
4774 "Unnecessary parentheses around '$match'\n" . $herectx);
4775 }
4776 }
4777
4778#goto labels aren't indented, allow a single space however
4779 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
4780 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
4781 if (WARN("INDENTED_LABEL",
4782 "labels should not be indented\n" . $herecurr) &&
4783 $fix) {
4784 $fixed[$fixlinenr] =~
4785 s/^(.)\s+/$1/;
4786 }
4787 }
4788
4789# return is not a function
4790 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
4791 my $spacing = $1;
4792 if ($perl_version_ok &&
4793 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4794 my $value = $1;
4795 $value = deparenthesize($value);
4796 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4797 ERROR("RETURN_PARENTHESES",
4798 "return is not a function, parentheses are not required\n" . $herecurr);
4799 }
4800 } elsif ($spacing !~ /\s+/) {
4801 ERROR("SPACING",
4802 "space required before the open parenthesis '('\n" . $herecurr);
4803 }
4804 }
4805
4806# unnecessary return in a void function
4807# at end-of-function, with the previous line a single leading tab, then return;
4808# and the line before that not a goto label target like "out:"
4809 if ($sline =~ /^[ \+]}\s*$/ &&
4810 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4811 $linenr >= 3 &&
4812 $lines[$linenr - 3] =~ /^[ +]/ &&
4813 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
4814 WARN("RETURN_VOID",
4815 "void function return statements are not generally useful\n" . $hereprev);
4816 }
4817
4818# if statements using unnecessary parentheses - ie: if ((foo == bar))
4819 if ($perl_version_ok &&
4820 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4821 my $openparens = $1;
4822 my $count = $openparens =~ tr@\(@\(@;
4823 my $msg = "";
4824 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4825 my $comp = $4; #Not $1 because of $LvalOrFunc
4826 $msg = " - maybe == should be = ?" if ($comp eq "==");
4827 WARN("UNNECESSARY_PARENTHESES",
4828 "Unnecessary parentheses$msg\n" . $herecurr);
4829 }
4830 }
4831
4832# comparisons with a constant or upper case identifier on the left
4833# avoid cases like "foo + BAR < baz"
4834# only fix matches surrounded by parentheses to avoid incorrect
4835# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4836 if ($perl_version_ok &&
4837 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4838 my $lead = $1;
4839 my $const = $2;
4840 my $comp = $3;
4841 my $to = $4;
4842 my $newcomp = $comp;
4843 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
4844 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4845 WARN("CONSTANT_COMPARISON",
4846 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4847 $fix) {
4848 if ($comp eq "<") {
4849 $newcomp = ">";
4850 } elsif ($comp eq "<=") {
4851 $newcomp = ">=";
4852 } elsif ($comp eq ">") {
4853 $newcomp = "<";
4854 } elsif ($comp eq ">=") {
4855 $newcomp = "<=";
4856 }
4857 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4858 }
4859 }
4860
4861# Return of what appears to be an errno should normally be negative
4862 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
4863 my $name = $1;
4864 if ($name ne 'EOF' && $name ne 'ERROR') {
4865 WARN("USE_NEGATIVE_ERRNO",
4866 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
4867 }
4868 }
4869
4870# Need a space before open parenthesis after if, while etc
4871 if ($line =~ /\b(if|while|for|switch)\(/) {
4872 if (ERROR("SPACING",
4873 "space required before the open parenthesis '('\n" . $herecurr) &&
4874 $fix) {
4875 $fixed[$fixlinenr] =~
4876 s/\b(if|while|for|switch)\(/$1 \(/;
4877 }
4878 }
4879
4880# Check for illegal assignment in if conditional -- and check for trailing
4881# statements after the conditional.
4882 if ($line =~ /do\s*(?!{)/) {
4883 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4884 ctx_statement_block($linenr, $realcnt, 0)
4885 if (!defined $stat);
4886 my ($stat_next) = ctx_statement_block($line_nr_next,
4887 $remain_next, $off_next);
4888 $stat_next =~ s/\n./\n /g;
4889 ##print "stat<$stat> stat_next<$stat_next>\n";
4890
4891 if ($stat_next =~ /^\s*while\b/) {
4892 # If the statement carries leading newlines,
4893 # then count those as offsets.
4894 my ($whitespace) =
4895 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4896 my $offset =
4897 statement_rawlines($whitespace) - 1;
4898
4899 $suppress_whiletrailers{$line_nr_next +
4900 $offset} = 1;
4901 }
4902 }
4903 if (!defined $suppress_whiletrailers{$linenr} &&
4904 defined($stat) && defined($cond) &&
4905 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
4906 my ($s, $c) = ($stat, $cond);
4907
4908 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
4909 ERROR("ASSIGN_IN_IF",
4910 "do not use assignment in if condition\n" . $herecurr);
4911 }
4912
4913 # Find out what is on the end of the line after the
4914 # conditional.
4915 substr($s, 0, length($c), '');
4916 $s =~ s/\n.*//g;
4917 $s =~ s/$;//g; # Remove any comments
4918 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4919 $c !~ /}\s*while\s*/)
4920 {
4921 # Find out how long the conditional actually is.
4922 my @newlines = ($c =~ /\n/gs);
4923 my $cond_lines = 1 + $#newlines;
4924 my $stat_real = '';
4925
4926 $stat_real = raw_line($linenr, $cond_lines)
4927 . "\n" if ($cond_lines);
4928 if (defined($stat_real) && $cond_lines > 1) {
4929 $stat_real = "[...]\n$stat_real";
4930 }
4931
4932 ERROR("TRAILING_STATEMENTS",
4933 "trailing statements should be on next line\n" . $herecurr . $stat_real);
4934 }
4935 }
4936
4937# Check for bitwise tests written as boolean
4938 if ($line =~ /
4939 (?:
4940 (?:\[|\(|\&\&|\|\|)
4941 \s*0[xX][0-9]+\s*
4942 (?:\&\&|\|\|)
4943 |
4944 (?:\&\&|\|\|)
4945 \s*0[xX][0-9]+\s*
4946 (?:\&\&|\|\||\)|\])
4947 )/x)
4948 {
4949 WARN("HEXADECIMAL_BOOLEAN_TEST",
4950 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
4951 }
4952
4953# if and else should not have general statements after it
4954 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4955 my $s = $1;
4956 $s =~ s/$;//g; # Remove any comments
4957 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
4958 ERROR("TRAILING_STATEMENTS",
4959 "trailing statements should be on next line\n" . $herecurr);
4960 }
4961 }
4962# if should not continue a brace
4963 if ($line =~ /}\s*if\b/) {
4964 ERROR("TRAILING_STATEMENTS",
4965 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
4966 $herecurr);
4967 }
4968# case and default should not have general statements after them
4969 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4970 $line !~ /\G(?:
4971 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
4972 \s*return\s+
4973 )/xg)
4974 {
4975 ERROR("TRAILING_STATEMENTS",
4976 "trailing statements should be on next line\n" . $herecurr);
4977 }
4978
4979 # Check for }<nl>else {, these must be at the same
4980 # indent level to be relevant to each other.
4981 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4982 $previndent == $indent) {
4983 if (ERROR("ELSE_AFTER_BRACE",
4984 "else should follow close brace '}'\n" . $hereprev) &&
4985 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4986 fix_delete_line($fixlinenr - 1, $prevrawline);
4987 fix_delete_line($fixlinenr, $rawline);
4988 my $fixedline = $prevrawline;
4989 $fixedline =~ s/}\s*$//;
4990 if ($fixedline !~ /^\+\s*$/) {
4991 fix_insert_line($fixlinenr, $fixedline);
4992 }
4993 $fixedline = $rawline;
4994 $fixedline =~ s/^(.\s*)else/$1} else/;
4995 fix_insert_line($fixlinenr, $fixedline);
4996 }
4997 }
4998
4999 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5000 $previndent == $indent) {
5001 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5002
5003 # Find out what is on the end of the line after the
5004 # conditional.
5005 substr($s, 0, length($c), '');
5006 $s =~ s/\n.*//g;
5007
5008 if ($s =~ /^\s*;/) {
5009 if (ERROR("WHILE_AFTER_BRACE",
5010 "while should follow close brace '}'\n" . $hereprev) &&
5011 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5012 fix_delete_line($fixlinenr - 1, $prevrawline);
5013 fix_delete_line($fixlinenr, $rawline);
5014 my $fixedline = $prevrawline;
5015 my $trailing = $rawline;
5016 $trailing =~ s/^\+//;
5017 $trailing = trim($trailing);
5018 $fixedline =~ s/}\s*$/} $trailing/;
5019 fix_insert_line($fixlinenr, $fixedline);
5020 }
5021 }
5022 }
5023
5024#Specific variable tests
5025 while ($line =~ m{($Constant|$Lval)}g) {
5026 my $var = $1;
5027
5028#CamelCase
5029 if ($var !~ /^$Constant$/ &&
5030 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5031#Ignore Page<foo> variants
5032 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5033#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
5034 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
5035#Ignore some three character SI units explicitly, like MiB and KHz
5036 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5037 while ($var =~ m{($Ident)}g) {
5038 my $word = $1;
5039 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5040 if ($check) {
5041 seed_camelcase_includes();
5042 if (!$file && !$camelcase_file_seeded) {
5043 seed_camelcase_file($realfile);
5044 $camelcase_file_seeded = 1;
5045 }
5046 }
5047 if (!defined $camelcase{$word}) {
5048 $camelcase{$word} = 1;
5049 CHK("CAMELCASE",
5050 "Avoid CamelCase: <$word>\n" . $herecurr);
5051 }
5052 }
5053 }
5054 }
5055
5056#no spaces allowed after \ in define
5057 if ($line =~ /\#\s*define.*\\\s+$/) {
5058 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5059 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5060 $fix) {
5061 $fixed[$fixlinenr] =~ s/\s+$//;
5062 }
5063 }
5064
5065# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5066# itself <asm/foo.h> (uses RAW line)
5067 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5068 my $file = "$1.h";
5069 my $checkfile = "include/linux/$file";
5070 if (-f "$root/$checkfile" &&
5071 $realfile ne $checkfile &&
5072 $1 !~ /$allowed_asm_includes/)
5073 {
5074 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5075 if ($asminclude > 0) {
5076 if ($realfile =~ m{^arch/}) {
5077 CHK("ARCH_INCLUDE_LINUX",
5078 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5079 } else {
5080 WARN("INCLUDE_LINUX",
5081 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5082 }
5083 }
5084 }
5085 }
5086
5087# multi-statement macros should be enclosed in a do while loop, grab the
5088# first statement and ensure its the whole macro if its not enclosed
5089# in a known good container
5090 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5091 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5092 my $ln = $linenr;
5093 my $cnt = $realcnt;
5094 my ($off, $dstat, $dcond, $rest);
5095 my $ctx = '';
5096 my $has_flow_statement = 0;
5097 my $has_arg_concat = 0;
5098 ($dstat, $dcond, $ln, $cnt, $off) =
5099 ctx_statement_block($linenr, $realcnt, 0);
5100 $ctx = $dstat;
5101 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5102 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5103
5104 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5105 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5106
5107 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5108 my $define_args = $1;
5109 my $define_stmt = $dstat;
5110 my @def_args = ();
5111
5112 if (defined $define_args && $define_args ne "") {
5113 $define_args = substr($define_args, 1, length($define_args) - 2);
5114 $define_args =~ s/\s*//g;
5115 $define_args =~ s/\\\+?//g;
5116 @def_args = split(",", $define_args);
5117 }
5118
5119 $dstat =~ s/$;//g;
5120 $dstat =~ s/\\\n.//g;
5121 $dstat =~ s/^\s*//s;
5122 $dstat =~ s/\s*$//s;
5123
5124 # Flatten any parentheses and braces
5125 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5126 $dstat =~ s/\{[^\{\}]*\}/1/ ||
5127 $dstat =~ s/.\[[^\[\]]*\]/1/)
5128 {
5129 }
5130
5131 # Flatten any obvious string concatentation.
5132 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5133 $dstat =~ s/$Ident\s*($String)/$1/)
5134 {
5135 }
5136
5137 # Make asm volatile uses seem like a generic function
5138 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5139
5140 my $exceptions = qr{
5141 $Declare|
5142 module_param_named|
5143 MODULE_PARM_DESC|
5144 DECLARE_PER_CPU|
5145 DEFINE_PER_CPU|
5146 __typeof__\(|
5147 union|
5148 struct|
5149 \.$Ident\s*=\s*|
5150 ^\"|\"$|
5151 ^\[
5152 }x;
5153 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5154
5155 $ctx =~ s/\n*$//;
5156 my $stmt_cnt = statement_rawlines($ctx);
5157 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5158
5159 if ($dstat ne '' &&
5160 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5161 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5162 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5163 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5164 $dstat !~ /$exceptions/ &&
5165 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5166 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5167 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5168 $dstat !~ /^for\s*$Constant$/ && # for (...)
5169 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5170 $dstat !~ /^do\s*{/ && # do {...
5171 $dstat !~ /^\(\{/ && # ({...
5172 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5173 {
5174 if ($dstat =~ /^\s*if\b/) {
5175 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5176 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5177 } elsif ($dstat =~ /;/) {
5178 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5179 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5180 } else {
5181 ERROR("COMPLEX_MACRO",
5182 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
5183 }
5184
5185 }
5186
5187 # Make $define_stmt single line, comment-free, etc
5188 my @stmt_array = split('\n', $define_stmt);
5189 my $first = 1;
5190 $define_stmt = "";
5191 foreach my $l (@stmt_array) {
5192 $l =~ s/\\$//;
5193 if ($first) {
5194 $define_stmt = $l;
5195 $first = 0;
5196 } elsif ($l =~ /^[\+ ]/) {
5197 $define_stmt .= substr($l, 1);
5198 }
5199 }
5200 $define_stmt =~ s/$;//g;
5201 $define_stmt =~ s/\s+/ /g;
5202 $define_stmt = trim($define_stmt);
5203
5204# check if any macro arguments are reused (ignore '...' and 'type')
5205 foreach my $arg (@def_args) {
5206 next if ($arg =~ /\.\.\./);
5207 next if ($arg =~ /^type$/i);
5208 my $tmp_stmt = $define_stmt;
5209 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5210 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5211 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5212 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
5213 if ($use_cnt > 1) {
5214 CHK("MACRO_ARG_REUSE",
5215 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
5216 }
5217# check if any macro arguments may have other precedence issues
5218 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
5219 ((defined($1) && $1 ne ',') ||
5220 (defined($2) && $2 ne ','))) {
5221 CHK("MACRO_ARG_PRECEDENCE",
5222 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
5223 }
5224 }
5225
5226# check for macros with flow control, but without ## concatenation
5227# ## concatenation is commonly a macro that defines a function so ignore those
5228 if ($has_flow_statement && !$has_arg_concat) {
5229 my $cnt = statement_rawlines($ctx);
5230 my $herectx = get_stat_here($linenr, $cnt, $here);
5231
5232 WARN("MACRO_WITH_FLOW_CONTROL",
5233 "Macros with flow control statements should be avoided\n" . "$herectx");
5234 }
5235
5236# check for line continuations outside of #defines, preprocessor #, and asm
5237
5238 } else {
5239 if ($prevline !~ /^..*\\$/ &&
5240 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5241 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
5242 $line =~ /^\+.*\\$/) {
5243 WARN("LINE_CONTINUATIONS",
5244 "Avoid unnecessary line continuations\n" . $herecurr);
5245 }
5246 }
5247
5248# do {} while (0) macro tests:
5249# single-statement macros do not need to be enclosed in do while (0) loop,
5250# macro should not end with a semicolon
5251 if ($perl_version_ok &&
5252 $realfile !~ m@/vmlinux.lds.h$@ &&
5253 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5254 my $ln = $linenr;
5255 my $cnt = $realcnt;
5256 my ($off, $dstat, $dcond, $rest);
5257 my $ctx = '';
5258 ($dstat, $dcond, $ln, $cnt, $off) =
5259 ctx_statement_block($linenr, $realcnt, 0);
5260 $ctx = $dstat;
5261
5262 $dstat =~ s/\\\n.//g;
5263 $dstat =~ s/$;/ /g;
5264
5265 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5266 my $stmts = $2;
5267 my $semis = $3;
5268
5269 $ctx =~ s/\n*$//;
5270 my $cnt = statement_rawlines($ctx);
5271 my $herectx = get_stat_here($linenr, $cnt, $here);
5272
5273 if (($stmts =~ tr/;/;/) == 1 &&
5274 $stmts !~ /^\s*(if|while|for|switch)\b/) {
5275 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5276 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5277 }
5278 if (defined $semis && $semis ne "") {
5279 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5280 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5281 }
5282 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5283 $ctx =~ s/\n*$//;
5284 my $cnt = statement_rawlines($ctx);
5285 my $herectx = get_stat_here($linenr, $cnt, $here);
5286
5287 WARN("TRAILING_SEMICOLON",
5288 "macros should not use a trailing semicolon\n" . "$herectx");
5289 }
5290 }
5291
5292# check for redundant bracing round if etc
5293 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5294 my ($level, $endln, @chunks) =
5295 ctx_statement_full($linenr, $realcnt, 1);
5296 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5297 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5298 if ($#chunks > 0 && $level == 0) {
5299 my @allowed = ();
5300 my $allow = 0;
5301 my $seen = 0;
5302 my $herectx = $here . "\n";
5303 my $ln = $linenr - 1;
5304 for my $chunk (@chunks) {
5305 my ($cond, $block) = @{$chunk};
5306
5307 # If the condition carries leading newlines, then count those as offsets.
5308 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5309 my $offset = statement_rawlines($whitespace) - 1;
5310
5311 $allowed[$allow] = 0;
5312 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5313
5314 # We have looked at and allowed this specific line.
5315 $suppress_ifbraces{$ln + $offset} = 1;
5316
5317 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
5318 $ln += statement_rawlines($block) - 1;
5319
5320 substr($block, 0, length($cond), '');
5321
5322 $seen++ if ($block =~ /^\s*{/);
5323
5324 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5325 if (statement_lines($cond) > 1) {
5326 #print "APW: ALLOWED: cond<$cond>\n";
5327 $allowed[$allow] = 1;
5328 }
5329 if ($block =~/\b(?:if|for|while)\b/) {
5330 #print "APW: ALLOWED: block<$block>\n";
5331 $allowed[$allow] = 1;
5332 }
5333 if (statement_block_size($block) > 1) {
5334 #print "APW: ALLOWED: lines block<$block>\n";
5335 $allowed[$allow] = 1;
5336 }
5337 $allow++;
5338 }
5339 if ($seen) {
5340 my $sum_allowed = 0;
5341 foreach (@allowed) {
5342 $sum_allowed += $_;
5343 }
5344 if ($sum_allowed == 0) {
5345 WARN("BRACES",
5346 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5347 } elsif ($sum_allowed != $allow &&
5348 $seen != $allow) {
5349 CHK("BRACES",
5350 "braces {} should be used on all arms of this statement\n" . $herectx);
5351 }
5352 }
5353 }
5354 }
5355 if (!defined $suppress_ifbraces{$linenr - 1} &&
5356 $line =~ /\b(if|while|for|else)\b/) {
5357 my $allowed = 0;
5358
5359 # Check the pre-context.
5360 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5361 #print "APW: ALLOWED: pre<$1>\n";
5362 $allowed = 1;
5363 }
5364
5365 my ($level, $endln, @chunks) =
5366 ctx_statement_full($linenr, $realcnt, $-[0]);
5367
5368 # Check the condition.
5369 my ($cond, $block) = @{$chunks[0]};
5370 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5371 if (defined $cond) {
5372 substr($block, 0, length($cond), '');
5373 }
5374 if (statement_lines($cond) > 1) {
5375 #print "APW: ALLOWED: cond<$cond>\n";
5376 $allowed = 1;
5377 }
5378 if ($block =~/\b(?:if|for|while)\b/) {
5379 #print "APW: ALLOWED: block<$block>\n";
5380 $allowed = 1;
5381 }
5382 if (statement_block_size($block) > 1) {
5383 #print "APW: ALLOWED: lines block<$block>\n";
5384 $allowed = 1;
5385 }
5386 # Check the post-context.
5387 if (defined $chunks[1]) {
5388 my ($cond, $block) = @{$chunks[1]};
5389 if (defined $cond) {
5390 substr($block, 0, length($cond), '');
5391 }
5392 if ($block =~ /^\s*\{/) {
5393 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5394 $allowed = 1;
5395 }
5396 }
5397 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5398 my $cnt = statement_rawlines($block);
5399 my $herectx = get_stat_here($linenr, $cnt, $here);
5400
5401 WARN("BRACES",
5402 "braces {} are not necessary for single statement blocks\n" . $herectx);
5403 }
5404 }
5405
5406# check for single line unbalanced braces
5407 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5408 $sline =~ /^.\s*else\s*\{\s*$/) {
5409 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5410 }
5411
5412# check for unnecessary blank lines around braces
5413 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
5414 if (CHK("BRACES",
5415 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5416 $fix && $prevrawline =~ /^\+/) {
5417 fix_delete_line($fixlinenr - 1, $prevrawline);
5418 }
5419 }
5420 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
5421 if (CHK("BRACES",
5422 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5423 $fix) {
5424 fix_delete_line($fixlinenr, $rawline);
5425 }
5426 }
5427
5428# no volatiles please
5429 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5430 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
5431 WARN("VOLATILE",
5432 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5433 }
5434
5435# Check for user-visible strings broken across lines, which breaks the ability
5436# to grep for the string. Make exceptions when the previous string ends in a
5437# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5438# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5439 if ($line =~ /^\+\s*$String/ &&
5440 $prevline =~ /"\s*$/ &&
5441 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5442 if (WARN("SPLIT_STRING",
5443 "quoted string split across lines\n" . $hereprev) &&
5444 $fix &&
5445 $prevrawline =~ /^\+.*"\s*$/ &&
5446 $last_coalesced_string_linenr != $linenr - 1) {
5447 my $extracted_string = get_quoted_string($line, $rawline);
5448 my $comma_close = "";
5449 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5450 $comma_close = $1;
5451 }
5452
5453 fix_delete_line($fixlinenr - 1, $prevrawline);
5454 fix_delete_line($fixlinenr, $rawline);
5455 my $fixedline = $prevrawline;
5456 $fixedline =~ s/"\s*$//;
5457 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5458 fix_insert_line($fixlinenr - 1, $fixedline);
5459 $fixedline = $rawline;
5460 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5461 if ($fixedline !~ /\+\s*$/) {
5462 fix_insert_line($fixlinenr, $fixedline);
5463 }
5464 $last_coalesced_string_linenr = $linenr;
5465 }
5466 }
5467
5468# check for missing a space in a string concatenation
5469 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5470 WARN('MISSING_SPACE',
5471 "break quoted strings at a space character\n" . $hereprev);
5472 }
5473
5474# check for an embedded function name in a string when the function is known
5475# This does not work very well for -f --file checking as it depends on patch
5476# context providing the function name or a single line form for in-file
5477# function declarations
5478 if ($line =~ /^\+.*$String/ &&
5479 defined($context_function) &&
5480 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5481 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
5482 WARN("EMBEDDED_FUNCTION_NAME",
5483 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5484 }
5485
5486# check for spaces before a quoted newline
5487 if ($rawline =~ /^.*\".*\s\\n/) {
5488 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5489 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5490 $fix) {
5491 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5492 }
5493
5494 }
5495
5496# concatenated string without spaces between elements
5497 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5498 if (CHK("CONCATENATED_STRING",
5499 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5500 $fix) {
5501 while ($line =~ /($String)/g) {
5502 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5503 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5504 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5505 }
5506 }
5507 }
5508
5509# uncoalesced string fragments
5510 if ($line =~ /$String\s*"/) {
5511 if (WARN("STRING_FRAGMENTS",
5512 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5513 $fix) {
5514 while ($line =~ /($String)(?=\s*")/g) {
5515 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5516 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5517 }
5518 }
5519 }
5520
5521# check for non-standard and hex prefixed decimal printf formats
5522 my $show_L = 1; #don't show the same defect twice
5523 my $show_Z = 1;
5524 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5525 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
5526 $string =~ s/%%/__/g;
5527 # check for %L
5528 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
5529 WARN("PRINTF_L",
5530 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5531 $show_L = 0;
5532 }
5533 # check for %Z
5534 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5535 WARN("PRINTF_Z",
5536 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5537 $show_Z = 0;
5538 }
5539 # check for 0x<decimal>
5540 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5541 ERROR("PRINTF_0XDECIMAL",
5542 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5543 }
5544 }
5545
5546# check for line continuations in quoted strings with odd counts of "
5547 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
5548 WARN("LINE_CONTINUATIONS",
5549 "Avoid line continuations in quoted strings\n" . $herecurr);
5550 }
5551
5552# warn about #if 0
5553 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
5554 WARN("IF_0",
5555 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5556 }
5557
5558# warn about #if 1
5559 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5560 WARN("IF_1",
5561 "Consider removing the #if 1 and its #endif\n" . $herecurr);
5562 }
5563
5564# check for needless "if (<foo>) fn(<foo>)" uses
5565 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
5566 my $tested = quotemeta($1);
5567 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5568 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5569 my $func = $1;
5570 if (WARN('NEEDLESS_IF',
5571 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5572 $fix) {
5573 my $do_fix = 1;
5574 my $leading_tabs = "";
5575 my $new_leading_tabs = "";
5576 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5577 $leading_tabs = $1;
5578 } else {
5579 $do_fix = 0;
5580 }
5581 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5582 $new_leading_tabs = $1;
5583 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5584 $do_fix = 0;
5585 }
5586 } else {
5587 $do_fix = 0;
5588 }
5589 if ($do_fix) {
5590 fix_delete_line($fixlinenr - 1, $prevrawline);
5591 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5592 }
5593 }
5594 }
5595 }
5596
5597# check for unnecessary "Out of Memory" messages
5598 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5599 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5600 (defined $1 || defined $3) &&
5601 $linenr > 3) {
5602 my $testval = $2;
5603 my $testline = $lines[$linenr - 3];
5604
5605 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5606# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5607
5608 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5609 $s !~ /\b__GFP_NOWARN\b/ ) {
5610 WARN("OOM_MESSAGE",
5611 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5612 }
5613 }
5614
5615# check for logging functions with KERN_<LEVEL>
5616 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
5617 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5618 my $level = $1;
5619 if (WARN("UNNECESSARY_KERN_LEVEL",
5620 "Possible unnecessary $level\n" . $herecurr) &&
5621 $fix) {
5622 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5623 }
5624 }
5625
5626# check for logging continuations
5627 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5628 WARN("LOGGING_CONTINUATION",
5629 "Avoid logging continuation uses where feasible\n" . $herecurr);
5630 }
5631
5632# check for mask then right shift without a parentheses
5633 if ($perl_version_ok &&
5634 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5635 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5636 WARN("MASK_THEN_SHIFT",
5637 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5638 }
5639
5640# check for pointer comparisons to NULL
5641 if ($perl_version_ok) {
5642 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5643 my $val = $1;
5644 my $equal = "!";
5645 $equal = "" if ($4 eq "!=");
5646 if (CHK("COMPARISON_TO_NULL",
5647 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5648 $fix) {
5649 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5650 }
5651 }
5652 }
5653
5654# check for bad placement of section $InitAttribute (e.g.: __initdata)
5655 if ($line =~ /(\b$InitAttribute\b)/) {
5656 my $attr = $1;
5657 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5658 my $ptr = $1;
5659 my $var = $2;
5660 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5661 ERROR("MISPLACED_INIT",
5662 "$attr should be placed after $var\n" . $herecurr)) ||
5663 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5664 WARN("MISPLACED_INIT",
5665 "$attr should be placed after $var\n" . $herecurr))) &&
5666 $fix) {
5667 $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;
5668 }
5669 }
5670 }
5671
5672# check for $InitAttributeData (ie: __initdata) with const
5673 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5674 my $attr = $1;
5675 $attr =~ /($InitAttributePrefix)(.*)/;
5676 my $attr_prefix = $1;
5677 my $attr_type = $2;
5678 if (ERROR("INIT_ATTRIBUTE",
5679 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5680 $fix) {
5681 $fixed[$fixlinenr] =~
5682 s/$InitAttributeData/${attr_prefix}initconst/;
5683 }
5684 }
5685
5686# check for $InitAttributeConst (ie: __initconst) without const
5687 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5688 my $attr = $1;
5689 if (ERROR("INIT_ATTRIBUTE",
5690 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5691 $fix) {
5692 my $lead = $fixed[$fixlinenr] =~
5693 /(^\+\s*(?:static\s+))/;
5694 $lead = rtrim($1);
5695 $lead = "$lead " if ($lead !~ /^\+$/);
5696 $lead = "${lead}const ";
5697 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
5698 }
5699 }
5700
5701# check for __read_mostly with const non-pointer (should just be const)
5702 if ($line =~ /\b__read_mostly\b/ &&
5703 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5704 if (ERROR("CONST_READ_MOSTLY",
5705 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5706 $fix) {
5707 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5708 }
5709 }
5710
5711# don't use __constant_<foo> functions outside of include/uapi/
5712 if ($realfile !~ m@^include/uapi/@ &&
5713 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5714 my $constant_func = $1;
5715 my $func = $constant_func;
5716 $func =~ s/^__constant_//;
5717 if (WARN("CONSTANT_CONVERSION",
5718 "$constant_func should be $func\n" . $herecurr) &&
5719 $fix) {
5720 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
5721 }
5722 }
5723
5724# prefer usleep_range over udelay
5725 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
5726 my $delay = $1;
5727 # ignore udelay's < 10, however
5728 if (! ($delay < 10) ) {
5729 CHK("USLEEP_RANGE",
5730 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5731 }
5732 if ($delay > 2000) {
5733 WARN("LONG_UDELAY",
5734 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
5735 }
5736 }
5737
5738# warn about unexpectedly long msleep's
5739 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5740 if ($1 < 20) {
5741 WARN("MSLEEP",
5742 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5743 }
5744 }
5745
5746# check for comparisons of jiffies
5747 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5748 WARN("JIFFIES_COMPARISON",
5749 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5750 }
5751
5752# check for comparisons of get_jiffies_64()
5753 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5754 WARN("JIFFIES_COMPARISON",
5755 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5756 }
5757
5758# warn about #ifdefs in C files
5759# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5760# print "#ifdef in C files should be avoided\n";
5761# print "$herecurr";
5762# $clean = 0;
5763# }
5764
5765# warn about spacing in #ifdefs
5766 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
5767 if (ERROR("SPACING",
5768 "exactly one space required after that #$1\n" . $herecurr) &&
5769 $fix) {
5770 $fixed[$fixlinenr] =~
5771 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5772 }
5773
5774 }
5775
5776# check for spinlock_t definitions without a comment.
5777 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5778 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
5779 my $which = $1;
5780 if (!ctx_has_comment($first_line, $linenr)) {
5781 CHK("UNCOMMENTED_DEFINITION",
5782 "$1 definition without comment\n" . $herecurr);
5783 }
5784 }
5785# check for memory barriers without a comment.
5786
5787 my $barriers = qr{
5788 mb|
5789 rmb|
5790 wmb|
5791 read_barrier_depends
5792 }x;
5793 my $barrier_stems = qr{
5794 mb__before_atomic|
5795 mb__after_atomic|
5796 store_release|
5797 load_acquire|
5798 store_mb|
5799 (?:$barriers)
5800 }x;
5801 my $all_barriers = qr{
5802 (?:$barriers)|
5803 smp_(?:$barrier_stems)|
5804 virt_(?:$barrier_stems)
5805 }x;
5806
5807 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
5808 if (!ctx_has_comment($first_line, $linenr)) {
5809 WARN("MEMORY_BARRIER",
5810 "memory barrier without comment\n" . $herecurr);
5811 }
5812 }
5813
5814 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5815
5816 if ($realfile !~ m@^include/asm-generic/@ &&
5817 $realfile !~ m@/barrier\.h$@ &&
5818 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5819 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5820 WARN("MEMORY_BARRIER",
5821 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5822 }
5823
5824# check for waitqueue_active without a comment.
5825 if ($line =~ /\bwaitqueue_active\s*\(/) {
5826 if (!ctx_has_comment($first_line, $linenr)) {
5827 WARN("WAITQUEUE_ACTIVE",
5828 "waitqueue_active without comment\n" . $herecurr);
5829 }
5830 }
5831
5832# check for smp_read_barrier_depends and read_barrier_depends
5833 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5834 WARN("READ_BARRIER_DEPENDS",
5835 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5836 }
5837
5838# check of hardware specific defines
5839 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5840 CHK("ARCH_DEFINES",
5841 "architecture specific defines should be avoided\n" . $herecurr);
5842 }
5843
5844# check that the storage class is not after a type
5845 if ($line =~ /\b($Type)\s+($Storage)\b/) {
5846 WARN("STORAGE_CLASS",
5847 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5848 }
5849# Check that the storage class is at the beginning of a declaration
5850 if ($line =~ /\b$Storage\b/ &&
5851 $line !~ /^.\s*$Storage/ &&
5852 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5853 $1 !~ /[\,\)]\s*$/) {
5854 WARN("STORAGE_CLASS",
5855 "storage class should be at the beginning of the declaration\n" . $herecurr);
5856 }
5857
5858# check the location of the inline attribute, that it is between
5859# storage class and type.
5860 if ($line =~ /\b$Type\s+$Inline\b/ ||
5861 $line =~ /\b$Inline\s+$Storage\b/) {
5862 ERROR("INLINE_LOCATION",
5863 "inline keyword should sit between storage class and type\n" . $herecurr);
5864 }
5865
5866# Check for __inline__ and __inline, prefer inline
5867 if ($realfile !~ m@\binclude/uapi/@ &&
5868 $line =~ /\b(__inline__|__inline)\b/) {
5869 if (WARN("INLINE",
5870 "plain inline is preferred over $1\n" . $herecurr) &&
5871 $fix) {
5872 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
5873
5874 }
5875 }
5876
5877# Check for __attribute__ packed, prefer __packed
5878 if ($realfile !~ m@\binclude/uapi/@ &&
5879 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
5880 WARN("PREFER_PACKED",
5881 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
5882 }
5883
5884# Check for __attribute__ aligned, prefer __aligned
5885 if ($realfile !~ m@\binclude/uapi/@ &&
5886 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
5887 WARN("PREFER_ALIGNED",
5888 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
5889 }
5890
5891# Check for __attribute__ section, prefer __section
5892 if ($realfile !~ m@\binclude/uapi/@ &&
5893 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
5894 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
5895 my $new = substr($old, 1, -1);
5896 if (WARN("PREFER_SECTION",
5897 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
5898 $fix) {
5899 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5900 }
5901 }
5902
5903# Check for __attribute__ format(printf, prefer __printf
5904 if ($realfile !~ m@\binclude/uapi/@ &&
5905 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
5906 if (WARN("PREFER_PRINTF",
5907 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5908 $fix) {
5909 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5910
5911 }
5912 }
5913
5914# Check for __attribute__ format(scanf, prefer __scanf
5915 if ($realfile !~ m@\binclude/uapi/@ &&
5916 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
5917 if (WARN("PREFER_SCANF",
5918 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5919 $fix) {
5920 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5921 }
5922 }
5923
5924# Check for __attribute__ weak, or __weak declarations (may have link issues)
5925 if ($perl_version_ok &&
5926 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5927 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5928 $line =~ /\b__weak\b/)) {
5929 ERROR("WEAK_DECLARATION",
5930 "Using weak declarations can have unintended link defects\n" . $herecurr);
5931 }
5932
5933# check for c99 types like uint8_t used outside of uapi/ and tools/
5934 if ($realfile !~ m@\binclude/uapi/@ &&
5935 $realfile !~ m@\btools/@ &&
5936 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5937 my $type = $1;
5938 if ($type =~ /\b($typeC99Typedefs)\b/) {
5939 $type = $1;
5940 my $kernel_type = 'u';
5941 $kernel_type = 's' if ($type =~ /^_*[si]/);
5942 $type =~ /(\d+)/;
5943 $kernel_type .= $1;
5944 if (CHK("PREFER_KERNEL_TYPES",
5945 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5946 $fix) {
5947 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5948 }
5949 }
5950 }
5951
5952# check for cast of C90 native int or longer types constants
5953 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5954 my $cast = $1;
5955 my $const = $2;
5956 if (WARN("TYPECAST_INT_CONSTANT",
5957 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5958 $fix) {
5959 my $suffix = "";
5960 my $newconst = $const;
5961 $newconst =~ s/${Int_type}$//;
5962 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5963 if ($cast =~ /\blong\s+long\b/) {
5964 $suffix .= 'LL';
5965 } elsif ($cast =~ /\blong\b/) {
5966 $suffix .= 'L';
5967 }
5968 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5969 }
5970 }
5971
5972# check for sizeof(&)
5973 if ($line =~ /\bsizeof\s*\(\s*\&/) {
5974 WARN("SIZEOF_ADDRESS",
5975 "sizeof(& should be avoided\n" . $herecurr);
5976 }
5977
5978# check for sizeof without parenthesis
5979 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
5980 if (WARN("SIZEOF_PARENTHESIS",
5981 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5982 $fix) {
5983 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5984 }
5985 }
5986
5987# check for struct spinlock declarations
5988 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5989 WARN("USE_SPINLOCK_T",
5990 "struct spinlock should be spinlock_t\n" . $herecurr);
5991 }
5992
5993# check for seq_printf uses that could be seq_puts
5994 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
5995 my $fmt = get_quoted_string($line, $rawline);
5996 $fmt =~ s/%%//g;
5997 if ($fmt !~ /%/) {
5998 if (WARN("PREFER_SEQ_PUTS",
5999 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6000 $fix) {
6001 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6002 }
6003 }
6004 }
6005
6006# check for vsprintf extension %p<foo> misuses
6007 if ($perl_version_ok &&
6008 defined $stat &&
6009 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6010 $1 !~ /^_*volatile_*$/) {
6011 my $stat_real;
6012
6013 my $lc = $stat =~ tr@\n@@;
6014 $lc = $lc + $linenr;
6015 for (my $count = $linenr; $count <= $lc; $count++) {
6016 my $specifier;
6017 my $extension;
6018 my $bad_specifier = "";
6019 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6020 $fmt =~ s/%%//g;
6021
6022 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
6023 $specifier = $1;
6024 $extension = $2;
6025 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxt]/) {
6026 $bad_specifier = $specifier;
6027 last;
6028 }
6029 if ($extension eq "x" && !defined($stat_real)) {
6030 if (!defined($stat_real)) {
6031 $stat_real = get_stat_real($linenr, $lc);
6032 }
6033 WARN("VSPRINTF_SPECIFIER_PX",
6034 "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");
6035 }
6036 }
6037 if ($bad_specifier ne "") {
6038 my $stat_real = get_stat_real($linenr, $lc);
6039 my $ext_type = "Invalid";
6040 my $use = "";
6041 if ($bad_specifier =~ /p[Ff]/) {
6042 $ext_type = "Deprecated";
6043 $use = " - use %pS instead";
6044 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6045 }
6046
6047 WARN("VSPRINTF_POINTER_EXTENSION",
6048 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6049 }
6050 }
6051 }
6052
6053# Check for misused memsets
6054 if ($perl_version_ok &&
6055 defined $stat &&
6056 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6057
6058 my $ms_addr = $2;
6059 my $ms_val = $7;
6060 my $ms_size = $12;
6061
6062 if ($ms_size =~ /^(0x|)0$/i) {
6063 ERROR("MEMSET",
6064 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6065 } elsif ($ms_size =~ /^(0x|)1$/i) {
6066 WARN("MEMSET",
6067 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6068 }
6069 }
6070
6071# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6072# if ($perl_version_ok &&
6073# defined $stat &&
6074# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6075# if (WARN("PREFER_ETHER_ADDR_COPY",
6076# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6077# $fix) {
6078# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6079# }
6080# }
6081
6082# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6083# if ($perl_version_ok &&
6084# defined $stat &&
6085# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6086# WARN("PREFER_ETHER_ADDR_EQUAL",
6087# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6088# }
6089
6090# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6091# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6092# if ($perl_version_ok &&
6093# defined $stat &&
6094# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6095#
6096# my $ms_val = $7;
6097#
6098# if ($ms_val =~ /^(?:0x|)0+$/i) {
6099# if (WARN("PREFER_ETH_ZERO_ADDR",
6100# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6101# $fix) {
6102# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6103# }
6104# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6105# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6106# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6107# $fix) {
6108# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6109# }
6110# }
6111# }
6112
6113# typecasts on min/max could be min_t/max_t
6114 if ($perl_version_ok &&
6115 defined $stat &&
6116 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
6117 if (defined $2 || defined $7) {
6118 my $call = $1;
6119 my $cast1 = deparenthesize($2);
6120 my $arg1 = $3;
6121 my $cast2 = deparenthesize($7);
6122 my $arg2 = $8;
6123 my $cast;
6124
6125 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
6126 $cast = "$cast1 or $cast2";
6127 } elsif ($cast1 ne "") {
6128 $cast = $cast1;
6129 } else {
6130 $cast = $cast2;
6131 }
6132 WARN("MINMAX",
6133 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
6134 }
6135 }
6136
6137# check usleep_range arguments
6138 if ($perl_version_ok &&
6139 defined $stat &&
6140 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6141 my $min = $1;
6142 my $max = $7;
6143 if ($min eq $max) {
6144 WARN("USLEEP_RANGE",
6145 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6146 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6147 $min > $max) {
6148 WARN("USLEEP_RANGE",
6149 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6150 }
6151 }
6152
6153# check for naked sscanf
6154 if ($perl_version_ok &&
6155 defined $stat &&
6156 $line =~ /\bsscanf\b/ &&
6157 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6158 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6159 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6160 my $lc = $stat =~ tr@\n@@;
6161 $lc = $lc + $linenr;
6162 my $stat_real = get_stat_real($linenr, $lc);
6163 WARN("NAKED_SSCANF",
6164 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6165 }
6166
6167# check for simple sscanf that should be kstrto<foo>
6168 if ($perl_version_ok &&
6169 defined $stat &&
6170 $line =~ /\bsscanf\b/) {
6171 my $lc = $stat =~ tr@\n@@;
6172 $lc = $lc + $linenr;
6173 my $stat_real = get_stat_real($linenr, $lc);
6174 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6175 my $format = $6;
6176 my $count = $format =~ tr@%@%@;
6177 if ($count == 1 &&
6178 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6179 WARN("SSCANF_TO_KSTRTO",
6180 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6181 }
6182 }
6183 }
6184
6185# check for new externs in .h files.
6186 if ($realfile =~ /\.h$/ &&
6187 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
6188 if (CHK("AVOID_EXTERNS",
6189 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
6190 $fix) {
6191 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
6192 }
6193 }
6194
6195# check for new externs in .c files.
6196 if ($realfile =~ /\.c$/ && defined $stat &&
6197 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
6198 {
6199 my $function_name = $1;
6200 my $paren_space = $2;
6201
6202 my $s = $stat;
6203 if (defined $cond) {
6204 substr($s, 0, length($cond), '');
6205 }
6206 if ($s =~ /^\s*;/ &&
6207 $function_name ne 'uninitialized_var')
6208 {
6209 WARN("AVOID_EXTERNS",
6210 "externs should be avoided in .c files\n" . $herecurr);
6211 }
6212
6213 if ($paren_space =~ /\n/) {
6214 WARN("FUNCTION_ARGUMENTS",
6215 "arguments for function declarations should follow identifier\n" . $herecurr);
6216 }
6217
6218 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6219 $stat =~ /^.\s*extern\s+/)
6220 {
6221 WARN("AVOID_EXTERNS",
6222 "externs should be avoided in .c files\n" . $herecurr);
6223 }
6224
6225# check for function declarations that have arguments without identifier names
6226 if (defined $stat &&
6227 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6228 $1 ne "void") {
6229 my $args = trim($1);
6230 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6231 my $arg = trim($1);
6232 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6233 WARN("FUNCTION_ARGUMENTS",
6234 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6235 }
6236 }
6237 }
6238
6239# check for function definitions
6240 if ($perl_version_ok &&
6241 defined $stat &&
6242 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6243 $context_function = $1;
6244
6245# check for multiline function definition with misplaced open brace
6246 my $ok = 0;
6247 my $cnt = statement_rawlines($stat);
6248 my $herectx = $here . "\n";
6249 for (my $n = 0; $n < $cnt; $n++) {
6250 my $rl = raw_line($linenr, $n);
6251 $herectx .= $rl . "\n";
6252 $ok = 1 if ($rl =~ /^[ \+]\{/);
6253 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6254 last if $rl =~ /^[ \+].*\{/;
6255 }
6256 if (!$ok) {
6257 ERROR("OPEN_BRACE",
6258 "open brace '{' following function definitions go on the next line\n" . $herectx);
6259 }
6260 }
6261
6262# checks for new __setup's
6263 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6264 my $name = $1;
6265
6266 if (!grep(/$name/, @setup_docs)) {
6267 CHK("UNDOCUMENTED_SETUP",
6268 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6269 }
6270 }
6271
6272# check for pointless casting of alloc functions
6273 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
6274 WARN("UNNECESSARY_CASTS",
6275 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6276 }
6277
6278# alloc style
6279# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6280 if ($perl_version_ok &&
6281 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6282 CHK("ALLOC_SIZEOF_STRUCT",
6283 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6284 }
6285
6286# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6287 if ($perl_version_ok &&
6288 defined $stat &&
6289 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6290 my $oldfunc = $3;
6291 my $a1 = $4;
6292 my $a2 = $10;
6293 my $newfunc = "kmalloc_array";
6294 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
6295 my $r1 = $a1;
6296 my $r2 = $a2;
6297 if ($a1 =~ /^sizeof\s*\S/) {
6298 $r1 = $a2;
6299 $r2 = $a1;
6300 }
6301 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6302 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
6303 my $cnt = statement_rawlines($stat);
6304 my $herectx = get_stat_here($linenr, $cnt, $here);
6305
6306 if (WARN("ALLOC_WITH_MULTIPLY",
6307 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6308 $cnt == 1 &&
6309 $fix) {
6310 $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;
6311 }
6312 }
6313 }
6314
6315# check for krealloc arg reuse
6316 if ($perl_version_ok &&
6317 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6318 $1 eq $3) {
6319 WARN("KREALLOC_ARG_REUSE",
6320 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6321 }
6322
6323# check for alloc argument mismatch
6324 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6325 WARN("ALLOC_ARRAY_ARGS",
6326 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6327 }
6328
6329# check for multiple semicolons
6330 if ($line =~ /;\s*;\s*$/) {
6331 if (WARN("ONE_SEMICOLON",
6332 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6333 $fix) {
6334 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
6335 }
6336 }
6337
6338# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6339 if ($realfile !~ m@^include/uapi/@ &&
6340 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
6341 my $ull = "";
6342 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6343 if (CHK("BIT_MACRO",
6344 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6345 $fix) {
6346 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6347 }
6348 }
6349
6350# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6351 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6352 my $config = $1;
6353 if (WARN("PREFER_IS_ENABLED",
6354 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6355 $fix) {
6356 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6357 }
6358 }
6359
6360# check for case / default statements not preceded by break/fallthrough/switch
6361 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6362 my $has_break = 0;
6363 my $has_statement = 0;
6364 my $count = 0;
6365 my $prevline = $linenr;
6366 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
6367 $prevline--;
6368 my $rline = $rawlines[$prevline - 1];
6369 my $fline = $lines[$prevline - 1];
6370 last if ($fline =~ /^\@\@/);
6371 next if ($fline =~ /^\-/);
6372 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6373 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6374 next if ($fline =~ /^.[\s$;]*$/);
6375 $has_statement = 1;
6376 $count++;
6377 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6378 }
6379 if (!$has_break && $has_statement) {
6380 WARN("MISSING_BREAK",
6381 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
6382 }
6383 }
6384
6385# check for switch/default statements without a break;
6386 if ($perl_version_ok &&
6387 defined $stat &&
6388 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6389 my $cnt = statement_rawlines($stat);
6390 my $herectx = get_stat_here($linenr, $cnt, $here);
6391
6392 WARN("DEFAULT_NO_BREAK",
6393 "switch default: should use break\n" . $herectx);
6394 }
6395
6396# check for gcc specific __FUNCTION__
6397 if ($line =~ /\b__FUNCTION__\b/) {
6398 if (WARN("USE_FUNC",
6399 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6400 $fix) {
6401 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
6402 }
6403 }
6404
6405# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6406 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6407 ERROR("DATE_TIME",
6408 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6409 }
6410
6411# check for use of yield()
6412 if ($line =~ /\byield\s*\(\s*\)/) {
6413 WARN("YIELD",
6414 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6415 }
6416
6417# check for comparisons against true and false
6418 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6419 my $lead = $1;
6420 my $arg = $2;
6421 my $test = $3;
6422 my $otype = $4;
6423 my $trail = $5;
6424 my $op = "!";
6425
6426 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6427
6428 my $type = lc($otype);
6429 if ($type =~ /^(?:true|false)$/) {
6430 if (("$test" eq "==" && "$type" eq "true") ||
6431 ("$test" eq "!=" && "$type" eq "false")) {
6432 $op = "";
6433 }
6434
6435 CHK("BOOL_COMPARISON",
6436 "Using comparison to $otype is error prone\n" . $herecurr);
6437
6438## maybe suggesting a correct construct would better
6439## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6440
6441 }
6442 }
6443
6444# check for semaphores initialized locked
6445 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
6446 WARN("CONSIDER_COMPLETION",
6447 "consider using a completion\n" . $herecurr);
6448 }
6449
6450# recommend kstrto* over simple_strto* and strict_strto*
6451 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
6452 WARN("CONSIDER_KSTRTO",
6453 "$1 is obsolete, use k$3 instead\n" . $herecurr);
6454 }
6455
6456# check for __initcall(), use device_initcall() explicitly or more appropriate function please
6457 if ($line =~ /^.\s*__initcall\s*\(/) {
6458 WARN("USE_DEVICE_INITCALL",
6459 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6460 }
6461
6462# check for spin_is_locked(), suggest lockdep instead
6463 if ($line =~ /\bspin_is_locked\(/) {
6464 WARN("USE_LOCKDEP",
6465 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6466 }
6467
6468# check for deprecated apis
6469 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6470 my $deprecated_api = $1;
6471 my $new_api = $deprecated_apis{$deprecated_api};
6472 WARN("DEPRECATED_API",
6473 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6474 }
6475
6476# check for various structs that are normally const (ops, kgdb, device_tree)
6477# and avoid what seem like struct definitions 'struct foo {'
6478 if ($line !~ /\bconst\b/ &&
6479 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
6480 WARN("CONST_STRUCT",
6481 "struct $1 should normally be const\n" . $herecurr);
6482 }
6483
6484# use of NR_CPUS is usually wrong
6485# ignore definitions of NR_CPUS and usage to define arrays as likely right
6486 if ($line =~ /\bNR_CPUS\b/ &&
6487 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6488 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
6489 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6490 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6491 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
6492 {
6493 WARN("NR_CPUS",
6494 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6495 }
6496
6497# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6498 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6499 ERROR("DEFINE_ARCH_HAS",
6500 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6501 }
6502
6503# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6504 if ($perl_version_ok &&
6505 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6506 WARN("LIKELY_MISUSE",
6507 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6508 }
6509
6510# nested likely/unlikely calls
6511 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6512 WARN("LIKELY_MISUSE",
6513 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6514 }
6515
6516# whine mightly about in_atomic
6517 if ($line =~ /\bin_atomic\s*\(/) {
6518 if ($realfile =~ m@^drivers/@) {
6519 ERROR("IN_ATOMIC",
6520 "do not use in_atomic in drivers\n" . $herecurr);
6521 } elsif ($realfile !~ m@^kernel/@) {
6522 WARN("IN_ATOMIC",
6523 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
6524 }
6525 }
6526
6527# check for mutex_trylock_recursive usage
6528 if ($line =~ /mutex_trylock_recursive/) {
6529 ERROR("LOCKING",
6530 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6531 }
6532
6533# check for lockdep_set_novalidate_class
6534 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6535 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6536 if ($realfile !~ m@^kernel/lockdep@ &&
6537 $realfile !~ m@^include/linux/lockdep@ &&
6538 $realfile !~ m@^drivers/base/core@) {
6539 ERROR("LOCKDEP",
6540 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
6541 }
6542 }
6543
6544 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6545 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
6546 WARN("EXPORTED_WORLD_WRITABLE",
6547 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6548 }
6549
6550# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6551# and whether or not function naming is typical and if
6552# DEVICE_ATTR permissions uses are unusual too
6553 if ($perl_version_ok &&
6554 defined $stat &&
6555 $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*\)/) {
6556 my $var = $1;
6557 my $perms = $2;
6558 my $show = $3;
6559 my $store = $4;
6560 my $octal_perms = perms_to_octal($perms);
6561 if ($show =~ /^${var}_show$/ &&
6562 $store =~ /^${var}_store$/ &&
6563 $octal_perms eq "0644") {
6564 if (WARN("DEVICE_ATTR_RW",
6565 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6566 $fix) {
6567 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6568 }
6569 } elsif ($show =~ /^${var}_show$/ &&
6570 $store =~ /^NULL$/ &&
6571 $octal_perms eq "0444") {
6572 if (WARN("DEVICE_ATTR_RO",
6573 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6574 $fix) {
6575 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6576 }
6577 } elsif ($show =~ /^NULL$/ &&
6578 $store =~ /^${var}_store$/ &&
6579 $octal_perms eq "0200") {
6580 if (WARN("DEVICE_ATTR_WO",
6581 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6582 $fix) {
6583 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6584 }
6585 } elsif ($octal_perms eq "0644" ||
6586 $octal_perms eq "0444" ||
6587 $octal_perms eq "0200") {
6588 my $newshow = "$show";
6589 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6590 my $newstore = $store;
6591 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6592 my $rename = "";
6593 if ($show ne $newshow) {
6594 $rename .= " '$show' to '$newshow'";
6595 }
6596 if ($store ne $newstore) {
6597 $rename .= " '$store' to '$newstore'";
6598 }
6599 WARN("DEVICE_ATTR_FUNCTIONS",
6600 "Consider renaming function(s)$rename\n" . $herecurr);
6601 } else {
6602 WARN("DEVICE_ATTR_PERMS",
6603 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6604 }
6605 }
6606
6607# Mode permission misuses where it seems decimal should be octal
6608# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6609# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6610# specific definition of not visible in sysfs.
6611# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6612# use the default permissions
6613 if ($perl_version_ok &&
6614 defined $stat &&
6615 $line =~ /$mode_perms_search/) {
6616 foreach my $entry (@mode_permission_funcs) {
6617 my $func = $entry->[0];
6618 my $arg_pos = $entry->[1];
6619
6620 my $lc = $stat =~ tr@\n@@;
6621 $lc = $lc + $linenr;
6622 my $stat_real = get_stat_real($linenr, $lc);
6623
6624 my $skip_args = "";
6625 if ($arg_pos > 1) {
6626 $arg_pos--;
6627 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6628 }
6629 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
6630 if ($stat =~ /$test/) {
6631 my $val = $1;
6632 $val = $6 if ($skip_args ne "");
6633 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6634 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6635 ($val =~ /^$Octal$/ && length($val) ne 4))) {
6636 ERROR("NON_OCTAL_PERMISSIONS",
6637 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
6638 }
6639 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6640 ERROR("EXPORTED_WORLD_WRITABLE",
6641 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6642 }
6643 }
6644 }
6645 }
6646
6647# check for uses of S_<PERMS> that could be octal for readability
6648 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
6649 my $oval = $1;
6650 my $octal = perms_to_octal($oval);
6651 if (WARN("SYMBOLIC_PERMS",
6652 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6653 $fix) {
6654 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
6655 }
6656 }
6657
6658# validate content of MODULE_LICENSE against list from include/linux/module.h
6659 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6660 my $extracted_string = get_quoted_string($line, $rawline);
6661 my $valid_licenses = qr{
6662 GPL|
6663 GPL\ v2|
6664 GPL\ and\ additional\ rights|
6665 Dual\ BSD/GPL|
6666 Dual\ MIT/GPL|
6667 Dual\ MPL/GPL|
6668 Proprietary
6669 }x;
6670 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6671 WARN("MODULE_LICENSE",
6672 "unknown module license " . $extracted_string . "\n" . $herecurr);
6673 }
6674 }
6675
6676# check for sysctl duplicate constants
6677 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6678 WARN("DUPLICATED_SYSCTL_CONST",
6679 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6680 }
6681 }
6682
6683 # If we have no input at all, then there is nothing to report on
6684 # so just keep quiet.
6685 if ($#rawlines == -1) {
6686 exit(0);
6687 }
6688
6689 # In mailback mode only produce a report in the negative, for
6690 # things that appear to be patches.
6691 if ($mailback && ($clean == 1 || !$is_patch)) {
6692 exit(0);
6693 }
6694
6695 # This is not a patch, and we are are in 'no-patch' mode so
6696 # just keep quiet.
6697 if (!$chk_patch && !$is_patch) {
6698 exit(0);
6699 }
6700
6701 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
6702 ERROR("NOT_UNIFIED_DIFF",
6703 "Does not appear to be a unified-diff format patch\n");
6704 }
6705 if ($is_patch && $has_commit_log && $chk_signoff) {
6706 if ($signoff == 0) {
6707 ERROR("MISSING_SIGN_OFF",
6708 "Missing Signed-off-by: line(s)\n");
6709 } elsif (!$authorsignoff) {
6710 WARN("NO_AUTHOR_SIGN_OFF",
6711 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6712 }
6713 }
6714
6715 print report_dump();
6716 if ($summary && !($clean == 1 && $quiet == 1)) {
6717 print "$filename " if ($summary_file);
6718 print "total: $cnt_error errors, $cnt_warn warnings, " .
6719 (($check)? "$cnt_chk checks, " : "") .
6720 "$cnt_lines lines checked\n";
6721 }
6722
6723 if ($quiet == 0) {
6724 # If there were any defects found and not already fixing them
6725 if (!$clean and !$fix) {
6726 print << "EOM"
6727
6728NOTE: For some of the reported defects, checkpatch may be able to
6729 mechanically convert to the typical style using --fix or --fix-inplace.
6730EOM
6731 }
6732 # If there were whitespace errors which cleanpatch can fix
6733 # then suggest that.
6734 if ($rpt_cleaners) {
6735 $rpt_cleaners = 0;
6736 print << "EOM"
6737
6738NOTE: Whitespace errors detected.
6739 You may wish to use scripts/cleanpatch or scripts/cleanfile
6740EOM
6741 }
6742 }
6743
6744 if ($clean == 0 && $fix &&
6745 ("@rawlines" ne "@fixed" ||
6746 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
6747 my $newfile = $filename;
6748 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
6749 my $linecount = 0;
6750 my $f;
6751
6752 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6753
6754 open($f, '>', $newfile)
6755 or die "$P: Can't open $newfile for write\n";
6756 foreach my $fixed_line (@fixed) {
6757 $linecount++;
6758 if ($file) {
6759 if ($linecount > 3) {
6760 $fixed_line =~ s/^\+//;
6761 print $f $fixed_line . "\n";
6762 }
6763 } else {
6764 print $f $fixed_line . "\n";
6765 }
6766 }
6767 close($f);
6768
6769 if (!$quiet) {
6770 print << "EOM";
6771
6772Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6773
6774Do _NOT_ trust the results written to this file.
6775Do _NOT_ submit these changes without inspecting them for correctness.
6776
6777This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6778No warranties, expressed or implied...
6779EOM
6780 }
6781 }
6782
6783 if ($quiet == 0) {
6784 print "\n";
6785 if ($clean == 1) {
6786 print "$vname has no obvious style problems and is ready for submission.\n";
6787 } else {
6788 print "$vname has style problems, please review.\n";
6789 }
6790 }
6791 return $clean;
6792}
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3#
4# (c) 2001, Dave Jones. (the file handling bit)
5# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8# (c) 2010-2018 Joe Perches <joe@perches.com>
9
10use strict;
11use warnings;
12use POSIX;
13use File::Basename;
14use Cwd 'abs_path';
15use Term::ANSIColor qw(:constants);
16use Encode qw(decode encode);
17
18my $P = $0;
19my $D = dirname(abs_path($P));
20
21my $V = '0.32';
22
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $verbose = 0;
27my %verbose_messages = ();
28my %verbose_emitted = ();
29my $tree = 1;
30my $chk_signoff = 1;
31my $chk_fixes_tag = 1;
32my $chk_patch = 1;
33my $tst_only;
34my $emacs = 0;
35my $terse = 0;
36my $showfile = 0;
37my $file = 0;
38my $git = 0;
39my %git_commits = ();
40my $check = 0;
41my $check_orig = 0;
42my $summary = 1;
43my $mailback = 0;
44my $summary_file = 0;
45my $show_types = 0;
46my $list_types = 0;
47my $fix = 0;
48my $fix_inplace = 0;
49my $root;
50my $gitroot = $ENV{'GIT_DIR'};
51$gitroot = ".git" if !defined($gitroot);
52my %debug;
53my %camelcase = ();
54my %use_type = ();
55my @use = ();
56my %ignore_type = ();
57my @ignore = ();
58my $help = 0;
59my $configuration_file = ".checkpatch.conf";
60my $max_line_length = 100;
61my $ignore_perl_version = 0;
62my $minimum_perl_version = 5.10.0;
63my $min_conf_desc_length = 4;
64my $spelling_file = "$D/spelling.txt";
65my $codespell = 0;
66my $codespellfile = "/usr/share/codespell/dictionary.txt";
67my $user_codespellfile = "";
68my $conststructsfile = "$D/const_structs.checkpatch";
69my $docsfile = "$D/../Documentation/dev-tools/checkpatch.rst";
70my $typedefsfile;
71my $color = "auto";
72my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
73# git output parsing needs US English output, so first set backtick child process LANGUAGE
74my $git_command ='export LANGUAGE=en_US.UTF-8; git';
75my $tabsize = 8;
76my ${CONFIG_} = "CONFIG_";
77
78my %maybe_linker_symbol; # for externs in c exceptions, when seen in *vmlinux.lds.h
79
80sub help {
81 my ($exitcode) = @_;
82
83 print << "EOM";
84Usage: $P [OPTION]... [FILE]...
85Version: $V
86
87Options:
88 -q, --quiet quiet
89 -v, --verbose verbose mode
90 --no-tree run without a kernel tree
91 --no-signoff do not check for 'Signed-off-by' line
92 --no-fixes-tag do not check for 'Fixes:' tag
93 --patch treat FILE as patchfile (default)
94 --emacs emacs compile window format
95 --terse one line per report
96 --showfile emit diffed file position, not input file position
97 -g, --git treat FILE as a single commit or git revision range
98 single git commit with:
99 <rev>
100 <rev>^
101 <rev>~n
102 multiple git commits with:
103 <rev1>..<rev2>
104 <rev1>...<rev2>
105 <rev>-<count>
106 git merges are ignored
107 -f, --file treat FILE as regular source file
108 --subjective, --strict enable more subjective tests
109 --list-types list the possible message types
110 --types TYPE(,TYPE2...) show only these comma separated message types
111 --ignore TYPE(,TYPE2...) ignore various comma separated message types
112 --show-types show the specific message type in the output
113 --max-line-length=n set the maximum line length, (default $max_line_length)
114 if exceeded, warn on patches
115 requires --strict for use with --file
116 --min-conf-desc-length=n set the min description length, if shorter, warn
117 --tab-size=n set the number of spaces for tab (default $tabsize)
118 --root=PATH PATH to the kernel tree root
119 --no-summary suppress the per-file summary
120 --mailback only produce a report in case of warnings/errors
121 --summary-file include the filename in summary
122 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
123 'values', 'possible', 'type', and 'attr' (default
124 is all off)
125 --test-only=WORD report only warnings/errors containing WORD
126 literally
127 --fix EXPERIMENTAL - may create horrible results
128 If correctable single-line errors exist, create
129 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
130 with potential errors corrected to the preferred
131 checkpatch style
132 --fix-inplace EXPERIMENTAL - may create horrible results
133 Is the same as --fix, but overwrites the input
134 file. It's your fault if there's no backup or git
135 --ignore-perl-version override checking of perl version. expect
136 runtime errors.
137 --codespell Use the codespell dictionary for spelling/typos
138 (default:$codespellfile)
139 --codespellfile Use this codespell dictionary
140 --typedefsfile Read additional types from this file
141 --color[=WHEN] Use colors 'always', 'never', or only when output
142 is a terminal ('auto'). Default is 'auto'.
143 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
144 ${CONFIG_})
145 -h, --help, --version display this help and exit
146
147When FILE is - read standard input.
148EOM
149
150 exit($exitcode);
151}
152
153sub uniq {
154 my %seen;
155 return grep { !$seen{$_}++ } @_;
156}
157
158sub list_types {
159 my ($exitcode) = @_;
160
161 my $count = 0;
162
163 local $/ = undef;
164
165 open(my $script, '<', abs_path($P)) or
166 die "$P: Can't read '$P' $!\n";
167
168 my $text = <$script>;
169 close($script);
170
171 my %types = ();
172 # Also catch when type or level is passed through a variable
173 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
174 if (defined($1)) {
175 if (exists($types{$2})) {
176 $types{$2} .= ",$1" if ($types{$2} ne $1);
177 } else {
178 $types{$2} = $1;
179 }
180 } else {
181 $types{$2} = "UNDETERMINED";
182 }
183 }
184
185 print("#\tMessage type\n\n");
186 if ($color) {
187 print(" ( Color coding: ");
188 print(RED . "ERROR" . RESET);
189 print(" | ");
190 print(YELLOW . "WARNING" . RESET);
191 print(" | ");
192 print(GREEN . "CHECK" . RESET);
193 print(" | ");
194 print("Multiple levels / Undetermined");
195 print(" )\n\n");
196 }
197
198 foreach my $type (sort keys %types) {
199 my $orig_type = $type;
200 if ($color) {
201 my $level = $types{$type};
202 if ($level eq "ERROR") {
203 $type = RED . $type . RESET;
204 } elsif ($level eq "WARN") {
205 $type = YELLOW . $type . RESET;
206 } elsif ($level eq "CHK") {
207 $type = GREEN . $type . RESET;
208 }
209 }
210 print(++$count . "\t" . $type . "\n");
211 if ($verbose && exists($verbose_messages{$orig_type})) {
212 my $message = $verbose_messages{$orig_type};
213 $message =~ s/\n/\n\t/g;
214 print("\t" . $message . "\n\n");
215 }
216 }
217
218 exit($exitcode);
219}
220
221my $conf = which_conf($configuration_file);
222if (-f $conf) {
223 my @conf_args;
224 open(my $conffile, '<', "$conf")
225 or warn "$P: Can't find a readable $configuration_file file $!\n";
226
227 while (<$conffile>) {
228 my $line = $_;
229
230 $line =~ s/\s*\n?$//g;
231 $line =~ s/^\s*//g;
232 $line =~ s/\s+/ /g;
233
234 next if ($line =~ m/^\s*#/);
235 next if ($line =~ m/^\s*$/);
236
237 my @words = split(" ", $line);
238 foreach my $word (@words) {
239 last if ($word =~ m/^#/);
240 push (@conf_args, $word);
241 }
242 }
243 close($conffile);
244 unshift(@ARGV, @conf_args) if @conf_args;
245}
246
247sub load_docs {
248 open(my $docs, '<', "$docsfile")
249 or warn "$P: Can't read the documentation file $docsfile $!\n";
250
251 my $type = '';
252 my $desc = '';
253 my $in_desc = 0;
254
255 while (<$docs>) {
256 chomp;
257 my $line = $_;
258 $line =~ s/\s+$//;
259
260 if ($line =~ /^\s*\*\*(.+)\*\*$/) {
261 if ($desc ne '') {
262 $verbose_messages{$type} = trim($desc);
263 }
264 $type = $1;
265 $desc = '';
266 $in_desc = 1;
267 } elsif ($in_desc) {
268 if ($line =~ /^(?:\s{4,}|$)/) {
269 $line =~ s/^\s{4}//;
270 $desc .= $line;
271 $desc .= "\n";
272 } else {
273 $verbose_messages{$type} = trim($desc);
274 $type = '';
275 $desc = '';
276 $in_desc = 0;
277 }
278 }
279 }
280
281 if ($desc ne '') {
282 $verbose_messages{$type} = trim($desc);
283 }
284 close($docs);
285}
286
287# Perl's Getopt::Long allows options to take optional arguments after a space.
288# Prevent --color by itself from consuming other arguments
289foreach (@ARGV) {
290 if ($_ eq "--color" || $_ eq "-color") {
291 $_ = "--color=$color";
292 }
293}
294
295GetOptions(
296 'q|quiet+' => \$quiet,
297 'v|verbose!' => \$verbose,
298 'tree!' => \$tree,
299 'signoff!' => \$chk_signoff,
300 'fixes-tag!' => \$chk_fixes_tag,
301 'patch!' => \$chk_patch,
302 'emacs!' => \$emacs,
303 'terse!' => \$terse,
304 'showfile!' => \$showfile,
305 'f|file!' => \$file,
306 'g|git!' => \$git,
307 'subjective!' => \$check,
308 'strict!' => \$check,
309 'ignore=s' => \@ignore,
310 'types=s' => \@use,
311 'show-types!' => \$show_types,
312 'list-types!' => \$list_types,
313 'max-line-length=i' => \$max_line_length,
314 'min-conf-desc-length=i' => \$min_conf_desc_length,
315 'tab-size=i' => \$tabsize,
316 'root=s' => \$root,
317 'summary!' => \$summary,
318 'mailback!' => \$mailback,
319 'summary-file!' => \$summary_file,
320 'fix!' => \$fix,
321 'fix-inplace!' => \$fix_inplace,
322 'ignore-perl-version!' => \$ignore_perl_version,
323 'debug=s' => \%debug,
324 'test-only=s' => \$tst_only,
325 'codespell!' => \$codespell,
326 'codespellfile=s' => \$user_codespellfile,
327 'typedefsfile=s' => \$typedefsfile,
328 'color=s' => \$color,
329 'no-color' => \$color, #keep old behaviors of -nocolor
330 'nocolor' => \$color, #keep old behaviors of -nocolor
331 'kconfig-prefix=s' => \${CONFIG_},
332 'h|help' => \$help,
333 'version' => \$help
334) or $help = 2;
335
336if ($user_codespellfile) {
337 # Use the user provided codespell file unconditionally
338 $codespellfile = $user_codespellfile;
339} elsif (!(-f $codespellfile)) {
340 # If /usr/share/codespell/dictionary.txt is not present, try to find it
341 # under codespell's install directory: <codespell_root>/data/dictionary.txt
342 if (($codespell || $help) && which("python3") ne "") {
343 my $python_codespell_dict = << "EOF";
344
345import os.path as op
346import codespell_lib
347codespell_dir = op.dirname(codespell_lib.__file__)
348codespell_file = op.join(codespell_dir, 'data', 'dictionary.txt')
349print(codespell_file, end='')
350EOF
351
352 my $codespell_dict = `python3 -c "$python_codespell_dict" 2> /dev/null`;
353 $codespellfile = $codespell_dict if (-f $codespell_dict);
354 }
355}
356
357# $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
358# $help is 2 if invalid option is passed - exitcode: 1
359help($help - 1) if ($help);
360
361die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
362die "$P: --verbose cannot be used with --terse\n" if ($verbose && $terse);
363
364if ($color =~ /^[01]$/) {
365 $color = !$color;
366} elsif ($color =~ /^always$/i) {
367 $color = 1;
368} elsif ($color =~ /^never$/i) {
369 $color = 0;
370} elsif ($color =~ /^auto$/i) {
371 $color = (-t STDOUT);
372} else {
373 die "$P: Invalid color mode: $color\n";
374}
375
376load_docs() if ($verbose);
377list_types(0) if ($list_types);
378
379$fix = 1 if ($fix_inplace);
380$check_orig = $check;
381
382my $exit = 0;
383
384my $perl_version_ok = 1;
385if ($^V && $^V lt $minimum_perl_version) {
386 $perl_version_ok = 0;
387 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
388 exit(1) if (!$ignore_perl_version);
389}
390
391#if no filenames are given, push '-' to read patch from stdin
392if ($#ARGV < 0) {
393 push(@ARGV, '-');
394}
395
396# skip TAB size 1 to avoid additional checks on $tabsize - 1
397die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
398
399sub hash_save_array_words {
400 my ($hashRef, $arrayRef) = @_;
401
402 my @array = split(/,/, join(',', @$arrayRef));
403 foreach my $word (@array) {
404 $word =~ s/\s*\n?$//g;
405 $word =~ s/^\s*//g;
406 $word =~ s/\s+/ /g;
407 $word =~ tr/[a-z]/[A-Z]/;
408
409 next if ($word =~ m/^\s*#/);
410 next if ($word =~ m/^\s*$/);
411
412 $hashRef->{$word}++;
413 }
414}
415
416sub hash_show_words {
417 my ($hashRef, $prefix) = @_;
418
419 if (keys %$hashRef) {
420 print "\nNOTE: $prefix message types:";
421 foreach my $word (sort keys %$hashRef) {
422 print " $word";
423 }
424 print "\n";
425 }
426}
427
428hash_save_array_words(\%ignore_type, \@ignore);
429hash_save_array_words(\%use_type, \@use);
430
431my $dbg_values = 0;
432my $dbg_possible = 0;
433my $dbg_type = 0;
434my $dbg_attr = 0;
435for my $key (keys %debug) {
436 ## no critic
437 eval "\${dbg_$key} = '$debug{$key}';";
438 die "$@" if ($@);
439}
440
441my $rpt_cleaners = 0;
442
443if ($terse) {
444 $emacs = 1;
445 $quiet++;
446}
447
448if ($tree) {
449 if (defined $root) {
450 if (!top_of_kernel_tree($root)) {
451 die "$P: $root: --root does not point at a valid tree\n";
452 }
453 } else {
454 if (top_of_kernel_tree('.')) {
455 $root = '.';
456 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
457 top_of_kernel_tree($1)) {
458 $root = $1;
459 }
460 }
461
462 if (!defined $root) {
463 print "Must be run from the top-level dir. of a kernel tree\n";
464 exit(2);
465 }
466}
467
468my $emitted_corrupt = 0;
469
470our $Ident = qr{
471 [A-Za-z_][A-Za-z\d_]*
472 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
473 }x;
474our $Storage = qr{extern|static|asmlinkage};
475our $Sparse = qr{
476 __user|
477 __kernel|
478 __force|
479 __iomem|
480 __must_check|
481 __kprobes|
482 __ref|
483 __refconst|
484 __refdata|
485 __rcu|
486 __private
487 }x;
488our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
489our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
490our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
491our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
492our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
493
494# Notes to $Attribute:
495# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
496our $Attribute = qr{
497 const|
498 volatile|
499 __percpu|
500 __nocast|
501 __safe|
502 __bitwise|
503 __packed__|
504 __packed2__|
505 __naked|
506 __maybe_unused|
507 __always_unused|
508 __noreturn|
509 __used|
510 __cold|
511 __pure|
512 __noclone|
513 __deprecated|
514 __read_mostly|
515 __ro_after_init|
516 __kprobes|
517 $InitAttribute|
518 __aligned\s*\(.*\)|
519 ____cacheline_aligned|
520 ____cacheline_aligned_in_smp|
521 ____cacheline_internodealigned_in_smp|
522 __weak|
523 __alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\)
524 }x;
525our $Modifier;
526our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
527our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
528our $Lval = qr{$Ident(?:$Member)*};
529
530our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
531our $Binary = qr{(?i)0b[01]+$Int_type?};
532our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
533our $Int = qr{[0-9]+$Int_type?};
534our $Octal = qr{0[0-7]+$Int_type?};
535our $String = qr{(?:\b[Lu])?"[X\t]*"};
536our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
537our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
538our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
539our $Float = qr{$Float_hex|$Float_dec|$Float_int};
540our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
541our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
542our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
543our $Arithmetic = qr{\+|-|\*|\/|%};
544our $Operators = qr{
545 <=|>=|==|!=|
546 =>|->|<<|>>|<|>|!|~|
547 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
548 }x;
549
550our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
551
552our $BasicType;
553our $NonptrType;
554our $NonptrTypeMisordered;
555our $NonptrTypeWithAttr;
556our $Type;
557our $TypeMisordered;
558our $Declare;
559our $DeclareMisordered;
560
561our $NON_ASCII_UTF8 = qr{
562 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
563 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
564 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
565 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
566 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
567 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
568 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
569}x;
570
571our $UTF8 = qr{
572 [\x09\x0A\x0D\x20-\x7E] # ASCII
573 | $NON_ASCII_UTF8
574}x;
575
576our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
577our $typeOtherOSTypedefs = qr{(?x:
578 u_(?:char|short|int|long) | # bsd
579 u(?:nchar|short|int|long) # sysv
580)};
581our $typeKernelTypedefs = qr{(?x:
582 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
583 atomic_t
584)};
585our $typeStdioTypedefs = qr{(?x:
586 FILE
587)};
588our $typeTypedefs = qr{(?x:
589 $typeC99Typedefs\b|
590 $typeOtherOSTypedefs\b|
591 $typeKernelTypedefs\b|
592 $typeStdioTypedefs\b
593)};
594
595our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
596
597our $logFunctions = qr{(?x:
598 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
599 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
600 TP_printk|
601 WARN(?:_RATELIMIT|_ONCE|)|
602 panic|
603 MODULE_[A-Z_]+|
604 seq_vprintf|seq_printf|seq_puts
605)};
606
607our $allocFunctions = qr{(?x:
608 (?:(?:devm_)?
609 (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? |
610 kstrdup(?:_const)? |
611 kmemdup(?:_nul)?) |
612 (?:\w+)?alloc_skb(?:_ip_align)? |
613 # dev_alloc_skb/netdev_alloc_skb, et al
614 dma_alloc_coherent
615)};
616
617our $signature_tags = qr{(?xi:
618 Signed-off-by:|
619 Co-developed-by:|
620 Acked-by:|
621 Tested-by:|
622 Reviewed-by:|
623 Reported-by:|
624 Suggested-by:|
625 To:|
626 Cc:
627)};
628
629our @link_tags = qw(Link Closes);
630
631#Create a search and print patterns for all these strings to be used directly below
632our $link_tags_search = "";
633our $link_tags_print = "";
634foreach my $entry (@link_tags) {
635 if ($link_tags_search ne "") {
636 $link_tags_search .= '|';
637 $link_tags_print .= ' or ';
638 }
639 $entry .= ':';
640 $link_tags_search .= $entry;
641 $link_tags_print .= "'$entry'";
642}
643$link_tags_search = "(?:${link_tags_search})";
644
645our $tracing_logging_tags = qr{(?xi:
646 [=-]*> |
647 <[=-]* |
648 \[ |
649 \] |
650 start |
651 called |
652 entered |
653 entry |
654 enter |
655 in |
656 inside |
657 here |
658 begin |
659 exit |
660 end |
661 done |
662 leave |
663 completed |
664 out |
665 return |
666 [\.\!:\s]*
667)};
668
669sub edit_distance_min {
670 my (@arr) = @_;
671 my $len = scalar @arr;
672 if ((scalar @arr) < 1) {
673 # if underflow, return
674 return;
675 }
676 my $min = $arr[0];
677 for my $i (0 .. ($len-1)) {
678 if ($arr[$i] < $min) {
679 $min = $arr[$i];
680 }
681 }
682 return $min;
683}
684
685sub get_edit_distance {
686 my ($str1, $str2) = @_;
687 $str1 = lc($str1);
688 $str2 = lc($str2);
689 $str1 =~ s/-//g;
690 $str2 =~ s/-//g;
691 my $len1 = length($str1);
692 my $len2 = length($str2);
693 # two dimensional array storing minimum edit distance
694 my @distance;
695 for my $i (0 .. $len1) {
696 for my $j (0 .. $len2) {
697 if ($i == 0) {
698 $distance[$i][$j] = $j;
699 } elsif ($j == 0) {
700 $distance[$i][$j] = $i;
701 } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) {
702 $distance[$i][$j] = $distance[$i - 1][$j - 1];
703 } else {
704 my $dist1 = $distance[$i][$j - 1]; #insert distance
705 my $dist2 = $distance[$i - 1][$j]; # remove
706 my $dist3 = $distance[$i - 1][$j - 1]; #replace
707 $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3);
708 }
709 }
710 }
711 return $distance[$len1][$len2];
712}
713
714sub find_standard_signature {
715 my ($sign_off) = @_;
716 my @standard_signature_tags = (
717 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:',
718 'Reviewed-by:', 'Reported-by:', 'Suggested-by:'
719 );
720 foreach my $signature (@standard_signature_tags) {
721 return $signature if (get_edit_distance($sign_off, $signature) <= 2);
722 }
723
724 return "";
725}
726
727our $obsolete_archives = qr{(?xi:
728 \Qfreedesktop.org/archives/dri-devel\E |
729 \Qlists.infradead.org\E |
730 \Qlkml.org\E |
731 \Qmail-archive.com\E |
732 \Qmailman.alsa-project.org/pipermail\E |
733 \Qmarc.info\E |
734 \Qozlabs.org/pipermail\E |
735 \Qspinics.net\E
736)};
737
738our @typeListMisordered = (
739 qr{char\s+(?:un)?signed},
740 qr{int\s+(?:(?:un)?signed\s+)?short\s},
741 qr{int\s+short(?:\s+(?:un)?signed)},
742 qr{short\s+int(?:\s+(?:un)?signed)},
743 qr{(?:un)?signed\s+int\s+short},
744 qr{short\s+(?:un)?signed},
745 qr{long\s+int\s+(?:un)?signed},
746 qr{int\s+long\s+(?:un)?signed},
747 qr{long\s+(?:un)?signed\s+int},
748 qr{int\s+(?:un)?signed\s+long},
749 qr{int\s+(?:un)?signed},
750 qr{int\s+long\s+long\s+(?:un)?signed},
751 qr{long\s+long\s+int\s+(?:un)?signed},
752 qr{long\s+long\s+(?:un)?signed\s+int},
753 qr{long\s+long\s+(?:un)?signed},
754 qr{long\s+(?:un)?signed},
755);
756
757our @typeList = (
758 qr{void},
759 qr{(?:(?:un)?signed\s+)?char},
760 qr{(?:(?:un)?signed\s+)?short\s+int},
761 qr{(?:(?:un)?signed\s+)?short},
762 qr{(?:(?:un)?signed\s+)?int},
763 qr{(?:(?:un)?signed\s+)?long\s+int},
764 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
765 qr{(?:(?:un)?signed\s+)?long\s+long},
766 qr{(?:(?:un)?signed\s+)?long},
767 qr{(?:un)?signed},
768 qr{float},
769 qr{double},
770 qr{bool},
771 qr{struct\s+$Ident},
772 qr{union\s+$Ident},
773 qr{enum\s+$Ident},
774 qr{${Ident}_t},
775 qr{${Ident}_handler},
776 qr{${Ident}_handler_fn},
777 @typeListMisordered,
778);
779
780our $C90_int_types = qr{(?x:
781 long\s+long\s+int\s+(?:un)?signed|
782 long\s+long\s+(?:un)?signed\s+int|
783 long\s+long\s+(?:un)?signed|
784 (?:(?:un)?signed\s+)?long\s+long\s+int|
785 (?:(?:un)?signed\s+)?long\s+long|
786 int\s+long\s+long\s+(?:un)?signed|
787 int\s+(?:(?:un)?signed\s+)?long\s+long|
788
789 long\s+int\s+(?:un)?signed|
790 long\s+(?:un)?signed\s+int|
791 long\s+(?:un)?signed|
792 (?:(?:un)?signed\s+)?long\s+int|
793 (?:(?:un)?signed\s+)?long|
794 int\s+long\s+(?:un)?signed|
795 int\s+(?:(?:un)?signed\s+)?long|
796
797 int\s+(?:un)?signed|
798 (?:(?:un)?signed\s+)?int
799)};
800
801our @typeListFile = ();
802our @typeListWithAttr = (
803 @typeList,
804 qr{struct\s+$InitAttribute\s+$Ident},
805 qr{union\s+$InitAttribute\s+$Ident},
806);
807
808our @modifierList = (
809 qr{fastcall},
810);
811our @modifierListFile = ();
812
813our @mode_permission_funcs = (
814 ["module_param", 3],
815 ["module_param_(?:array|named|string)", 4],
816 ["module_param_array_named", 5],
817 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
818 ["proc_create(?:_data|)", 2],
819 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
820 ["IIO_DEV_ATTR_[A-Z_]+", 1],
821 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
822 ["SENSOR_TEMPLATE(?:_2|)", 3],
823 ["__ATTR", 2],
824);
825
826my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
827
828#Create a search pattern for all these functions to speed up a loop below
829our $mode_perms_search = "";
830foreach my $entry (@mode_permission_funcs) {
831 $mode_perms_search .= '|' if ($mode_perms_search ne "");
832 $mode_perms_search .= $entry->[0];
833}
834$mode_perms_search = "(?:${mode_perms_search})";
835
836our %deprecated_apis = (
837 "synchronize_rcu_bh" => "synchronize_rcu",
838 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
839 "call_rcu_bh" => "call_rcu",
840 "rcu_barrier_bh" => "rcu_barrier",
841 "synchronize_sched" => "synchronize_rcu",
842 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
843 "call_rcu_sched" => "call_rcu",
844 "rcu_barrier_sched" => "rcu_barrier",
845 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
846 "cond_synchronize_sched" => "cond_synchronize_rcu",
847 "kmap" => "kmap_local_page",
848 "kunmap" => "kunmap_local",
849 "kmap_atomic" => "kmap_local_page",
850 "kunmap_atomic" => "kunmap_local",
851);
852
853#Create a search pattern for all these strings to speed up a loop below
854our $deprecated_apis_search = "";
855foreach my $entry (keys %deprecated_apis) {
856 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
857 $deprecated_apis_search .= $entry;
858}
859$deprecated_apis_search = "(?:${deprecated_apis_search})";
860
861our $mode_perms_world_writable = qr{
862 S_IWUGO |
863 S_IWOTH |
864 S_IRWXUGO |
865 S_IALLUGO |
866 0[0-7][0-7][2367]
867}x;
868
869our %mode_permission_string_types = (
870 "S_IRWXU" => 0700,
871 "S_IRUSR" => 0400,
872 "S_IWUSR" => 0200,
873 "S_IXUSR" => 0100,
874 "S_IRWXG" => 0070,
875 "S_IRGRP" => 0040,
876 "S_IWGRP" => 0020,
877 "S_IXGRP" => 0010,
878 "S_IRWXO" => 0007,
879 "S_IROTH" => 0004,
880 "S_IWOTH" => 0002,
881 "S_IXOTH" => 0001,
882 "S_IRWXUGO" => 0777,
883 "S_IRUGO" => 0444,
884 "S_IWUGO" => 0222,
885 "S_IXUGO" => 0111,
886);
887
888#Create a search pattern for all these strings to speed up a loop below
889our $mode_perms_string_search = "";
890foreach my $entry (keys %mode_permission_string_types) {
891 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
892 $mode_perms_string_search .= $entry;
893}
894our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
895our $multi_mode_perms_string_search = qr{
896 ${single_mode_perms_string_search}
897 (?:\s*\|\s*${single_mode_perms_string_search})*
898}x;
899
900sub perms_to_octal {
901 my ($string) = @_;
902
903 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
904
905 my $val = "";
906 my $oval = "";
907 my $to = 0;
908 my $curpos = 0;
909 my $lastpos = 0;
910 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
911 $curpos = pos($string);
912 my $match = $2;
913 my $omatch = $1;
914 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
915 $lastpos = $curpos;
916 $to |= $mode_permission_string_types{$match};
917 $val .= '\s*\|\s*' if ($val ne "");
918 $val .= $match;
919 $oval .= $omatch;
920 }
921 $oval =~ s/^\s*\|\s*//;
922 $oval =~ s/\s*\|\s*$//;
923 return sprintf("%04o", $to);
924}
925
926our $allowed_asm_includes = qr{(?x:
927 irq|
928 memory|
929 time|
930 reboot
931)};
932# memory.h: ARM has a custom one
933
934# Load common spelling mistakes and build regular expression list.
935my $misspellings;
936my %spelling_fix;
937
938if (open(my $spelling, '<', $spelling_file)) {
939 while (<$spelling>) {
940 my $line = $_;
941
942 $line =~ s/\s*\n?$//g;
943 $line =~ s/^\s*//g;
944
945 next if ($line =~ m/^\s*#/);
946 next if ($line =~ m/^\s*$/);
947
948 my ($suspect, $fix) = split(/\|\|/, $line);
949
950 $spelling_fix{$suspect} = $fix;
951 }
952 close($spelling);
953} else {
954 warn "No typos will be found - file '$spelling_file': $!\n";
955}
956
957if ($codespell) {
958 if (open(my $spelling, '<', $codespellfile)) {
959 while (<$spelling>) {
960 my $line = $_;
961
962 $line =~ s/\s*\n?$//g;
963 $line =~ s/^\s*//g;
964
965 next if ($line =~ m/^\s*#/);
966 next if ($line =~ m/^\s*$/);
967 next if ($line =~ m/, disabled/i);
968
969 $line =~ s/,.*$//;
970
971 my ($suspect, $fix) = split(/->/, $line);
972
973 $spelling_fix{$suspect} = $fix;
974 }
975 close($spelling);
976 } else {
977 warn "No codespell typos will be found - file '$codespellfile': $!\n";
978 }
979}
980
981$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
982
983sub read_words {
984 my ($wordsRef, $file) = @_;
985
986 if (open(my $words, '<', $file)) {
987 while (<$words>) {
988 my $line = $_;
989
990 $line =~ s/\s*\n?$//g;
991 $line =~ s/^\s*//g;
992
993 next if ($line =~ m/^\s*#/);
994 next if ($line =~ m/^\s*$/);
995 if ($line =~ /\s/) {
996 print("$file: '$line' invalid - ignored\n");
997 next;
998 }
999
1000 $$wordsRef .= '|' if (defined $$wordsRef);
1001 $$wordsRef .= $line;
1002 }
1003 close($file);
1004 return 1;
1005 }
1006
1007 return 0;
1008}
1009
1010my $const_structs;
1011if (show_type("CONST_STRUCT")) {
1012 read_words(\$const_structs, $conststructsfile)
1013 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
1014}
1015
1016if (defined($typedefsfile)) {
1017 my $typeOtherTypedefs;
1018 read_words(\$typeOtherTypedefs, $typedefsfile)
1019 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
1020 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
1021}
1022
1023sub build_types {
1024 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
1025 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
1026 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
1027 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
1028 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
1029 $BasicType = qr{
1030 (?:$typeTypedefs\b)|
1031 (?:${all}\b)
1032 }x;
1033 $NonptrType = qr{
1034 (?:$Modifier\s+|const\s+)*
1035 (?:
1036 (?:typeof|__typeof__)\s*\([^\)]*\)|
1037 (?:$typeTypedefs\b)|
1038 (?:${all}\b)
1039 )
1040 (?:\s+$Modifier|\s+const)*
1041 }x;
1042 $NonptrTypeMisordered = qr{
1043 (?:$Modifier\s+|const\s+)*
1044 (?:
1045 (?:${Misordered}\b)
1046 )
1047 (?:\s+$Modifier|\s+const)*
1048 }x;
1049 $NonptrTypeWithAttr = qr{
1050 (?:$Modifier\s+|const\s+)*
1051 (?:
1052 (?:typeof|__typeof__)\s*\([^\)]*\)|
1053 (?:$typeTypedefs\b)|
1054 (?:${allWithAttr}\b)
1055 )
1056 (?:\s+$Modifier|\s+const)*
1057 }x;
1058 $Type = qr{
1059 $NonptrType
1060 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
1061 (?:\s+$Inline|\s+$Modifier)*
1062 }x;
1063 $TypeMisordered = qr{
1064 $NonptrTypeMisordered
1065 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
1066 (?:\s+$Inline|\s+$Modifier)*
1067 }x;
1068 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
1069 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
1070}
1071build_types();
1072
1073our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
1074
1075# Using $balanced_parens, $LvalOrFunc, or $FuncArg
1076# requires at least perl version v5.10.0
1077# Any use must be runtime checked with $^V
1078
1079our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
1080our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
1081our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
1082
1083our $declaration_macros = qr{(?x:
1084 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
1085 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
1086 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(|
1087 (?:$Storage\s+)?(?:XA_STATE|XA_STATE_ORDER)\s*\(
1088)};
1089
1090our %allow_repeated_words = (
1091 add => '',
1092 added => '',
1093 bad => '',
1094 be => '',
1095);
1096
1097sub deparenthesize {
1098 my ($string) = @_;
1099 return "" if (!defined($string));
1100
1101 while ($string =~ /^\s*\(.*\)\s*$/) {
1102 $string =~ s@^\s*\(\s*@@;
1103 $string =~ s@\s*\)\s*$@@;
1104 }
1105
1106 $string =~ s@\s+@ @g;
1107
1108 return $string;
1109}
1110
1111sub seed_camelcase_file {
1112 my ($file) = @_;
1113
1114 return if (!(-f $file));
1115
1116 local $/;
1117
1118 open(my $include_file, '<', "$file")
1119 or warn "$P: Can't read '$file' $!\n";
1120 my $text = <$include_file>;
1121 close($include_file);
1122
1123 my @lines = split('\n', $text);
1124
1125 foreach my $line (@lines) {
1126 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
1127 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
1128 $camelcase{$1} = 1;
1129 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
1130 $camelcase{$1} = 1;
1131 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
1132 $camelcase{$1} = 1;
1133 }
1134 }
1135}
1136
1137our %maintained_status = ();
1138
1139sub is_maintained_obsolete {
1140 my ($filename) = @_;
1141
1142 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
1143
1144 if (!exists($maintained_status{$filename})) {
1145 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1146 }
1147
1148 return $maintained_status{$filename} =~ /obsolete/i;
1149}
1150
1151sub is_SPDX_License_valid {
1152 my ($license) = @_;
1153
1154 return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
1155
1156 my $root_path = abs_path($root);
1157 my $status = `cd "$root_path"; echo "$license" | scripts/spdxcheck.py -`;
1158 return 0 if ($status ne "");
1159 return 1;
1160}
1161
1162my $camelcase_seeded = 0;
1163sub seed_camelcase_includes {
1164 return if ($camelcase_seeded);
1165
1166 my $files;
1167 my $camelcase_cache = "";
1168 my @include_files = ();
1169
1170 $camelcase_seeded = 1;
1171
1172 if (-e "$gitroot") {
1173 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1174 chomp $git_last_include_commit;
1175 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
1176 } else {
1177 my $last_mod_date = 0;
1178 $files = `find $root/include -name "*.h"`;
1179 @include_files = split('\n', $files);
1180 foreach my $file (@include_files) {
1181 my $date = POSIX::strftime("%Y%m%d%H%M",
1182 localtime((stat $file)[9]));
1183 $last_mod_date = $date if ($last_mod_date < $date);
1184 }
1185 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
1186 }
1187
1188 if ($camelcase_cache ne "" && -f $camelcase_cache) {
1189 open(my $camelcase_file, '<', "$camelcase_cache")
1190 or warn "$P: Can't read '$camelcase_cache' $!\n";
1191 while (<$camelcase_file>) {
1192 chomp;
1193 $camelcase{$_} = 1;
1194 }
1195 close($camelcase_file);
1196
1197 return;
1198 }
1199
1200 if (-e "$gitroot") {
1201 $files = `${git_command} ls-files "include/*.h"`;
1202 @include_files = split('\n', $files);
1203 }
1204
1205 foreach my $file (@include_files) {
1206 seed_camelcase_file($file);
1207 }
1208
1209 if ($camelcase_cache ne "") {
1210 unlink glob ".checkpatch-camelcase.*";
1211 open(my $camelcase_file, '>', "$camelcase_cache")
1212 or warn "$P: Can't write '$camelcase_cache' $!\n";
1213 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
1214 print $camelcase_file ("$_\n");
1215 }
1216 close($camelcase_file);
1217 }
1218}
1219
1220sub git_is_single_file {
1221 my ($filename) = @_;
1222
1223 return 0 if ((which("git") eq "") || !(-e "$gitroot"));
1224
1225 my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
1226 my $count = $output =~ tr/\n//;
1227 return $count eq 1 && $output =~ m{^${filename}$};
1228}
1229
1230sub git_commit_info {
1231 my ($commit, $id, $desc) = @_;
1232
1233 return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot"));
1234
1235 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
1236 $output =~ s/^\s*//gm;
1237 my @lines = split("\n", $output);
1238
1239 return ($id, $desc) if ($#lines < 0);
1240
1241 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
1242# Maybe one day convert this block of bash into something that returns
1243# all matching commit ids, but it's very slow...
1244#
1245# echo "checking commits $1..."
1246# git rev-list --remotes | grep -i "^$1" |
1247# while read line ; do
1248# git log --format='%H %s' -1 $line |
1249# echo "commit $(cut -c 1-12,41-)"
1250# done
1251 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
1252 $lines[0] =~ /^fatal: bad object $commit/) {
1253 $id = undef;
1254 } else {
1255 $id = substr($lines[0], 0, 12);
1256 $desc = substr($lines[0], 41);
1257 }
1258
1259 return ($id, $desc);
1260}
1261
1262$chk_signoff = 0 if ($file);
1263$chk_fixes_tag = 0 if ($file);
1264
1265my @rawlines = ();
1266my @lines = ();
1267my @fixed = ();
1268my @fixed_inserted = ();
1269my @fixed_deleted = ();
1270my $fixlinenr = -1;
1271
1272# If input is git commits, extract all commits from the commit expressions.
1273# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1274die "$P: No git repository found\n" if ($git && !-e "$gitroot");
1275
1276if ($git) {
1277 my @commits = ();
1278 foreach my $commit_expr (@ARGV) {
1279 my $git_range;
1280 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1281 $git_range = "-$2 $1";
1282 } elsif ($commit_expr =~ m/\.\./) {
1283 $git_range = "$commit_expr";
1284 } else {
1285 $git_range = "-1 $commit_expr";
1286 }
1287 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1288 foreach my $line (split(/\n/, $lines)) {
1289 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1290 next if (!defined($1) || !defined($2));
1291 my $sha1 = $1;
1292 my $subject = $2;
1293 unshift(@commits, $sha1);
1294 $git_commits{$sha1} = $subject;
1295 }
1296 }
1297 die "$P: no git commits after extraction!\n" if (@commits == 0);
1298 @ARGV = @commits;
1299}
1300
1301my $vname;
1302$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
1303for my $filename (@ARGV) {
1304 my $FILE;
1305 my $is_git_file = git_is_single_file($filename);
1306 my $oldfile = $file;
1307 $file = 1 if ($is_git_file);
1308 if ($git) {
1309 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1310 die "$P: $filename: git format-patch failed - $!\n";
1311 } elsif ($file) {
1312 open($FILE, '-|', "diff -u /dev/null $filename") ||
1313 die "$P: $filename: diff failed - $!\n";
1314 } elsif ($filename eq '-') {
1315 open($FILE, '<&STDIN');
1316 } else {
1317 open($FILE, '<', "$filename") ||
1318 die "$P: $filename: open failed - $!\n";
1319 }
1320 if ($filename eq '-') {
1321 $vname = 'Your patch';
1322 } elsif ($git) {
1323 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
1324 } else {
1325 $vname = $filename;
1326 }
1327 while (<$FILE>) {
1328 chomp;
1329 push(@rawlines, $_);
1330 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
1331 }
1332 close($FILE);
1333
1334 if ($#ARGV > 0 && $quiet == 0) {
1335 print '-' x length($vname) . "\n";
1336 print "$vname\n";
1337 print '-' x length($vname) . "\n";
1338 }
1339
1340 if (!process($filename)) {
1341 $exit = 1;
1342 }
1343 @rawlines = ();
1344 @lines = ();
1345 @fixed = ();
1346 @fixed_inserted = ();
1347 @fixed_deleted = ();
1348 $fixlinenr = -1;
1349 @modifierListFile = ();
1350 @typeListFile = ();
1351 build_types();
1352 $file = $oldfile if ($is_git_file);
1353}
1354
1355if (!$quiet) {
1356 hash_show_words(\%use_type, "Used");
1357 hash_show_words(\%ignore_type, "Ignored");
1358
1359 if (!$perl_version_ok) {
1360 print << "EOM"
1361
1362NOTE: perl $^V is not modern enough to detect all possible issues.
1363 An upgrade to at least perl $minimum_perl_version is suggested.
1364EOM
1365 }
1366 if ($exit) {
1367 print << "EOM"
1368
1369NOTE: If any of the errors are false positives, please report
1370 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1371EOM
1372 }
1373}
1374
1375exit($exit);
1376
1377sub top_of_kernel_tree {
1378 my ($root) = @_;
1379
1380 my @tree_check = (
1381 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1382 "README", "Documentation", "arch", "include", "drivers",
1383 "fs", "init", "ipc", "kernel", "lib", "scripts",
1384 );
1385
1386 foreach my $check (@tree_check) {
1387 if (! -e $root . '/' . $check) {
1388 return 0;
1389 }
1390 }
1391 return 1;
1392}
1393
1394sub parse_email {
1395 my ($formatted_email) = @_;
1396
1397 my $name = "";
1398 my $quoted = "";
1399 my $name_comment = "";
1400 my $address = "";
1401 my $comment = "";
1402
1403 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1404 $name = $1;
1405 $address = $2;
1406 $comment = $3 if defined $3;
1407 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1408 $address = $1;
1409 $comment = $2 if defined $2;
1410 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1411 $address = $1;
1412 $comment = $2 if defined $2;
1413 $formatted_email =~ s/\Q$address\E.*$//;
1414 $name = $formatted_email;
1415 $name = trim($name);
1416 $name =~ s/^\"|\"$//g;
1417 # If there's a name left after stripping spaces and
1418 # leading quotes, and the address doesn't have both
1419 # leading and trailing angle brackets, the address
1420 # is invalid. ie:
1421 # "joe smith joe@smith.com" bad
1422 # "joe smith <joe@smith.com" bad
1423 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1424 $name = "";
1425 $address = "";
1426 $comment = "";
1427 }
1428 }
1429
1430 # Extract comments from names excluding quoted parts
1431 # "John D. (Doe)" - Do not extract
1432 if ($name =~ s/\"(.+)\"//) {
1433 $quoted = $1;
1434 }
1435 while ($name =~ s/\s*($balanced_parens)\s*/ /) {
1436 $name_comment .= trim($1);
1437 }
1438 $name =~ s/^[ \"]+|[ \"]+$//g;
1439 $name = trim("$quoted $name");
1440
1441 $address = trim($address);
1442 $address =~ s/^\<|\>$//g;
1443 $comment = trim($comment);
1444
1445 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1446 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1447 $name = "\"$name\"";
1448 }
1449
1450 return ($name, $name_comment, $address, $comment);
1451}
1452
1453sub format_email {
1454 my ($name, $name_comment, $address, $comment) = @_;
1455
1456 my $formatted_email;
1457
1458 $name =~ s/^[ \"]+|[ \"]+$//g;
1459 $address = trim($address);
1460 $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes
1461
1462 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1463 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1464 $name = "\"$name\"";
1465 }
1466
1467 $name_comment = trim($name_comment);
1468 $name_comment = " $name_comment" if ($name_comment ne "");
1469 $comment = trim($comment);
1470 $comment = " $comment" if ($comment ne "");
1471
1472 if ("$name" eq "") {
1473 $formatted_email = "$address";
1474 } else {
1475 $formatted_email = "$name$name_comment <$address>";
1476 }
1477 $formatted_email .= "$comment";
1478 return $formatted_email;
1479}
1480
1481sub reformat_email {
1482 my ($email) = @_;
1483
1484 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1485 return format_email($email_name, $name_comment, $email_address, $comment);
1486}
1487
1488sub same_email_addresses {
1489 my ($email1, $email2) = @_;
1490
1491 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1492 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1493
1494 return $email1_name eq $email2_name &&
1495 $email1_address eq $email2_address &&
1496 $name1_comment eq $name2_comment &&
1497 $comment1 eq $comment2;
1498}
1499
1500sub which {
1501 my ($bin) = @_;
1502
1503 foreach my $path (split(/:/, $ENV{PATH})) {
1504 if (-e "$path/$bin") {
1505 return "$path/$bin";
1506 }
1507 }
1508
1509 return "";
1510}
1511
1512sub which_conf {
1513 my ($conf) = @_;
1514
1515 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1516 if (-e "$path/$conf") {
1517 return "$path/$conf";
1518 }
1519 }
1520
1521 return "";
1522}
1523
1524sub expand_tabs {
1525 my ($str) = @_;
1526
1527 my $res = '';
1528 my $n = 0;
1529 for my $c (split(//, $str)) {
1530 if ($c eq "\t") {
1531 $res .= ' ';
1532 $n++;
1533 for (; ($n % $tabsize) != 0; $n++) {
1534 $res .= ' ';
1535 }
1536 next;
1537 }
1538 $res .= $c;
1539 $n++;
1540 }
1541
1542 return $res;
1543}
1544sub copy_spacing {
1545 (my $res = shift) =~ tr/\t/ /c;
1546 return $res;
1547}
1548
1549sub line_stats {
1550 my ($line) = @_;
1551
1552 # Drop the diff line leader and expand tabs
1553 $line =~ s/^.//;
1554 $line = expand_tabs($line);
1555
1556 # Pick the indent from the front of the line.
1557 my ($white) = ($line =~ /^(\s*)/);
1558
1559 return (length($line), length($white));
1560}
1561
1562my $sanitise_quote = '';
1563
1564sub sanitise_line_reset {
1565 my ($in_comment) = @_;
1566
1567 if ($in_comment) {
1568 $sanitise_quote = '*/';
1569 } else {
1570 $sanitise_quote = '';
1571 }
1572}
1573sub sanitise_line {
1574 my ($line) = @_;
1575
1576 my $res = '';
1577 my $l = '';
1578
1579 my $qlen = 0;
1580 my $off = 0;
1581 my $c;
1582
1583 # Always copy over the diff marker.
1584 $res = substr($line, 0, 1);
1585
1586 for ($off = 1; $off < length($line); $off++) {
1587 $c = substr($line, $off, 1);
1588
1589 # Comments we are whacking completely including the begin
1590 # and end, all to $;.
1591 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1592 $sanitise_quote = '*/';
1593
1594 substr($res, $off, 2, "$;$;");
1595 $off++;
1596 next;
1597 }
1598 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
1599 $sanitise_quote = '';
1600 substr($res, $off, 2, "$;$;");
1601 $off++;
1602 next;
1603 }
1604 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1605 $sanitise_quote = '//';
1606
1607 substr($res, $off, 2, $sanitise_quote);
1608 $off++;
1609 next;
1610 }
1611
1612 # A \ in a string means ignore the next character.
1613 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1614 $c eq "\\") {
1615 substr($res, $off, 2, 'XX');
1616 $off++;
1617 next;
1618 }
1619 # Regular quotes.
1620 if ($c eq "'" || $c eq '"') {
1621 if ($sanitise_quote eq '') {
1622 $sanitise_quote = $c;
1623
1624 substr($res, $off, 1, $c);
1625 next;
1626 } elsif ($sanitise_quote eq $c) {
1627 $sanitise_quote = '';
1628 }
1629 }
1630
1631 #print "c<$c> SQ<$sanitise_quote>\n";
1632 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1633 substr($res, $off, 1, $;);
1634 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1635 substr($res, $off, 1, $;);
1636 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1637 substr($res, $off, 1, 'X');
1638 } else {
1639 substr($res, $off, 1, $c);
1640 }
1641 }
1642
1643 if ($sanitise_quote eq '//') {
1644 $sanitise_quote = '';
1645 }
1646
1647 # The pathname on a #include may be surrounded by '<' and '>'.
1648 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
1649 my $clean = 'X' x length($1);
1650 $res =~ s@\<.*\>@<$clean>@;
1651
1652 # The whole of a #error is a string.
1653 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
1654 my $clean = 'X' x length($1);
1655 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
1656 }
1657
1658 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1659 my $match = $1;
1660 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1661 }
1662
1663 return $res;
1664}
1665
1666sub get_quoted_string {
1667 my ($line, $rawline) = @_;
1668
1669 return "" if (!defined($line) || !defined($rawline));
1670 return "" if ($line !~ m/($String)/g);
1671 return substr($rawline, $-[0], $+[0] - $-[0]);
1672}
1673
1674sub ctx_statement_block {
1675 my ($linenr, $remain, $off) = @_;
1676 my $line = $linenr - 1;
1677 my $blk = '';
1678 my $soff = $off;
1679 my $coff = $off - 1;
1680 my $coff_set = 0;
1681
1682 my $loff = 0;
1683
1684 my $type = '';
1685 my $level = 0;
1686 my @stack = ();
1687 my $p;
1688 my $c;
1689 my $len = 0;
1690
1691 my $remainder;
1692 while (1) {
1693 @stack = (['', 0]) if ($#stack == -1);
1694
1695 #warn "CSB: blk<$blk> remain<$remain>\n";
1696 # If we are about to drop off the end, pull in more
1697 # context.
1698 if ($off >= $len) {
1699 for (; $remain > 0; $line++) {
1700 last if (!defined $lines[$line]);
1701 next if ($lines[$line] =~ /^-/);
1702 $remain--;
1703 $loff = $len;
1704 $blk .= $lines[$line] . "\n";
1705 $len = length($blk);
1706 $line++;
1707 last;
1708 }
1709 # Bail if there is no further context.
1710 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1711 if ($off >= $len) {
1712 last;
1713 }
1714 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1715 $level++;
1716 $type = '#';
1717 }
1718 }
1719 $p = $c;
1720 $c = substr($blk, $off, 1);
1721 $remainder = substr($blk, $off);
1722
1723 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1724
1725 # Handle nested #if/#else.
1726 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1727 push(@stack, [ $type, $level ]);
1728 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1729 ($type, $level) = @{$stack[$#stack - 1]};
1730 } elsif ($remainder =~ /^#\s*endif\b/) {
1731 ($type, $level) = @{pop(@stack)};
1732 }
1733
1734 # Statement ends at the ';' or a close '}' at the
1735 # outermost level.
1736 if ($level == 0 && $c eq ';') {
1737 last;
1738 }
1739
1740 # An else is really a conditional as long as its not else if
1741 if ($level == 0 && $coff_set == 0 &&
1742 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1743 $remainder =~ /^(else)(?:\s|{)/ &&
1744 $remainder !~ /^else\s+if\b/) {
1745 $coff = $off + length($1) - 1;
1746 $coff_set = 1;
1747 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1748 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1749 }
1750
1751 if (($type eq '' || $type eq '(') && $c eq '(') {
1752 $level++;
1753 $type = '(';
1754 }
1755 if ($type eq '(' && $c eq ')') {
1756 $level--;
1757 $type = ($level != 0)? '(' : '';
1758
1759 if ($level == 0 && $coff < $soff) {
1760 $coff = $off;
1761 $coff_set = 1;
1762 #warn "CSB: mark coff<$coff>\n";
1763 }
1764 }
1765 if (($type eq '' || $type eq '{') && $c eq '{') {
1766 $level++;
1767 $type = '{';
1768 }
1769 if ($type eq '{' && $c eq '}') {
1770 $level--;
1771 $type = ($level != 0)? '{' : '';
1772
1773 if ($level == 0) {
1774 if (substr($blk, $off + 1, 1) eq ';') {
1775 $off++;
1776 }
1777 last;
1778 }
1779 }
1780 # Preprocessor commands end at the newline unless escaped.
1781 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1782 $level--;
1783 $type = '';
1784 $off++;
1785 last;
1786 }
1787 $off++;
1788 }
1789 # We are truly at the end, so shuffle to the next line.
1790 if ($off == $len) {
1791 $loff = $len + 1;
1792 $line++;
1793 $remain--;
1794 }
1795
1796 my $statement = substr($blk, $soff, $off - $soff + 1);
1797 my $condition = substr($blk, $soff, $coff - $soff + 1);
1798
1799 #warn "STATEMENT<$statement>\n";
1800 #warn "CONDITION<$condition>\n";
1801
1802 #print "coff<$coff> soff<$off> loff<$loff>\n";
1803
1804 return ($statement, $condition,
1805 $line, $remain + 1, $off - $loff + 1, $level);
1806}
1807
1808sub statement_lines {
1809 my ($stmt) = @_;
1810
1811 # Strip the diff line prefixes and rip blank lines at start and end.
1812 $stmt =~ s/(^|\n)./$1/g;
1813 $stmt =~ s/^\s*//;
1814 $stmt =~ s/\s*$//;
1815
1816 my @stmt_lines = ($stmt =~ /\n/g);
1817
1818 return $#stmt_lines + 2;
1819}
1820
1821sub statement_rawlines {
1822 my ($stmt) = @_;
1823
1824 my @stmt_lines = ($stmt =~ /\n/g);
1825
1826 return $#stmt_lines + 2;
1827}
1828
1829sub statement_block_size {
1830 my ($stmt) = @_;
1831
1832 $stmt =~ s/(^|\n)./$1/g;
1833 $stmt =~ s/^\s*{//;
1834 $stmt =~ s/}\s*$//;
1835 $stmt =~ s/^\s*//;
1836 $stmt =~ s/\s*$//;
1837
1838 my @stmt_lines = ($stmt =~ /\n/g);
1839 my @stmt_statements = ($stmt =~ /;/g);
1840
1841 my $stmt_lines = $#stmt_lines + 2;
1842 my $stmt_statements = $#stmt_statements + 1;
1843
1844 if ($stmt_lines > $stmt_statements) {
1845 return $stmt_lines;
1846 } else {
1847 return $stmt_statements;
1848 }
1849}
1850
1851sub ctx_statement_full {
1852 my ($linenr, $remain, $off) = @_;
1853 my ($statement, $condition, $level);
1854
1855 my (@chunks);
1856
1857 # Grab the first conditional/block pair.
1858 ($statement, $condition, $linenr, $remain, $off, $level) =
1859 ctx_statement_block($linenr, $remain, $off);
1860 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1861 push(@chunks, [ $condition, $statement ]);
1862 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1863 return ($level, $linenr, @chunks);
1864 }
1865
1866 # Pull in the following conditional/block pairs and see if they
1867 # could continue the statement.
1868 for (;;) {
1869 ($statement, $condition, $linenr, $remain, $off, $level) =
1870 ctx_statement_block($linenr, $remain, $off);
1871 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1872 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
1873 #print "C: push\n";
1874 push(@chunks, [ $condition, $statement ]);
1875 }
1876
1877 return ($level, $linenr, @chunks);
1878}
1879
1880sub ctx_block_get {
1881 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
1882 my $line;
1883 my $start = $linenr - 1;
1884 my $blk = '';
1885 my @o;
1886 my @c;
1887 my @res = ();
1888
1889 my $level = 0;
1890 my @stack = ($level);
1891 for ($line = $start; $remain > 0; $line++) {
1892 next if ($rawlines[$line] =~ /^-/);
1893 $remain--;
1894
1895 $blk .= $rawlines[$line];
1896
1897 # Handle nested #if/#else.
1898 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1899 push(@stack, $level);
1900 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1901 $level = $stack[$#stack - 1];
1902 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1903 $level = pop(@stack);
1904 }
1905
1906 foreach my $c (split(//, $lines[$line])) {
1907 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1908 if ($off > 0) {
1909 $off--;
1910 next;
1911 }
1912
1913 if ($c eq $close && $level > 0) {
1914 $level--;
1915 last if ($level == 0);
1916 } elsif ($c eq $open) {
1917 $level++;
1918 }
1919 }
1920
1921 if (!$outer || $level <= 1) {
1922 push(@res, $rawlines[$line]);
1923 }
1924
1925 last if ($level == 0);
1926 }
1927
1928 return ($level, @res);
1929}
1930sub ctx_block_outer {
1931 my ($linenr, $remain) = @_;
1932
1933 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1934 return @r;
1935}
1936sub ctx_block {
1937 my ($linenr, $remain) = @_;
1938
1939 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1940 return @r;
1941}
1942sub ctx_statement {
1943 my ($linenr, $remain, $off) = @_;
1944
1945 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1946 return @r;
1947}
1948sub ctx_block_level {
1949 my ($linenr, $remain) = @_;
1950
1951 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1952}
1953sub ctx_statement_level {
1954 my ($linenr, $remain, $off) = @_;
1955
1956 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1957}
1958
1959sub ctx_locate_comment {
1960 my ($first_line, $end_line) = @_;
1961
1962 # If c99 comment on the current line, or the line before or after
1963 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1964 return $current_comment if (defined $current_comment);
1965 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1966 return $current_comment if (defined $current_comment);
1967 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1968 return $current_comment if (defined $current_comment);
1969
1970 # Catch a comment on the end of the line itself.
1971 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1972 return $current_comment if (defined $current_comment);
1973
1974 # Look through the context and try and figure out if there is a
1975 # comment.
1976 my $in_comment = 0;
1977 $current_comment = '';
1978 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1979 my $line = $rawlines[$linenr - 1];
1980 #warn " $line\n";
1981 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1982 $in_comment = 1;
1983 }
1984 if ($line =~ m@/\*@) {
1985 $in_comment = 1;
1986 }
1987 if (!$in_comment && $current_comment ne '') {
1988 $current_comment = '';
1989 }
1990 $current_comment .= $line . "\n" if ($in_comment);
1991 if ($line =~ m@\*/@) {
1992 $in_comment = 0;
1993 }
1994 }
1995
1996 chomp($current_comment);
1997 return($current_comment);
1998}
1999sub ctx_has_comment {
2000 my ($first_line, $end_line) = @_;
2001 my $cmt = ctx_locate_comment($first_line, $end_line);
2002
2003 ##print "LINE: $rawlines[$end_line - 1 ]\n";
2004 ##print "CMMT: $cmt\n";
2005
2006 return ($cmt ne '');
2007}
2008
2009sub raw_line {
2010 my ($linenr, $cnt) = @_;
2011
2012 my $offset = $linenr - 1;
2013 $cnt++;
2014
2015 my $line;
2016 while ($cnt) {
2017 $line = $rawlines[$offset++];
2018 next if (defined($line) && $line =~ /^-/);
2019 $cnt--;
2020 }
2021
2022 return $line;
2023}
2024
2025sub get_stat_real {
2026 my ($linenr, $lc) = @_;
2027
2028 my $stat_real = raw_line($linenr, 0);
2029 for (my $count = $linenr + 1; $count <= $lc; $count++) {
2030 $stat_real = $stat_real . "\n" . raw_line($count, 0);
2031 }
2032
2033 return $stat_real;
2034}
2035
2036sub get_stat_here {
2037 my ($linenr, $cnt, $here) = @_;
2038
2039 my $herectx = $here . "\n";
2040 for (my $n = 0; $n < $cnt; $n++) {
2041 $herectx .= raw_line($linenr, $n) . "\n";
2042 }
2043
2044 return $herectx;
2045}
2046
2047sub cat_vet {
2048 my ($vet) = @_;
2049 my ($res, $coded);
2050
2051 $res = '';
2052 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
2053 $res .= $1;
2054 if ($2 ne '') {
2055 $coded = sprintf("^%c", unpack('C', $2) + 64);
2056 $res .= $coded;
2057 }
2058 }
2059 $res =~ s/$/\$/;
2060
2061 return $res;
2062}
2063
2064my $av_preprocessor = 0;
2065my $av_pending;
2066my @av_paren_type;
2067my $av_pend_colon;
2068
2069sub annotate_reset {
2070 $av_preprocessor = 0;
2071 $av_pending = '_';
2072 @av_paren_type = ('E');
2073 $av_pend_colon = 'O';
2074}
2075
2076sub annotate_values {
2077 my ($stream, $type) = @_;
2078
2079 my $res;
2080 my $var = '_' x length($stream);
2081 my $cur = $stream;
2082
2083 print "$stream\n" if ($dbg_values > 1);
2084
2085 while (length($cur)) {
2086 @av_paren_type = ('E') if ($#av_paren_type < 0);
2087 print " <" . join('', @av_paren_type) .
2088 "> <$type> <$av_pending>" if ($dbg_values > 1);
2089 if ($cur =~ /^(\s+)/o) {
2090 print "WS($1)\n" if ($dbg_values > 1);
2091 if ($1 =~ /\n/ && $av_preprocessor) {
2092 $type = pop(@av_paren_type);
2093 $av_preprocessor = 0;
2094 }
2095
2096 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
2097 print "CAST($1)\n" if ($dbg_values > 1);
2098 push(@av_paren_type, $type);
2099 $type = 'c';
2100
2101 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
2102 print "DECLARE($1)\n" if ($dbg_values > 1);
2103 $type = 'T';
2104
2105 } elsif ($cur =~ /^($Modifier)\s*/) {
2106 print "MODIFIER($1)\n" if ($dbg_values > 1);
2107 $type = 'T';
2108
2109 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
2110 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
2111 $av_preprocessor = 1;
2112 push(@av_paren_type, $type);
2113 if ($2 ne '') {
2114 $av_pending = 'N';
2115 }
2116 $type = 'E';
2117
2118 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
2119 print "UNDEF($1)\n" if ($dbg_values > 1);
2120 $av_preprocessor = 1;
2121 push(@av_paren_type, $type);
2122
2123 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
2124 print "PRE_START($1)\n" if ($dbg_values > 1);
2125 $av_preprocessor = 1;
2126
2127 push(@av_paren_type, $type);
2128 push(@av_paren_type, $type);
2129 $type = 'E';
2130
2131 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
2132 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
2133 $av_preprocessor = 1;
2134
2135 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
2136
2137 $type = 'E';
2138
2139 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
2140 print "PRE_END($1)\n" if ($dbg_values > 1);
2141
2142 $av_preprocessor = 1;
2143
2144 # Assume all arms of the conditional end as this
2145 # one does, and continue as if the #endif was not here.
2146 pop(@av_paren_type);
2147 push(@av_paren_type, $type);
2148 $type = 'E';
2149
2150 } elsif ($cur =~ /^(\\\n)/o) {
2151 print "PRECONT($1)\n" if ($dbg_values > 1);
2152
2153 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
2154 print "ATTR($1)\n" if ($dbg_values > 1);
2155 $av_pending = $type;
2156 $type = 'N';
2157
2158 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
2159 print "SIZEOF($1)\n" if ($dbg_values > 1);
2160 if (defined $2) {
2161 $av_pending = 'V';
2162 }
2163 $type = 'N';
2164
2165 } elsif ($cur =~ /^(if|while|for)\b/o) {
2166 print "COND($1)\n" if ($dbg_values > 1);
2167 $av_pending = 'E';
2168 $type = 'N';
2169
2170 } elsif ($cur =~/^(case)/o) {
2171 print "CASE($1)\n" if ($dbg_values > 1);
2172 $av_pend_colon = 'C';
2173 $type = 'N';
2174
2175 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
2176 print "KEYWORD($1)\n" if ($dbg_values > 1);
2177 $type = 'N';
2178
2179 } elsif ($cur =~ /^(\()/o) {
2180 print "PAREN('$1')\n" if ($dbg_values > 1);
2181 push(@av_paren_type, $av_pending);
2182 $av_pending = '_';
2183 $type = 'N';
2184
2185 } elsif ($cur =~ /^(\))/o) {
2186 my $new_type = pop(@av_paren_type);
2187 if ($new_type ne '_') {
2188 $type = $new_type;
2189 print "PAREN('$1') -> $type\n"
2190 if ($dbg_values > 1);
2191 } else {
2192 print "PAREN('$1')\n" if ($dbg_values > 1);
2193 }
2194
2195 } elsif ($cur =~ /^($Ident)\s*\(/o) {
2196 print "FUNC($1)\n" if ($dbg_values > 1);
2197 $type = 'V';
2198 $av_pending = 'V';
2199
2200 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
2201 if (defined $2 && $type eq 'C' || $type eq 'T') {
2202 $av_pend_colon = 'B';
2203 } elsif ($type eq 'E') {
2204 $av_pend_colon = 'L';
2205 }
2206 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
2207 $type = 'V';
2208
2209 } elsif ($cur =~ /^($Ident|$Constant)/o) {
2210 print "IDENT($1)\n" if ($dbg_values > 1);
2211 $type = 'V';
2212
2213 } elsif ($cur =~ /^($Assignment)/o) {
2214 print "ASSIGN($1)\n" if ($dbg_values > 1);
2215 $type = 'N';
2216
2217 } elsif ($cur =~/^(;|{|})/) {
2218 print "END($1)\n" if ($dbg_values > 1);
2219 $type = 'E';
2220 $av_pend_colon = 'O';
2221
2222 } elsif ($cur =~/^(,)/) {
2223 print "COMMA($1)\n" if ($dbg_values > 1);
2224 $type = 'C';
2225
2226 } elsif ($cur =~ /^(\?)/o) {
2227 print "QUESTION($1)\n" if ($dbg_values > 1);
2228 $type = 'N';
2229
2230 } elsif ($cur =~ /^(:)/o) {
2231 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
2232
2233 substr($var, length($res), 1, $av_pend_colon);
2234 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
2235 $type = 'E';
2236 } else {
2237 $type = 'N';
2238 }
2239 $av_pend_colon = 'O';
2240
2241 } elsif ($cur =~ /^(\[)/o) {
2242 print "CLOSE($1)\n" if ($dbg_values > 1);
2243 $type = 'N';
2244
2245 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
2246 my $variant;
2247
2248 print "OPV($1)\n" if ($dbg_values > 1);
2249 if ($type eq 'V') {
2250 $variant = 'B';
2251 } else {
2252 $variant = 'U';
2253 }
2254
2255 substr($var, length($res), 1, $variant);
2256 $type = 'N';
2257
2258 } elsif ($cur =~ /^($Operators)/o) {
2259 print "OP($1)\n" if ($dbg_values > 1);
2260 if ($1 ne '++' && $1 ne '--') {
2261 $type = 'N';
2262 }
2263
2264 } elsif ($cur =~ /(^.)/o) {
2265 print "C($1)\n" if ($dbg_values > 1);
2266 }
2267 if (defined $1) {
2268 $cur = substr($cur, length($1));
2269 $res .= $type x length($1);
2270 }
2271 }
2272
2273 return ($res, $var);
2274}
2275
2276sub possible {
2277 my ($possible, $line) = @_;
2278 my $notPermitted = qr{(?:
2279 ^(?:
2280 $Modifier|
2281 $Storage|
2282 $Type|
2283 DEFINE_\S+
2284 )$|
2285 ^(?:
2286 goto|
2287 return|
2288 case|
2289 else|
2290 asm|__asm__|
2291 do|
2292 \#|
2293 \#\#|
2294 )(?:\s|$)|
2295 ^(?:typedef|struct|enum)\b
2296 )}x;
2297 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2298 if ($possible !~ $notPermitted) {
2299 # Check for modifiers.
2300 $possible =~ s/\s*$Storage\s*//g;
2301 $possible =~ s/\s*$Sparse\s*//g;
2302 if ($possible =~ /^\s*$/) {
2303
2304 } elsif ($possible =~ /\s/) {
2305 $possible =~ s/\s*$Type\s*//g;
2306 for my $modifier (split(' ', $possible)) {
2307 if ($modifier !~ $notPermitted) {
2308 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
2309 push(@modifierListFile, $modifier);
2310 }
2311 }
2312
2313 } else {
2314 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
2315 push(@typeListFile, $possible);
2316 }
2317 build_types();
2318 } else {
2319 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
2320 }
2321}
2322
2323my $prefix = '';
2324
2325sub show_type {
2326 my ($type) = @_;
2327
2328 $type =~ tr/[a-z]/[A-Z]/;
2329
2330 return defined $use_type{$type} if (scalar keys %use_type > 0);
2331
2332 return !defined $ignore_type{$type};
2333}
2334
2335sub report {
2336 my ($level, $type, $msg) = @_;
2337
2338 if (!show_type($type) ||
2339 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
2340 return 0;
2341 }
2342 my $output = '';
2343 if ($color) {
2344 if ($level eq 'ERROR') {
2345 $output .= RED;
2346 } elsif ($level eq 'WARNING') {
2347 $output .= YELLOW;
2348 } else {
2349 $output .= GREEN;
2350 }
2351 }
2352 $output .= $prefix . $level . ':';
2353 if ($show_types) {
2354 $output .= BLUE if ($color);
2355 $output .= "$type:";
2356 }
2357 $output .= RESET if ($color);
2358 $output .= ' ' . $msg . "\n";
2359
2360 if ($showfile) {
2361 my @lines = split("\n", $output, -1);
2362 splice(@lines, 1, 1);
2363 $output = join("\n", @lines);
2364 }
2365
2366 if ($terse) {
2367 $output = (split('\n', $output))[0] . "\n";
2368 }
2369
2370 if ($verbose && exists($verbose_messages{$type}) &&
2371 !exists($verbose_emitted{$type})) {
2372 $output .= $verbose_messages{$type} . "\n\n";
2373 $verbose_emitted{$type} = 1;
2374 }
2375
2376 push(our @report, $output);
2377
2378 return 1;
2379}
2380
2381sub report_dump {
2382 our @report;
2383}
2384
2385sub fixup_current_range {
2386 my ($lineRef, $offset, $length) = @_;
2387
2388 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2389 my $o = $1;
2390 my $l = $2;
2391 my $no = $o + $offset;
2392 my $nl = $l + $length;
2393 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2394 }
2395}
2396
2397sub fix_inserted_deleted_lines {
2398 my ($linesRef, $insertedRef, $deletedRef) = @_;
2399
2400 my $range_last_linenr = 0;
2401 my $delta_offset = 0;
2402
2403 my $old_linenr = 0;
2404 my $new_linenr = 0;
2405
2406 my $next_insert = 0;
2407 my $next_delete = 0;
2408
2409 my @lines = ();
2410
2411 my $inserted = @{$insertedRef}[$next_insert++];
2412 my $deleted = @{$deletedRef}[$next_delete++];
2413
2414 foreach my $old_line (@{$linesRef}) {
2415 my $save_line = 1;
2416 my $line = $old_line; #don't modify the array
2417 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
2418 $delta_offset = 0;
2419 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2420 $range_last_linenr = $new_linenr;
2421 fixup_current_range(\$line, $delta_offset, 0);
2422 }
2423
2424 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2425 $deleted = @{$deletedRef}[$next_delete++];
2426 $save_line = 0;
2427 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2428 }
2429
2430 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2431 push(@lines, ${$inserted}{'LINE'});
2432 $inserted = @{$insertedRef}[$next_insert++];
2433 $new_linenr++;
2434 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2435 }
2436
2437 if ($save_line) {
2438 push(@lines, $line);
2439 $new_linenr++;
2440 }
2441
2442 $old_linenr++;
2443 }
2444
2445 return @lines;
2446}
2447
2448sub fix_insert_line {
2449 my ($linenr, $line) = @_;
2450
2451 my $inserted = {
2452 LINENR => $linenr,
2453 LINE => $line,
2454 };
2455 push(@fixed_inserted, $inserted);
2456}
2457
2458sub fix_delete_line {
2459 my ($linenr, $line) = @_;
2460
2461 my $deleted = {
2462 LINENR => $linenr,
2463 LINE => $line,
2464 };
2465
2466 push(@fixed_deleted, $deleted);
2467}
2468
2469sub ERROR {
2470 my ($type, $msg) = @_;
2471
2472 if (report("ERROR", $type, $msg)) {
2473 our $clean = 0;
2474 our $cnt_error++;
2475 return 1;
2476 }
2477 return 0;
2478}
2479sub WARN {
2480 my ($type, $msg) = @_;
2481
2482 if (report("WARNING", $type, $msg)) {
2483 our $clean = 0;
2484 our $cnt_warn++;
2485 return 1;
2486 }
2487 return 0;
2488}
2489sub CHK {
2490 my ($type, $msg) = @_;
2491
2492 if ($check && report("CHECK", $type, $msg)) {
2493 our $clean = 0;
2494 our $cnt_chk++;
2495 return 1;
2496 }
2497 return 0;
2498}
2499
2500sub check_absolute_file {
2501 my ($absolute, $herecurr) = @_;
2502 my $file = $absolute;
2503
2504 ##print "absolute<$absolute>\n";
2505
2506 # See if any suffix of this path is a path within the tree.
2507 while ($file =~ s@^[^/]*/@@) {
2508 if (-f "$root/$file") {
2509 ##print "file<$file>\n";
2510 last;
2511 }
2512 }
2513 if (! -f _) {
2514 return 0;
2515 }
2516
2517 # It is, so see if the prefix is acceptable.
2518 my $prefix = $absolute;
2519 substr($prefix, -length($file)) = '';
2520
2521 ##print "prefix<$prefix>\n";
2522 if ($prefix ne ".../") {
2523 WARN("USE_RELATIVE_PATH",
2524 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
2525 }
2526}
2527
2528sub trim {
2529 my ($string) = @_;
2530
2531 $string =~ s/^\s+|\s+$//g;
2532
2533 return $string;
2534}
2535
2536sub ltrim {
2537 my ($string) = @_;
2538
2539 $string =~ s/^\s+//;
2540
2541 return $string;
2542}
2543
2544sub rtrim {
2545 my ($string) = @_;
2546
2547 $string =~ s/\s+$//;
2548
2549 return $string;
2550}
2551
2552sub string_find_replace {
2553 my ($string, $find, $replace) = @_;
2554
2555 $string =~ s/$find/$replace/g;
2556
2557 return $string;
2558}
2559
2560sub tabify {
2561 my ($leading) = @_;
2562
2563 my $source_indent = $tabsize;
2564 my $max_spaces_before_tab = $source_indent - 1;
2565 my $spaces_to_tab = " " x $source_indent;
2566
2567 #convert leading spaces to tabs
2568 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2569 #Remove spaces before a tab
2570 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2571
2572 return "$leading";
2573}
2574
2575sub pos_last_openparen {
2576 my ($line) = @_;
2577
2578 my $pos = 0;
2579
2580 my $opens = $line =~ tr/\(/\(/;
2581 my $closes = $line =~ tr/\)/\)/;
2582
2583 my $last_openparen = 0;
2584
2585 if (($opens == 0) || ($closes >= $opens)) {
2586 return -1;
2587 }
2588
2589 my $len = length($line);
2590
2591 for ($pos = 0; $pos < $len; $pos++) {
2592 my $string = substr($line, $pos);
2593 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2594 $pos += length($1) - 1;
2595 } elsif (substr($line, $pos, 1) eq '(') {
2596 $last_openparen = $pos;
2597 } elsif (index($string, '(') == -1) {
2598 last;
2599 }
2600 }
2601
2602 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
2603}
2604
2605sub get_raw_comment {
2606 my ($line, $rawline) = @_;
2607 my $comment = '';
2608
2609 for my $i (0 .. (length($line) - 1)) {
2610 if (substr($line, $i, 1) eq "$;") {
2611 $comment .= substr($rawline, $i, 1);
2612 }
2613 }
2614
2615 return $comment;
2616}
2617
2618sub exclude_global_initialisers {
2619 my ($realfile) = @_;
2620
2621 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2622 return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ ||
2623 $realfile =~ m@^samples/bpf/.*_kern\.c$@ ||
2624 $realfile =~ m@/bpf/.*\.bpf\.c$@;
2625}
2626
2627sub process {
2628 my $filename = shift;
2629
2630 my $linenr=0;
2631 my $prevline="";
2632 my $prevrawline="";
2633 my $stashline="";
2634 my $stashrawline="";
2635
2636 my $length;
2637 my $indent;
2638 my $previndent=0;
2639 my $stashindent=0;
2640
2641 our $clean = 1;
2642 my $signoff = 0;
2643 my $fixes_tag = 0;
2644 my $is_revert = 0;
2645 my $needs_fixes_tag = "";
2646 my $author = '';
2647 my $authorsignoff = 0;
2648 my $author_sob = '';
2649 my $is_patch = 0;
2650 my $is_binding_patch = -1;
2651 my $in_header_lines = $file ? 0 : 1;
2652 my $in_commit_log = 0; #Scanning lines before patch
2653 my $has_patch_separator = 0; #Found a --- line
2654 my $has_commit_log = 0; #Encountered lines before patch
2655 my $commit_log_lines = 0; #Number of commit log lines
2656 my $commit_log_possible_stack_dump = 0;
2657 my $commit_log_long_line = 0;
2658 my $commit_log_has_diff = 0;
2659 my $reported_maintainer_file = 0;
2660 my $non_utf8_charset = 0;
2661
2662 my $last_git_commit_id_linenr = -1;
2663
2664 my $last_blank_line = 0;
2665 my $last_coalesced_string_linenr = -1;
2666
2667 our @report = ();
2668 our $cnt_lines = 0;
2669 our $cnt_error = 0;
2670 our $cnt_warn = 0;
2671 our $cnt_chk = 0;
2672
2673 # Trace the real file/line as we go.
2674 my $realfile = '';
2675 my $realline = 0;
2676 my $realcnt = 0;
2677 my $here = '';
2678 my $context_function; #undef'd unless there's a known function
2679 my $in_comment = 0;
2680 my $comment_edge = 0;
2681 my $first_line = 0;
2682 my $p1_prefix = '';
2683
2684 my $prev_values = 'E';
2685
2686 # suppression flags
2687 my %suppress_ifbraces;
2688 my %suppress_whiletrailers;
2689 my %suppress_export;
2690 my $suppress_statement = 0;
2691
2692 my %signatures = ();
2693
2694 # Pre-scan the patch sanitizing the lines.
2695 # Pre-scan the patch looking for any __setup documentation.
2696 #
2697 my @setup_docs = ();
2698 my $setup_docs = 0;
2699
2700 my $camelcase_file_seeded = 0;
2701
2702 my $checklicenseline = 1;
2703
2704 sanitise_line_reset();
2705 my $line;
2706 foreach my $rawline (@rawlines) {
2707 $linenr++;
2708 $line = $rawline;
2709
2710 push(@fixed, $rawline) if ($fix);
2711
2712 if ($rawline=~/^\+\+\+\s+(\S+)/) {
2713 $setup_docs = 0;
2714 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
2715 $setup_docs = 1;
2716 }
2717 #next;
2718 }
2719 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2720 $realline=$1-1;
2721 if (defined $2) {
2722 $realcnt=$3+1;
2723 } else {
2724 $realcnt=1+1;
2725 }
2726 $in_comment = 0;
2727
2728 # Guestimate if this is a continuing comment. Run
2729 # the context looking for a comment "edge". If this
2730 # edge is a close comment then we must be in a comment
2731 # at context start.
2732 my $edge;
2733 my $cnt = $realcnt;
2734 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2735 next if (defined $rawlines[$ln - 1] &&
2736 $rawlines[$ln - 1] =~ /^-/);
2737 $cnt--;
2738 #print "RAW<$rawlines[$ln - 1]>\n";
2739 last if (!defined $rawlines[$ln - 1]);
2740 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2741 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2742 ($edge) = $1;
2743 last;
2744 }
2745 }
2746 if (defined $edge && $edge eq '*/') {
2747 $in_comment = 1;
2748 }
2749
2750 # Guestimate if this is a continuing comment. If this
2751 # is the start of a diff block and this line starts
2752 # ' *' then it is very likely a comment.
2753 if (!defined $edge &&
2754 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
2755 {
2756 $in_comment = 1;
2757 }
2758
2759 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2760 sanitise_line_reset($in_comment);
2761
2762 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
2763 # Standardise the strings and chars within the input to
2764 # simplify matching -- only bother with positive lines.
2765 $line = sanitise_line($rawline);
2766 }
2767 push(@lines, $line);
2768
2769 if ($realcnt > 1) {
2770 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2771 } else {
2772 $realcnt = 0;
2773 }
2774
2775 #print "==>$rawline\n";
2776 #print "-->$line\n";
2777
2778 if ($setup_docs && $line =~ /^\+/) {
2779 push(@setup_docs, $line);
2780 }
2781 }
2782
2783 $prefix = '';
2784
2785 $realcnt = 0;
2786 $linenr = 0;
2787 $fixlinenr = -1;
2788 foreach my $line (@lines) {
2789 $linenr++;
2790 $fixlinenr++;
2791 my $sline = $line; #copy of $line
2792 $sline =~ s/$;/ /g; #with comments as spaces
2793
2794 my $rawline = $rawlines[$linenr - 1];
2795 my $raw_comment = get_raw_comment($line, $rawline);
2796
2797# check if it's a mode change, rename or start of a patch
2798 if (!$in_commit_log &&
2799 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2800 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2801 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2802 $is_patch = 1;
2803 }
2804
2805#extract the line range in the file after the patch is applied
2806 if (!$in_commit_log &&
2807 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2808 my $context = $4;
2809 $is_patch = 1;
2810 $first_line = $linenr + 1;
2811 $realline=$1-1;
2812 if (defined $2) {
2813 $realcnt=$3+1;
2814 } else {
2815 $realcnt=1+1;
2816 }
2817 annotate_reset();
2818 $prev_values = 'E';
2819
2820 %suppress_ifbraces = ();
2821 %suppress_whiletrailers = ();
2822 %suppress_export = ();
2823 $suppress_statement = 0;
2824 if ($context =~ /\b(\w+)\s*\(/) {
2825 $context_function = $1;
2826 } else {
2827 undef $context_function;
2828 }
2829 next;
2830
2831# track the line number as we move through the hunk, note that
2832# new versions of GNU diff omit the leading space on completely
2833# blank context lines so we need to count that too.
2834 } elsif ($line =~ /^( |\+|$)/) {
2835 $realline++;
2836 $realcnt-- if ($realcnt != 0);
2837
2838 # Measure the line length and indent.
2839 ($length, $indent) = line_stats($rawline);
2840
2841 # Track the previous line.
2842 ($prevline, $stashline) = ($stashline, $line);
2843 ($previndent, $stashindent) = ($stashindent, $indent);
2844 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2845
2846 #warn "line<$line>\n";
2847
2848 } elsif ($realcnt == 1) {
2849 $realcnt--;
2850 }
2851
2852 my $hunk_line = ($realcnt != 0);
2853
2854 $here = "#$linenr: " if (!$file);
2855 $here = "#$realline: " if ($file);
2856
2857 my $found_file = 0;
2858 # extract the filename as it passes
2859 if ($line =~ /^diff --git.*?(\S+)$/) {
2860 $realfile = $1;
2861 $realfile =~ s@^([^/]*)/@@ if (!$file);
2862 $in_commit_log = 0;
2863 $found_file = 1;
2864 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
2865 $realfile = $1;
2866 $realfile =~ s@^([^/]*)/@@ if (!$file);
2867 $in_commit_log = 0;
2868
2869 $p1_prefix = $1;
2870 if (!$file && $tree && $p1_prefix ne '' &&
2871 -e "$root/$p1_prefix") {
2872 WARN("PATCH_PREFIX",
2873 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
2874 }
2875
2876 if ($realfile =~ m@^include/asm/@) {
2877 ERROR("MODIFIED_INCLUDE_ASM",
2878 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2879 }
2880 $found_file = 1;
2881 }
2882
2883#make up the handle for any error we report on this line
2884 if ($showfile) {
2885 $prefix = "$realfile:$realline: "
2886 } elsif ($emacs) {
2887 if ($file) {
2888 $prefix = "$filename:$realline: ";
2889 } else {
2890 $prefix = "$filename:$linenr: ";
2891 }
2892 }
2893
2894 if ($found_file) {
2895 if (is_maintained_obsolete($realfile)) {
2896 WARN("OBSOLETE",
2897 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2898 }
2899 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
2900 $check = 1;
2901 } else {
2902 $check = $check_orig;
2903 }
2904 $checklicenseline = 1;
2905
2906 if ($realfile !~ /^MAINTAINERS/) {
2907 my $last_binding_patch = $is_binding_patch;
2908
2909 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2910
2911 if (($last_binding_patch != -1) &&
2912 ($last_binding_patch ^ $is_binding_patch)) {
2913 WARN("DT_SPLIT_BINDING_PATCH",
2914 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2915 }
2916 }
2917
2918 next;
2919 }
2920
2921 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
2922
2923 my $hereline = "$here\n$rawline\n";
2924 my $herecurr = "$here\n$rawline\n";
2925 my $hereprev = "$here\n$prevrawline\n$rawline\n";
2926
2927 $cnt_lines++ if ($realcnt != 0);
2928
2929# Verify the existence of a commit log if appropriate
2930# 2 is used because a $signature is counted in $commit_log_lines
2931 if ($in_commit_log) {
2932 if ($line !~ /^\s*$/) {
2933 $commit_log_lines++; #could be a $signature
2934 }
2935 } elsif ($has_commit_log && $commit_log_lines < 2) {
2936 WARN("COMMIT_MESSAGE",
2937 "Missing commit description - Add an appropriate one\n");
2938 $commit_log_lines = 2; #warn only once
2939 }
2940
2941# Check if the commit log has what seems like a diff which can confuse patch
2942 if ($in_commit_log && !$commit_log_has_diff &&
2943 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2944 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
2945 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2946 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2947 ERROR("DIFF_IN_COMMIT_MSG",
2948 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2949 $commit_log_has_diff = 1;
2950 }
2951
2952# Check for incorrect file permissions
2953 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2954 my $permhere = $here . "FILE: $realfile\n";
2955 if ($realfile !~ m@scripts/@ &&
2956 $realfile !~ /\.(py|pl|awk|sh)$/) {
2957 ERROR("EXECUTE_PERMISSIONS",
2958 "do not set execute permissions for source files\n" . $permhere);
2959 }
2960 }
2961
2962# Check the patch for a From:
2963 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2964 $author = $1;
2965 my $curline = $linenr;
2966 while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) {
2967 $author .= $1;
2968 }
2969 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2970 $author =~ s/"//g;
2971 $author = reformat_email($author);
2972 }
2973
2974# Check the patch for a signoff:
2975 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
2976 $signoff++;
2977 $in_commit_log = 0;
2978 if ($author ne '' && $authorsignoff != 1) {
2979 if (same_email_addresses($1, $author)) {
2980 $authorsignoff = 1;
2981 } else {
2982 my $ctx = $1;
2983 my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx);
2984 my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author);
2985
2986 if (lc $email_address eq lc $author_address && $email_name eq $author_name) {
2987 $author_sob = $ctx;
2988 $authorsignoff = 2;
2989 } elsif (lc $email_address eq lc $author_address) {
2990 $author_sob = $ctx;
2991 $authorsignoff = 3;
2992 } elsif ($email_name eq $author_name) {
2993 $author_sob = $ctx;
2994 $authorsignoff = 4;
2995
2996 my $address1 = $email_address;
2997 my $address2 = $author_address;
2998
2999 if ($address1 =~ /(\S+)\+\S+(\@.*)/) {
3000 $address1 = "$1$2";
3001 }
3002 if ($address2 =~ /(\S+)\+\S+(\@.*)/) {
3003 $address2 = "$1$2";
3004 }
3005 if ($address1 eq $address2) {
3006 $authorsignoff = 5;
3007 }
3008 }
3009 }
3010 }
3011 }
3012
3013# Check for patch separator
3014 if ($line =~ /^---$/) {
3015 $has_patch_separator = 1;
3016 $in_commit_log = 0;
3017 }
3018
3019# Check if MAINTAINERS is being updated. If so, there's probably no need to
3020# emit the "does MAINTAINERS need updating?" message on file add/move/delete
3021 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
3022 $reported_maintainer_file = 1;
3023 }
3024
3025# Check signature styles
3026 if (!$in_header_lines &&
3027 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
3028 my $space_before = $1;
3029 my $sign_off = $2;
3030 my $space_after = $3;
3031 my $email = $4;
3032 my $ucfirst_sign_off = ucfirst(lc($sign_off));
3033
3034 if ($sign_off !~ /$signature_tags/) {
3035 my $suggested_signature = find_standard_signature($sign_off);
3036 if ($suggested_signature eq "") {
3037 WARN("BAD_SIGN_OFF",
3038 "Non-standard signature: $sign_off\n" . $herecurr);
3039 } else {
3040 if (WARN("BAD_SIGN_OFF",
3041 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) &&
3042 $fix) {
3043 $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/;
3044 }
3045 }
3046 }
3047 if (defined $space_before && $space_before ne "") {
3048 if (WARN("BAD_SIGN_OFF",
3049 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
3050 $fix) {
3051 $fixed[$fixlinenr] =
3052 "$ucfirst_sign_off $email";
3053 }
3054 }
3055 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
3056 if (WARN("BAD_SIGN_OFF",
3057 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
3058 $fix) {
3059 $fixed[$fixlinenr] =
3060 "$ucfirst_sign_off $email";
3061 }
3062
3063 }
3064 if (!defined $space_after || $space_after ne " ") {
3065 if (WARN("BAD_SIGN_OFF",
3066 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
3067 $fix) {
3068 $fixed[$fixlinenr] =
3069 "$ucfirst_sign_off $email";
3070 }
3071 }
3072
3073 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
3074 my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment));
3075 if ($suggested_email eq "") {
3076 ERROR("BAD_SIGN_OFF",
3077 "Unrecognized email address: '$email'\n" . $herecurr);
3078 } else {
3079 my $dequoted = $suggested_email;
3080 $dequoted =~ s/^"//;
3081 $dequoted =~ s/" </ </;
3082 # Don't force email to have quotes
3083 # Allow just an angle bracketed address
3084 if (!same_email_addresses($email, $suggested_email)) {
3085 if (WARN("BAD_SIGN_OFF",
3086 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) &&
3087 $fix) {
3088 $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/;
3089 }
3090 }
3091
3092 # Address part shouldn't have comments
3093 my $stripped_address = $email_address;
3094 $stripped_address =~ s/\([^\(\)]*\)//g;
3095 if ($email_address ne $stripped_address) {
3096 if (WARN("BAD_SIGN_OFF",
3097 "address part of email should not have comments: '$email_address'\n" . $herecurr) &&
3098 $fix) {
3099 $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/;
3100 }
3101 }
3102
3103 # Only one name comment should be allowed
3104 my $comment_count = () = $name_comment =~ /\([^\)]+\)/g;
3105 if ($comment_count > 1) {
3106 WARN("BAD_SIGN_OFF",
3107 "Use a single name comment in email: '$email'\n" . $herecurr);
3108 }
3109
3110
3111 # stable@vger.kernel.org or stable@kernel.org shouldn't
3112 # have an email name. In addition comments should strictly
3113 # begin with a #
3114 if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) {
3115 if (($comment ne "" && $comment !~ /^#.+/) ||
3116 ($email_name ne "")) {
3117 my $cur_name = $email_name;
3118 my $new_comment = $comment;
3119 $cur_name =~ s/[a-zA-Z\s\-\"]+//g;
3120
3121 # Remove brackets enclosing comment text
3122 # and # from start of comments to get comment text
3123 $new_comment =~ s/^\((.*)\)$/$1/;
3124 $new_comment =~ s/^\[(.*)\]$/$1/;
3125 $new_comment =~ s/^[\s\#]+|\s+$//g;
3126
3127 $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment);
3128 $new_comment = " # $new_comment" if ($new_comment ne "");
3129 my $new_email = "$email_address$new_comment";
3130
3131 if (WARN("BAD_STABLE_ADDRESS_STYLE",
3132 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) &&
3133 $fix) {
3134 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3135 }
3136 }
3137 } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) {
3138 my $new_comment = $comment;
3139
3140 # Extract comment text from within brackets or
3141 # c89 style /*...*/ comments
3142 $new_comment =~ s/^\[(.*)\]$/$1/;
3143 $new_comment =~ s/^\/\*(.*)\*\/$/$1/;
3144
3145 $new_comment = trim($new_comment);
3146 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3147 $new_comment = "($new_comment)" if ($new_comment ne "");
3148 my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment);
3149
3150 if (WARN("BAD_SIGN_OFF",
3151 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) &&
3152 $fix) {
3153 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/;
3154 }
3155 }
3156 }
3157
3158# Check for duplicate signatures
3159 my $sig_nospace = $line;
3160 $sig_nospace =~ s/\s//g;
3161 $sig_nospace = lc($sig_nospace);
3162 if (defined $signatures{$sig_nospace}) {
3163 WARN("BAD_SIGN_OFF",
3164 "Duplicate signature\n" . $herecurr);
3165 } else {
3166 $signatures{$sig_nospace} = 1;
3167 }
3168
3169# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
3170 if ($sign_off =~ /^co-developed-by:$/i) {
3171 if ($email eq $author) {
3172 WARN("BAD_SIGN_OFF",
3173 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . $herecurr);
3174 }
3175 if (!defined $lines[$linenr]) {
3176 WARN("BAD_SIGN_OFF",
3177 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr);
3178 } elsif ($rawlines[$linenr] !~ /^signed-off-by:\s*(.*)/i) {
3179 WARN("BAD_SIGN_OFF",
3180 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr . $rawlines[$linenr] . "\n");
3181 } elsif ($1 ne $email) {
3182 WARN("BAD_SIGN_OFF",
3183 "Co-developed-by and Signed-off-by: name/email do not match\n" . $herecurr . $rawlines[$linenr] . "\n");
3184 }
3185 }
3186
3187# check if Reported-by: is followed by a Closes: tag
3188 if ($sign_off =~ /^reported(?:|-and-tested)-by:$/i) {
3189 if (!defined $lines[$linenr]) {
3190 WARN("BAD_REPORTED_BY_LINK",
3191 "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . "\n");
3192 } elsif ($rawlines[$linenr] !~ /^closes:\s*/i) {
3193 WARN("BAD_REPORTED_BY_LINK",
3194 "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n");
3195 }
3196 }
3197 }
3198
3199# These indicate a bug fix
3200 if (!$in_header_lines && !$is_patch &&
3201 $line =~ /^This reverts commit/) {
3202 $is_revert = 1;
3203 }
3204
3205 if (!$in_header_lines && !$is_patch &&
3206 $line =~ /((?:(?:BUG: K.|UB)SAN: |Call Trace:|stable\@|syzkaller))/) {
3207 $needs_fixes_tag = $1;
3208 }
3209
3210# Check Fixes: styles is correct
3211 if (!$in_header_lines &&
3212 $line =~ /^\s*(fixes:?)\s*(?:commit\s*)?([0-9a-f]{5,40})(?:\s*($balanced_parens))?/i) {
3213 my $tag = $1;
3214 my $orig_commit = $2;
3215 my $title;
3216 my $title_has_quotes = 0;
3217 $fixes_tag = 1;
3218 if (defined $3) {
3219 # Always strip leading/trailing parens then double quotes if existing
3220 $title = substr($3, 1, -1);
3221 if ($title =~ /^".*"$/) {
3222 $title = substr($title, 1, -1);
3223 $title_has_quotes = 1;
3224 }
3225 } else {
3226 $title = "commit title"
3227 }
3228
3229
3230 my $tag_case = not ($tag eq "Fixes:");
3231 my $tag_space = not ($line =~ /^fixes:? [0-9a-f]{5,40} ($balanced_parens)/i);
3232
3233 my $id_length = not ($orig_commit =~ /^[0-9a-f]{12}$/i);
3234 my $id_case = not ($orig_commit !~ /[A-F]/);
3235
3236 my $id = "0123456789ab";
3237 my ($cid, $ctitle) = git_commit_info($orig_commit, $id,
3238 $title);
3239
3240 if ($ctitle ne $title || $tag_case || $tag_space ||
3241 $id_length || $id_case || !$title_has_quotes) {
3242 if (WARN("BAD_FIXES_TAG",
3243 "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&
3244 $fix) {
3245 $fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")";
3246 }
3247 }
3248 }
3249
3250# Check email subject for common tools that don't need to be mentioned
3251 if ($in_header_lines &&
3252 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
3253 WARN("EMAIL_SUBJECT",
3254 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
3255 }
3256
3257# Check for Gerrit Change-Ids not in any patch context
3258 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
3259 if (ERROR("GERRIT_CHANGE_ID",
3260 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
3261 $fix) {
3262 fix_delete_line($fixlinenr, $rawline);
3263 }
3264 }
3265
3266# Check if the commit log is in a possible stack dump
3267 if ($in_commit_log && !$commit_log_possible_stack_dump &&
3268 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
3269 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
3270 # timestamp
3271 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
3272 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
3273 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
3274 # stack dump address styles
3275 $commit_log_possible_stack_dump = 1;
3276 }
3277
3278# Check for line lengths > 75 in commit log, warn once
3279 if ($in_commit_log && !$commit_log_long_line &&
3280 length($line) > 75 &&
3281 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
3282 # file delta changes
3283 $line =~ /^\s*(?:[\w\.\-\+]*\/)++[\w\.\-\+]+:/ ||
3284 # filename then :
3285 $line =~ /^\s*(?:Fixes:|$link_tags_search|$signature_tags)/i ||
3286 # A Fixes:, link or signature tag line
3287 $commit_log_possible_stack_dump)) {
3288 WARN("COMMIT_LOG_LONG_LINE",
3289 "Prefer a maximum 75 chars per line (possible unwrapped commit description?)\n" . $herecurr);
3290 $commit_log_long_line = 1;
3291 }
3292
3293# Reset possible stack dump if a blank line is found
3294 if ($in_commit_log && $commit_log_possible_stack_dump &&
3295 $line =~ /^\s*$/) {
3296 $commit_log_possible_stack_dump = 0;
3297 }
3298
3299# Check for odd tags before a URI/URL
3300 if ($in_commit_log &&
3301 $line =~ /^\s*(\w+:)\s*http/ && $1 !~ /^$link_tags_search$/) {
3302 if ($1 =~ /^v(?:ersion)?\d+/i) {
3303 WARN("COMMIT_LOG_VERSIONING",
3304 "Patch version information should be after the --- line\n" . $herecurr);
3305 } else {
3306 WARN("COMMIT_LOG_USE_LINK",
3307 "Unknown link reference '$1', use $link_tags_print instead\n" . $herecurr);
3308 }
3309 }
3310
3311# Check for misuse of the link tags
3312 if ($in_commit_log &&
3313 $line =~ /^\s*(\w+:)\s*(\S+)/) {
3314 my $tag = $1;
3315 my $value = $2;
3316 if ($tag =~ /^$link_tags_search$/ && $value !~ m{^https?://}) {
3317 WARN("COMMIT_LOG_WRONG_LINK",
3318 "'$tag' should be followed by a public http(s) link\n" . $herecurr);
3319 }
3320 }
3321
3322# Check for lines starting with a #
3323 if ($in_commit_log && $line =~ /^#/) {
3324 if (WARN("COMMIT_COMMENT_SYMBOL",
3325 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) &&
3326 $fix) {
3327 $fixed[$fixlinenr] =~ s/^/ /;
3328 }
3329 }
3330
3331# Check for git id commit length and improperly formed commit descriptions
3332# A correctly formed commit description is:
3333# commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
3334# with the commit subject '("' prefix and '")' suffix
3335# This is a fairly compilicated block as it tests for what appears to be
3336# bare SHA-1 hash with minimum length of 5. It also avoids several types of
3337# possible SHA-1 matches.
3338# A commit match can span multiple lines so this block attempts to find a
3339# complete typical commit on a maximum of 3 lines
3340 if ($perl_version_ok &&
3341 $in_commit_log && !$commit_log_possible_stack_dump &&
3342 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
3343 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
3344 (($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
3345 ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) ||
3346 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
3347 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3348 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
3349 my $init_char = "c";
3350 my $orig_commit = "";
3351 my $short = 1;
3352 my $long = 0;
3353 my $case = 1;
3354 my $space = 1;
3355 my $id = '0123456789ab';
3356 my $orig_desc = "commit description";
3357 my $description = "";
3358 my $herectx = $herecurr;
3359 my $has_parens = 0;
3360 my $has_quotes = 0;
3361
3362 my $input = $line;
3363 if ($line =~ /(?:\bcommit\s+[0-9a-f]{5,}|\bcommit\s*$)/i) {
3364 for (my $n = 0; $n < 2; $n++) {
3365 if ($input =~ /\bcommit\s+[0-9a-f]{5,}\s*($balanced_parens)/i) {
3366 $orig_desc = $1;
3367 $has_parens = 1;
3368 # Always strip leading/trailing parens then double quotes if existing
3369 $orig_desc = substr($orig_desc, 1, -1);
3370 if ($orig_desc =~ /^".*"$/) {
3371 $orig_desc = substr($orig_desc, 1, -1);
3372 $has_quotes = 1;
3373 }
3374 last;
3375 }
3376 last if ($#lines < $linenr + $n);
3377 $input .= " " . trim($rawlines[$linenr + $n]);
3378 $herectx .= "$rawlines[$linenr + $n]\n";
3379 }
3380 $herectx = $herecurr if (!$has_parens);
3381 }
3382
3383 if ($input =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
3384 $init_char = $1;
3385 $orig_commit = lc($2);
3386 $short = 0 if ($input =~ /\bcommit\s+[0-9a-f]{12,40}/i);
3387 $long = 1 if ($input =~ /\bcommit\s+[0-9a-f]{41,}/i);
3388 $space = 0 if ($input =~ /\bcommit [0-9a-f]/i);
3389 $case = 0 if ($input =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
3390 } elsif ($input =~ /\b([0-9a-f]{12,40})\b/i) {
3391 $orig_commit = lc($1);
3392 }
3393
3394 ($id, $description) = git_commit_info($orig_commit,
3395 $id, $orig_desc);
3396
3397 if (defined($id) &&
3398 ($short || $long || $space || $case || ($orig_desc ne $description) || !$has_quotes) &&
3399 $last_git_commit_id_linenr != $linenr - 1) {
3400 ERROR("GIT_COMMIT_ID",
3401 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
3402 }
3403 #don't report the next line if this line ends in commit and the sha1 hash is the next line
3404 $last_git_commit_id_linenr = $linenr if ($line =~ /\bcommit\s*$/i);
3405 }
3406
3407# Check for mailing list archives other than lore.kernel.org
3408 if ($rawline =~ m{http.*\b$obsolete_archives}) {
3409 WARN("PREFER_LORE_ARCHIVE",
3410 "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr);
3411 }
3412
3413# Check for added, moved or deleted files
3414 if (!$reported_maintainer_file && !$in_commit_log &&
3415 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
3416 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
3417 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
3418 (defined($1) || defined($2))))) {
3419 $is_patch = 1;
3420 $reported_maintainer_file = 1;
3421 WARN("FILE_PATH_CHANGES",
3422 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
3423 }
3424
3425# Check for adding new DT bindings not in schema format
3426 if (!$in_commit_log &&
3427 ($line =~ /^new file mode\s*\d+\s*$/) &&
3428 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3429 WARN("DT_SCHEMA_BINDING_PATCH",
3430 "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
3431 }
3432
3433# Check for wrappage within a valid hunk of the file
3434 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
3435 ERROR("CORRUPTED_PATCH",
3436 "patch seems to be corrupt (line wrapped?)\n" .
3437 $herecurr) if (!$emitted_corrupt++);
3438 }
3439
3440# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3441 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
3442 $rawline !~ m/^$UTF8*$/) {
3443 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3444
3445 my $blank = copy_spacing($rawline);
3446 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3447 my $hereptr = "$hereline$ptr\n";
3448
3449 CHK("INVALID_UTF8",
3450 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
3451 }
3452
3453# Check if it's the start of a commit log
3454# (not a header line and we haven't seen the patch filename)
3455 if ($in_header_lines && $realfile =~ /^$/ &&
3456 !($rawline =~ /^\s+(?:\S|$)/ ||
3457 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
3458 $in_header_lines = 0;
3459 $in_commit_log = 1;
3460 $has_commit_log = 1;
3461 }
3462
3463# Check if there is UTF-8 in a commit log when a mail header has explicitly
3464# declined it, i.e defined some charset where it is missing.
3465 if ($in_header_lines &&
3466 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3467 $1 !~ /utf-8/i) {
3468 $non_utf8_charset = 1;
3469 }
3470
3471 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
3472 $rawline =~ /$NON_ASCII_UTF8/) {
3473 WARN("UTF8_BEFORE_PATCH",
3474 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3475 }
3476
3477# Check for absolute kernel paths in commit message
3478 if ($tree && $in_commit_log) {
3479 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3480 my $file = $1;
3481
3482 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3483 check_absolute_file($1, $herecurr)) {
3484 #
3485 } else {
3486 check_absolute_file($file, $herecurr);
3487 }
3488 }
3489 }
3490
3491# Check for various typo / spelling mistakes
3492 if (defined($misspellings) &&
3493 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
3494 while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) {
3495 my $typo = $1;
3496 my $blank = copy_spacing($rawline);
3497 my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo);
3498 my $hereptr = "$hereline$ptr\n";
3499 my $typo_fix = $spelling_fix{lc($typo)};
3500 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3501 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
3502 my $msg_level = \&WARN;
3503 $msg_level = \&CHK if ($file);
3504 if (&{$msg_level}("TYPO_SPELLING",
3505 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) &&
3506 $fix) {
3507 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3508 }
3509 }
3510 }
3511
3512# check for invalid commit id
3513 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3514 my $id;
3515 my $description;
3516 ($id, $description) = git_commit_info($2, undef, undef);
3517 if (!defined($id)) {
3518 WARN("UNKNOWN_COMMIT_ID",
3519 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3520 }
3521 }
3522
3523# check for repeated words separated by a single space
3524# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3525 if (($rawline =~ /^\+/ || $in_commit_log) &&
3526 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
3527 pos($rawline) = 1 if (!$in_commit_log);
3528 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3529
3530 my $first = $1;
3531 my $second = $2;
3532 my $start_pos = $-[1];
3533 my $end_pos = $+[2];
3534 if ($first =~ /(?:struct|union|enum)/) {
3535 pos($rawline) += length($first) + length($second) + 1;
3536 next;
3537 }
3538
3539 next if (lc($first) ne lc($second));
3540 next if ($first eq 'long');
3541
3542 # check for character before and after the word matches
3543 my $start_char = '';
3544 my $end_char = '';
3545 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
3546 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
3547
3548 next if ($start_char =~ /^\S$/);
3549 next if (index(" \t.,;?!", $end_char) == -1);
3550
3551 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3552 if ($first =~ /\b[0-9a-f]{2,}\b/i) {
3553 next if (!exists($allow_repeated_words{lc($first)}));
3554 }
3555
3556 if (WARN("REPEATED_WORD",
3557 "Possible repeated word: '$first'\n" . $herecurr) &&
3558 $fix) {
3559 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3560 }
3561 }
3562
3563 # if it's a repeated word on consecutive lines in a comment block
3564 if ($prevline =~ /$;+\s*$/ &&
3565 $prevrawline =~ /($word_pattern)\s*$/) {
3566 my $last_word = $1;
3567 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3568 if (WARN("REPEATED_WORD",
3569 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3570 $fix) {
3571 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3572 }
3573 }
3574 }
3575 }
3576
3577# ignore non-hunk lines and lines being removed
3578 next if (!$hunk_line || $line =~ /^-/);
3579
3580#trailing whitespace
3581 if ($line =~ /^\+.*\015/) {
3582 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3583 if (ERROR("DOS_LINE_ENDINGS",
3584 "DOS line endings\n" . $herevet) &&
3585 $fix) {
3586 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
3587 }
3588 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3589 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3590 if (ERROR("TRAILING_WHITESPACE",
3591 "trailing whitespace\n" . $herevet) &&
3592 $fix) {
3593 $fixed[$fixlinenr] =~ s/\s+$//;
3594 }
3595
3596 $rpt_cleaners = 1;
3597 }
3598
3599# Check for FSF mailing addresses.
3600 if ($rawline =~ /\bwrite to the Free/i ||
3601 $rawline =~ /\b675\s+Mass\s+Ave/i ||
3602 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3603 $rawline =~ /\b51\s+Franklin\s+St/i) {
3604 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3605 my $msg_level = \&ERROR;
3606 $msg_level = \&CHK if ($file);
3607 &{$msg_level}("FSF_MAILING_ADDRESS",
3608 "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)
3609 }
3610
3611# check for Kconfig help text having a real description
3612# Only applies when adding the entry originally, after that we do not have
3613# sufficient context to determine whether it is indeed long enough.
3614 if ($realfile =~ /Kconfig/ &&
3615 # 'choice' is usually the last thing on the line (though
3616 # Kconfig supports named choices), so use a word boundary
3617 # (\b) rather than a whitespace character (\s)
3618 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
3619 my $ln = $linenr;
3620 my $needs_help = 0;
3621 my $has_help = 0;
3622 my $help_length = 0;
3623 while (defined $lines[$ln]) {
3624 my $f = $lines[$ln++];
3625
3626 next if ($f =~ /^-/);
3627 last if ($f !~ /^[\+ ]/); # !patch context
3628
3629 if ($f =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
3630 $needs_help = 1;
3631 next;
3632 }
3633 if ($f =~ /^\+\s*help\s*$/) {
3634 $has_help = 1;
3635 next;
3636 }
3637
3638 $f =~ s/^.//; # strip patch context [+ ]
3639 $f =~ s/#.*//; # strip # directives
3640 $f =~ s/^\s+//; # strip leading blanks
3641 next if ($f =~ /^$/); # skip blank lines
3642
3643 # At the end of this Kconfig block:
3644 # This only checks context lines in the patch
3645 # and so hopefully shouldn't trigger false
3646 # positives, even though some of these are
3647 # common words in help texts
3648 if ($f =~ /^(?:config|menuconfig|choice|endchoice|
3649 if|endif|menu|endmenu|source)\b/x) {
3650 last;
3651 }
3652 $help_length++ if ($has_help);
3653 }
3654 if ($needs_help &&
3655 $help_length < $min_conf_desc_length) {
3656 my $stat_real = get_stat_real($linenr, $ln - 1);
3657 WARN("CONFIG_DESCRIPTION",
3658 "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n");
3659 }
3660 }
3661
3662# check MAINTAINERS entries
3663 if ($realfile =~ /^MAINTAINERS$/) {
3664# check MAINTAINERS entries for the right form
3665 if ($rawline =~ /^\+[A-Z]:/ &&
3666 $rawline !~ /^\+[A-Z]:\t\S/) {
3667 if (WARN("MAINTAINERS_STYLE",
3668 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3669 $fix) {
3670 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3671 }
3672 }
3673# check MAINTAINERS entries for the right ordering too
3674 my $preferred_order = 'MRLSWQBCPTFXNK';
3675 if ($rawline =~ /^\+[A-Z]:/ &&
3676 $prevrawline =~ /^[\+ ][A-Z]:/) {
3677 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3678 my $cur = $1;
3679 my $curval = $2;
3680 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3681 my $prev = $1;
3682 my $prevval = $2;
3683 my $curindex = index($preferred_order, $cur);
3684 my $previndex = index($preferred_order, $prev);
3685 if ($curindex < 0) {
3686 WARN("MAINTAINERS_STYLE",
3687 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3688 } else {
3689 if ($previndex >= 0 && $curindex < $previndex) {
3690 WARN("MAINTAINERS_STYLE",
3691 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3692 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3693 ($prev eq 'X' && $cur eq 'X')) &&
3694 ($prevval cmp $curval) > 0) {
3695 WARN("MAINTAINERS_STYLE",
3696 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3697 }
3698 }
3699 }
3700 }
3701
3702 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3703 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3704 my $flag = $1;
3705 my $replacement = {
3706 'EXTRA_AFLAGS' => 'asflags-y',
3707 'EXTRA_CFLAGS' => 'ccflags-y',
3708 'EXTRA_CPPFLAGS' => 'cppflags-y',
3709 'EXTRA_LDFLAGS' => 'ldflags-y',
3710 };
3711
3712 WARN("DEPRECATED_VARIABLE",
3713 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3714 }
3715
3716# check for DT compatible documentation
3717 if (defined $root &&
3718 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3719 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3720
3721 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3722
3723 my $dt_path = $root . "/Documentation/devicetree/bindings/";
3724 my $vp_file = $dt_path . "vendor-prefixes.yaml";
3725
3726 foreach my $compat (@compats) {
3727 my $compat2 = $compat;
3728 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3729 my $compat3 = $compat;
3730 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3731 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
3732 if ( $? >> 8 ) {
3733 WARN("UNDOCUMENTED_DT_STRING",
3734 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3735 }
3736
3737 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3738 my $vendor = $1;
3739 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
3740 if ( $? >> 8 ) {
3741 WARN("UNDOCUMENTED_DT_STRING",
3742 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3743 }
3744 }
3745 }
3746
3747# check for using SPDX license tag at beginning of files
3748 if ($realline == $checklicenseline) {
3749 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3750 $checklicenseline = 2;
3751 } elsif ($rawline =~ /^\+/) {
3752 my $comment = "";
3753 if ($realfile =~ /\.(h|s|S)$/) {
3754 $comment = '/*';
3755 } elsif ($realfile =~ /\.(c|rs|dts|dtsi)$/) {
3756 $comment = '//';
3757 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
3758 $comment = '#';
3759 } elsif ($realfile =~ /\.rst$/) {
3760 $comment = '..';
3761 }
3762
3763# check SPDX comment style for .[chsS] files
3764 if ($realfile =~ /\.[chsS]$/ &&
3765 $rawline =~ /SPDX-License-Identifier:/ &&
3766 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
3767 WARN("SPDX_LICENSE_TAG",
3768 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3769 }
3770
3771 if ($comment !~ /^$/ &&
3772 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3773 WARN("SPDX_LICENSE_TAG",
3774 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
3775 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
3776 my $spdx_license = $1;
3777 if (!is_SPDX_License_valid($spdx_license)) {
3778 WARN("SPDX_LICENSE_TAG",
3779 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3780 }
3781 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3782 $spdx_license !~ /GPL-2\.0(?:-only)? OR BSD-2-Clause/) {
3783 my $msg_level = \&WARN;
3784 $msg_level = \&CHK if ($file);
3785 if (&{$msg_level}("SPDX_LICENSE_TAG",
3786
3787 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3788 $fix) {
3789 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3790 }
3791 }
3792 if ($realfile =~ m@^include/dt-bindings/@ &&
3793 $spdx_license !~ /GPL-2\.0(?:-only)? OR \S+/) {
3794 WARN("SPDX_LICENSE_TAG",
3795 "DT binding headers should be licensed (GPL-2.0-only OR .*)\n" . $herecurr);
3796 }
3797 }
3798 }
3799 }
3800
3801# check for embedded filenames
3802 if ($rawline =~ /^\+.*\b\Q$realfile\E\b/) {
3803 WARN("EMBEDDED_FILENAME",
3804 "It's generally not useful to have the filename in the file\n" . $herecurr);
3805 }
3806
3807# check we are in a valid source file if not then ignore this hunk
3808 next if ($realfile !~ /\.(h|c|rs|s|S|sh|dtsi|dts)$/);
3809
3810# check for using SPDX-License-Identifier on the wrong line number
3811 if ($realline != $checklicenseline &&
3812 $rawline =~ /\bSPDX-License-Identifier:/ &&
3813 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3814 WARN("SPDX_LICENSE_TAG",
3815 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3816 }
3817
3818# line length limit (with some exclusions)
3819#
3820# There are a few types of lines that may extend beyond $max_line_length:
3821# logging functions like pr_info that end in a string
3822# lines with a single string
3823# #defines that are a single string
3824# lines with an RFC3986 like URL
3825#
3826# There are 3 different line length message types:
3827# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3828# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3829# LONG_LINE all other lines longer than $max_line_length
3830#
3831# if LONG_LINE is ignored, the other 2 types are also ignored
3832#
3833
3834 if ($line =~ /^\+/ && $length > $max_line_length) {
3835 my $msg_type = "LONG_LINE";
3836
3837 # Check the allowed long line types first
3838
3839 # logging functions that end in a string that starts
3840 # before $max_line_length
3841 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3842 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3843 $msg_type = "";
3844
3845 # lines with only strings (w/ possible termination)
3846 # #defines with only strings
3847 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3848 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3849 $msg_type = "";
3850
3851 # More special cases
3852 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3853 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
3854 $msg_type = "";
3855
3856 # URL ($rawline is used in case the URL is in a comment)
3857 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3858 $msg_type = "";
3859
3860 # Otherwise set the alternate message types
3861
3862 # a comment starts before $max_line_length
3863 } elsif ($line =~ /($;[\s$;]*)$/ &&
3864 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3865 $msg_type = "LONG_LINE_COMMENT"
3866
3867 # a quoted string starts before $max_line_length
3868 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3869 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3870 $msg_type = "LONG_LINE_STRING"
3871 }
3872
3873 if ($msg_type ne "" &&
3874 show_type("LONG_LINE") && show_type($msg_type)) {
3875 my $msg_level = \&WARN;
3876 $msg_level = \&CHK if ($file);
3877 &{$msg_level}($msg_type,
3878 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
3879 }
3880 }
3881
3882# check for adding lines without a newline.
3883 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3884 if (WARN("MISSING_EOF_NEWLINE",
3885 "adding a line without newline at end of file\n" . $herecurr) &&
3886 $fix) {
3887 fix_delete_line($fixlinenr+1, "No newline at end of file");
3888 }
3889 }
3890
3891# check for .L prefix local symbols in .S files
3892 if ($realfile =~ /\.S$/ &&
3893 $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {
3894 WARN("AVOID_L_PREFIX",
3895 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr);
3896 }
3897
3898# check we are in a valid source file C or perl if not then ignore this hunk
3899 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
3900
3901# at the beginning of a line any tabs must come first and anything
3902# more than $tabsize must use tabs.
3903 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3904 $rawline =~ /^\+\s* \s*/) {
3905 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3906 $rpt_cleaners = 1;
3907 if (ERROR("CODE_INDENT",
3908 "code indent should use tabs where possible\n" . $herevet) &&
3909 $fix) {
3910 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
3911 }
3912 }
3913
3914# check for space before tabs.
3915 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3916 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
3917 if (WARN("SPACE_BEFORE_TAB",
3918 "please, no space before tabs\n" . $herevet) &&
3919 $fix) {
3920 while ($fixed[$fixlinenr] =~
3921 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
3922 while ($fixed[$fixlinenr] =~
3923 s/(^\+.*) +\t/$1\t/) {}
3924 }
3925 }
3926
3927# check for assignments on the start of a line
3928 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3929 my $operator = $1;
3930 if (CHK("ASSIGNMENT_CONTINUATIONS",
3931 "Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3932 $fix && $prevrawline =~ /^\+/) {
3933 # add assignment operator to the previous line, remove from current line
3934 $fixed[$fixlinenr - 1] .= " $operator";
3935 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3936 }
3937 }
3938
3939# check for && or || at the start of a line
3940 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3941 my $operator = $1;
3942 if (CHK("LOGICAL_CONTINUATIONS",
3943 "Logical continuations should be on the previous line\n" . $hereprev) &&
3944 $fix && $prevrawline =~ /^\+/) {
3945 # insert logical operator at last non-comment, non-whitepsace char on previous line
3946 $prevline =~ /[\s$;]*$/;
3947 my $line_end = substr($prevrawline, $-[0]);
3948 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
3949 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3950 }
3951 }
3952
3953# check indentation starts on a tab stop
3954 if ($perl_version_ok &&
3955 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3956 my $indent = length($1);
3957 if ($indent % $tabsize) {
3958 if (WARN("TABSTOP",
3959 "Statements should start on a tabstop\n" . $herecurr) &&
3960 $fix) {
3961 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
3962 }
3963 }
3964 }
3965
3966# check multi-line statement indentation matches previous line
3967 if ($perl_version_ok &&
3968 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3969 $prevline =~ /^\+(\t*)(.*)$/;
3970 my $oldindent = $1;
3971 my $rest = $2;
3972
3973 my $pos = pos_last_openparen($rest);
3974 if ($pos >= 0) {
3975 $line =~ /^(\+| )([ \t]*)/;
3976 my $newindent = $2;
3977
3978 my $goodtabindent = $oldindent .
3979 "\t" x ($pos / $tabsize) .
3980 " " x ($pos % $tabsize);
3981 my $goodspaceindent = $oldindent . " " x $pos;
3982
3983 if ($newindent ne $goodtabindent &&
3984 $newindent ne $goodspaceindent) {
3985
3986 if (CHK("PARENTHESIS_ALIGNMENT",
3987 "Alignment should match open parenthesis\n" . $hereprev) &&
3988 $fix && $line =~ /^\+/) {
3989 $fixed[$fixlinenr] =~
3990 s/^\+[ \t]*/\+$goodtabindent/;
3991 }
3992 }
3993 }
3994 }
3995
3996# check for space after cast like "(int) foo" or "(struct foo) bar"
3997# avoid checking a few false positives:
3998# "sizeof(<type>)" or "__alignof__(<type>)"
3999# function pointer declarations like "(*foo)(int) = bar;"
4000# structure definitions like "(struct foo) { 0 };"
4001# multiline macros that define functions
4002# known attributes or the __attribute__ keyword
4003 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
4004 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
4005 if (CHK("SPACING",
4006 "No space is necessary after a cast\n" . $herecurr) &&
4007 $fix) {
4008 $fixed[$fixlinenr] =~
4009 s/(\(\s*$Type\s*\))[ \t]+/$1/;
4010 }
4011 }
4012
4013# Block comments use * on subsequent lines
4014 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
4015 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
4016 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
4017 $rawline =~ /^\+/ && #line is new
4018 $rawline !~ /^\+[ \t]*\*/) { #no leading *
4019 WARN("BLOCK_COMMENT_STYLE",
4020 "Block comments use * on subsequent lines\n" . $hereprev);
4021 }
4022
4023# Block comments use */ on trailing lines
4024 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
4025 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
4026 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
4027 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
4028 WARN("BLOCK_COMMENT_STYLE",
4029 "Block comments use a trailing */ on a separate line\n" . $herecurr);
4030 }
4031
4032# Block comment * alignment
4033 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
4034 $line =~ /^\+[ \t]*$;/ && #leading comment
4035 $rawline =~ /^\+[ \t]*\*/ && #leading *
4036 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
4037 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
4038 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
4039 my $oldindent;
4040 $prevrawline =~ m@^\+([ \t]*/?)\*@;
4041 if (defined($1)) {
4042 $oldindent = expand_tabs($1);
4043 } else {
4044 $prevrawline =~ m@^\+(.*/?)\*@;
4045 $oldindent = expand_tabs($1);
4046 }
4047 $rawline =~ m@^\+([ \t]*)\*@;
4048 my $newindent = $1;
4049 $newindent = expand_tabs($newindent);
4050 if (length($oldindent) ne length($newindent)) {
4051 WARN("BLOCK_COMMENT_STYLE",
4052 "Block comments should align the * on each line\n" . $hereprev);
4053 }
4054 }
4055
4056# check for missing blank lines after struct/union declarations
4057# with exceptions for various attributes and macros
4058 if ($prevline =~ /^[\+ ]};?\s*$/ &&
4059 $line =~ /^\+/ &&
4060 !($line =~ /^\+\s*$/ ||
4061 $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param|ALLOW_ERROR_INJECTION)/ ||
4062 $line =~ /^\+\s*MODULE_/i ||
4063 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
4064 $line =~ /^\+[a-z_]*init/ ||
4065 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
4066 $line =~ /^\+\s*DECLARE/ ||
4067 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
4068 $line =~ /^\+\s*__setup/)) {
4069 if (CHK("LINE_SPACING",
4070 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
4071 $fix) {
4072 fix_insert_line($fixlinenr, "\+");
4073 }
4074 }
4075
4076# check for multiple consecutive blank lines
4077 if ($prevline =~ /^[\+ ]\s*$/ &&
4078 $line =~ /^\+\s*$/ &&
4079 $last_blank_line != ($linenr - 1)) {
4080 if (CHK("LINE_SPACING",
4081 "Please don't use multiple blank lines\n" . $hereprev) &&
4082 $fix) {
4083 fix_delete_line($fixlinenr, $rawline);
4084 }
4085
4086 $last_blank_line = $linenr;
4087 }
4088
4089# check for missing blank lines after declarations
4090# (declarations must have the same indentation and not be at the start of line)
4091 if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) {
4092 # use temporaries
4093 my $sl = $sline;
4094 my $pl = $prevline;
4095 # remove $Attribute/$Sparse uses to simplify comparisons
4096 $sl =~ s/\b(?:$Attribute|$Sparse)\b//g;
4097 $pl =~ s/\b(?:$Attribute|$Sparse)\b//g;
4098 if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
4099 # function pointer declarations
4100 $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
4101 # foo bar; where foo is some local typedef or #define
4102 $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
4103 # known declaration macros
4104 $pl =~ /^\+\s+$declaration_macros/) &&
4105 # for "else if" which can look like "$Ident $Ident"
4106 !($pl =~ /^\+\s+$c90_Keywords\b/ ||
4107 # other possible extensions of declaration lines
4108 $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
4109 # not starting a section or a macro "\" extended line
4110 $pl =~ /(?:\{\s*|\\)$/) &&
4111 # looks like a declaration
4112 !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
4113 # function pointer declarations
4114 $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
4115 # foo bar; where foo is some local typedef or #define
4116 $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
4117 # known declaration macros
4118 $sl =~ /^\+\s+$declaration_macros/ ||
4119 # start of struct or union or enum
4120 $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
4121 # start or end of block or continuation of declaration
4122 $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
4123 # bitfield continuation
4124 $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
4125 # other possible extensions of declaration lines
4126 $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
4127 if (WARN("LINE_SPACING",
4128 "Missing a blank line after declarations\n" . $hereprev) &&
4129 $fix) {
4130 fix_insert_line($fixlinenr, "\+");
4131 }
4132 }
4133 }
4134
4135# check for spaces at the beginning of a line.
4136# Exceptions:
4137# 1) within comments
4138# 2) indented preprocessor commands
4139# 3) hanging labels
4140 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
4141 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
4142 if (WARN("LEADING_SPACE",
4143 "please, no spaces at the start of a line\n" . $herevet) &&
4144 $fix) {
4145 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
4146 }
4147 }
4148
4149# check we are in a valid C source file if not then ignore this hunk
4150 next if ($realfile !~ /\.(h|c)$/);
4151
4152# check for unusual line ending [ or (
4153 if ($line =~ /^\+.*([\[\(])\s*$/) {
4154 CHK("OPEN_ENDED_LINE",
4155 "Lines should not end with a '$1'\n" . $herecurr);
4156 }
4157
4158# check if this appears to be the start function declaration, save the name
4159 if ($sline =~ /^\+\{\s*$/ &&
4160 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
4161 $context_function = $1;
4162 }
4163
4164# check if this appears to be the end of function declaration
4165 if ($sline =~ /^\+\}\s*$/) {
4166 undef $context_function;
4167 }
4168
4169# check indentation of any line with a bare else
4170# (but not if it is a multiple line "if (foo) return bar; else return baz;")
4171# if the previous line is a break or return and is indented 1 tab more...
4172 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
4173 my $tabs = length($1) + 1;
4174 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
4175 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
4176 defined $lines[$linenr] &&
4177 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
4178 WARN("UNNECESSARY_ELSE",
4179 "else is not generally useful after a break or return\n" . $hereprev);
4180 }
4181 }
4182
4183# check indentation of a line with a break;
4184# if the previous line is a goto, return or break
4185# and is indented the same # of tabs
4186 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
4187 my $tabs = $1;
4188 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
4189 if (WARN("UNNECESSARY_BREAK",
4190 "break is not useful after a $1\n" . $hereprev) &&
4191 $fix) {
4192 fix_delete_line($fixlinenr, $rawline);
4193 }
4194 }
4195 }
4196
4197# check for RCS/CVS revision markers
4198 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
4199 WARN("CVS_KEYWORD",
4200 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
4201 }
4202
4203# check for old HOTPLUG __dev<foo> section markings
4204 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
4205 WARN("HOTPLUG_SECTION",
4206 "Using $1 is unnecessary\n" . $herecurr);
4207 }
4208
4209# Check for potential 'bare' types
4210 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
4211 $realline_next);
4212#print "LINE<$line>\n";
4213 if ($linenr > $suppress_statement &&
4214 $realcnt && $sline =~ /.\s*\S/) {
4215 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4216 ctx_statement_block($linenr, $realcnt, 0);
4217 $stat =~ s/\n./\n /g;
4218 $cond =~ s/\n./\n /g;
4219
4220#print "linenr<$linenr> <$stat>\n";
4221 # If this statement has no statement boundaries within
4222 # it there is no point in retrying a statement scan
4223 # until we hit end of it.
4224 my $frag = $stat; $frag =~ s/;+\s*$//;
4225 if ($frag !~ /(?:{|;)/) {
4226#print "skip<$line_nr_next>\n";
4227 $suppress_statement = $line_nr_next;
4228 }
4229
4230 # Find the real next line.
4231 $realline_next = $line_nr_next;
4232 if (defined $realline_next &&
4233 (!defined $lines[$realline_next - 1] ||
4234 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
4235 $realline_next++;
4236 }
4237
4238 my $s = $stat;
4239 $s =~ s/{.*$//s;
4240
4241 # Ignore goto labels.
4242 if ($s =~ /$Ident:\*$/s) {
4243
4244 # Ignore functions being called
4245 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
4246
4247 } elsif ($s =~ /^.\s*else\b/s) {
4248
4249 # declarations always start with types
4250 } 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) {
4251 my $type = $1;
4252 $type =~ s/\s+/ /g;
4253 possible($type, "A:" . $s);
4254
4255 # definitions in global scope can only start with types
4256 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
4257 possible($1, "B:" . $s);
4258 }
4259
4260 # any (foo ... *) is a pointer cast, and foo is a type
4261 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
4262 possible($1, "C:" . $s);
4263 }
4264
4265 # Check for any sort of function declaration.
4266 # int foo(something bar, other baz);
4267 # void (*store_gdt)(x86_descr_ptr *);
4268 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
4269 my ($name_len) = length($1);
4270
4271 my $ctx = $s;
4272 substr($ctx, 0, $name_len + 1, '');
4273 $ctx =~ s/\)[^\)]*$//;
4274
4275 for my $arg (split(/\s*,\s*/, $ctx)) {
4276 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
4277
4278 possible($1, "D:" . $s);
4279 }
4280 }
4281 }
4282
4283 }
4284
4285#
4286# Checks which may be anchored in the context.
4287#
4288
4289# Check for switch () and associated case and default
4290# statements should be at the same indent.
4291 if ($line=~/\bswitch\s*\(.*\)/) {
4292 my $err = '';
4293 my $sep = '';
4294 my @ctx = ctx_block_outer($linenr, $realcnt);
4295 shift(@ctx);
4296 for my $ctx (@ctx) {
4297 my ($clen, $cindent) = line_stats($ctx);
4298 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
4299 $indent != $cindent) {
4300 $err .= "$sep$ctx\n";
4301 $sep = '';
4302 } else {
4303 $sep = "[...]\n";
4304 }
4305 }
4306 if ($err ne '') {
4307 ERROR("SWITCH_CASE_INDENT_LEVEL",
4308 "switch and case should be at the same indent\n$hereline$err");
4309 }
4310 }
4311
4312# if/while/etc brace do not go on next line, unless defining a do while loop,
4313# or if that brace on the next line is for something else
4314 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
4315 my $pre_ctx = "$1$2";
4316
4317 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
4318
4319 if ($line =~ /^\+\t{6,}/) {
4320 WARN("DEEP_INDENTATION",
4321 "Too many leading tabs - consider code refactoring\n" . $herecurr);
4322 }
4323
4324 my $ctx_cnt = $realcnt - $#ctx - 1;
4325 my $ctx = join("\n", @ctx);
4326
4327 my $ctx_ln = $linenr;
4328 my $ctx_skip = $realcnt;
4329
4330 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4331 defined $lines[$ctx_ln - 1] &&
4332 $lines[$ctx_ln - 1] =~ /^-/)) {
4333 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4334 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
4335 $ctx_ln++;
4336 }
4337
4338 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4339 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4340
4341 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
4342 ERROR("OPEN_BRACE",
4343 "that open brace { should be on the previous line\n" .
4344 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
4345 }
4346 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4347 $ctx =~ /\)\s*\;\s*$/ &&
4348 defined $lines[$ctx_ln - 1])
4349 {
4350 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
4351 if ($nindent > $indent) {
4352 WARN("TRAILING_SEMICOLON",
4353 "trailing semicolon indicates no statements, indent implies otherwise\n" .
4354 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
4355 }
4356 }
4357 }
4358
4359# Check relative indent for conditionals and blocks.
4360 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
4361 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4362 ctx_statement_block($linenr, $realcnt, 0)
4363 if (!defined $stat);
4364 my ($s, $c) = ($stat, $cond);
4365
4366 substr($s, 0, length($c), '');
4367
4368 # remove inline comments
4369 $s =~ s/$;/ /g;
4370 $c =~ s/$;/ /g;
4371
4372 # Find out how long the conditional actually is.
4373 my @newlines = ($c =~ /\n/gs);
4374 my $cond_lines = 1 + $#newlines;
4375
4376 # Make sure we remove the line prefixes as we have
4377 # none on the first line, and are going to readd them
4378 # where necessary.
4379 $s =~ s/\n./\n/gs;
4380 while ($s =~ /\n\s+\\\n/) {
4381 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
4382 }
4383
4384 # We want to check the first line inside the block
4385 # starting at the end of the conditional, so remove:
4386 # 1) any blank line termination
4387 # 2) any opening brace { on end of the line
4388 # 3) any do (...) {
4389 my $continuation = 0;
4390 my $check = 0;
4391 $s =~ s/^.*\bdo\b//;
4392 $s =~ s/^\s*{//;
4393 if ($s =~ s/^\s*\\//) {
4394 $continuation = 1;
4395 }
4396 if ($s =~ s/^\s*?\n//) {
4397 $check = 1;
4398 $cond_lines++;
4399 }
4400
4401 # Also ignore a loop construct at the end of a
4402 # preprocessor statement.
4403 if (($prevline =~ /^.\s*#\s*define\s/ ||
4404 $prevline =~ /\\\s*$/) && $continuation == 0) {
4405 $check = 0;
4406 }
4407
4408 my $cond_ptr = -1;
4409 $continuation = 0;
4410 while ($cond_ptr != $cond_lines) {
4411 $cond_ptr = $cond_lines;
4412
4413 # If we see an #else/#elif then the code
4414 # is not linear.
4415 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4416 $check = 0;
4417 }
4418
4419 # Ignore:
4420 # 1) blank lines, they should be at 0,
4421 # 2) preprocessor lines, and
4422 # 3) labels.
4423 if ($continuation ||
4424 $s =~ /^\s*?\n/ ||
4425 $s =~ /^\s*#\s*?/ ||
4426 $s =~ /^\s*$Ident\s*:/) {
4427 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
4428 if ($s =~ s/^.*?\n//) {
4429 $cond_lines++;
4430 }
4431 }
4432 }
4433
4434 my (undef, $sindent) = line_stats("+" . $s);
4435 my $stat_real = raw_line($linenr, $cond_lines);
4436
4437 # Check if either of these lines are modified, else
4438 # this is not this patch's fault.
4439 if (!defined($stat_real) ||
4440 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
4441 $check = 0;
4442 }
4443 if (defined($stat_real) && $cond_lines > 1) {
4444 $stat_real = "[...]\n$stat_real";
4445 }
4446
4447 #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";
4448
4449 if ($check && $s ne '' &&
4450 (($sindent % $tabsize) != 0 ||
4451 ($sindent < $indent) ||
4452 ($sindent == $indent &&
4453 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
4454 ($sindent > $indent + $tabsize))) {
4455 WARN("SUSPECT_CODE_INDENT",
4456 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4457 }
4458 }
4459
4460 # Track the 'values' across context and added lines.
4461 my $opline = $line; $opline =~ s/^./ /;
4462 my ($curr_values, $curr_vars) =
4463 annotate_values($opline . "\n", $prev_values);
4464 $curr_values = $prev_values . $curr_values;
4465 if ($dbg_values) {
4466 my $outline = $opline; $outline =~ s/\t/ /g;
4467 print "$linenr > .$outline\n";
4468 print "$linenr > $curr_values\n";
4469 print "$linenr > $curr_vars\n";
4470 }
4471 $prev_values = substr($curr_values, -1);
4472
4473#ignore lines not being added
4474 next if ($line =~ /^[^\+]/);
4475
4476# check for self assignments used to avoid compiler warnings
4477# e.g.: int foo = foo, *bar = NULL;
4478# struct foo bar = *(&(bar));
4479 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
4480 my $var = $1;
4481 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4482 WARN("SELF_ASSIGNMENT",
4483 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
4484 }
4485 }
4486
4487# check for dereferences that span multiple lines
4488 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
4489 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
4490 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
4491 my $ref = $1;
4492 $line =~ /^.\s*($Lval)/;
4493 $ref .= $1;
4494 $ref =~ s/\s//g;
4495 WARN("MULTILINE_DEREFERENCE",
4496 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
4497 }
4498
4499# check for declarations of signed or unsigned without int
4500 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4501 my $type = $1;
4502 my $var = $2;
4503 $var = "" if (!defined $var);
4504 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
4505 my $sign = $1;
4506 my $pointer = $2;
4507
4508 $pointer = "" if (!defined $pointer);
4509
4510 if (WARN("UNSPECIFIED_INT",
4511 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4512 $fix) {
4513 my $decl = trim($sign) . " int ";
4514 my $comp_pointer = $pointer;
4515 $comp_pointer =~ s/\s//g;
4516 $decl .= $comp_pointer;
4517 $decl = rtrim($decl) if ($var eq "");
4518 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
4519 }
4520 }
4521 }
4522
4523# TEST: allow direct testing of the type matcher.
4524 if ($dbg_type) {
4525 if ($line =~ /^.\s*$Declare\s*$/) {
4526 ERROR("TEST_TYPE",
4527 "TEST: is type\n" . $herecurr);
4528 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
4529 ERROR("TEST_NOT_TYPE",
4530 "TEST: is not type ($1 is)\n". $herecurr);
4531 }
4532 next;
4533 }
4534# TEST: allow direct testing of the attribute matcher.
4535 if ($dbg_attr) {
4536 if ($line =~ /^.\s*$Modifier\s*$/) {
4537 ERROR("TEST_ATTR",
4538 "TEST: is attr\n" . $herecurr);
4539 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
4540 ERROR("TEST_NOT_ATTR",
4541 "TEST: is not attr ($1 is)\n". $herecurr);
4542 }
4543 next;
4544 }
4545
4546# check for initialisation to aggregates open brace on the next line
4547 if ($line =~ /^.\s*{/ &&
4548 $prevline =~ /(?:^|[^=])=\s*$/) {
4549 if (ERROR("OPEN_BRACE",
4550 "that open brace { should be on the previous line\n" . $hereprev) &&
4551 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4552 fix_delete_line($fixlinenr - 1, $prevrawline);
4553 fix_delete_line($fixlinenr, $rawline);
4554 my $fixedline = $prevrawline;
4555 $fixedline =~ s/\s*=\s*$/ = {/;
4556 fix_insert_line($fixlinenr, $fixedline);
4557 $fixedline = $line;
4558 $fixedline =~ s/^(.\s*)\{\s*/$1/;
4559 fix_insert_line($fixlinenr, $fixedline);
4560 }
4561 }
4562
4563#
4564# Checks which are anchored on the added line.
4565#
4566
4567# check for malformed paths in #include statements (uses RAW line)
4568 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
4569 my $path = $1;
4570 if ($path =~ m{//}) {
4571 ERROR("MALFORMED_INCLUDE",
4572 "malformed #include filename\n" . $herecurr);
4573 }
4574 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4575 ERROR("UAPI_INCLUDE",
4576 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
4577 }
4578 }
4579
4580# no C99 // comments
4581 if ($line =~ m{//}) {
4582 if (ERROR("C99_COMMENTS",
4583 "do not use C99 // comments\n" . $herecurr) &&
4584 $fix) {
4585 my $line = $fixed[$fixlinenr];
4586 if ($line =~ /\/\/(.*)$/) {
4587 my $comment = trim($1);
4588 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
4589 }
4590 }
4591 }
4592 # Remove C99 comments.
4593 $line =~ s@//.*@@;
4594 $opline =~ s@//.*@@;
4595
4596# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4597# the whole statement.
4598#print "APW <$lines[$realline_next - 1]>\n";
4599 if (defined $realline_next &&
4600 exists $lines[$realline_next - 1] &&
4601 !defined $suppress_export{$realline_next} &&
4602 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
4603 # Handle definitions which produce identifiers with
4604 # a prefix:
4605 # XXX(foo);
4606 # EXPORT_SYMBOL(something_foo);
4607 my $name = $1;
4608 $name =~ s/^\s*($Ident).*/$1/;
4609 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
4610 $name =~ /^${Ident}_$2/) {
4611#print "FOO C name<$name>\n";
4612 $suppress_export{$realline_next} = 1;
4613
4614 } elsif ($stat !~ /(?:
4615 \n.}\s*$|
4616 ^.DEFINE_$Ident\(\Q$name\E\)|
4617 ^.DECLARE_$Ident\(\Q$name\E\)|
4618 ^.LIST_HEAD\(\Q$name\E\)|
4619 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4620 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
4621 )/x) {
4622#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4623 $suppress_export{$realline_next} = 2;
4624 } else {
4625 $suppress_export{$realline_next} = 1;
4626 }
4627 }
4628 if (!defined $suppress_export{$linenr} &&
4629 $prevline =~ /^.\s*$/ &&
4630 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) {
4631#print "FOO B <$lines[$linenr - 1]>\n";
4632 $suppress_export{$linenr} = 2;
4633 }
4634 if (defined $suppress_export{$linenr} &&
4635 $suppress_export{$linenr} == 2) {
4636 WARN("EXPORT_SYMBOL",
4637 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
4638 }
4639
4640# check for global initialisers.
4641 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ &&
4642 !exclude_global_initialisers($realfile)) {
4643 if (ERROR("GLOBAL_INITIALISERS",
4644 "do not initialise globals to $1\n" . $herecurr) &&
4645 $fix) {
4646 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
4647 }
4648 }
4649# check for static initialisers.
4650 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
4651 if (ERROR("INITIALISED_STATIC",
4652 "do not initialise statics to $1\n" .
4653 $herecurr) &&
4654 $fix) {
4655 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
4656 }
4657 }
4658
4659# check for misordered declarations of char/short/int/long with signed/unsigned
4660 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4661 my $tmp = trim($1);
4662 WARN("MISORDERED_TYPE",
4663 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4664 }
4665
4666# check for unnecessary <signed> int declarations of short/long/long long
4667 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4668 my $type = trim($1);
4669 next if ($type !~ /\bint\b/);
4670 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4671 my $new_type = $type;
4672 $new_type =~ s/\b\s*int\s*\b/ /;
4673 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4674 $new_type =~ s/^const\s+//;
4675 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4676 $new_type = "const $new_type" if ($type =~ /^const\b/);
4677 $new_type =~ s/\s+/ /g;
4678 $new_type = trim($new_type);
4679 if (WARN("UNNECESSARY_INT",
4680 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4681 $fix) {
4682 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4683 }
4684 }
4685
4686# check for static const char * arrays.
4687 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
4688 WARN("STATIC_CONST_CHAR_ARRAY",
4689 "static const char * array should probably be static const char * const\n" .
4690 $herecurr);
4691 }
4692
4693# check for initialized const char arrays that should be static const
4694 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4695 if (WARN("STATIC_CONST_CHAR_ARRAY",
4696 "const array should probably be static const\n" . $herecurr) &&
4697 $fix) {
4698 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4699 }
4700 }
4701
4702# check for static char foo[] = "bar" declarations.
4703 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
4704 WARN("STATIC_CONST_CHAR_ARRAY",
4705 "static char array declaration should probably be static const char\n" .
4706 $herecurr);
4707 }
4708
4709# check for const <foo> const where <foo> is not a pointer or array type
4710 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4711 my $found = $1;
4712 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4713 WARN("CONST_CONST",
4714 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4715 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4716 WARN("CONST_CONST",
4717 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4718 }
4719 }
4720
4721# check for const static or static <non ptr type> const declarations
4722# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4723 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
4724 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
4725 if (WARN("STATIC_CONST",
4726 "Move const after static - use 'static const $1'\n" . $herecurr) &&
4727 $fix) {
4728 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
4729 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
4730 }
4731 }
4732
4733# check for non-global char *foo[] = {"bar", ...} declarations.
4734 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4735 WARN("STATIC_CONST_CHAR_ARRAY",
4736 "char * array declaration might be better as static const\n" .
4737 $herecurr);
4738 }
4739
4740# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4741 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4742 my $array = $1;
4743 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4744 my $array_div = $1;
4745 if (WARN("ARRAY_SIZE",
4746 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4747 $fix) {
4748 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4749 }
4750 }
4751 }
4752
4753# check for function declarations without arguments like "int foo()"
4754 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
4755 if (ERROR("FUNCTION_WITHOUT_ARGS",
4756 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4757 $fix) {
4758 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
4759 }
4760 }
4761
4762# check for new typedefs, only function parameters and sparse annotations
4763# make sense.
4764 if ($line =~ /\btypedef\s/ &&
4765 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
4766 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
4767 $line !~ /\b$typeTypedefs\b/ &&
4768 $line !~ /\b__bitwise\b/) {
4769 WARN("NEW_TYPEDEFS",
4770 "do not add new typedefs\n" . $herecurr);
4771 }
4772
4773# * goes on variable not on type
4774 # (char*[ const])
4775 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4776 #print "AA<$1>\n";
4777 my ($ident, $from, $to) = ($1, $2, $2);
4778
4779 # Should start with a space.
4780 $to =~ s/^(\S)/ $1/;
4781 # Should not end with a space.
4782 $to =~ s/\s+$//;
4783 # '*'s should not have spaces between.
4784 while ($to =~ s/\*\s+\*/\*\*/) {
4785 }
4786
4787## print "1: from<$from> to<$to> ident<$ident>\n";
4788 if ($from ne $to) {
4789 if (ERROR("POINTER_LOCATION",
4790 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4791 $fix) {
4792 my $sub_from = $ident;
4793 my $sub_to = $ident;
4794 $sub_to =~ s/\Q$from\E/$to/;
4795 $fixed[$fixlinenr] =~
4796 s@\Q$sub_from\E@$sub_to@;
4797 }
4798 }
4799 }
4800 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4801 #print "BB<$1>\n";
4802 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
4803
4804 # Should start with a space.
4805 $to =~ s/^(\S)/ $1/;
4806 # Should not end with a space.
4807 $to =~ s/\s+$//;
4808 # '*'s should not have spaces between.
4809 while ($to =~ s/\*\s+\*/\*\*/) {
4810 }
4811 # Modifiers should have spaces.
4812 $to =~ s/(\b$Modifier$)/$1 /;
4813
4814## print "2: from<$from> to<$to> ident<$ident>\n";
4815 if ($from ne $to && $ident !~ /^$Modifier$/) {
4816 if (ERROR("POINTER_LOCATION",
4817 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4818 $fix) {
4819
4820 my $sub_from = $match;
4821 my $sub_to = $match;
4822 $sub_to =~ s/\Q$from\E/$to/;
4823 $fixed[$fixlinenr] =~
4824 s@\Q$sub_from\E@$sub_to@;
4825 }
4826 }
4827 }
4828
4829# do not use BUG() or variants
4830 if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) {
4831 my $msg_level = \&WARN;
4832 $msg_level = \&CHK if ($file);
4833 &{$msg_level}("AVOID_BUG",
4834 "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr);
4835 }
4836
4837# avoid LINUX_VERSION_CODE
4838 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
4839 WARN("LINUX_VERSION_CODE",
4840 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4841 }
4842
4843# check for uses of printk_ratelimit
4844 if ($line =~ /\bprintk_ratelimit\s*\(/) {
4845 WARN("PRINTK_RATELIMITED",
4846 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
4847 }
4848
4849# printk should use KERN_* levels
4850 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4851 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4852 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
4853 }
4854
4855# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4856 if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) {
4857 my $printk = $1;
4858 my $modifier = $2;
4859 my $orig = $3;
4860 $modifier = "" if (!defined($modifier));
4861 my $level = lc($orig);
4862 $level = "warn" if ($level eq "warning");
4863 my $level2 = $level;
4864 $level2 = "dbg" if ($level eq "debug");
4865 $level .= $modifier;
4866 $level2 .= $modifier;
4867 WARN("PREFER_PR_LEVEL",
4868 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr);
4869 }
4870
4871# prefer dev_<level> to dev_printk(KERN_<LEVEL>
4872 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4873 my $orig = $1;
4874 my $level = lc($orig);
4875 $level = "warn" if ($level eq "warning");
4876 $level = "dbg" if ($level eq "debug");
4877 WARN("PREFER_DEV_LEVEL",
4878 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4879 }
4880
4881# trace_printk should not be used in production code.
4882 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4883 WARN("TRACE_PRINTK",
4884 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4885 }
4886
4887# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4888# number of false positives, but assembly files are not checked, so at
4889# least the arch entry code will not trigger this warning.
4890 if ($line =~ /\bENOSYS\b/) {
4891 WARN("ENOSYS",
4892 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4893 }
4894
4895# ENOTSUPP is not a standard error code and should be avoided in new patches.
4896# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4897# Similarly to ENOSYS warning a small number of false positives is expected.
4898 if (!$file && $line =~ /\bENOTSUPP\b/) {
4899 if (WARN("ENOTSUPP",
4900 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4901 $fix) {
4902 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4903 }
4904 }
4905
4906# function brace can't be on same line, except for #defines of do while,
4907# or if closed on same line
4908 if ($perl_version_ok &&
4909 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4910 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4911 $sline !~ /}/) {
4912 if (ERROR("OPEN_BRACE",
4913 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
4914 $fix) {
4915 fix_delete_line($fixlinenr, $rawline);
4916 my $fixed_line = $rawline;
4917 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
4918 my $line1 = $1;
4919 my $line2 = $2;
4920 fix_insert_line($fixlinenr, ltrim($line1));
4921 fix_insert_line($fixlinenr, "\+{");
4922 if ($line2 !~ /^\s*$/) {
4923 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4924 }
4925 }
4926 }
4927
4928# open braces for enum, union and struct go on the same line.
4929 if ($line =~ /^.\s*{/ &&
4930 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
4931 if (ERROR("OPEN_BRACE",
4932 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4933 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4934 fix_delete_line($fixlinenr - 1, $prevrawline);
4935 fix_delete_line($fixlinenr, $rawline);
4936 my $fixedline = rtrim($prevrawline) . " {";
4937 fix_insert_line($fixlinenr, $fixedline);
4938 $fixedline = $rawline;
4939 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
4940 if ($fixedline !~ /^\+\s*$/) {
4941 fix_insert_line($fixlinenr, $fixedline);
4942 }
4943 }
4944 }
4945
4946# missing space after union, struct or enum definition
4947 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4948 if (WARN("SPACING",
4949 "missing space after $1 definition\n" . $herecurr) &&
4950 $fix) {
4951 $fixed[$fixlinenr] =~
4952 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4953 }
4954 }
4955
4956# Function pointer declarations
4957# check spacing between type, funcptr, and args
4958# canonical declaration is "type (*funcptr)(args...)"
4959 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
4960 my $declare = $1;
4961 my $pre_pointer_space = $2;
4962 my $post_pointer_space = $3;
4963 my $funcname = $4;
4964 my $post_funcname_space = $5;
4965 my $pre_args_space = $6;
4966
4967# the $Declare variable will capture all spaces after the type
4968# so check it for a missing trailing missing space but pointer return types
4969# don't need a space so don't warn for those.
4970 my $post_declare_space = "";
4971 if ($declare =~ /(\s+)$/) {
4972 $post_declare_space = $1;
4973 $declare = rtrim($declare);
4974 }
4975 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
4976 WARN("SPACING",
4977 "missing space after return type\n" . $herecurr);
4978 $post_declare_space = " ";
4979 }
4980
4981# unnecessary space "type (*funcptr)(args...)"
4982# This test is not currently implemented because these declarations are
4983# equivalent to
4984# int foo(int bar, ...)
4985# and this is form shouldn't/doesn't generate a checkpatch warning.
4986#
4987# elsif ($declare =~ /\s{2,}$/) {
4988# WARN("SPACING",
4989# "Multiple spaces after return type\n" . $herecurr);
4990# }
4991
4992# unnecessary space "type ( *funcptr)(args...)"
4993 if (defined $pre_pointer_space &&
4994 $pre_pointer_space =~ /^\s/) {
4995 WARN("SPACING",
4996 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4997 }
4998
4999# unnecessary space "type (* funcptr)(args...)"
5000 if (defined $post_pointer_space &&
5001 $post_pointer_space =~ /^\s/) {
5002 WARN("SPACING",
5003 "Unnecessary space before function pointer name\n" . $herecurr);
5004 }
5005
5006# unnecessary space "type (*funcptr )(args...)"
5007 if (defined $post_funcname_space &&
5008 $post_funcname_space =~ /^\s/) {
5009 WARN("SPACING",
5010 "Unnecessary space after function pointer name\n" . $herecurr);
5011 }
5012
5013# unnecessary space "type (*funcptr) (args...)"
5014 if (defined $pre_args_space &&
5015 $pre_args_space =~ /^\s/) {
5016 WARN("SPACING",
5017 "Unnecessary space before function pointer arguments\n" . $herecurr);
5018 }
5019
5020 if (show_type("SPACING") && $fix) {
5021 $fixed[$fixlinenr] =~
5022 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
5023 }
5024 }
5025
5026# check for spacing round square brackets; allowed:
5027# 1. with a type on the left -- int [] a;
5028# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
5029# 3. inside a curly brace -- = { [0...10] = 5 }
5030 while ($line =~ /(.*?\s)\[/g) {
5031 my ($where, $prefix) = ($-[1], $1);
5032 if ($prefix !~ /$Type\s+$/ &&
5033 ($where != 0 || $prefix !~ /^.\s+$/) &&
5034 $prefix !~ /[{,:]\s+$/) {
5035 if (ERROR("BRACKET_SPACE",
5036 "space prohibited before open square bracket '['\n" . $herecurr) &&
5037 $fix) {
5038 $fixed[$fixlinenr] =~
5039 s/^(\+.*?)\s+\[/$1\[/;
5040 }
5041 }
5042 }
5043
5044# check for spaces between functions and their parentheses.
5045 while ($line =~ /($Ident)\s+\(/g) {
5046 my $name = $1;
5047 my $ctx_before = substr($line, 0, $-[1]);
5048 my $ctx = "$ctx_before$name";
5049
5050 # Ignore those directives where spaces _are_ permitted.
5051 if ($name =~ /^(?:
5052 if|for|while|switch|return|case|
5053 volatile|__volatile__|
5054 __attribute__|format|__extension__|
5055 asm|__asm__|scoped_guard)$/x)
5056 {
5057 # cpp #define statements have non-optional spaces, ie
5058 # if there is a space between the name and the open
5059 # parenthesis it is simply not a parameter group.
5060 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
5061
5062 # cpp #elif statement condition may start with a (
5063 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
5064
5065 # If this whole things ends with a type its most
5066 # likely a typedef for a function.
5067 } elsif ($ctx =~ /$Type$/) {
5068
5069 } else {
5070 if (WARN("SPACING",
5071 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
5072 $fix) {
5073 $fixed[$fixlinenr] =~
5074 s/\b$name\s+\(/$name\(/;
5075 }
5076 }
5077 }
5078
5079# Check operator spacing.
5080 if (!($line=~/\#\s*include/)) {
5081 my $fixed_line = "";
5082 my $line_fixed = 0;
5083
5084 my $ops = qr{
5085 <<=|>>=|<=|>=|==|!=|
5086 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
5087 =>|->|<<|>>|<|>|=|!|~|
5088 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
5089 \?:|\?|:
5090 }x;
5091 my @elements = split(/($ops|;)/, $opline);
5092
5093## print("element count: <" . $#elements . ">\n");
5094## foreach my $el (@elements) {
5095## print("el: <$el>\n");
5096## }
5097
5098 my @fix_elements = ();
5099 my $off = 0;
5100
5101 foreach my $el (@elements) {
5102 push(@fix_elements, substr($rawline, $off, length($el)));
5103 $off += length($el);
5104 }
5105
5106 $off = 0;
5107
5108 my $blank = copy_spacing($opline);
5109 my $last_after = -1;
5110
5111 for (my $n = 0; $n < $#elements; $n += 2) {
5112
5113 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
5114
5115## print("n: <$n> good: <$good>\n");
5116
5117 $off += length($elements[$n]);
5118
5119 # Pick up the preceding and succeeding characters.
5120 my $ca = substr($opline, 0, $off);
5121 my $cc = '';
5122 if (length($opline) >= ($off + length($elements[$n + 1]))) {
5123 $cc = substr($opline, $off + length($elements[$n + 1]));
5124 }
5125 my $cb = "$ca$;$cc";
5126
5127 my $a = '';
5128 $a = 'V' if ($elements[$n] ne '');
5129 $a = 'W' if ($elements[$n] =~ /\s$/);
5130 $a = 'C' if ($elements[$n] =~ /$;$/);
5131 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
5132 $a = 'O' if ($elements[$n] eq '');
5133 $a = 'E' if ($ca =~ /^\s*$/);
5134
5135 my $op = $elements[$n + 1];
5136
5137 my $c = '';
5138 if (defined $elements[$n + 2]) {
5139 $c = 'V' if ($elements[$n + 2] ne '');
5140 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
5141 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
5142 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
5143 $c = 'O' if ($elements[$n + 2] eq '');
5144 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
5145 } else {
5146 $c = 'E';
5147 }
5148
5149 my $ctx = "${a}x${c}";
5150
5151 my $at = "(ctx:$ctx)";
5152
5153 my $ptr = substr($blank, 0, $off) . "^";
5154 my $hereptr = "$hereline$ptr\n";
5155
5156 # Pull out the value of this operator.
5157 my $op_type = substr($curr_values, $off + 1, 1);
5158
5159 # Get the full operator variant.
5160 my $opv = $op . substr($curr_vars, $off, 1);
5161
5162 # Ignore operators passed as parameters.
5163 if ($op_type ne 'V' &&
5164 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
5165
5166# # Ignore comments
5167# } elsif ($op =~ /^$;+$/) {
5168
5169 # ; should have either the end of line or a space or \ after it
5170 } elsif ($op eq ';') {
5171 if ($ctx !~ /.x[WEBC]/ &&
5172 $cc !~ /^\\/ && $cc !~ /^;/) {
5173 if (ERROR("SPACING",
5174 "space required after that '$op' $at\n" . $hereptr)) {
5175 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
5176 $line_fixed = 1;
5177 }
5178 }
5179
5180 # // is a comment
5181 } elsif ($op eq '//') {
5182
5183 # : when part of a bitfield
5184 } elsif ($opv eq ':B') {
5185 # skip the bitfield test for now
5186
5187 # No spaces for:
5188 # ->
5189 } elsif ($op eq '->') {
5190 if ($ctx =~ /Wx.|.xW/) {
5191 if (ERROR("SPACING",
5192 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
5193 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5194 if (defined $fix_elements[$n + 2]) {
5195 $fix_elements[$n + 2] =~ s/^\s+//;
5196 }
5197 $line_fixed = 1;
5198 }
5199 }
5200
5201 # , must not have a space before and must have a space on the right.
5202 } elsif ($op eq ',') {
5203 my $rtrim_before = 0;
5204 my $space_after = 0;
5205 if ($ctx =~ /Wx./) {
5206 if (ERROR("SPACING",
5207 "space prohibited before that '$op' $at\n" . $hereptr)) {
5208 $line_fixed = 1;
5209 $rtrim_before = 1;
5210 }
5211 }
5212 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
5213 if (ERROR("SPACING",
5214 "space required after that '$op' $at\n" . $hereptr)) {
5215 $line_fixed = 1;
5216 $last_after = $n;
5217 $space_after = 1;
5218 }
5219 }
5220 if ($rtrim_before || $space_after) {
5221 if ($rtrim_before) {
5222 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5223 } else {
5224 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
5225 }
5226 if ($space_after) {
5227 $good .= " ";
5228 }
5229 }
5230
5231 # '*' as part of a type definition -- reported already.
5232 } elsif ($opv eq '*_') {
5233 #warn "'*' is part of type\n";
5234
5235 # unary operators should have a space before and
5236 # none after. May be left adjacent to another
5237 # unary operator, or a cast
5238 } elsif ($op eq '!' || $op eq '~' ||
5239 $opv eq '*U' || $opv eq '-U' ||
5240 $opv eq '&U' || $opv eq '&&U') {
5241 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
5242 if (ERROR("SPACING",
5243 "space required before that '$op' $at\n" . $hereptr)) {
5244 if ($n != $last_after + 2) {
5245 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
5246 $line_fixed = 1;
5247 }
5248 }
5249 }
5250 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
5251 # A unary '*' may be const
5252
5253 } elsif ($ctx =~ /.xW/) {
5254 if (ERROR("SPACING",
5255 "space prohibited after that '$op' $at\n" . $hereptr)) {
5256 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
5257 if (defined $fix_elements[$n + 2]) {
5258 $fix_elements[$n + 2] =~ s/^\s+//;
5259 }
5260 $line_fixed = 1;
5261 }
5262 }
5263
5264 # unary ++ and unary -- are allowed no space on one side.
5265 } elsif ($op eq '++' or $op eq '--') {
5266 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
5267 if (ERROR("SPACING",
5268 "space required one side of that '$op' $at\n" . $hereptr)) {
5269 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
5270 $line_fixed = 1;
5271 }
5272 }
5273 if ($ctx =~ /Wx[BE]/ ||
5274 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
5275 if (ERROR("SPACING",
5276 "space prohibited before that '$op' $at\n" . $hereptr)) {
5277 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5278 $line_fixed = 1;
5279 }
5280 }
5281 if ($ctx =~ /ExW/) {
5282 if (ERROR("SPACING",
5283 "space prohibited after that '$op' $at\n" . $hereptr)) {
5284 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
5285 if (defined $fix_elements[$n + 2]) {
5286 $fix_elements[$n + 2] =~ s/^\s+//;
5287 }
5288 $line_fixed = 1;
5289 }
5290 }
5291
5292 # << and >> may either have or not have spaces both sides
5293 } elsif ($op eq '<<' or $op eq '>>' or
5294 $op eq '&' or $op eq '^' or $op eq '|' or
5295 $op eq '+' or $op eq '-' or
5296 $op eq '*' or $op eq '/' or
5297 $op eq '%')
5298 {
5299 if ($check) {
5300 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
5301 if (CHK("SPACING",
5302 "spaces preferred around that '$op' $at\n" . $hereptr)) {
5303 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5304 $fix_elements[$n + 2] =~ s/^\s+//;
5305 $line_fixed = 1;
5306 }
5307 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
5308 if (CHK("SPACING",
5309 "space preferred before that '$op' $at\n" . $hereptr)) {
5310 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
5311 $line_fixed = 1;
5312 }
5313 }
5314 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
5315 if (ERROR("SPACING",
5316 "need consistent spacing around '$op' $at\n" . $hereptr)) {
5317 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5318 if (defined $fix_elements[$n + 2]) {
5319 $fix_elements[$n + 2] =~ s/^\s+//;
5320 }
5321 $line_fixed = 1;
5322 }
5323 }
5324
5325 # A colon needs no spaces before when it is
5326 # terminating a case value or a label.
5327 } elsif ($opv eq ':C' || $opv eq ':L') {
5328 if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) {
5329 if (ERROR("SPACING",
5330 "space prohibited before that '$op' $at\n" . $hereptr)) {
5331 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
5332 $line_fixed = 1;
5333 }
5334 }
5335
5336 # All the others need spaces both sides.
5337 } elsif ($ctx !~ /[EWC]x[CWE]/) {
5338 my $ok = 0;
5339
5340 # Ignore email addresses <foo@bar>
5341 if (($op eq '<' &&
5342 $cc =~ /^\S+\@\S+>/) ||
5343 ($op eq '>' &&
5344 $ca =~ /<\S+\@\S+$/))
5345 {
5346 $ok = 1;
5347 }
5348
5349 # for asm volatile statements
5350 # ignore a colon with another
5351 # colon immediately before or after
5352 if (($op eq ':') &&
5353 ($ca =~ /:$/ || $cc =~ /^:/)) {
5354 $ok = 1;
5355 }
5356
5357 # messages are ERROR, but ?: are CHK
5358 if ($ok == 0) {
5359 my $msg_level = \&ERROR;
5360 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
5361
5362 if (&{$msg_level}("SPACING",
5363 "spaces required around that '$op' $at\n" . $hereptr)) {
5364 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5365 if (defined $fix_elements[$n + 2]) {
5366 $fix_elements[$n + 2] =~ s/^\s+//;
5367 }
5368 $line_fixed = 1;
5369 }
5370 }
5371 }
5372 $off += length($elements[$n + 1]);
5373
5374## print("n: <$n> GOOD: <$good>\n");
5375
5376 $fixed_line = $fixed_line . $good;
5377 }
5378
5379 if (($#elements % 2) == 0) {
5380 $fixed_line = $fixed_line . $fix_elements[$#elements];
5381 }
5382
5383 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5384 $fixed[$fixlinenr] = $fixed_line;
5385 }
5386
5387
5388 }
5389
5390# check for whitespace before a non-naked semicolon
5391 if ($line =~ /^\+.*\S\s+;\s*$/) {
5392 if (WARN("SPACING",
5393 "space prohibited before semicolon\n" . $herecurr) &&
5394 $fix) {
5395 1 while $fixed[$fixlinenr] =~
5396 s/^(\+.*\S)\s+;/$1;/;
5397 }
5398 }
5399
5400# check for multiple assignments
5401 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
5402 CHK("MULTIPLE_ASSIGNMENTS",
5403 "multiple assignments should be avoided\n" . $herecurr);
5404 }
5405
5406## # check for multiple declarations, allowing for a function declaration
5407## # continuation.
5408## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5409## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5410##
5411## # Remove any bracketed sections to ensure we do not
5412## # falsely report the parameters of functions.
5413## my $ln = $line;
5414## while ($ln =~ s/\([^\(\)]*\)//g) {
5415## }
5416## if ($ln =~ /,/) {
5417## WARN("MULTIPLE_DECLARATION",
5418## "declaring multiple variables together should be avoided\n" . $herecurr);
5419## }
5420## }
5421
5422#need space before brace following if, while, etc
5423 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
5424 $line =~ /\b(?:else|do)\{/) {
5425 if (ERROR("SPACING",
5426 "space required before the open brace '{'\n" . $herecurr) &&
5427 $fix) {
5428 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
5429 }
5430 }
5431
5432## # check for blank lines before declarations
5433## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5434## $prevrawline =~ /^.\s*$/) {
5435## WARN("SPACING",
5436## "No blank lines before declarations\n" . $hereprev);
5437## }
5438##
5439
5440# closing brace should have a space following it when it has anything
5441# on the line
5442 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
5443 if (ERROR("SPACING",
5444 "space required after that close brace '}'\n" . $herecurr) &&
5445 $fix) {
5446 $fixed[$fixlinenr] =~
5447 s/}((?!(?:,|;|\)))\S)/} $1/;
5448 }
5449 }
5450
5451# check spacing on square brackets
5452 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
5453 if (ERROR("SPACING",
5454 "space prohibited after that open square bracket '['\n" . $herecurr) &&
5455 $fix) {
5456 $fixed[$fixlinenr] =~
5457 s/\[\s+/\[/;
5458 }
5459 }
5460 if ($line =~ /\s\]/) {
5461 if (ERROR("SPACING",
5462 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
5463 $fix) {
5464 $fixed[$fixlinenr] =~
5465 s/\s+\]/\]/;
5466 }
5467 }
5468
5469# check spacing on parentheses
5470 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
5471 $line !~ /for\s*\(\s+;/) {
5472 if (ERROR("SPACING",
5473 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
5474 $fix) {
5475 $fixed[$fixlinenr] =~
5476 s/\(\s+/\(/;
5477 }
5478 }
5479 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
5480 $line !~ /for\s*\(.*;\s+\)/ &&
5481 $line !~ /:\s+\)/) {
5482 if (ERROR("SPACING",
5483 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
5484 $fix) {
5485 $fixed[$fixlinenr] =~
5486 s/\s+\)/\)/;
5487 }
5488 }
5489
5490# check unnecessary parentheses around addressof/dereference single $Lvals
5491# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5492
5493 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
5494 my $var = $1;
5495 if (CHK("UNNECESSARY_PARENTHESES",
5496 "Unnecessary parentheses around $var\n" . $herecurr) &&
5497 $fix) {
5498 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5499 }
5500 }
5501
5502# check for unnecessary parentheses around function pointer uses
5503# ie: (foo->bar)(); should be foo->bar();
5504# but not "if (foo->bar) (" to avoid some false positives
5505 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5506 my $var = $2;
5507 if (CHK("UNNECESSARY_PARENTHESES",
5508 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5509 $fix) {
5510 my $var2 = deparenthesize($var);
5511 $var2 =~ s/\s//g;
5512 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5513 }
5514 }
5515
5516# check for unnecessary parentheses around comparisons in if uses
5517# when !drivers/staging or command-line uses --strict
5518 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
5519 $perl_version_ok && defined($stat) &&
5520 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
5521 my $if_stat = $1;
5522 my $test = substr($2, 1, -1);
5523 my $herectx;
5524 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5525 my $match = $1;
5526 # avoid parentheses around potential macro args
5527 next if ($match =~ /^\s*\w+\s*$/);
5528 if (!defined($herectx)) {
5529 $herectx = $here . "\n";
5530 my $cnt = statement_rawlines($if_stat);
5531 for (my $n = 0; $n < $cnt; $n++) {
5532 my $rl = raw_line($linenr, $n);
5533 $herectx .= $rl . "\n";
5534 last if $rl =~ /^[ \+].*\{/;
5535 }
5536 }
5537 CHK("UNNECESSARY_PARENTHESES",
5538 "Unnecessary parentheses around '$match'\n" . $herectx);
5539 }
5540 }
5541
5542# check that goto labels aren't indented (allow a single space indentation)
5543# and ignore bitfield definitions like foo:1
5544# Strictly, labels can have whitespace after the identifier and before the :
5545# but this is not allowed here as many ?: uses would appear to be labels
5546 if ($sline =~ /^.\s+[A-Za-z_][A-Za-z\d_]*:(?!\s*\d+)/ &&
5547 $sline !~ /^. [A-Za-z\d_][A-Za-z\d_]*:/ &&
5548 $sline !~ /^.\s+default:/) {
5549 if (WARN("INDENTED_LABEL",
5550 "labels should not be indented\n" . $herecurr) &&
5551 $fix) {
5552 $fixed[$fixlinenr] =~
5553 s/^(.)\s+/$1/;
5554 }
5555 }
5556
5557# check if a statement with a comma should be two statements like:
5558# foo = bar(), /* comma should be semicolon */
5559# bar = baz();
5560 if (defined($stat) &&
5561 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5562 my $cnt = statement_rawlines($stat);
5563 my $herectx = get_stat_here($linenr, $cnt, $here);
5564 WARN("SUSPECT_COMMA_SEMICOLON",
5565 "Possible comma where semicolon could be used\n" . $herectx);
5566 }
5567
5568# return is not a function
5569 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
5570 my $spacing = $1;
5571 if ($perl_version_ok &&
5572 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
5573 my $value = $1;
5574 $value = deparenthesize($value);
5575 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5576 ERROR("RETURN_PARENTHESES",
5577 "return is not a function, parentheses are not required\n" . $herecurr);
5578 }
5579 } elsif ($spacing !~ /\s+/) {
5580 ERROR("SPACING",
5581 "space required before the open parenthesis '('\n" . $herecurr);
5582 }
5583 }
5584
5585# unnecessary return in a void function
5586# at end-of-function, with the previous line a single leading tab, then return;
5587# and the line before that not a goto label target like "out:"
5588 if ($sline =~ /^[ \+]}\s*$/ &&
5589 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5590 $linenr >= 3 &&
5591 $lines[$linenr - 3] =~ /^[ +]/ &&
5592 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
5593 WARN("RETURN_VOID",
5594 "void function return statements are not generally useful\n" . $hereprev);
5595 }
5596
5597# if statements using unnecessary parentheses - ie: if ((foo == bar))
5598 if ($perl_version_ok &&
5599 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5600 my $openparens = $1;
5601 my $count = $openparens =~ tr@\(@\(@;
5602 my $msg = "";
5603 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5604 my $comp = $4; #Not $1 because of $LvalOrFunc
5605 $msg = " - maybe == should be = ?" if ($comp eq "==");
5606 WARN("UNNECESSARY_PARENTHESES",
5607 "Unnecessary parentheses$msg\n" . $herecurr);
5608 }
5609 }
5610
5611# comparisons with a constant or upper case identifier on the left
5612# avoid cases like "foo + BAR < baz"
5613# only fix matches surrounded by parentheses to avoid incorrect
5614# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5615 if ($perl_version_ok &&
5616 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5617 my $lead = $1;
5618 my $const = $2;
5619 my $comp = $3;
5620 my $to = $4;
5621 my $newcomp = $comp;
5622 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
5623 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5624 WARN("CONSTANT_COMPARISON",
5625 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5626 $fix) {
5627 if ($comp eq "<") {
5628 $newcomp = ">";
5629 } elsif ($comp eq "<=") {
5630 $newcomp = ">=";
5631 } elsif ($comp eq ">") {
5632 $newcomp = "<";
5633 } elsif ($comp eq ">=") {
5634 $newcomp = "<=";
5635 }
5636 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5637 }
5638 }
5639
5640# Return of what appears to be an errno should normally be negative
5641 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
5642 my $name = $1;
5643 if ($name ne 'EOF' && $name ne 'ERROR' && $name !~ /^EPOLL/) {
5644 WARN("USE_NEGATIVE_ERRNO",
5645 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
5646 }
5647 }
5648
5649# Need a space before open parenthesis after if, while etc
5650 if ($line =~ /\b(if|while|for|switch)\(/) {
5651 if (ERROR("SPACING",
5652 "space required before the open parenthesis '('\n" . $herecurr) &&
5653 $fix) {
5654 $fixed[$fixlinenr] =~
5655 s/\b(if|while|for|switch)\(/$1 \(/;
5656 }
5657 }
5658
5659# Check for illegal assignment in if conditional -- and check for trailing
5660# statements after the conditional.
5661 if ($line =~ /do\s*(?!{)/) {
5662 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5663 ctx_statement_block($linenr, $realcnt, 0)
5664 if (!defined $stat);
5665 my ($stat_next) = ctx_statement_block($line_nr_next,
5666 $remain_next, $off_next);
5667 $stat_next =~ s/\n./\n /g;
5668 ##print "stat<$stat> stat_next<$stat_next>\n";
5669
5670 if ($stat_next =~ /^\s*while\b/) {
5671 # If the statement carries leading newlines,
5672 # then count those as offsets.
5673 my ($whitespace) =
5674 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5675 my $offset =
5676 statement_rawlines($whitespace) - 1;
5677
5678 $suppress_whiletrailers{$line_nr_next +
5679 $offset} = 1;
5680 }
5681 }
5682 if (!defined $suppress_whiletrailers{$linenr} &&
5683 defined($stat) && defined($cond) &&
5684 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
5685 my ($s, $c) = ($stat, $cond);
5686 my $fixed_assign_in_if = 0;
5687
5688 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
5689 if (ERROR("ASSIGN_IN_IF",
5690 "do not use assignment in if condition\n" . $herecurr) &&
5691 $fix && $perl_version_ok) {
5692 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5693 my $space = $1;
5694 my $not = $2;
5695 my $statement = $3;
5696 my $assigned = $4;
5697 my $test = $8;
5698 my $against = $9;
5699 my $brace = $15;
5700 fix_delete_line($fixlinenr, $rawline);
5701 fix_insert_line($fixlinenr, "$space$statement;");
5702 my $newline = "${space}if (";
5703 $newline .= '!' if defined($not);
5704 $newline .= '(' if (defined $not && defined($test) && defined($against));
5705 $newline .= "$assigned";
5706 $newline .= " $test $against" if (defined($test) && defined($against));
5707 $newline .= ')' if (defined $not && defined($test) && defined($against));
5708 $newline .= ')';
5709 $newline .= " {" if (defined($brace));
5710 fix_insert_line($fixlinenr + 1, $newline);
5711 $fixed_assign_in_if = 1;
5712 }
5713 }
5714 }
5715
5716 # Find out what is on the end of the line after the
5717 # conditional.
5718 substr($s, 0, length($c), '');
5719 $s =~ s/\n.*//g;
5720 $s =~ s/$;//g; # Remove any comments
5721 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5722 $c !~ /}\s*while\s*/)
5723 {
5724 # Find out how long the conditional actually is.
5725 my @newlines = ($c =~ /\n/gs);
5726 my $cond_lines = 1 + $#newlines;
5727 my $stat_real = '';
5728
5729 $stat_real = raw_line($linenr, $cond_lines)
5730 . "\n" if ($cond_lines);
5731 if (defined($stat_real) && $cond_lines > 1) {
5732 $stat_real = "[...]\n$stat_real";
5733 }
5734
5735 if (ERROR("TRAILING_STATEMENTS",
5736 "trailing statements should be on next line\n" . $herecurr . $stat_real) &&
5737 !$fixed_assign_in_if &&
5738 $cond_lines == 0 &&
5739 $fix && $perl_version_ok &&
5740 $fixed[$fixlinenr] =~ /^\+(\s*)((?:if|while|for)\s*$balanced_parens)\s*(.*)$/) {
5741 my $indent = $1;
5742 my $test = $2;
5743 my $rest = rtrim($4);
5744 if ($rest =~ /;$/) {
5745 $fixed[$fixlinenr] = "\+$indent$test";
5746 fix_insert_line($fixlinenr + 1, "$indent\t$rest");
5747 }
5748 }
5749 }
5750 }
5751
5752# Check for bitwise tests written as boolean
5753 if ($line =~ /
5754 (?:
5755 (?:\[|\(|\&\&|\|\|)
5756 \s*0[xX][0-9]+\s*
5757 (?:\&\&|\|\|)
5758 |
5759 (?:\&\&|\|\|)
5760 \s*0[xX][0-9]+\s*
5761 (?:\&\&|\|\||\)|\])
5762 )/x)
5763 {
5764 WARN("HEXADECIMAL_BOOLEAN_TEST",
5765 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
5766 }
5767
5768# if and else should not have general statements after it
5769 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5770 my $s = $1;
5771 $s =~ s/$;//g; # Remove any comments
5772 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
5773 ERROR("TRAILING_STATEMENTS",
5774 "trailing statements should be on next line\n" . $herecurr);
5775 }
5776 }
5777# if should not continue a brace
5778 if ($line =~ /}\s*if\b/) {
5779 ERROR("TRAILING_STATEMENTS",
5780 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
5781 $herecurr);
5782 }
5783# case and default should not have general statements after them
5784 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5785 $line !~ /\G(?:
5786 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
5787 \s*return\s+
5788 )/xg)
5789 {
5790 ERROR("TRAILING_STATEMENTS",
5791 "trailing statements should be on next line\n" . $herecurr);
5792 }
5793
5794 # Check for }<nl>else {, these must be at the same
5795 # indent level to be relevant to each other.
5796 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5797 $previndent == $indent) {
5798 if (ERROR("ELSE_AFTER_BRACE",
5799 "else should follow close brace '}'\n" . $hereprev) &&
5800 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5801 fix_delete_line($fixlinenr - 1, $prevrawline);
5802 fix_delete_line($fixlinenr, $rawline);
5803 my $fixedline = $prevrawline;
5804 $fixedline =~ s/}\s*$//;
5805 if ($fixedline !~ /^\+\s*$/) {
5806 fix_insert_line($fixlinenr, $fixedline);
5807 }
5808 $fixedline = $rawline;
5809 $fixedline =~ s/^(.\s*)else/$1} else/;
5810 fix_insert_line($fixlinenr, $fixedline);
5811 }
5812 }
5813
5814 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5815 $previndent == $indent) {
5816 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5817
5818 # Find out what is on the end of the line after the
5819 # conditional.
5820 substr($s, 0, length($c), '');
5821 $s =~ s/\n.*//g;
5822
5823 if ($s =~ /^\s*;/) {
5824 if (ERROR("WHILE_AFTER_BRACE",
5825 "while should follow close brace '}'\n" . $hereprev) &&
5826 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5827 fix_delete_line($fixlinenr - 1, $prevrawline);
5828 fix_delete_line($fixlinenr, $rawline);
5829 my $fixedline = $prevrawline;
5830 my $trailing = $rawline;
5831 $trailing =~ s/^\+//;
5832 $trailing = trim($trailing);
5833 $fixedline =~ s/}\s*$/} $trailing/;
5834 fix_insert_line($fixlinenr, $fixedline);
5835 }
5836 }
5837 }
5838
5839#Specific variable tests
5840 while ($line =~ m{($Constant|$Lval)}g) {
5841 my $var = $1;
5842
5843#CamelCase
5844 if ($var !~ /^$Constant$/ &&
5845 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
5846#Ignore some autogenerated defines and enum values
5847 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
5848#Ignore Page<foo> variants
5849 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
5850#Ignore ETHTOOL_LINK_MODE_<foo> variants
5851 $var !~ /^ETHTOOL_LINK_MODE_/ &&
5852#Ignore SI style variants like nS, mV and dB
5853#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5854 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
5855#Ignore some three character SI units explicitly, like MiB and KHz
5856 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
5857 while ($var =~ m{\b($Ident)}g) {
5858 my $word = $1;
5859 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
5860 if ($check) {
5861 seed_camelcase_includes();
5862 if (!$file && !$camelcase_file_seeded) {
5863 seed_camelcase_file($realfile);
5864 $camelcase_file_seeded = 1;
5865 }
5866 }
5867 if (!defined $camelcase{$word}) {
5868 $camelcase{$word} = 1;
5869 CHK("CAMELCASE",
5870 "Avoid CamelCase: <$word>\n" . $herecurr);
5871 }
5872 }
5873 }
5874 }
5875
5876#no spaces allowed after \ in define
5877 if ($line =~ /\#\s*define.*\\\s+$/) {
5878 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5879 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5880 $fix) {
5881 $fixed[$fixlinenr] =~ s/\s+$//;
5882 }
5883 }
5884
5885# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5886# itself <asm/foo.h> (uses RAW line)
5887 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
5888 my $file = "$1.h";
5889 my $checkfile = "include/linux/$file";
5890 if (-f "$root/$checkfile" &&
5891 $realfile ne $checkfile &&
5892 $1 !~ /$allowed_asm_includes/)
5893 {
5894 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5895 if ($asminclude > 0) {
5896 if ($realfile =~ m{^arch/}) {
5897 CHK("ARCH_INCLUDE_LINUX",
5898 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5899 } else {
5900 WARN("INCLUDE_LINUX",
5901 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5902 }
5903 }
5904 }
5905 }
5906
5907# multi-statement macros should be enclosed in a do while loop, grab the
5908# first statement and ensure its the whole macro if its not enclosed
5909# in a known good container
5910 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5911 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
5912 my $ln = $linenr;
5913 my $cnt = $realcnt;
5914 my ($off, $dstat, $dcond, $rest);
5915 my $ctx = '';
5916 my $has_flow_statement = 0;
5917 my $has_arg_concat = 0;
5918 ($dstat, $dcond, $ln, $cnt, $off) =
5919 ctx_statement_block($linenr, $realcnt, 0);
5920 $ctx = $dstat;
5921 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5922 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5923
5924 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
5925 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
5926
5927 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5928 my $define_args = $1;
5929 my $define_stmt = $dstat;
5930 my @def_args = ();
5931
5932 if (defined $define_args && $define_args ne "") {
5933 $define_args = substr($define_args, 1, length($define_args) - 2);
5934 $define_args =~ s/\s*//g;
5935 $define_args =~ s/\\\+?//g;
5936 @def_args = split(",", $define_args);
5937 }
5938
5939 $dstat =~ s/$;//g;
5940 $dstat =~ s/\\\n.//g;
5941 $dstat =~ s/^\s*//s;
5942 $dstat =~ s/\s*$//s;
5943
5944 # Flatten any parentheses and braces
5945 while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
5946 $dstat =~ s/\{[^\{\}]*\}/1u/ ||
5947 $dstat =~ s/.\[[^\[\]]*\]/1u/)
5948 {
5949 }
5950
5951 # Flatten any obvious string concatenation.
5952 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5953 $dstat =~ s/$Ident\s*($String)/$1/)
5954 {
5955 }
5956
5957 # Make asm volatile uses seem like a generic function
5958 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5959
5960 my $exceptions = qr{
5961 $Declare|
5962 module_param_named|
5963 MODULE_PARM_DESC|
5964 DECLARE_PER_CPU|
5965 DEFINE_PER_CPU|
5966 __typeof__\(|
5967 union|
5968 struct|
5969 \.$Ident\s*=\s*|
5970 ^\"|\"$|
5971 ^\[
5972 }x;
5973 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5974
5975 $ctx =~ s/\n*$//;
5976 my $stmt_cnt = statement_rawlines($ctx);
5977 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
5978
5979 if ($dstat ne '' &&
5980 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5981 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
5982 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5983 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
5984 $dstat !~ /$exceptions/ &&
5985 $dstat !~ /^\.$Ident\s*=/ && # .foo =
5986 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
5987 $dstat !~ /^case\b/ && # case ...
5988 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5989 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...}
5990 $dstat !~ /^for\s*$Constant$/ && # for (...)
5991 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5992 $dstat !~ /^do\s*{/ && # do {...
5993 $dstat !~ /^\(\{/ && # ({...
5994 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
5995 {
5996 if ($dstat =~ /^\s*if\b/) {
5997 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5998 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5999 } elsif ($dstat =~ /;/) {
6000 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
6001 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
6002 } else {
6003 ERROR("COMPLEX_MACRO",
6004 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
6005 }
6006
6007 }
6008
6009 # Make $define_stmt single line, comment-free, etc
6010 my @stmt_array = split('\n', $define_stmt);
6011 my $first = 1;
6012 $define_stmt = "";
6013 foreach my $l (@stmt_array) {
6014 $l =~ s/\\$//;
6015 if ($first) {
6016 $define_stmt = $l;
6017 $first = 0;
6018 } elsif ($l =~ /^[\+ ]/) {
6019 $define_stmt .= substr($l, 1);
6020 }
6021 }
6022 $define_stmt =~ s/$;//g;
6023 $define_stmt =~ s/\s+/ /g;
6024 $define_stmt = trim($define_stmt);
6025
6026# check if any macro arguments are reused (ignore '...' and 'type')
6027 foreach my $arg (@def_args) {
6028 next if ($arg =~ /\.\.\./);
6029 next if ($arg =~ /^type$/i);
6030 my $tmp_stmt = $define_stmt;
6031 $tmp_stmt =~ s/\b(__must_be_array|offsetof|sizeof|sizeof_field|__stringify|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
6032 $tmp_stmt =~ s/\#+\s*$arg\b//g;
6033 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
6034 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
6035 if ($use_cnt > 1) {
6036 CHK("MACRO_ARG_REUSE",
6037 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
6038 }
6039# check if any macro arguments may have other precedence issues
6040 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
6041 ((defined($1) && $1 ne ',') ||
6042 (defined($2) && $2 ne ','))) {
6043 CHK("MACRO_ARG_PRECEDENCE",
6044 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
6045 }
6046
6047# check if this is an unused argument
6048 if ($define_stmt !~ /\b$arg\b/) {
6049 WARN("MACRO_ARG_UNUSED",
6050 "Argument '$arg' is not used in function-like macro\n" . "$herectx");
6051 }
6052 }
6053
6054# check for macros with flow control, but without ## concatenation
6055# ## concatenation is commonly a macro that defines a function so ignore those
6056 if ($has_flow_statement && !$has_arg_concat) {
6057 my $cnt = statement_rawlines($ctx);
6058 my $herectx = get_stat_here($linenr, $cnt, $here);
6059
6060 WARN("MACRO_WITH_FLOW_CONTROL",
6061 "Macros with flow control statements should be avoided\n" . "$herectx");
6062 }
6063
6064# check for line continuations outside of #defines, preprocessor #, and asm
6065
6066 } elsif ($realfile =~ m@/vmlinux.lds.h$@) {
6067 $line =~ s/(\w+)/$maybe_linker_symbol{$1}++/ge;
6068 #print "REAL: $realfile\nln: $line\nkeys:", sort keys %maybe_linker_symbol;
6069 } else {
6070 if ($prevline !~ /^..*\\$/ &&
6071 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
6072 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
6073 $line =~ /^\+.*\\$/) {
6074 WARN("LINE_CONTINUATIONS",
6075 "Avoid unnecessary line continuations\n" . $herecurr);
6076 }
6077 }
6078
6079# do {} while (0) macro tests:
6080# single-statement macros do not need to be enclosed in do while (0) loop,
6081# macro should not end with a semicolon
6082 if ($perl_version_ok &&
6083 $realfile !~ m@/vmlinux.lds.h$@ &&
6084 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
6085 my $ln = $linenr;
6086 my $cnt = $realcnt;
6087 my ($off, $dstat, $dcond, $rest);
6088 my $ctx = '';
6089 ($dstat, $dcond, $ln, $cnt, $off) =
6090 ctx_statement_block($linenr, $realcnt, 0);
6091 $ctx = $dstat;
6092
6093 $dstat =~ s/\\\n.//g;
6094 $dstat =~ s/$;/ /g;
6095
6096 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
6097 my $stmts = $2;
6098 my $semis = $3;
6099
6100 $ctx =~ s/\n*$//;
6101 my $cnt = statement_rawlines($ctx);
6102 my $herectx = get_stat_here($linenr, $cnt, $here);
6103
6104 if (($stmts =~ tr/;/;/) == 1 &&
6105 $stmts !~ /^\s*(if|while|for|switch)\b/) {
6106 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
6107 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
6108 }
6109 if (defined $semis && $semis ne "") {
6110 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
6111 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
6112 }
6113 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
6114 $ctx =~ s/\n*$//;
6115 my $cnt = statement_rawlines($ctx);
6116 my $herectx = get_stat_here($linenr, $cnt, $here);
6117
6118 WARN("TRAILING_SEMICOLON",
6119 "macros should not use a trailing semicolon\n" . "$herectx");
6120 }
6121 }
6122
6123# check for redundant bracing round if etc
6124 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
6125 my ($level, $endln, @chunks) =
6126 ctx_statement_full($linenr, $realcnt, 1);
6127 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
6128 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
6129 if ($#chunks > 0 && $level == 0) {
6130 my @allowed = ();
6131 my $allow = 0;
6132 my $seen = 0;
6133 my $herectx = $here . "\n";
6134 my $ln = $linenr - 1;
6135 for my $chunk (@chunks) {
6136 my ($cond, $block) = @{$chunk};
6137
6138 # If the condition carries leading newlines, then count those as offsets.
6139 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
6140 my $offset = statement_rawlines($whitespace) - 1;
6141
6142 $allowed[$allow] = 0;
6143 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
6144
6145 # We have looked at and allowed this specific line.
6146 $suppress_ifbraces{$ln + $offset} = 1;
6147
6148 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
6149 $ln += statement_rawlines($block) - 1;
6150
6151 substr($block, 0, length($cond), '');
6152
6153 $seen++ if ($block =~ /^\s*{/);
6154
6155 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
6156 if (statement_lines($cond) > 1) {
6157 #print "APW: ALLOWED: cond<$cond>\n";
6158 $allowed[$allow] = 1;
6159 }
6160 if ($block =~/\b(?:if|for|while)\b/) {
6161 #print "APW: ALLOWED: block<$block>\n";
6162 $allowed[$allow] = 1;
6163 }
6164 if (statement_block_size($block) > 1) {
6165 #print "APW: ALLOWED: lines block<$block>\n";
6166 $allowed[$allow] = 1;
6167 }
6168 $allow++;
6169 }
6170 if ($seen) {
6171 my $sum_allowed = 0;
6172 foreach (@allowed) {
6173 $sum_allowed += $_;
6174 }
6175 if ($sum_allowed == 0) {
6176 WARN("BRACES",
6177 "braces {} are not necessary for any arm of this statement\n" . $herectx);
6178 } elsif ($sum_allowed != $allow &&
6179 $seen != $allow) {
6180 CHK("BRACES",
6181 "braces {} should be used on all arms of this statement\n" . $herectx);
6182 }
6183 }
6184 }
6185 }
6186 if (!defined $suppress_ifbraces{$linenr - 1} &&
6187 $line =~ /\b(if|while|for|else)\b/) {
6188 my $allowed = 0;
6189
6190 # Check the pre-context.
6191 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
6192 #print "APW: ALLOWED: pre<$1>\n";
6193 $allowed = 1;
6194 }
6195
6196 my ($level, $endln, @chunks) =
6197 ctx_statement_full($linenr, $realcnt, $-[0]);
6198
6199 # Check the condition.
6200 my ($cond, $block) = @{$chunks[0]};
6201 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
6202 if (defined $cond) {
6203 substr($block, 0, length($cond), '');
6204 }
6205 if (statement_lines($cond) > 1) {
6206 #print "APW: ALLOWED: cond<$cond>\n";
6207 $allowed = 1;
6208 }
6209 if ($block =~/\b(?:if|for|while)\b/) {
6210 #print "APW: ALLOWED: block<$block>\n";
6211 $allowed = 1;
6212 }
6213 if (statement_block_size($block) > 1) {
6214 #print "APW: ALLOWED: lines block<$block>\n";
6215 $allowed = 1;
6216 }
6217 # Check the post-context.
6218 if (defined $chunks[1]) {
6219 my ($cond, $block) = @{$chunks[1]};
6220 if (defined $cond) {
6221 substr($block, 0, length($cond), '');
6222 }
6223 if ($block =~ /^\s*\{/) {
6224 #print "APW: ALLOWED: chunk-1 block<$block>\n";
6225 $allowed = 1;
6226 }
6227 }
6228 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
6229 my $cnt = statement_rawlines($block);
6230 my $herectx = get_stat_here($linenr, $cnt, $here);
6231
6232 WARN("BRACES",
6233 "braces {} are not necessary for single statement blocks\n" . $herectx);
6234 }
6235 }
6236
6237# check for single line unbalanced braces
6238 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
6239 $sline =~ /^.\s*else\s*\{\s*$/) {
6240 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
6241 }
6242
6243# check for unnecessary blank lines around braces
6244 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
6245 if (CHK("BRACES",
6246 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
6247 $fix && $prevrawline =~ /^\+/) {
6248 fix_delete_line($fixlinenr - 1, $prevrawline);
6249 }
6250 }
6251 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
6252 if (CHK("BRACES",
6253 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
6254 $fix) {
6255 fix_delete_line($fixlinenr, $rawline);
6256 }
6257 }
6258
6259# no volatiles please
6260 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
6261 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
6262 WARN("VOLATILE",
6263 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
6264 }
6265
6266# Check for user-visible strings broken across lines, which breaks the ability
6267# to grep for the string. Make exceptions when the previous string ends in a
6268# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
6269# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
6270 if ($line =~ /^\+\s*$String/ &&
6271 $prevline =~ /"\s*$/ &&
6272 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
6273 if (WARN("SPLIT_STRING",
6274 "quoted string split across lines\n" . $hereprev) &&
6275 $fix &&
6276 $prevrawline =~ /^\+.*"\s*$/ &&
6277 $last_coalesced_string_linenr != $linenr - 1) {
6278 my $extracted_string = get_quoted_string($line, $rawline);
6279 my $comma_close = "";
6280 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
6281 $comma_close = $1;
6282 }
6283
6284 fix_delete_line($fixlinenr - 1, $prevrawline);
6285 fix_delete_line($fixlinenr, $rawline);
6286 my $fixedline = $prevrawline;
6287 $fixedline =~ s/"\s*$//;
6288 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
6289 fix_insert_line($fixlinenr - 1, $fixedline);
6290 $fixedline = $rawline;
6291 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
6292 if ($fixedline !~ /\+\s*$/) {
6293 fix_insert_line($fixlinenr, $fixedline);
6294 }
6295 $last_coalesced_string_linenr = $linenr;
6296 }
6297 }
6298
6299# check for missing a space in a string concatenation
6300 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
6301 WARN('MISSING_SPACE',
6302 "break quoted strings at a space character\n" . $hereprev);
6303 }
6304
6305# check for an embedded function name in a string when the function is known
6306# This does not work very well for -f --file checking as it depends on patch
6307# context providing the function name or a single line form for in-file
6308# function declarations
6309 if ($line =~ /^\+.*$String/ &&
6310 defined($context_function) &&
6311 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
6312 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
6313 WARN("EMBEDDED_FUNCTION_NAME",
6314 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
6315 }
6316
6317# check for unnecessary function tracing like uses
6318# This does not use $logFunctions because there are many instances like
6319# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6320 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6321 if (WARN("TRACING_LOGGING",
6322 "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) &&
6323 $fix) {
6324 fix_delete_line($fixlinenr, $rawline);
6325 }
6326 }
6327
6328# check for spaces before a quoted newline
6329 if ($rawline =~ /^.*\".*\s\\n/) {
6330 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
6331 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
6332 $fix) {
6333 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
6334 }
6335
6336 }
6337
6338# concatenated string without spaces between elements
6339 if ($line =~ /$String[A-Z_]/ ||
6340 ($line =~ /([A-Za-z0-9_]+)$String/ && $1 !~ /^[Lu]$/)) {
6341 if (CHK("CONCATENATED_STRING",
6342 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
6343 $fix) {
6344 while ($line =~ /($String)/g) {
6345 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6346 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
6347 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
6348 }
6349 }
6350 }
6351
6352# uncoalesced string fragments
6353 if ($line =~ /$String\s*[Lu]?"/) {
6354 if (WARN("STRING_FRAGMENTS",
6355 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
6356 $fix) {
6357 while ($line =~ /($String)(?=\s*")/g) {
6358 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
6359 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
6360 }
6361 }
6362 }
6363
6364# check for non-standard and hex prefixed decimal printf formats
6365 my $show_L = 1; #don't show the same defect twice
6366 my $show_Z = 1;
6367 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
6368 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
6369 $string =~ s/%%/__/g;
6370 # check for %L
6371 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
6372 WARN("PRINTF_L",
6373 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6374 $show_L = 0;
6375 }
6376 # check for %Z
6377 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6378 WARN("PRINTF_Z",
6379 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6380 $show_Z = 0;
6381 }
6382 # check for 0x<decimal>
6383 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6384 ERROR("PRINTF_0XDECIMAL",
6385 "Prefixing 0x with decimal output is defective\n" . $herecurr);
6386 }
6387 }
6388
6389# check for line continuations in quoted strings with odd counts of "
6390 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
6391 WARN("LINE_CONTINUATIONS",
6392 "Avoid line continuations in quoted strings\n" . $herecurr);
6393 }
6394
6395# warn about #if 0
6396 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
6397 WARN("IF_0",
6398 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
6399 }
6400
6401# warn about #if 1
6402 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
6403 WARN("IF_1",
6404 "Consider removing the #if 1 and its #endif\n" . $herecurr);
6405 }
6406
6407# check for needless "if (<foo>) fn(<foo>)" uses
6408 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
6409 my $tested = quotemeta($1);
6410 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6411 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6412 my $func = $1;
6413 if (WARN('NEEDLESS_IF',
6414 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6415 $fix) {
6416 my $do_fix = 1;
6417 my $leading_tabs = "";
6418 my $new_leading_tabs = "";
6419 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6420 $leading_tabs = $1;
6421 } else {
6422 $do_fix = 0;
6423 }
6424 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6425 $new_leading_tabs = $1;
6426 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6427 $do_fix = 0;
6428 }
6429 } else {
6430 $do_fix = 0;
6431 }
6432 if ($do_fix) {
6433 fix_delete_line($fixlinenr - 1, $prevrawline);
6434 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6435 }
6436 }
6437 }
6438 }
6439
6440# check for unnecessary "Out of Memory" messages
6441 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6442 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6443 (defined $1 || defined $3) &&
6444 $linenr > 3) {
6445 my $testval = $2;
6446 my $testline = $lines[$linenr - 3];
6447
6448 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6449# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6450
6451 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6452 $s !~ /\b__GFP_NOWARN\b/ ) {
6453 WARN("OOM_MESSAGE",
6454 "Possible unnecessary 'out of memory' message\n" . $hereprev);
6455 }
6456 }
6457
6458# check for logging functions with KERN_<LEVEL>
6459 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
6460 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6461 my $level = $1;
6462 if (WARN("UNNECESSARY_KERN_LEVEL",
6463 "Possible unnecessary $level\n" . $herecurr) &&
6464 $fix) {
6465 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
6466 }
6467 }
6468
6469# check for logging continuations
6470 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
6471 WARN("LOGGING_CONTINUATION",
6472 "Avoid logging continuation uses where feasible\n" . $herecurr);
6473 }
6474
6475# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6476 if (defined $stat &&
6477 $line =~ /\b$logFunctions\s*\(/ &&
6478 index($stat, '"') >= 0) {
6479 my $lc = $stat =~ tr@\n@@;
6480 $lc = $lc + $linenr;
6481 my $stat_real = get_stat_real($linenr, $lc);
6482 pos($stat_real) = index($stat_real, '"');
6483 while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) {
6484 my $pspec = $1;
6485 my $h = $2;
6486 my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@;
6487 if (WARN("UNNECESSARY_MODIFIER",
6488 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") &&
6489 $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) {
6490 my $nspec = $pspec;
6491 $nspec =~ s/h//g;
6492 $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/;
6493 }
6494 }
6495 }
6496
6497# check for mask then right shift without a parentheses
6498 if ($perl_version_ok &&
6499 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6500 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6501 WARN("MASK_THEN_SHIFT",
6502 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6503 }
6504
6505# check for pointer comparisons to NULL
6506 if ($perl_version_ok) {
6507 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6508 my $val = $1;
6509 my $equal = "!";
6510 $equal = "" if ($4 eq "!=");
6511 if (CHK("COMPARISON_TO_NULL",
6512 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6513 $fix) {
6514 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6515 }
6516 }
6517 }
6518
6519# check for bad placement of section $InitAttribute (e.g.: __initdata)
6520 if ($line =~ /(\b$InitAttribute\b)/) {
6521 my $attr = $1;
6522 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6523 my $ptr = $1;
6524 my $var = $2;
6525 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
6526 ERROR("MISPLACED_INIT",
6527 "$attr should be placed after $var\n" . $herecurr)) ||
6528 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
6529 WARN("MISPLACED_INIT",
6530 "$attr should be placed after $var\n" . $herecurr))) &&
6531 $fix) {
6532 $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;
6533 }
6534 }
6535 }
6536
6537# check for $InitAttributeData (ie: __initdata) with const
6538 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6539 my $attr = $1;
6540 $attr =~ /($InitAttributePrefix)(.*)/;
6541 my $attr_prefix = $1;
6542 my $attr_type = $2;
6543 if (ERROR("INIT_ATTRIBUTE",
6544 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6545 $fix) {
6546 $fixed[$fixlinenr] =~
6547 s/$InitAttributeData/${attr_prefix}initconst/;
6548 }
6549 }
6550
6551# check for $InitAttributeConst (ie: __initconst) without const
6552 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6553 my $attr = $1;
6554 if (ERROR("INIT_ATTRIBUTE",
6555 "Use of $attr requires a separate use of const\n" . $herecurr) &&
6556 $fix) {
6557 my $lead = $fixed[$fixlinenr] =~
6558 /(^\+\s*(?:static\s+))/;
6559 $lead = rtrim($1);
6560 $lead = "$lead " if ($lead !~ /^\+$/);
6561 $lead = "${lead}const ";
6562 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
6563 }
6564 }
6565
6566# check for __read_mostly with const non-pointer (should just be const)
6567 if ($line =~ /\b__read_mostly\b/ &&
6568 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6569 if (ERROR("CONST_READ_MOSTLY",
6570 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6571 $fix) {
6572 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6573 }
6574 }
6575
6576# don't use __constant_<foo> functions outside of include/uapi/
6577 if ($realfile !~ m@^include/uapi/@ &&
6578 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6579 my $constant_func = $1;
6580 my $func = $constant_func;
6581 $func =~ s/^__constant_//;
6582 if (WARN("CONSTANT_CONVERSION",
6583 "$constant_func should be $func\n" . $herecurr) &&
6584 $fix) {
6585 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
6586 }
6587 }
6588
6589# prefer usleep_range over udelay
6590 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
6591 my $delay = $1;
6592 # ignore udelay's < 10, however
6593 if (! ($delay < 10) ) {
6594 CHK("USLEEP_RANGE",
6595 "usleep_range is preferred over udelay; see function description of usleep_range() and udelay().\n" . $herecurr);
6596 }
6597 if ($delay > 2000) {
6598 WARN("LONG_UDELAY",
6599 "long udelay - prefer mdelay; see function description of mdelay().\n" . $herecurr);
6600 }
6601 }
6602
6603# warn about unexpectedly long msleep's
6604 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
6605 if ($1 < 20) {
6606 WARN("MSLEEP",
6607 "msleep < 20ms can sleep for up to 20ms; see function description of msleep().\n" . $herecurr);
6608 }
6609 }
6610
6611# check for comparisons of jiffies
6612 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
6613 WARN("JIFFIES_COMPARISON",
6614 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6615 }
6616
6617# check for comparisons of get_jiffies_64()
6618 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
6619 WARN("JIFFIES_COMPARISON",
6620 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6621 }
6622
6623# warn about #ifdefs in C files
6624# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6625# print "#ifdef in C files should be avoided\n";
6626# print "$herecurr";
6627# $clean = 0;
6628# }
6629
6630# warn about spacing in #ifdefs
6631 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
6632 if (ERROR("SPACING",
6633 "exactly one space required after that #$1\n" . $herecurr) &&
6634 $fix) {
6635 $fixed[$fixlinenr] =~
6636 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
6637 }
6638
6639 }
6640
6641# check for spinlock_t definitions without a comment.
6642 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6643 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
6644 my $which = $1;
6645 if (!ctx_has_comment($first_line, $linenr)) {
6646 CHK("UNCOMMENTED_DEFINITION",
6647 "$1 definition without comment\n" . $herecurr);
6648 }
6649 }
6650# check for memory barriers without a comment.
6651
6652 my $barriers = qr{
6653 mb|
6654 rmb|
6655 wmb
6656 }x;
6657 my $barrier_stems = qr{
6658 mb__before_atomic|
6659 mb__after_atomic|
6660 store_release|
6661 load_acquire|
6662 store_mb|
6663 (?:$barriers)
6664 }x;
6665 my $all_barriers = qr{
6666 (?:$barriers)|
6667 smp_(?:$barrier_stems)|
6668 virt_(?:$barrier_stems)
6669 }x;
6670
6671 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
6672 if (!ctx_has_comment($first_line, $linenr)) {
6673 WARN("MEMORY_BARRIER",
6674 "memory barrier without comment\n" . $herecurr);
6675 }
6676 }
6677
6678 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6679
6680 if ($realfile !~ m@^include/asm-generic/@ &&
6681 $realfile !~ m@/barrier\.h$@ &&
6682 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6683 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6684 WARN("MEMORY_BARRIER",
6685 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6686 }
6687
6688# check for waitqueue_active without a comment.
6689 if ($line =~ /\bwaitqueue_active\s*\(/) {
6690 if (!ctx_has_comment($first_line, $linenr)) {
6691 WARN("WAITQUEUE_ACTIVE",
6692 "waitqueue_active without comment\n" . $herecurr);
6693 }
6694 }
6695
6696# check for data_race without a comment.
6697 if ($line =~ /\bdata_race\s*\(/) {
6698 if (!ctx_has_comment($first_line, $linenr)) {
6699 WARN("DATA_RACE",
6700 "data_race without comment\n" . $herecurr);
6701 }
6702 }
6703
6704# check of hardware specific defines
6705 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6706 CHK("ARCH_DEFINES",
6707 "architecture specific defines should be avoided\n" . $herecurr);
6708 }
6709
6710# check that the storage class is not after a type
6711 if ($line =~ /\b($Type)\s+($Storage)\b/) {
6712 WARN("STORAGE_CLASS",
6713 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6714 }
6715# Check that the storage class is at the beginning of a declaration
6716 if ($line =~ /\b$Storage\b/ &&
6717 $line !~ /^.\s*$Storage/ &&
6718 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6719 $1 !~ /[\,\)]\s*$/) {
6720 WARN("STORAGE_CLASS",
6721 "storage class should be at the beginning of the declaration\n" . $herecurr);
6722 }
6723
6724# check the location of the inline attribute, that it is between
6725# storage class and type.
6726 if ($line =~ /\b$Type\s+$Inline\b/ ||
6727 $line =~ /\b$Inline\s+$Storage\b/) {
6728 ERROR("INLINE_LOCATION",
6729 "inline keyword should sit between storage class and type\n" . $herecurr);
6730 }
6731
6732# Check for __inline__ and __inline, prefer inline
6733 if ($realfile !~ m@\binclude/uapi/@ &&
6734 $line =~ /\b(__inline__|__inline)\b/) {
6735 if (WARN("INLINE",
6736 "plain inline is preferred over $1\n" . $herecurr) &&
6737 $fix) {
6738 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
6739
6740 }
6741 }
6742
6743# Check for compiler attributes
6744 if ($realfile !~ m@\binclude/uapi/@ &&
6745 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
6746 my $attr = $1;
6747 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
6748
6749 my %attr_list = (
6750 "alias" => "__alias",
6751 "aligned" => "__aligned",
6752 "always_inline" => "__always_inline",
6753 "assume_aligned" => "__assume_aligned",
6754 "cold" => "__cold",
6755 "const" => "__attribute_const__",
6756 "copy" => "__copy",
6757 "designated_init" => "__designated_init",
6758 "externally_visible" => "__visible",
6759 "format" => "printf|scanf",
6760 "gnu_inline" => "__gnu_inline",
6761 "malloc" => "__malloc",
6762 "mode" => "__mode",
6763 "no_caller_saved_registers" => "__no_caller_saved_registers",
6764 "noclone" => "__noclone",
6765 "noinline" => "noinline",
6766 "nonstring" => "__nonstring",
6767 "noreturn" => "__noreturn",
6768 "packed" => "__packed",
6769 "pure" => "__pure",
6770 "section" => "__section",
6771 "used" => "__used",
6772 "weak" => "__weak"
6773 );
6774
6775 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
6776 my $orig_attr = $1;
6777 my $params = '';
6778 $params = $2 if defined($2);
6779 my $curr_attr = $orig_attr;
6780 $curr_attr =~ s/^[\s_]+|[\s_]+$//g;
6781 if (exists($attr_list{$curr_attr})) {
6782 my $new = $attr_list{$curr_attr};
6783 if ($curr_attr eq "format" && $params) {
6784 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
6785 $new = "__$1\($2";
6786 } else {
6787 $new = "$new$params";
6788 }
6789 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6790 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
6791 $fix) {
6792 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6793 $fixed[$fixlinenr] =~ s/$remove//;
6794 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6795 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6796 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6797 }
6798 }
6799 }
6800
6801 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6802 if ($attr =~ /^_*unused/) {
6803 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6804 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6805 }
6806 }
6807
6808# Check for __attribute__ weak, or __weak declarations (may have link issues)
6809 if ($perl_version_ok &&
6810 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6811 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6812 $line =~ /\b__weak\b/)) {
6813 ERROR("WEAK_DECLARATION",
6814 "Using weak declarations can have unintended link defects\n" . $herecurr);
6815 }
6816
6817# check for c99 types like uint8_t used outside of uapi/ and tools/
6818 if ($realfile !~ m@\binclude/uapi/@ &&
6819 $realfile !~ m@\btools/@ &&
6820 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6821 my $type = $1;
6822 if ($type =~ /\b($typeC99Typedefs)\b/) {
6823 $type = $1;
6824 my $kernel_type = 'u';
6825 $kernel_type = 's' if ($type =~ /^_*[si]/);
6826 $type =~ /(\d+)/;
6827 $kernel_type .= $1;
6828 if (CHK("PREFER_KERNEL_TYPES",
6829 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6830 $fix) {
6831 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6832 }
6833 }
6834 }
6835
6836# check for cast of C90 native int or longer types constants
6837 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6838 my $cast = $1;
6839 my $const = $2;
6840 my $suffix = "";
6841 my $newconst = $const;
6842 $newconst =~ s/${Int_type}$//;
6843 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6844 if ($cast =~ /\blong\s+long\b/) {
6845 $suffix .= 'LL';
6846 } elsif ($cast =~ /\blong\b/) {
6847 $suffix .= 'L';
6848 }
6849 if (WARN("TYPECAST_INT_CONSTANT",
6850 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
6851 $fix) {
6852 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6853 }
6854 }
6855
6856# check for sizeof(&)
6857 if ($line =~ /\bsizeof\s*\(\s*\&/) {
6858 WARN("SIZEOF_ADDRESS",
6859 "sizeof(& should be avoided\n" . $herecurr);
6860 }
6861
6862# check for sizeof without parenthesis
6863 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
6864 if (WARN("SIZEOF_PARENTHESIS",
6865 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6866 $fix) {
6867 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6868 }
6869 }
6870
6871# check for struct spinlock declarations
6872 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6873 WARN("USE_SPINLOCK_T",
6874 "struct spinlock should be spinlock_t\n" . $herecurr);
6875 }
6876
6877# check for seq_printf uses that could be seq_puts
6878 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
6879 my $fmt = get_quoted_string($line, $rawline);
6880 $fmt =~ s/%%//g;
6881 if ($fmt !~ /%/) {
6882 if (WARN("PREFER_SEQ_PUTS",
6883 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6884 $fix) {
6885 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
6886 }
6887 }
6888 }
6889
6890# check for vsprintf extension %p<foo> misuses
6891 if ($perl_version_ok &&
6892 defined $stat &&
6893 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6894 $1 !~ /^_*volatile_*$/) {
6895 my $stat_real;
6896
6897 my $lc = $stat =~ tr@\n@@;
6898 $lc = $lc + $linenr;
6899 for (my $count = $linenr; $count <= $lc; $count++) {
6900 my $specifier;
6901 my $extension;
6902 my $qualifier;
6903 my $bad_specifier = "";
6904 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6905 $fmt =~ s/%%//g;
6906
6907 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
6908 $specifier = $1;
6909 $extension = $2;
6910 $qualifier = $3;
6911 if ($extension !~ /[4SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
6912 ($extension eq "f" &&
6913 defined $qualifier && $qualifier !~ /^w/) ||
6914 ($extension eq "4" &&
6915 defined $qualifier && $qualifier !~ /^cc/)) {
6916 $bad_specifier = $specifier;
6917 last;
6918 }
6919 if ($extension eq "x" && !defined($stat_real)) {
6920 if (!defined($stat_real)) {
6921 $stat_real = get_stat_real($linenr, $lc);
6922 }
6923 WARN("VSPRINTF_SPECIFIER_PX",
6924 "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");
6925 }
6926 }
6927 if ($bad_specifier ne "") {
6928 my $stat_real = get_stat_real($linenr, $lc);
6929 my $msg_level = \&WARN;
6930 my $ext_type = "Invalid";
6931 my $use = "";
6932 if ($bad_specifier =~ /p[Ff]/) {
6933 $use = " - use %pS instead";
6934 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6935 } elsif ($bad_specifier =~ /pA/) {
6936 $use = " - '%pA' is only intended to be used from Rust code";
6937 $msg_level = \&ERROR;
6938 }
6939
6940 &{$msg_level}("VSPRINTF_POINTER_EXTENSION",
6941 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6942 }
6943 }
6944 }
6945
6946# Check for misused memsets
6947 if ($perl_version_ok &&
6948 defined $stat &&
6949 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
6950
6951 my $ms_addr = $2;
6952 my $ms_val = $7;
6953 my $ms_size = $12;
6954
6955 if ($ms_size =~ /^(0x|)0$/i) {
6956 ERROR("MEMSET",
6957 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
6958 } elsif ($ms_size =~ /^(0x|)1$/i) {
6959 WARN("MEMSET",
6960 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6961 }
6962 }
6963
6964# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6965# if ($perl_version_ok &&
6966# defined $stat &&
6967# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6968# if (WARN("PREFER_ETHER_ADDR_COPY",
6969# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6970# $fix) {
6971# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6972# }
6973# }
6974
6975# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6976# if ($perl_version_ok &&
6977# defined $stat &&
6978# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6979# WARN("PREFER_ETHER_ADDR_EQUAL",
6980# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6981# }
6982
6983# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6984# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6985# if ($perl_version_ok &&
6986# defined $stat &&
6987# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6988#
6989# my $ms_val = $7;
6990#
6991# if ($ms_val =~ /^(?:0x|)0+$/i) {
6992# if (WARN("PREFER_ETH_ZERO_ADDR",
6993# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6994# $fix) {
6995# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6996# }
6997# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6998# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6999# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
7000# $fix) {
7001# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
7002# }
7003# }
7004# }
7005
7006# strcpy uses that should likely be strscpy
7007 if ($line =~ /\bstrcpy\s*\(/) {
7008 WARN("STRCPY",
7009 "Prefer strscpy over strcpy - see: https://github.com/KSPP/linux/issues/88\n" . $herecurr);
7010 }
7011
7012# strlcpy uses that should likely be strscpy
7013 if ($line =~ /\bstrlcpy\s*\(/) {
7014 WARN("STRLCPY",
7015 "Prefer strscpy over strlcpy - see: https://github.com/KSPP/linux/issues/89\n" . $herecurr);
7016 }
7017
7018# strncpy uses that should likely be strscpy or strscpy_pad
7019 if ($line =~ /\bstrncpy\s*\(/) {
7020 WARN("STRNCPY",
7021 "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90\n" . $herecurr);
7022 }
7023
7024# ethtool_sprintf uses that should likely be ethtool_puts
7025 if ($line =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
7026 if (WARN("PREFER_ETHTOOL_PUTS",
7027 "Prefer ethtool_puts over ethtool_sprintf with only two arguments\n" . $herecurr) &&
7028 $fix) {
7029 $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*($FuncArg)/ethtool_puts($1, $7)/;
7030 }
7031 }
7032
7033 # use $rawline because $line loses %s via sanitization and thus we can't match against it.
7034 if ($rawline =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*\"\%s\"\s*,\s*$FuncArg\s*\)/) {
7035 if (WARN("PREFER_ETHTOOL_PUTS",
7036 "Prefer ethtool_puts over ethtool_sprintf with standalone \"%s\" specifier\n" . $herecurr) &&
7037 $fix) {
7038 $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*"\%s"\s*,\s*($FuncArg)/ethtool_puts($1, $7)/;
7039 }
7040 }
7041
7042
7043# typecasts on min/max could be min_t/max_t
7044 if ($perl_version_ok &&
7045 defined $stat &&
7046 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
7047 if (defined $2 || defined $7) {
7048 my $call = $1;
7049 my $cast1 = deparenthesize($2);
7050 my $arg1 = $3;
7051 my $cast2 = deparenthesize($7);
7052 my $arg2 = $8;
7053 my $cast;
7054
7055 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
7056 $cast = "$cast1 or $cast2";
7057 } elsif ($cast1 ne "") {
7058 $cast = $cast1;
7059 } else {
7060 $cast = $cast2;
7061 }
7062 WARN("MINMAX",
7063 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
7064 }
7065 }
7066
7067# check usleep_range arguments
7068 if ($perl_version_ok &&
7069 defined $stat &&
7070 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
7071 my $min = $1;
7072 my $max = $7;
7073 if ($min eq $max) {
7074 WARN("USLEEP_RANGE",
7075 "usleep_range should not use min == max args; see function description of usleep_range().\n" . "$here\n$stat\n");
7076 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
7077 $min > $max) {
7078 WARN("USLEEP_RANGE",
7079 "usleep_range args reversed, use min then max; see function description of usleep_range().\n" . "$here\n$stat\n");
7080 }
7081 }
7082
7083# check for naked sscanf
7084 if ($perl_version_ok &&
7085 defined $stat &&
7086 $line =~ /\bsscanf\b/ &&
7087 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
7088 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
7089 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
7090 my $lc = $stat =~ tr@\n@@;
7091 $lc = $lc + $linenr;
7092 my $stat_real = get_stat_real($linenr, $lc);
7093 WARN("NAKED_SSCANF",
7094 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
7095 }
7096
7097# check for simple sscanf that should be kstrto<foo>
7098 if ($perl_version_ok &&
7099 defined $stat &&
7100 $line =~ /\bsscanf\b/) {
7101 my $lc = $stat =~ tr@\n@@;
7102 $lc = $lc + $linenr;
7103 my $stat_real = get_stat_real($linenr, $lc);
7104 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
7105 my $format = $6;
7106 my $count = $format =~ tr@%@%@;
7107 if ($count == 1 &&
7108 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
7109 WARN("SSCANF_TO_KSTRTO",
7110 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
7111 }
7112 }
7113 }
7114
7115# check for new externs in .h files.
7116 if ($realfile =~ /\.h$/ &&
7117 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
7118 if (CHK("AVOID_EXTERNS",
7119 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
7120 $fix) {
7121 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
7122 }
7123 }
7124
7125# check for new externs in .c files.
7126 if ($realfile =~ /\.c$/ && defined $stat &&
7127 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
7128 {
7129 my $function_name = $1;
7130 my $paren_space = $2;
7131
7132 my $s = $stat;
7133 if (defined $cond) {
7134 substr($s, 0, length($cond), '');
7135 }
7136 if ($s =~ /^\s*;/)
7137 {
7138 WARN("AVOID_EXTERNS",
7139 "externs should be avoided in .c files\n" . $herecurr);
7140 }
7141
7142 if ($paren_space =~ /\n/) {
7143 WARN("FUNCTION_ARGUMENTS",
7144 "arguments for function declarations should follow identifier\n" . $herecurr);
7145 }
7146
7147 } elsif ($realfile =~ /\.c$/ && defined $stat &&
7148 $stat =~ /^\+extern struct\s+(\w+)\s+(\w+)\[\];/)
7149 {
7150 my ($st_type, $st_name) = ($1, $2);
7151
7152 for my $s (keys %maybe_linker_symbol) {
7153 #print "Linker symbol? $st_name : $s\n";
7154 goto LIKELY_LINKER_SYMBOL
7155 if $st_name =~ /$s/;
7156 }
7157 WARN("AVOID_EXTERNS",
7158 "found a file-scoped extern type:$st_type name:$st_name in .c file\n"
7159 . "is this a linker symbol ?\n" . $herecurr);
7160 LIKELY_LINKER_SYMBOL:
7161
7162 } elsif ($realfile =~ /\.c$/ && defined $stat &&
7163 $stat =~ /^.\s*extern\s+/)
7164 {
7165 WARN("AVOID_EXTERNS",
7166 "externs should be avoided in .c files\n" . $herecurr);
7167 }
7168
7169# check for function declarations that have arguments without identifier names
7170 if (defined $stat &&
7171 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
7172 $1 ne "void") {
7173 my $args = trim($1);
7174 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
7175 my $arg = trim($1);
7176 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
7177 WARN("FUNCTION_ARGUMENTS",
7178 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
7179 }
7180 }
7181 }
7182
7183# check for function definitions
7184 if ($perl_version_ok &&
7185 defined $stat &&
7186 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
7187 $context_function = $1;
7188
7189# check for multiline function definition with misplaced open brace
7190 my $ok = 0;
7191 my $cnt = statement_rawlines($stat);
7192 my $herectx = $here . "\n";
7193 for (my $n = 0; $n < $cnt; $n++) {
7194 my $rl = raw_line($linenr, $n);
7195 $herectx .= $rl . "\n";
7196 $ok = 1 if ($rl =~ /^[ \+]\{/);
7197 $ok = 1 if ($rl =~ /\{/ && $n == 0);
7198 last if $rl =~ /^[ \+].*\{/;
7199 }
7200 if (!$ok) {
7201 ERROR("OPEN_BRACE",
7202 "open brace '{' following function definitions go on the next line\n" . $herectx);
7203 }
7204 }
7205
7206# checks for new __setup's
7207 if ($rawline =~ /\b__setup\("([^"]*)"/) {
7208 my $name = $1;
7209
7210 if (!grep(/$name/, @setup_docs)) {
7211 CHK("UNDOCUMENTED_SETUP",
7212 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
7213 }
7214 }
7215
7216# check for pointless casting of alloc functions
7217 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
7218 WARN("UNNECESSARY_CASTS",
7219 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
7220 }
7221
7222# alloc style
7223# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
7224 if ($perl_version_ok &&
7225 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
7226 CHK("ALLOC_SIZEOF_STRUCT",
7227 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
7228 }
7229
7230# check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc
7231 if ($perl_version_ok &&
7232 defined $stat &&
7233 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
7234 my $oldfunc = $3;
7235 my $a1 = $4;
7236 my $a2 = $10;
7237 my $newfunc = "kmalloc_array";
7238 $newfunc = "kvmalloc_array" if ($oldfunc eq "kvmalloc");
7239 $newfunc = "kvcalloc" if ($oldfunc eq "kvzalloc");
7240 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
7241 my $r1 = $a1;
7242 my $r2 = $a2;
7243 if ($a1 =~ /^sizeof\s*\S/) {
7244 $r1 = $a2;
7245 $r2 = $a1;
7246 }
7247 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
7248 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
7249 my $cnt = statement_rawlines($stat);
7250 my $herectx = get_stat_here($linenr, $cnt, $here);
7251
7252 if (WARN("ALLOC_WITH_MULTIPLY",
7253 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
7254 $cnt == 1 &&
7255 $fix) {
7256 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
7257 }
7258 }
7259 }
7260
7261# check for krealloc arg reuse
7262 if ($perl_version_ok &&
7263 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
7264 $1 eq $3) {
7265 WARN("KREALLOC_ARG_REUSE",
7266 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
7267 }
7268
7269# check for alloc argument mismatch
7270 if ($line =~ /\b((?:devm_)?((?:k|kv)?(calloc|malloc_array)(?:_node)?))\s*\(\s*sizeof\b/) {
7271 WARN("ALLOC_ARRAY_ARGS",
7272 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
7273 }
7274
7275# check for multiple semicolons
7276 if ($line =~ /;\s*;\s*$/) {
7277 if (WARN("ONE_SEMICOLON",
7278 "Statements terminations use 1 semicolon\n" . $herecurr) &&
7279 $fix) {
7280 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
7281 }
7282 }
7283
7284# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7285 if ($realfile !~ m@^include/uapi/@ &&
7286 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
7287 my $ull = "";
7288 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
7289 if (CHK("BIT_MACRO",
7290 "Prefer using the BIT$ull macro\n" . $herecurr) &&
7291 $fix) {
7292 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
7293 }
7294 }
7295
7296# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
7297 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
7298 WARN("IS_ENABLED_CONFIG",
7299 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
7300 }
7301
7302# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
7303 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
7304 my $config = $1;
7305 if (WARN("PREFER_IS_ENABLED",
7306 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
7307 $fix) {
7308 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
7309 }
7310 }
7311
7312# check for /* fallthrough */ like comment, prefer fallthrough;
7313 my @fallthroughs = (
7314 'fallthrough',
7315 '@fallthrough@',
7316 'lint -fallthrough[ \t]*',
7317 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
7318 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
7319 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7320 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
7321 );
7322 if ($raw_comment ne '') {
7323 foreach my $ft (@fallthroughs) {
7324 if ($raw_comment =~ /$ft/) {
7325 my $msg_level = \&WARN;
7326 $msg_level = \&CHK if ($file);
7327 &{$msg_level}("PREFER_FALLTHROUGH",
7328 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
7329 last;
7330 }
7331 }
7332 }
7333
7334# check for switch/default statements without a break;
7335 if ($perl_version_ok &&
7336 defined $stat &&
7337 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
7338 my $cnt = statement_rawlines($stat);
7339 my $herectx = get_stat_here($linenr, $cnt, $here);
7340
7341 WARN("DEFAULT_NO_BREAK",
7342 "switch default: should use break\n" . $herectx);
7343 }
7344
7345# check for gcc specific __FUNCTION__
7346 if ($line =~ /\b__FUNCTION__\b/) {
7347 if (WARN("USE_FUNC",
7348 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
7349 $fix) {
7350 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
7351 }
7352 }
7353
7354# check for uses of __DATE__, __TIME__, __TIMESTAMP__
7355 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
7356 ERROR("DATE_TIME",
7357 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
7358 }
7359
7360# check for use of yield()
7361 if ($line =~ /\byield\s*\(\s*\)/) {
7362 WARN("YIELD",
7363 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
7364 }
7365
7366# check for comparisons against true and false
7367 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
7368 my $lead = $1;
7369 my $arg = $2;
7370 my $test = $3;
7371 my $otype = $4;
7372 my $trail = $5;
7373 my $op = "!";
7374
7375 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
7376
7377 my $type = lc($otype);
7378 if ($type =~ /^(?:true|false)$/) {
7379 if (("$test" eq "==" && "$type" eq "true") ||
7380 ("$test" eq "!=" && "$type" eq "false")) {
7381 $op = "";
7382 }
7383
7384 CHK("BOOL_COMPARISON",
7385 "Using comparison to $otype is error prone\n" . $herecurr);
7386
7387## maybe suggesting a correct construct would better
7388## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7389
7390 }
7391 }
7392
7393# check for semaphores initialized locked
7394 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
7395 WARN("CONSIDER_COMPLETION",
7396 "consider using a completion\n" . $herecurr);
7397 }
7398
7399# recommend kstrto* over simple_strto* and strict_strto*
7400 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
7401 WARN("CONSIDER_KSTRTO",
7402 "$1 is obsolete, use k$3 instead\n" . $herecurr);
7403 }
7404
7405# check for __initcall(), use device_initcall() explicitly or more appropriate function please
7406 if ($line =~ /^.\s*__initcall\s*\(/) {
7407 WARN("USE_DEVICE_INITCALL",
7408 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
7409 }
7410
7411# check for spin_is_locked(), suggest lockdep instead
7412 if ($line =~ /\bspin_is_locked\(/) {
7413 WARN("USE_LOCKDEP",
7414 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7415 }
7416
7417# check for deprecated apis
7418 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
7419 my $deprecated_api = $1;
7420 my $new_api = $deprecated_apis{$deprecated_api};
7421 WARN("DEPRECATED_API",
7422 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
7423 }
7424
7425# check for various structs that are normally const (ops, kgdb, device_tree)
7426# and avoid what seem like struct definitions 'struct foo {'
7427 if (defined($const_structs) &&
7428 $line !~ /\bconst\b/ &&
7429 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
7430 WARN("CONST_STRUCT",
7431 "struct $1 should normally be const\n" . $herecurr);
7432 }
7433
7434# use of NR_CPUS is usually wrong
7435# ignore definitions of NR_CPUS and usage to define arrays as likely right
7436# ignore designated initializers using NR_CPUS
7437 if ($line =~ /\bNR_CPUS\b/ &&
7438 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
7439 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
7440 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
7441 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
7442 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ &&
7443 $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/)
7444 {
7445 WARN("NR_CPUS",
7446 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7447 }
7448
7449# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7450 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
7451 ERROR("DEFINE_ARCH_HAS",
7452 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
7453 }
7454
7455# likely/unlikely comparisons similar to "(likely(foo) > 0)"
7456 if ($perl_version_ok &&
7457 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7458 WARN("LIKELY_MISUSE",
7459 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7460 }
7461
7462# return sysfs_emit(foo, fmt, ...) fmt without newline
7463 if ($line =~ /\breturn\s+sysfs_emit\s*\(\s*$FuncArg\s*,\s*($String)/ &&
7464 substr($rawline, $-[6], $+[6] - $-[6]) !~ /\\n"$/) {
7465 my $offset = $+[6] - 1;
7466 if (WARN("SYSFS_EMIT",
7467 "return sysfs_emit(...) formats should include a terminating newline\n" . $herecurr) &&
7468 $fix) {
7469 substr($fixed[$fixlinenr], $offset, 0) = '\\n';
7470 }
7471 }
7472
7473# check for array definition/declarations that should use flexible arrays instead
7474 if ($sline =~ /^[\+ ]\s*\}(?:\s*__packed)?\s*;\s*$/ &&
7475 $prevline =~ /^\+\s*(?:\}(?:\s*__packed\s*)?|$Type)\s*$Ident\s*\[\s*(0|1)\s*\]\s*;\s*$/) {
7476 if (ERROR("FLEXIBLE_ARRAY",
7477 "Use C99 flexible arrays - see https://docs.kernel.org/process/deprecated.html#zero-length-and-one-element-arrays\n" . $hereprev) &&
7478 $1 == '0' && $fix) {
7479 $fixed[$fixlinenr - 1] =~ s/\[\s*0\s*\]/[]/;
7480 }
7481 }
7482
7483# nested likely/unlikely calls
7484 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7485 WARN("LIKELY_MISUSE",
7486 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7487 }
7488
7489# whine mightly about in_atomic
7490 if ($line =~ /\bin_atomic\s*\(/) {
7491 if ($realfile =~ m@^drivers/@) {
7492 ERROR("IN_ATOMIC",
7493 "do not use in_atomic in drivers\n" . $herecurr);
7494 } elsif ($realfile !~ m@^kernel/@) {
7495 WARN("IN_ATOMIC",
7496 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
7497 }
7498 }
7499
7500# Complain about RCU Tasks Trace used outside of BPF (and of course, RCU).
7501 our $rcu_trace_funcs = qr{(?x:
7502 rcu_read_lock_trace |
7503 rcu_read_lock_trace_held |
7504 rcu_read_unlock_trace |
7505 call_rcu_tasks_trace |
7506 synchronize_rcu_tasks_trace |
7507 rcu_barrier_tasks_trace |
7508 rcu_request_urgent_qs_task
7509 )};
7510 our $rcu_trace_paths = qr{(?x:
7511 kernel/bpf/ |
7512 include/linux/bpf |
7513 net/bpf/ |
7514 kernel/rcu/ |
7515 include/linux/rcu
7516 )};
7517 if ($line =~ /\b($rcu_trace_funcs)\s*\(/) {
7518 if ($realfile !~ m{^$rcu_trace_paths}) {
7519 WARN("RCU_TASKS_TRACE",
7520 "use of RCU tasks trace is incorrect outside BPF or core RCU code\n" . $herecurr);
7521 }
7522 }
7523
7524# check for lockdep_set_novalidate_class
7525 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
7526 $line =~ /__lockdep_no_validate__\s*\)/ ) {
7527 if ($realfile !~ m@^kernel/lockdep@ &&
7528 $realfile !~ m@^include/linux/lockdep@ &&
7529 $realfile !~ m@^drivers/base/core@) {
7530 ERROR("LOCKDEP",
7531 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
7532 }
7533 }
7534
7535 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7536 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
7537 WARN("EXPORTED_WORLD_WRITABLE",
7538 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
7539 }
7540
7541# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7542# and whether or not function naming is typical and if
7543# DEVICE_ATTR permissions uses are unusual too
7544 if ($perl_version_ok &&
7545 defined $stat &&
7546 $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*\)/) {
7547 my $var = $1;
7548 my $perms = $2;
7549 my $show = $3;
7550 my $store = $4;
7551 my $octal_perms = perms_to_octal($perms);
7552 if ($show =~ /^${var}_show$/ &&
7553 $store =~ /^${var}_store$/ &&
7554 $octal_perms eq "0644") {
7555 if (WARN("DEVICE_ATTR_RW",
7556 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
7557 $fix) {
7558 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7559 }
7560 } elsif ($show =~ /^${var}_show$/ &&
7561 $store =~ /^NULL$/ &&
7562 $octal_perms eq "0444") {
7563 if (WARN("DEVICE_ATTR_RO",
7564 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
7565 $fix) {
7566 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7567 }
7568 } elsif ($show =~ /^NULL$/ &&
7569 $store =~ /^${var}_store$/ &&
7570 $octal_perms eq "0200") {
7571 if (WARN("DEVICE_ATTR_WO",
7572 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
7573 $fix) {
7574 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7575 }
7576 } elsif ($octal_perms eq "0644" ||
7577 $octal_perms eq "0444" ||
7578 $octal_perms eq "0200") {
7579 my $newshow = "$show";
7580 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
7581 my $newstore = $store;
7582 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
7583 my $rename = "";
7584 if ($show ne $newshow) {
7585 $rename .= " '$show' to '$newshow'";
7586 }
7587 if ($store ne $newstore) {
7588 $rename .= " '$store' to '$newstore'";
7589 }
7590 WARN("DEVICE_ATTR_FUNCTIONS",
7591 "Consider renaming function(s)$rename\n" . $herecurr);
7592 } else {
7593 WARN("DEVICE_ATTR_PERMS",
7594 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
7595 }
7596 }
7597
7598# Mode permission misuses where it seems decimal should be octal
7599# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7600# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7601# specific definition of not visible in sysfs.
7602# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7603# use the default permissions
7604 if ($perl_version_ok &&
7605 defined $stat &&
7606 $line =~ /$mode_perms_search/) {
7607 foreach my $entry (@mode_permission_funcs) {
7608 my $func = $entry->[0];
7609 my $arg_pos = $entry->[1];
7610
7611 my $lc = $stat =~ tr@\n@@;
7612 $lc = $lc + $linenr;
7613 my $stat_real = get_stat_real($linenr, $lc);
7614
7615 my $skip_args = "";
7616 if ($arg_pos > 1) {
7617 $arg_pos--;
7618 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
7619 }
7620 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
7621 if ($stat =~ /$test/) {
7622 my $val = $1;
7623 $val = $6 if ($skip_args ne "");
7624 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
7625 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
7626 ($val =~ /^$Octal$/ && length($val) ne 4))) {
7627 ERROR("NON_OCTAL_PERMISSIONS",
7628 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
7629 }
7630 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
7631 ERROR("EXPORTED_WORLD_WRITABLE",
7632 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7633 }
7634 }
7635 }
7636 }
7637
7638# check for uses of S_<PERMS> that could be octal for readability
7639 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
7640 my $oval = $1;
7641 my $octal = perms_to_octal($oval);
7642 if (WARN("SYMBOLIC_PERMS",
7643 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7644 $fix) {
7645 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
7646 }
7647 }
7648
7649# validate content of MODULE_LICENSE against list from include/linux/module.h
7650 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
7651 my $extracted_string = get_quoted_string($line, $rawline);
7652 my $valid_licenses = qr{
7653 GPL|
7654 GPL\ v2|
7655 GPL\ and\ additional\ rights|
7656 Dual\ BSD/GPL|
7657 Dual\ MIT/GPL|
7658 Dual\ MPL/GPL|
7659 Proprietary
7660 }x;
7661 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
7662 WARN("MODULE_LICENSE",
7663 "unknown module license " . $extracted_string . "\n" . $herecurr);
7664 }
7665 if (!$file && $extracted_string eq '"GPL v2"') {
7666 if (WARN("MODULE_LICENSE",
7667 "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) &&
7668 $fix) {
7669 $fixed[$fixlinenr] =~ s/\bMODULE_LICENSE\s*\(\s*"GPL v2"\s*\)/MODULE_LICENSE("GPL")/;
7670 }
7671 }
7672 }
7673
7674# check for sysctl duplicate constants
7675 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
7676 WARN("DUPLICATED_SYSCTL_CONST",
7677 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7678 }
7679 }
7680
7681 # If we have no input at all, then there is nothing to report on
7682 # so just keep quiet.
7683 if ($#rawlines == -1) {
7684 exit(0);
7685 }
7686
7687 # In mailback mode only produce a report in the negative, for
7688 # things that appear to be patches.
7689 if ($mailback && ($clean == 1 || !$is_patch)) {
7690 exit(0);
7691 }
7692
7693 # This is not a patch, and we are in 'no-patch' mode so
7694 # just keep quiet.
7695 if (!$chk_patch && !$is_patch) {
7696 exit(0);
7697 }
7698
7699 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
7700 ERROR("NOT_UNIFIED_DIFF",
7701 "Does not appear to be a unified-diff format patch\n");
7702 }
7703 if ($is_patch && $has_commit_log && $chk_fixes_tag) {
7704 if ($needs_fixes_tag ne "" && !$is_revert && !$fixes_tag) {
7705 WARN("MISSING_FIXES_TAG",
7706 "The commit message has '$needs_fixes_tag', perhaps it also needs a 'Fixes:' tag?\n");
7707 }
7708 }
7709 if ($is_patch && $has_commit_log && $chk_signoff) {
7710 if ($signoff == 0) {
7711 ERROR("MISSING_SIGN_OFF",
7712 "Missing Signed-off-by: line(s)\n");
7713 } elsif ($authorsignoff != 1) {
7714 # authorsignoff values:
7715 # 0 -> missing sign off
7716 # 1 -> sign off identical
7717 # 2 -> names and addresses match, comments mismatch
7718 # 3 -> addresses match, names different
7719 # 4 -> names match, addresses different
7720 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7721
7722 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
7723
7724 if ($authorsignoff == 0) {
7725 ERROR("NO_AUTHOR_SIGN_OFF",
7726 "Missing Signed-off-by: line by nominal patch author '$author'\n");
7727 } elsif ($authorsignoff == 2) {
7728 CHK("FROM_SIGN_OFF_MISMATCH",
7729 "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
7730 } elsif ($authorsignoff == 3) {
7731 WARN("FROM_SIGN_OFF_MISMATCH",
7732 "From:/Signed-off-by: email name mismatch: $sob_msg\n");
7733 } elsif ($authorsignoff == 4) {
7734 WARN("FROM_SIGN_OFF_MISMATCH",
7735 "From:/Signed-off-by: email address mismatch: $sob_msg\n");
7736 } elsif ($authorsignoff == 5) {
7737 WARN("FROM_SIGN_OFF_MISMATCH",
7738 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
7739 }
7740 }
7741 }
7742
7743 print report_dump();
7744 if ($summary && !($clean == 1 && $quiet == 1)) {
7745 print "$filename " if ($summary_file);
7746 print "total: $cnt_error errors, $cnt_warn warnings, " .
7747 (($check)? "$cnt_chk checks, " : "") .
7748 "$cnt_lines lines checked\n";
7749 }
7750
7751 if ($quiet == 0) {
7752 # If there were any defects found and not already fixing them
7753 if (!$clean and !$fix) {
7754 print << "EOM"
7755
7756NOTE: For some of the reported defects, checkpatch may be able to
7757 mechanically convert to the typical style using --fix or --fix-inplace.
7758EOM
7759 }
7760 # If there were whitespace errors which cleanpatch can fix
7761 # then suggest that.
7762 if ($rpt_cleaners) {
7763 $rpt_cleaners = 0;
7764 print << "EOM"
7765
7766NOTE: Whitespace errors detected.
7767 You may wish to use scripts/cleanpatch or scripts/cleanfile
7768EOM
7769 }
7770 }
7771
7772 if ($clean == 0 && $fix &&
7773 ("@rawlines" ne "@fixed" ||
7774 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
7775 my $newfile = $filename;
7776 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
7777 my $linecount = 0;
7778 my $f;
7779
7780 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7781
7782 open($f, '>', $newfile)
7783 or die "$P: Can't open $newfile for write\n";
7784 foreach my $fixed_line (@fixed) {
7785 $linecount++;
7786 if ($file) {
7787 if ($linecount > 3) {
7788 $fixed_line =~ s/^\+//;
7789 print $f $fixed_line . "\n";
7790 }
7791 } else {
7792 print $f $fixed_line . "\n";
7793 }
7794 }
7795 close($f);
7796
7797 if (!$quiet) {
7798 print << "EOM";
7799
7800Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
7801
7802Do _NOT_ trust the results written to this file.
7803Do _NOT_ submit these changes without inspecting them for correctness.
7804
7805This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7806No warranties, expressed or implied...
7807EOM
7808 }
7809 }
7810
7811 if ($quiet == 0) {
7812 print "\n";
7813 if ($clean == 1) {
7814 print "$vname has no obvious style problems and is ready for submission.\n";
7815 } else {
7816 print "$vname has style problems, please review.\n";
7817 }
7818 }
7819 return $clean;
7820}