blob: 1629e3513f0d13aec1b510511f1434bb3cfe60d9 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
30my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070031my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080032my $summary = 1;
33my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080034my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070035my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070036my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080037my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070038my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080039my %debug;
Joe Perches34456862013-07-03 15:05:34 -070040my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070041my %use_type = ();
42my @use = ();
43my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070044my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070045my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070046my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080047my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070048my $ignore_perl_version = 0;
49my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070050my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070051my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070052my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070053my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070054my $color = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070055
56sub help {
57 my ($exitcode) = @_;
58
59 print << "EOM";
60Usage: $P [OPTION]... [FILE]...
61Version: $V
62
63Options:
64 -q, --quiet quiet
65 --no-tree run without a kernel tree
66 --no-signoff do not check for 'Signed-off-by' line
67 --patch treat FILE as patchfile (default)
68 --emacs emacs compile window format
69 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070070 --showfile emit diffed file position, not input file position
Hannes Eder77f5b102009-09-21 17:04:37 -070071 -f, --file treat FILE as regular source file
72 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070073 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070074 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080075 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070076 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070077 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070078 --root=PATH PATH to the kernel tree root
79 --no-summary suppress the per-file summary
80 --mailback only produce a report in case of warnings/errors
81 --summary-file include the filename in summary
82 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
83 'values', 'possible', 'type', and 'attr' (default
84 is all off)
85 --test-only=WORD report only warnings/errors containing WORD
86 literally
Joe Perches3705ce52013-07-03 15:05:31 -070087 --fix EXPERIMENTAL - may create horrible results
88 If correctable single-line errors exist, create
89 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
90 with potential errors corrected to the preferred
91 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080092 --fix-inplace EXPERIMENTAL - may create horrible results
93 Is the same as --fix, but overwrites the input
94 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070095 --ignore-perl-version override checking of perl version. expect
96 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -070097 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -070098 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -070099 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700100 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700101 -h, --help, --version display this help and exit
102
103When FILE is - read standard input.
104EOM
105
106 exit($exitcode);
107}
108
Joe Perches000d1cc12011-07-25 17:13:25 -0700109my $conf = which_conf($configuration_file);
110if (-f $conf) {
111 my @conf_args;
112 open(my $conffile, '<', "$conf")
113 or warn "$P: Can't find a readable $configuration_file file $!\n";
114
115 while (<$conffile>) {
116 my $line = $_;
117
118 $line =~ s/\s*\n?$//g;
119 $line =~ s/^\s*//g;
120 $line =~ s/\s+/ /g;
121
122 next if ($line =~ m/^\s*#/);
123 next if ($line =~ m/^\s*$/);
124
125 my @words = split(" ", $line);
126 foreach my $word (@words) {
127 last if ($word =~ m/^#/);
128 push (@conf_args, $word);
129 }
130 }
131 close($conffile);
132 unshift(@ARGV, @conf_args) if @conf_args;
133}
134
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700135GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700136 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700137 'tree!' => \$tree,
138 'signoff!' => \$chk_signoff,
139 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700140 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800141 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700142 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700143 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700144 'subjective!' => \$check,
145 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700146 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700147 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700148 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800149 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700150 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700151 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800152 'summary!' => \$summary,
153 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800154 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700155 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800156 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700157 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800158 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700159 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700160 'codespell!' => \$codespell,
161 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700162 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700163 'h|help' => \$help,
164 'version' => \$help
165) or help(1);
166
167help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700168
Joe Perches9624b8d2014-01-23 15:54:44 -0800169$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700170$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800171
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700172my $exit = 0;
173
Dave Hansend62a2012013-09-11 14:23:56 -0700174if ($^V && $^V lt $minimum_perl_version) {
175 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
176 if (!$ignore_perl_version) {
177 exit(1);
178 }
179}
180
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700181if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700182 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700183 exit(1);
184}
185
Joe Perches91bfe482013-09-11 14:23:59 -0700186sub hash_save_array_words {
187 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700188
Joe Perches91bfe482013-09-11 14:23:59 -0700189 my @array = split(/,/, join(',', @$arrayRef));
190 foreach my $word (@array) {
191 $word =~ s/\s*\n?$//g;
192 $word =~ s/^\s*//g;
193 $word =~ s/\s+/ /g;
194 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700195
Joe Perches91bfe482013-09-11 14:23:59 -0700196 next if ($word =~ m/^\s*#/);
197 next if ($word =~ m/^\s*$/);
198
199 $hashRef->{$word}++;
200 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700201}
202
Joe Perches91bfe482013-09-11 14:23:59 -0700203sub hash_show_words {
204 my ($hashRef, $prefix) = @_;
205
Joe Perches3c816e42015-06-25 15:03:29 -0700206 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700207 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700208 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700209 print " $word";
210 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700211 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700212 }
213}
214
215hash_save_array_words(\%ignore_type, \@ignore);
216hash_save_array_words(\%use_type, \@use);
217
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800218my $dbg_values = 0;
219my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700220my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700221my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800222for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800223 ## no critic
224 eval "\${dbg_$key} = '$debug{$key}';";
225 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800226}
227
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700228my $rpt_cleaners = 0;
229
Andy Whitcroft8905a672007-11-28 16:21:06 -0800230if ($terse) {
231 $emacs = 1;
232 $quiet++;
233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235if ($tree) {
236 if (defined $root) {
237 if (!top_of_kernel_tree($root)) {
238 die "$P: $root: --root does not point at a valid tree\n";
239 }
240 } else {
241 if (top_of_kernel_tree('.')) {
242 $root = '.';
243 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
244 top_of_kernel_tree($1)) {
245 $root = $1;
246 }
247 }
248
249 if (!defined $root) {
250 print "Must be run from the top-level dir. of a kernel tree\n";
251 exit(2);
252 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700253}
254
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700255my $emitted_corrupt = 0;
256
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700257our $Ident = qr{
258 [A-Za-z_][A-Za-z\d_]*
259 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
260 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261our $Storage = qr{extern|static|asmlinkage};
262our $Sparse = qr{
263 __user|
264 __kernel|
265 __force|
266 __iomem|
267 __must_check|
268 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800269 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700270 __ref|
271 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700272 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800273our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
274our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
275our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
276our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
277our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700278
Wolfram Sang52131292010-03-05 13:43:51 -0800279# Notes to $Attribute:
280# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700281our $Attribute = qr{
282 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700283 __percpu|
284 __nocast|
285 __safe|
286 __bitwise__|
287 __packed__|
288 __packed2__|
289 __naked|
290 __maybe_unused|
291 __always_unused|
292 __noreturn|
293 __used|
294 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800295 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700296 __noclone|
297 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700298 __read_mostly|
299 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700300 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700301 ____cacheline_aligned|
302 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800303 ____cacheline_internodealigned_in_smp|
304 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700306our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700307our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700308our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
309our $Lval = qr{$Ident(?:$Member)*};
310
Joe Perches95e2c602013-07-03 15:05:20 -0700311our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
312our $Binary = qr{(?i)0b[01]+$Int_type?};
313our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
314our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700315our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800316our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800317our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
318our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
319our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800320our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700321our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800322our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700323our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700324our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700325our $Operators = qr{
326 <=|>=|==|!=|
327 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700328 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700329 }x;
330
Joe Perches91cb5192014-04-03 14:49:32 -0700331our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
332
Joe Perchesab7e23f2015-04-16 12:44:22 -0700333our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800334our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700335our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700336our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800337our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700338our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800339our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700340our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800341
Joe Perches15662b32011-10-31 17:13:12 -0700342our $NON_ASCII_UTF8 = qr{
343 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700344 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
345 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
346 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
347 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
348 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
349 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
350}x;
351
Joe Perches15662b32011-10-31 17:13:12 -0700352our $UTF8 = qr{
353 [\x09\x0A\x0D\x20-\x7E] # ASCII
354 | $NON_ASCII_UTF8
355}x;
356
Joe Perchese6176fa2015-06-25 15:02:49 -0700357our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800358our $typeOtherOSTypedefs = qr{(?x:
359 u_(?:char|short|int|long) | # bsd
360 u(?:nchar|short|int|long) # sysv
361)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700362our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700363 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700364 atomic_t
365)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700366our $typeTypedefs = qr{(?x:
367 $typeC99Typedefs\b|
368 $typeOtherOSTypedefs\b|
369 $typeKernelTypedefs\b
370)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700371
Joe Perches691e6692010-03-05 13:43:51 -0800372our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700373 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700374 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700375 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700376 panic|
Joe Perches06668722013-11-12 15:10:07 -0800377 MODULE_[A-Z_]+|
378 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800379)};
380
Joe Perches20112472011-07-25 17:13:23 -0700381our $signature_tags = qr{(?xi:
382 Signed-off-by:|
383 Acked-by:|
384 Tested-by:|
385 Reviewed-by:|
386 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700387 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700388 To:|
389 Cc:
390)};
391
Joe Perches18130872014-08-06 16:11:22 -0700392our @typeListMisordered = (
393 qr{char\s+(?:un)?signed},
394 qr{int\s+(?:(?:un)?signed\s+)?short\s},
395 qr{int\s+short(?:\s+(?:un)?signed)},
396 qr{short\s+int(?:\s+(?:un)?signed)},
397 qr{(?:un)?signed\s+int\s+short},
398 qr{short\s+(?:un)?signed},
399 qr{long\s+int\s+(?:un)?signed},
400 qr{int\s+long\s+(?:un)?signed},
401 qr{long\s+(?:un)?signed\s+int},
402 qr{int\s+(?:un)?signed\s+long},
403 qr{int\s+(?:un)?signed},
404 qr{int\s+long\s+long\s+(?:un)?signed},
405 qr{long\s+long\s+int\s+(?:un)?signed},
406 qr{long\s+long\s+(?:un)?signed\s+int},
407 qr{long\s+long\s+(?:un)?signed},
408 qr{long\s+(?:un)?signed},
409);
410
Andy Whitcroft8905a672007-11-28 16:21:06 -0800411our @typeList = (
412 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700413 qr{(?:(?:un)?signed\s+)?char},
414 qr{(?:(?:un)?signed\s+)?short\s+int},
415 qr{(?:(?:un)?signed\s+)?short},
416 qr{(?:(?:un)?signed\s+)?int},
417 qr{(?:(?:un)?signed\s+)?long\s+int},
418 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
419 qr{(?:(?:un)?signed\s+)?long\s+long},
420 qr{(?:(?:un)?signed\s+)?long},
421 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422 qr{float},
423 qr{double},
424 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800425 qr{struct\s+$Ident},
426 qr{union\s+$Ident},
427 qr{enum\s+$Ident},
428 qr{${Ident}_t},
429 qr{${Ident}_handler},
430 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700431 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800432);
Alex Dowad485ff232015-06-25 15:02:52 -0700433our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700434our @typeListWithAttr = (
435 @typeList,
436 qr{struct\s+$InitAttribute\s+$Ident},
437 qr{union\s+$InitAttribute\s+$Ident},
438);
439
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700440our @modifierList = (
441 qr{fastcall},
442);
Alex Dowad485ff232015-06-25 15:02:52 -0700443our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800444
Joe Perches24358802014-04-03 14:49:13 -0700445our @mode_permission_funcs = (
446 ["module_param", 3],
447 ["module_param_(?:array|named|string)", 4],
448 ["module_param_array_named", 5],
449 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
450 ["proc_create(?:_data|)", 2],
451 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
452);
453
Joe Perches515a2352014-04-03 14:49:24 -0700454#Create a search pattern for all these functions to speed up a loop below
455our $mode_perms_search = "";
456foreach my $entry (@mode_permission_funcs) {
457 $mode_perms_search .= '|' if ($mode_perms_search ne "");
458 $mode_perms_search .= $entry->[0];
459}
460
Joe Perchesb392c642015-04-16 12:44:16 -0700461our $mode_perms_world_writable = qr{
462 S_IWUGO |
463 S_IWOTH |
464 S_IRWXUGO |
465 S_IALLUGO |
466 0[0-7][0-7][2367]
467}x;
468
Wolfram Sang7840a942010-08-09 17:20:57 -0700469our $allowed_asm_includes = qr{(?x:
470 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700471 memory|
472 time|
473 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700474)};
475# memory.h: ARM has a custom one
476
Kees Cook66b47b42014-10-13 15:51:57 -0700477# Load common spelling mistakes and build regular expression list.
478my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700479my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700480
Joe Perches36061e32014-12-10 15:51:43 -0800481if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800482 while (<$spelling>) {
483 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700484
Joe Perches36061e32014-12-10 15:51:43 -0800485 $line =~ s/\s*\n?$//g;
486 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700487
Joe Perches36061e32014-12-10 15:51:43 -0800488 next if ($line =~ m/^\s*#/);
489 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700490
Joe Perches36061e32014-12-10 15:51:43 -0800491 my ($suspect, $fix) = split(/\|\|/, $line);
492
Joe Perches36061e32014-12-10 15:51:43 -0800493 $spelling_fix{$suspect} = $fix;
494 }
495 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800496} else {
497 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700498}
Kees Cook66b47b42014-10-13 15:51:57 -0700499
Joe Perchesebfd7d62015-04-16 12:44:14 -0700500if ($codespell) {
501 if (open(my $spelling, '<', $codespellfile)) {
502 while (<$spelling>) {
503 my $line = $_;
504
505 $line =~ s/\s*\n?$//g;
506 $line =~ s/^\s*//g;
507
508 next if ($line =~ m/^\s*#/);
509 next if ($line =~ m/^\s*$/);
510 next if ($line =~ m/, disabled/i);
511
512 $line =~ s/,.*$//;
513
514 my ($suspect, $fix) = split(/->/, $line);
515
516 $spelling_fix{$suspect} = $fix;
517 }
518 close($spelling);
519 } else {
520 warn "No codespell typos will be found - file '$codespellfile': $!\n";
521 }
522}
523
524$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
525
Andy Whitcroft8905a672007-11-28 16:21:06 -0800526sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700527 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
528 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700529 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700530 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700531 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700532 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700533 (?:$typeTypedefs\b)|
534 (?:${all}\b)
535 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800536 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700537 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800538 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800539 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700540 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700541 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800542 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700543 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800544 }x;
Joe Perches18130872014-08-06 16:11:22 -0700545 $NonptrTypeMisordered = qr{
546 (?:$Modifier\s+|const\s+)*
547 (?:
548 (?:${Misordered}\b)
549 )
550 (?:\s+$Modifier|\s+const)*
551 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700552 $NonptrTypeWithAttr = qr{
553 (?:$Modifier\s+|const\s+)*
554 (?:
555 (?:typeof|__typeof__)\s*\([^\)]*\)|
556 (?:$typeTypedefs\b)|
557 (?:${allWithAttr}\b)
558 )
559 (?:\s+$Modifier|\s+const)*
560 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800561 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700562 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700563 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700564 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800565 }x;
Joe Perches18130872014-08-06 16:11:22 -0700566 $TypeMisordered = qr{
567 $NonptrTypeMisordered
568 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
569 (?:\s+$Inline|\s+$Modifier)*
570 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700571 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700572 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800573}
574build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700575
Joe Perches7d2367a2011-07-25 17:13:22 -0700576our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700577
578# Using $balanced_parens, $LvalOrFunc, or $FuncArg
579# requires at least perl version v5.10.0
580# Any use must be runtime checked with $^V
581
582our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700583our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800584our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700585
Joe Perchesf8422302014-08-06 16:11:31 -0700586our $declaration_macros = qr{(?x:
587 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
588 (?:$Storage\s+)?LIST_HEAD\s*\(|
589 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
590)};
591
Joe Perches7d2367a2011-07-25 17:13:22 -0700592sub deparenthesize {
593 my ($string) = @_;
594 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700595
596 while ($string =~ /^\s*\(.*\)\s*$/) {
597 $string =~ s@^\s*\(\s*@@;
598 $string =~ s@\s*\)\s*$@@;
599 }
600
Joe Perches7d2367a2011-07-25 17:13:22 -0700601 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700602
Joe Perches7d2367a2011-07-25 17:13:22 -0700603 return $string;
604}
605
Joe Perches34456862013-07-03 15:05:34 -0700606sub seed_camelcase_file {
607 my ($file) = @_;
608
609 return if (!(-f $file));
610
611 local $/;
612
613 open(my $include_file, '<', "$file")
614 or warn "$P: Can't read '$file' $!\n";
615 my $text = <$include_file>;
616 close($include_file);
617
618 my @lines = split('\n', $text);
619
620 foreach my $line (@lines) {
621 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
622 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
623 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800624 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
625 $camelcase{$1} = 1;
626 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700627 $camelcase{$1} = 1;
628 }
629 }
630}
631
632my $camelcase_seeded = 0;
633sub seed_camelcase_includes {
634 return if ($camelcase_seeded);
635
636 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700637 my $camelcase_cache = "";
638 my @include_files = ();
639
640 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700641
Richard Genoud3645e322014-02-10 14:25:32 -0800642 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700643 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
644 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700645 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700646 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700647 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700648 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700649 @include_files = split('\n', $files);
650 foreach my $file (@include_files) {
651 my $date = POSIX::strftime("%Y%m%d%H%M",
652 localtime((stat $file)[9]));
653 $last_mod_date = $date if ($last_mod_date < $date);
654 }
655 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700656 }
Joe Perchesc707a812013-07-08 16:00:43 -0700657
658 if ($camelcase_cache ne "" && -f $camelcase_cache) {
659 open(my $camelcase_file, '<', "$camelcase_cache")
660 or warn "$P: Can't read '$camelcase_cache' $!\n";
661 while (<$camelcase_file>) {
662 chomp;
663 $camelcase{$_} = 1;
664 }
665 close($camelcase_file);
666
667 return;
668 }
669
Richard Genoud3645e322014-02-10 14:25:32 -0800670 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700671 $files = `git ls-files "include/*.h"`;
672 @include_files = split('\n', $files);
673 }
674
Joe Perches34456862013-07-03 15:05:34 -0700675 foreach my $file (@include_files) {
676 seed_camelcase_file($file);
677 }
Joe Perches351b2a12013-07-03 15:05:36 -0700678
Joe Perchesc707a812013-07-08 16:00:43 -0700679 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700680 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700681 open(my $camelcase_file, '>', "$camelcase_cache")
682 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700683 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
684 print $camelcase_file ("$_\n");
685 }
686 close($camelcase_file);
687 }
Joe Perches34456862013-07-03 15:05:34 -0700688}
689
Joe Perchesd311cd42014-08-06 16:10:57 -0700690sub git_commit_info {
691 my ($commit, $id, $desc) = @_;
692
693 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
694
695 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
696 $output =~ s/^\s*//gm;
697 my @lines = split("\n", $output);
698
Joe Perches0d7835f2015-02-13 14:38:35 -0800699 return ($id, $desc) if ($#lines < 0);
700
Joe Perchesd311cd42014-08-06 16:10:57 -0700701 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
702# Maybe one day convert this block of bash into something that returns
703# all matching commit ids, but it's very slow...
704#
705# echo "checking commits $1..."
706# git rev-list --remotes | grep -i "^$1" |
707# while read line ; do
708# git log --format='%H %s' -1 $line |
709# echo "commit $(cut -c 1-12,41-)"
710# done
711 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
712 } else {
713 $id = substr($lines[0], 0, 12);
714 $desc = substr($lines[0], 41);
715 }
716
717 return ($id, $desc);
718}
719
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700720$chk_signoff = 0 if ($file);
721
Andy Whitcroft00df3442007-06-08 13:47:06 -0700722my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800723my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700724my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700725my @fixed_inserted = ();
726my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700727my $fixlinenr = -1;
728
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800729my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700730for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800731 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700732 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800733 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700734 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800735 } elsif ($filename eq '-') {
736 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700737 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800738 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700739 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700740 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800741 if ($filename eq '-') {
742 $vname = 'Your patch';
743 } else {
744 $vname = $filename;
745 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800746 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700747 chomp;
748 push(@rawlines, $_);
749 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800750 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700751
752 if ($#ARGV > 0 && $quiet == 0) {
753 print '-' x length($vname) . "\n";
754 print "$vname\n";
755 print '-' x length($vname) . "\n";
756 }
757
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800758 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700759 $exit = 1;
760 }
761 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800762 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700763 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700764 @fixed_inserted = ();
765 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700766 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700767 @modifierListFile = ();
768 @typeListFile = ();
769 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700770}
771
Joe Perchesd8469f12015-06-25 15:03:00 -0700772if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700773 hash_show_words(\%use_type, "Used");
774 hash_show_words(\%ignore_type, "Ignored");
775
Joe Perchesd8469f12015-06-25 15:03:00 -0700776 if ($^V lt 5.10.0) {
777 print << "EOM"
778
779NOTE: perl $^V is not modern enough to detect all possible issues.
780 An upgrade to at least perl v5.10.0 is suggested.
781EOM
782 }
783 if ($exit) {
784 print << "EOM"
785
786NOTE: If any of the errors are false positives, please report
787 them to the maintainer, see CHECKPATCH in MAINTAINERS.
788EOM
789 }
790}
791
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700792exit($exit);
793
794sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795 my ($root) = @_;
796
797 my @tree_check = (
798 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
799 "README", "Documentation", "arch", "include", "drivers",
800 "fs", "init", "ipc", "kernel", "lib", "scripts",
801 );
802
803 foreach my $check (@tree_check) {
804 if (! -e $root . '/' . $check) {
805 return 0;
806 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700807 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700808 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700809}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700810
Joe Perches20112472011-07-25 17:13:23 -0700811sub parse_email {
812 my ($formatted_email) = @_;
813
814 my $name = "";
815 my $address = "";
816 my $comment = "";
817
818 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
819 $name = $1;
820 $address = $2;
821 $comment = $3 if defined $3;
822 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
823 $address = $1;
824 $comment = $2 if defined $2;
825 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
826 $address = $1;
827 $comment = $2 if defined $2;
828 $formatted_email =~ s/$address.*$//;
829 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700830 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700831 $name =~ s/^\"|\"$//g;
832 # If there's a name left after stripping spaces and
833 # leading quotes, and the address doesn't have both
834 # leading and trailing angle brackets, the address
835 # is invalid. ie:
836 # "joe smith joe@smith.com" bad
837 # "joe smith <joe@smith.com" bad
838 if ($name ne "" && $address !~ /^<[^>]+>$/) {
839 $name = "";
840 $address = "";
841 $comment = "";
842 }
843 }
844
Joe Perches3705ce52013-07-03 15:05:31 -0700845 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700846 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700847 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700848 $address =~ s/^\<|\>$//g;
849
850 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
851 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
852 $name = "\"$name\"";
853 }
854
855 return ($name, $address, $comment);
856}
857
858sub format_email {
859 my ($name, $address) = @_;
860
861 my $formatted_email;
862
Joe Perches3705ce52013-07-03 15:05:31 -0700863 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700864 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700865 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700866
867 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
868 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
869 $name = "\"$name\"";
870 }
871
872 if ("$name" eq "") {
873 $formatted_email = "$address";
874 } else {
875 $formatted_email = "$name <$address>";
876 }
877
878 return $formatted_email;
879}
880
Joe Perchesd311cd42014-08-06 16:10:57 -0700881sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700882 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700883
Joe Perchesbd474ca2014-08-06 16:11:10 -0700884 foreach my $path (split(/:/, $ENV{PATH})) {
885 if (-e "$path/$bin") {
886 return "$path/$bin";
887 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700888 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700889
Joe Perchesbd474ca2014-08-06 16:11:10 -0700890 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700891}
892
Joe Perches000d1cc12011-07-25 17:13:25 -0700893sub which_conf {
894 my ($conf) = @_;
895
896 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
897 if (-e "$path/$conf") {
898 return "$path/$conf";
899 }
900 }
901
902 return "";
903}
904
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700905sub expand_tabs {
906 my ($str) = @_;
907
908 my $res = '';
909 my $n = 0;
910 for my $c (split(//, $str)) {
911 if ($c eq "\t") {
912 $res .= ' ';
913 $n++;
914 for (; ($n % 8) != 0; $n++) {
915 $res .= ' ';
916 }
917 next;
918 }
919 $res .= $c;
920 $n++;
921 }
922
923 return $res;
924}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700925sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700926 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700927 return $res;
928}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700929
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700930sub line_stats {
931 my ($line) = @_;
932
933 # Drop the diff line leader and expand tabs
934 $line =~ s/^.//;
935 $line = expand_tabs($line);
936
937 # Pick the indent from the front of the line.
938 my ($white) = ($line =~ /^(\s*)/);
939
940 return (length($line), length($white));
941}
942
Andy Whitcroft773647a2008-03-28 14:15:58 -0700943my $sanitise_quote = '';
944
945sub sanitise_line_reset {
946 my ($in_comment) = @_;
947
948 if ($in_comment) {
949 $sanitise_quote = '*/';
950 } else {
951 $sanitise_quote = '';
952 }
953}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700954sub sanitise_line {
955 my ($line) = @_;
956
957 my $res = '';
958 my $l = '';
959
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800960 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700961 my $off = 0;
962 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700963
Andy Whitcroft773647a2008-03-28 14:15:58 -0700964 # Always copy over the diff marker.
965 $res = substr($line, 0, 1);
966
967 for ($off = 1; $off < length($line); $off++) {
968 $c = substr($line, $off, 1);
969
970 # Comments we are wacking completly including the begin
971 # and end, all to $;.
972 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
973 $sanitise_quote = '*/';
974
975 substr($res, $off, 2, "$;$;");
976 $off++;
977 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800978 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700979 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700980 $sanitise_quote = '';
981 substr($res, $off, 2, "$;$;");
982 $off++;
983 next;
984 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700985 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
986 $sanitise_quote = '//';
987
988 substr($res, $off, 2, $sanitise_quote);
989 $off++;
990 next;
991 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700992
993 # A \ in a string means ignore the next character.
994 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
995 $c eq "\\") {
996 substr($res, $off, 2, 'XX');
997 $off++;
998 next;
999 }
1000 # Regular quotes.
1001 if ($c eq "'" || $c eq '"') {
1002 if ($sanitise_quote eq '') {
1003 $sanitise_quote = $c;
1004
1005 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001006 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001007 } elsif ($sanitise_quote eq $c) {
1008 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001009 }
1010 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001011
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001012 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001013 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1014 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001015 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1016 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001017 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1018 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001019 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001020 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001021 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001022 }
1023
Daniel Walker113f04a2009-09-21 17:04:35 -07001024 if ($sanitise_quote eq '//') {
1025 $sanitise_quote = '';
1026 }
1027
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001028 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001029 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001030 my $clean = 'X' x length($1);
1031 $res =~ s@\<.*\>@<$clean>@;
1032
1033 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001034 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001035 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001036 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001037 }
1038
Andy Whitcroft00df3442007-06-08 13:47:06 -07001039 return $res;
1040}
1041
Joe Perchesa6962d72013-04-29 16:18:13 -07001042sub get_quoted_string {
1043 my ($line, $rawline) = @_;
1044
Joe Perches33acb542015-06-25 15:02:54 -07001045 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001046 return substr($rawline, $-[0], $+[0] - $-[0]);
1047}
1048
Andy Whitcroft8905a672007-11-28 16:21:06 -08001049sub ctx_statement_block {
1050 my ($linenr, $remain, $off) = @_;
1051 my $line = $linenr - 1;
1052 my $blk = '';
1053 my $soff = $off;
1054 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001055 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001056
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001057 my $loff = 0;
1058
Andy Whitcroft8905a672007-11-28 16:21:06 -08001059 my $type = '';
1060 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001061 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001062 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001063 my $c;
1064 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001065
1066 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001067 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001068 @stack = (['', 0]) if ($#stack == -1);
1069
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001071 # If we are about to drop off the end, pull in more
1072 # context.
1073 if ($off >= $len) {
1074 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001075 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001076 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001077 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001078 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001079 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001080 $len = length($blk);
1081 $line++;
1082 last;
1083 }
1084 # Bail if there is no further context.
1085 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001086 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001087 last;
1088 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001089 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1090 $level++;
1091 $type = '#';
1092 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001093 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001094 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001095 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001096 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001097
Andy Whitcroft773647a2008-03-28 14:15:58 -07001098 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001099
1100 # Handle nested #if/#else.
1101 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1102 push(@stack, [ $type, $level ]);
1103 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1104 ($type, $level) = @{$stack[$#stack - 1]};
1105 } elsif ($remainder =~ /^#\s*endif\b/) {
1106 ($type, $level) = @{pop(@stack)};
1107 }
1108
Andy Whitcroft8905a672007-11-28 16:21:06 -08001109 # Statement ends at the ';' or a close '}' at the
1110 # outermost level.
1111 if ($level == 0 && $c eq ';') {
1112 last;
1113 }
1114
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001115 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116 if ($level == 0 && $coff_set == 0 &&
1117 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1118 $remainder =~ /^(else)(?:\s|{)/ &&
1119 $remainder !~ /^else\s+if\b/) {
1120 $coff = $off + length($1) - 1;
1121 $coff_set = 1;
1122 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1123 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001124 }
1125
Andy Whitcroft8905a672007-11-28 16:21:06 -08001126 if (($type eq '' || $type eq '(') && $c eq '(') {
1127 $level++;
1128 $type = '(';
1129 }
1130 if ($type eq '(' && $c eq ')') {
1131 $level--;
1132 $type = ($level != 0)? '(' : '';
1133
1134 if ($level == 0 && $coff < $soff) {
1135 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001136 $coff_set = 1;
1137 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001138 }
1139 }
1140 if (($type eq '' || $type eq '{') && $c eq '{') {
1141 $level++;
1142 $type = '{';
1143 }
1144 if ($type eq '{' && $c eq '}') {
1145 $level--;
1146 $type = ($level != 0)? '{' : '';
1147
1148 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001149 if (substr($blk, $off + 1, 1) eq ';') {
1150 $off++;
1151 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001152 last;
1153 }
1154 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001155 # Preprocessor commands end at the newline unless escaped.
1156 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1157 $level--;
1158 $type = '';
1159 $off++;
1160 last;
1161 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001162 $off++;
1163 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001164 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001165 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001166 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001167 $line++;
1168 $remain--;
1169 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001170
1171 my $statement = substr($blk, $soff, $off - $soff + 1);
1172 my $condition = substr($blk, $soff, $coff - $soff + 1);
1173
1174 #warn "STATEMENT<$statement>\n";
1175 #warn "CONDITION<$condition>\n";
1176
Andy Whitcroft773647a2008-03-28 14:15:58 -07001177 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001178
1179 return ($statement, $condition,
1180 $line, $remain + 1, $off - $loff + 1, $level);
1181}
1182
Andy Whitcroftcf655042008-03-04 14:28:20 -08001183sub statement_lines {
1184 my ($stmt) = @_;
1185
1186 # Strip the diff line prefixes and rip blank lines at start and end.
1187 $stmt =~ s/(^|\n)./$1/g;
1188 $stmt =~ s/^\s*//;
1189 $stmt =~ s/\s*$//;
1190
1191 my @stmt_lines = ($stmt =~ /\n/g);
1192
1193 return $#stmt_lines + 2;
1194}
1195
1196sub statement_rawlines {
1197 my ($stmt) = @_;
1198
1199 my @stmt_lines = ($stmt =~ /\n/g);
1200
1201 return $#stmt_lines + 2;
1202}
1203
1204sub statement_block_size {
1205 my ($stmt) = @_;
1206
1207 $stmt =~ s/(^|\n)./$1/g;
1208 $stmt =~ s/^\s*{//;
1209 $stmt =~ s/}\s*$//;
1210 $stmt =~ s/^\s*//;
1211 $stmt =~ s/\s*$//;
1212
1213 my @stmt_lines = ($stmt =~ /\n/g);
1214 my @stmt_statements = ($stmt =~ /;/g);
1215
1216 my $stmt_lines = $#stmt_lines + 2;
1217 my $stmt_statements = $#stmt_statements + 1;
1218
1219 if ($stmt_lines > $stmt_statements) {
1220 return $stmt_lines;
1221 } else {
1222 return $stmt_statements;
1223 }
1224}
1225
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001226sub ctx_statement_full {
1227 my ($linenr, $remain, $off) = @_;
1228 my ($statement, $condition, $level);
1229
1230 my (@chunks);
1231
Andy Whitcroftcf655042008-03-04 14:28:20 -08001232 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001233 ($statement, $condition, $linenr, $remain, $off, $level) =
1234 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001235 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001236 push(@chunks, [ $condition, $statement ]);
1237 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1238 return ($level, $linenr, @chunks);
1239 }
1240
1241 # Pull in the following conditional/block pairs and see if they
1242 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001243 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001244 ($statement, $condition, $linenr, $remain, $off, $level) =
1245 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001246 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001247 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001248 #print "C: push\n";
1249 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001250 }
1251
1252 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001253}
1254
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001255sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001256 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001257 my $line;
1258 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001259 my $blk = '';
1260 my @o;
1261 my @c;
1262 my @res = ();
1263
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001264 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001265 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001266 for ($line = $start; $remain > 0; $line++) {
1267 next if ($rawlines[$line] =~ /^-/);
1268 $remain--;
1269
1270 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001271
1272 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001273 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001274 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001275 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001276 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001277 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001278 $level = pop(@stack);
1279 }
1280
Andy Whitcroft01464f32010-10-26 14:23:19 -07001281 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001282 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1283 if ($off > 0) {
1284 $off--;
1285 next;
1286 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001287
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001288 if ($c eq $close && $level > 0) {
1289 $level--;
1290 last if ($level == 0);
1291 } elsif ($c eq $open) {
1292 $level++;
1293 }
1294 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001295
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001296 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001297 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001298 }
1299
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001300 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001301 }
1302
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001303 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001304}
1305sub ctx_block_outer {
1306 my ($linenr, $remain) = @_;
1307
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001308 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1309 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001310}
1311sub ctx_block {
1312 my ($linenr, $remain) = @_;
1313
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001314 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1315 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001316}
1317sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001318 my ($linenr, $remain, $off) = @_;
1319
1320 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1321 return @r;
1322}
1323sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001324 my ($linenr, $remain) = @_;
1325
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001326 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001327}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001328sub ctx_statement_level {
1329 my ($linenr, $remain, $off) = @_;
1330
1331 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1332}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001333
1334sub ctx_locate_comment {
1335 my ($first_line, $end_line) = @_;
1336
1337 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001338 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001339 return $current_comment if (defined $current_comment);
1340
1341 # Look through the context and try and figure out if there is a
1342 # comment.
1343 my $in_comment = 0;
1344 $current_comment = '';
1345 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001346 my $line = $rawlines[$linenr - 1];
1347 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001348 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1349 $in_comment = 1;
1350 }
1351 if ($line =~ m@/\*@) {
1352 $in_comment = 1;
1353 }
1354 if (!$in_comment && $current_comment ne '') {
1355 $current_comment = '';
1356 }
1357 $current_comment .= $line . "\n" if ($in_comment);
1358 if ($line =~ m@\*/@) {
1359 $in_comment = 0;
1360 }
1361 }
1362
1363 chomp($current_comment);
1364 return($current_comment);
1365}
1366sub ctx_has_comment {
1367 my ($first_line, $end_line) = @_;
1368 my $cmt = ctx_locate_comment($first_line, $end_line);
1369
Andy Whitcroft00df3442007-06-08 13:47:06 -07001370 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001371 ##print "CMMT: $cmt\n";
1372
1373 return ($cmt ne '');
1374}
1375
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001376sub raw_line {
1377 my ($linenr, $cnt) = @_;
1378
1379 my $offset = $linenr - 1;
1380 $cnt++;
1381
1382 my $line;
1383 while ($cnt) {
1384 $line = $rawlines[$offset++];
1385 next if (defined($line) && $line =~ /^-/);
1386 $cnt--;
1387 }
1388
1389 return $line;
1390}
1391
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001392sub cat_vet {
1393 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001394 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001395
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001396 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001397 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1398 $res .= $1;
1399 if ($2 ne '') {
1400 $coded = sprintf("^%c", unpack('C', $2) + 64);
1401 $res .= $coded;
1402 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001403 }
1404 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001405
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001406 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001407}
1408
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001409my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001410my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001411my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001412my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001413
1414sub annotate_reset {
1415 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001416 $av_pending = '_';
1417 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001418 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001419}
1420
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001421sub annotate_values {
1422 my ($stream, $type) = @_;
1423
1424 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001425 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001426 my $cur = $stream;
1427
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001428 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001429
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001430 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001431 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001432 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001433 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001434 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001435 print "WS($1)\n" if ($dbg_values > 1);
1436 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001437 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001438 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001439 }
1440
Florian Micklerc023e4732011-01-12 16:59:58 -08001441 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001442 print "CAST($1)\n" if ($dbg_values > 1);
1443 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001444 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001445
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001446 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001447 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001448 $type = 'T';
1449
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001450 } elsif ($cur =~ /^($Modifier)\s*/) {
1451 print "MODIFIER($1)\n" if ($dbg_values > 1);
1452 $type = 'T';
1453
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001454 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001455 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001456 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001457 push(@av_paren_type, $type);
1458 if ($2 ne '') {
1459 $av_pending = 'N';
1460 }
1461 $type = 'E';
1462
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001463 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001464 print "UNDEF($1)\n" if ($dbg_values > 1);
1465 $av_preprocessor = 1;
1466 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001467
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001468 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001469 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001470 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001471
1472 push(@av_paren_type, $type);
1473 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001474 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001475
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001476 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001477 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1478 $av_preprocessor = 1;
1479
1480 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1481
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001482 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001483
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001484 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001485 print "PRE_END($1)\n" if ($dbg_values > 1);
1486
1487 $av_preprocessor = 1;
1488
1489 # Assume all arms of the conditional end as this
1490 # one does, and continue as if the #endif was not here.
1491 pop(@av_paren_type);
1492 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001493 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001494
1495 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001496 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001497
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001498 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1499 print "ATTR($1)\n" if ($dbg_values > 1);
1500 $av_pending = $type;
1501 $type = 'N';
1502
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001503 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001504 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001505 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001506 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001507 }
1508 $type = 'N';
1509
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001510 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001511 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001512 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001513 $type = 'N';
1514
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001515 } elsif ($cur =~/^(case)/o) {
1516 print "CASE($1)\n" if ($dbg_values > 1);
1517 $av_pend_colon = 'C';
1518 $type = 'N';
1519
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001520 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001521 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001522 $type = 'N';
1523
1524 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001525 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001526 push(@av_paren_type, $av_pending);
1527 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001528 $type = 'N';
1529
1530 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001531 my $new_type = pop(@av_paren_type);
1532 if ($new_type ne '_') {
1533 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001534 print "PAREN('$1') -> $type\n"
1535 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001536 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001537 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001538 }
1539
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001540 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001541 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001542 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001543 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001544
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001545 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1546 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001547 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001548 } elsif ($type eq 'E') {
1549 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001550 }
1551 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1552 $type = 'V';
1553
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001554 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001555 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001556 $type = 'V';
1557
1558 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001559 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001560 $type = 'N';
1561
Andy Whitcroftcf655042008-03-04 14:28:20 -08001562 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001563 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001564 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001565 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001566
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001567 } elsif ($cur =~/^(,)/) {
1568 print "COMMA($1)\n" if ($dbg_values > 1);
1569 $type = 'C';
1570
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001571 } elsif ($cur =~ /^(\?)/o) {
1572 print "QUESTION($1)\n" if ($dbg_values > 1);
1573 $type = 'N';
1574
1575 } elsif ($cur =~ /^(:)/o) {
1576 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1577
1578 substr($var, length($res), 1, $av_pend_colon);
1579 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1580 $type = 'E';
1581 } else {
1582 $type = 'N';
1583 }
1584 $av_pend_colon = 'O';
1585
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001586 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001587 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001588 $type = 'N';
1589
Andy Whitcroft0d413862008-10-15 22:02:16 -07001590 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001591 my $variant;
1592
1593 print "OPV($1)\n" if ($dbg_values > 1);
1594 if ($type eq 'V') {
1595 $variant = 'B';
1596 } else {
1597 $variant = 'U';
1598 }
1599
1600 substr($var, length($res), 1, $variant);
1601 $type = 'N';
1602
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001603 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001604 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001605 if ($1 ne '++' && $1 ne '--') {
1606 $type = 'N';
1607 }
1608
1609 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001610 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001611 }
1612 if (defined $1) {
1613 $cur = substr($cur, length($1));
1614 $res .= $type x length($1);
1615 }
1616 }
1617
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001618 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001619}
1620
Andy Whitcroft8905a672007-11-28 16:21:06 -08001621sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001622 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001623 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001624 ^(?:
1625 $Modifier|
1626 $Storage|
1627 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001628 DEFINE_\S+
1629 )$|
1630 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001631 goto|
1632 return|
1633 case|
1634 else|
1635 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001636 do|
1637 \#|
1638 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001639 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001640 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001641 )}x;
1642 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1643 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001644 # Check for modifiers.
1645 $possible =~ s/\s*$Storage\s*//g;
1646 $possible =~ s/\s*$Sparse\s*//g;
1647 if ($possible =~ /^\s*$/) {
1648
1649 } elsif ($possible =~ /\s/) {
1650 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001651 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001652 if ($modifier !~ $notPermitted) {
1653 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001654 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001655 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001656 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001657
1658 } else {
1659 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001660 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001661 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001662 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001663 } else {
1664 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001665 }
1666}
1667
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668my $prefix = '';
1669
Joe Perches000d1cc12011-07-25 17:13:25 -07001670sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001671 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001672
Joe Perchescbec18a2014-04-03 14:49:19 -07001673 return defined $use_type{$type} if (scalar keys %use_type > 0);
1674
1675 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001676}
1677
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001678sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001679 my ($level, $type, $msg) = @_;
1680
1681 if (!show_type($type) ||
1682 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001683 return 0;
1684 }
Joe Perches57230292015-06-25 15:03:03 -07001685 my $output = '';
1686 if (-t STDOUT && $color) {
1687 if ($level eq 'ERROR') {
1688 $output .= RED;
1689 } elsif ($level eq 'WARNING') {
1690 $output .= YELLOW;
1691 } else {
1692 $output .= GREEN;
1693 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001694 }
Joe Perches57230292015-06-25 15:03:03 -07001695 $output .= $prefix . $level . ':';
1696 if ($show_types) {
1697 $output .= BLUE if (-t STDOUT && $color);
1698 $output .= "$type:";
1699 }
1700 $output .= RESET if (-t STDOUT && $color);
1701 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001702
1703 if ($showfile) {
1704 my @lines = split("\n", $output, -1);
1705 splice(@lines, 1, 1);
1706 $output = join("\n", @lines);
1707 }
Joe Perches57230292015-06-25 15:03:03 -07001708 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001709
Joe Perches57230292015-06-25 15:03:03 -07001710 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001711
1712 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001713}
Joe Perchescbec18a2014-04-03 14:49:19 -07001714
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001715sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001716 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001717}
Joe Perches000d1cc12011-07-25 17:13:25 -07001718
Joe Perchesd752fcc2014-08-06 16:11:05 -07001719sub fixup_current_range {
1720 my ($lineRef, $offset, $length) = @_;
1721
1722 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1723 my $o = $1;
1724 my $l = $2;
1725 my $no = $o + $offset;
1726 my $nl = $l + $length;
1727 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1728 }
1729}
1730
1731sub fix_inserted_deleted_lines {
1732 my ($linesRef, $insertedRef, $deletedRef) = @_;
1733
1734 my $range_last_linenr = 0;
1735 my $delta_offset = 0;
1736
1737 my $old_linenr = 0;
1738 my $new_linenr = 0;
1739
1740 my $next_insert = 0;
1741 my $next_delete = 0;
1742
1743 my @lines = ();
1744
1745 my $inserted = @{$insertedRef}[$next_insert++];
1746 my $deleted = @{$deletedRef}[$next_delete++];
1747
1748 foreach my $old_line (@{$linesRef}) {
1749 my $save_line = 1;
1750 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001751 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001752 $delta_offset = 0;
1753 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1754 $range_last_linenr = $new_linenr;
1755 fixup_current_range(\$line, $delta_offset, 0);
1756 }
1757
1758 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1759 $deleted = @{$deletedRef}[$next_delete++];
1760 $save_line = 0;
1761 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1762 }
1763
1764 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1765 push(@lines, ${$inserted}{'LINE'});
1766 $inserted = @{$insertedRef}[$next_insert++];
1767 $new_linenr++;
1768 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1769 }
1770
1771 if ($save_line) {
1772 push(@lines, $line);
1773 $new_linenr++;
1774 }
1775
1776 $old_linenr++;
1777 }
1778
1779 return @lines;
1780}
1781
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001782sub fix_insert_line {
1783 my ($linenr, $line) = @_;
1784
1785 my $inserted = {
1786 LINENR => $linenr,
1787 LINE => $line,
1788 };
1789 push(@fixed_inserted, $inserted);
1790}
1791
1792sub fix_delete_line {
1793 my ($linenr, $line) = @_;
1794
1795 my $deleted = {
1796 LINENR => $linenr,
1797 LINE => $line,
1798 };
1799
1800 push(@fixed_deleted, $deleted);
1801}
1802
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001803sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001804 my ($type, $msg) = @_;
1805
1806 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 our $clean = 0;
1808 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001809 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001810 }
Joe Perches3705ce52013-07-03 15:05:31 -07001811 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001812}
1813sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001814 my ($type, $msg) = @_;
1815
1816 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 our $clean = 0;
1818 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001819 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001820 }
Joe Perches3705ce52013-07-03 15:05:31 -07001821 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001822}
1823sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001824 my ($type, $msg) = @_;
1825
1826 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001827 our $clean = 0;
1828 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001829 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001830 }
Joe Perches3705ce52013-07-03 15:05:31 -07001831 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001832}
1833
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001834sub check_absolute_file {
1835 my ($absolute, $herecurr) = @_;
1836 my $file = $absolute;
1837
1838 ##print "absolute<$absolute>\n";
1839
1840 # See if any suffix of this path is a path within the tree.
1841 while ($file =~ s@^[^/]*/@@) {
1842 if (-f "$root/$file") {
1843 ##print "file<$file>\n";
1844 last;
1845 }
1846 }
1847 if (! -f _) {
1848 return 0;
1849 }
1850
1851 # It is, so see if the prefix is acceptable.
1852 my $prefix = $absolute;
1853 substr($prefix, -length($file)) = '';
1854
1855 ##print "prefix<$prefix>\n";
1856 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001857 WARN("USE_RELATIVE_PATH",
1858 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001859 }
1860}
1861
Joe Perches3705ce52013-07-03 15:05:31 -07001862sub trim {
1863 my ($string) = @_;
1864
Joe Perchesb34c6482013-09-11 14:24:01 -07001865 $string =~ s/^\s+|\s+$//g;
1866
1867 return $string;
1868}
1869
1870sub ltrim {
1871 my ($string) = @_;
1872
1873 $string =~ s/^\s+//;
1874
1875 return $string;
1876}
1877
1878sub rtrim {
1879 my ($string) = @_;
1880
1881 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001882
1883 return $string;
1884}
1885
Joe Perches52ea8502013-11-12 15:10:09 -08001886sub string_find_replace {
1887 my ($string, $find, $replace) = @_;
1888
1889 $string =~ s/$find/$replace/g;
1890
1891 return $string;
1892}
1893
Joe Perches3705ce52013-07-03 15:05:31 -07001894sub tabify {
1895 my ($leading) = @_;
1896
1897 my $source_indent = 8;
1898 my $max_spaces_before_tab = $source_indent - 1;
1899 my $spaces_to_tab = " " x $source_indent;
1900
1901 #convert leading spaces to tabs
1902 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1903 #Remove spaces before a tab
1904 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1905
1906 return "$leading";
1907}
1908
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001909sub pos_last_openparen {
1910 my ($line) = @_;
1911
1912 my $pos = 0;
1913
1914 my $opens = $line =~ tr/\(/\(/;
1915 my $closes = $line =~ tr/\)/\)/;
1916
1917 my $last_openparen = 0;
1918
1919 if (($opens == 0) || ($closes >= $opens)) {
1920 return -1;
1921 }
1922
1923 my $len = length($line);
1924
1925 for ($pos = 0; $pos < $len; $pos++) {
1926 my $string = substr($line, $pos);
1927 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1928 $pos += length($1) - 1;
1929 } elsif (substr($line, $pos, 1) eq '(') {
1930 $last_openparen = $pos;
1931 } elsif (index($string, '(') == -1) {
1932 last;
1933 }
1934 }
1935
Joe Perches91cb5192014-04-03 14:49:32 -07001936 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001937}
1938
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001939sub process {
1940 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001941
1942 my $linenr=0;
1943 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001944 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001945 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001946 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001947
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001948 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001949 my $indent;
1950 my $previndent=0;
1951 my $stashindent=0;
1952
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001953 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001954 my $signoff = 0;
1955 my $is_patch = 0;
1956
Joe Perches29ee1b02014-08-06 16:10:35 -07001957 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001958 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches2a076f42015-04-16 12:44:28 -07001959 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07001960 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07001961 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001962 my $non_utf8_charset = 0;
1963
Joe Perches365dd4e2014-08-06 16:10:42 -07001964 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08001965 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07001966
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001967 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001968 our $cnt_lines = 0;
1969 our $cnt_error = 0;
1970 our $cnt_warn = 0;
1971 our $cnt_chk = 0;
1972
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001973 # Trace the real file/line as we go.
1974 my $realfile = '';
1975 my $realline = 0;
1976 my $realcnt = 0;
1977 my $here = '';
1978 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001979 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001980 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001981 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001982
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001983 my $prev_values = 'E';
1984
1985 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001986 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001987 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001988 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001989 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001990
Joe Perches7e51f192013-09-11 14:23:57 -07001991 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001992
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001993 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001994 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001995 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001996 my @setup_docs = ();
1997 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001998
Joe Perchesd8b07712013-11-12 15:10:06 -08001999 my $camelcase_file_seeded = 0;
2000
Andy Whitcroft773647a2008-03-28 14:15:58 -07002001 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002002 my $line;
2003 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002004 $linenr++;
2005 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002006
Joe Perches3705ce52013-07-03 15:05:31 -07002007 push(@fixed, $rawline) if ($fix);
2008
Andy Whitcroft773647a2008-03-28 14:15:58 -07002009 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002010 $setup_docs = 0;
2011 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2012 $setup_docs = 1;
2013 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002014 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002015 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002016 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2017 $realline=$1-1;
2018 if (defined $2) {
2019 $realcnt=$3+1;
2020 } else {
2021 $realcnt=1+1;
2022 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002023 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002024
2025 # Guestimate if this is a continuing comment. Run
2026 # the context looking for a comment "edge". If this
2027 # edge is a close comment then we must be in a comment
2028 # at context start.
2029 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002030 my $cnt = $realcnt;
2031 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2032 next if (defined $rawlines[$ln - 1] &&
2033 $rawlines[$ln - 1] =~ /^-/);
2034 $cnt--;
2035 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002036 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002037 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2038 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2039 ($edge) = $1;
2040 last;
2041 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002042 }
2043 if (defined $edge && $edge eq '*/') {
2044 $in_comment = 1;
2045 }
2046
2047 # Guestimate if this is a continuing comment. If this
2048 # is the start of a diff block and this line starts
2049 # ' *' then it is very likely a comment.
2050 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002051 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002052 {
2053 $in_comment = 1;
2054 }
2055
2056 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2057 sanitise_line_reset($in_comment);
2058
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002059 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002060 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002061 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002062 $line = sanitise_line($rawline);
2063 }
2064 push(@lines, $line);
2065
2066 if ($realcnt > 1) {
2067 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2068 } else {
2069 $realcnt = 0;
2070 }
2071
2072 #print "==>$rawline\n";
2073 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002074
2075 if ($setup_docs && $line =~ /^\+/) {
2076 push(@setup_docs, $line);
2077 }
2078 }
2079
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002080 $prefix = '';
2081
Andy Whitcroft773647a2008-03-28 14:15:58 -07002082 $realcnt = 0;
2083 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002084 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002085 foreach my $line (@lines) {
2086 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002087 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002088 my $sline = $line; #copy of $line
2089 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002090
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002091 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002092
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002093#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002094 if (!$in_commit_log &&
2095 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002096 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002097 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002098 $realline=$1-1;
2099 if (defined $2) {
2100 $realcnt=$3+1;
2101 } else {
2102 $realcnt=1+1;
2103 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002104 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002105 $prev_values = 'E';
2106
Andy Whitcroft773647a2008-03-28 14:15:58 -07002107 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002108 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002109 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002110 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002111 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002112
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002113# track the line number as we move through the hunk, note that
2114# new versions of GNU diff omit the leading space on completely
2115# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002116 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002117 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002118 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002119
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002120 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002121 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002122
2123 # Track the previous line.
2124 ($prevline, $stashline) = ($stashline, $line);
2125 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002126 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2127
Andy Whitcroft773647a2008-03-28 14:15:58 -07002128 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002129
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002130 } elsif ($realcnt == 1) {
2131 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002132 }
2133
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002134 my $hunk_line = ($realcnt != 0);
2135
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002136 $here = "#$linenr: " if (!$file);
2137 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002138
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002139 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002140 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002141 if ($line =~ /^diff --git.*?(\S+)$/) {
2142 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002143 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002144 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002145 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002146 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002147 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002148 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002149 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002150
2151 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002152 if (!$file && $tree && $p1_prefix ne '' &&
2153 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002154 WARN("PATCH_PREFIX",
2155 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002156 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002157
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002158 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002159 ERROR("MODIFIED_INCLUDE_ASM",
2160 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
Andy Whitcroft773647a2008-03-28 14:15:58 -07002161 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002162 $found_file = 1;
2163 }
2164
Joe Perches34d88152015-06-25 15:03:05 -07002165#make up the handle for any error we report on this line
2166 if ($showfile) {
2167 $prefix = "$realfile:$realline: "
2168 } elsif ($emacs) {
2169 $prefix = "$filename:$linenr: ";
2170 }
2171
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002172 if ($found_file) {
2173 if ($realfile =~ m@^(drivers/net/|net/)@) {
2174 $check = 1;
2175 } else {
2176 $check = $check_orig;
2177 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002178 next;
2179 }
2180
Randy Dunlap389834b2007-06-08 13:47:03 -07002181 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002182
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002183 my $hereline = "$here\n$rawline\n";
2184 my $herecurr = "$here\n$rawline\n";
2185 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002186
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002187 $cnt_lines++ if ($realcnt != 0);
2188
Joe Perchese518e9a2015-06-25 15:03:27 -07002189# Check if the commit log has what seems like a diff which can confuse patch
2190 if ($in_commit_log && !$commit_log_has_diff &&
2191 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2192 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2193 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2194 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2195 ERROR("DIFF_IN_COMMIT_MSG",
2196 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2197 $commit_log_has_diff = 1;
2198 }
2199
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002200# Check for incorrect file permissions
2201 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2202 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002203 if ($realfile !~ m@scripts/@ &&
2204 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002205 ERROR("EXECUTE_PERMISSIONS",
2206 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002207 }
2208 }
2209
Joe Perches20112472011-07-25 17:13:23 -07002210# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002211 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002212 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002213 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002214 }
2215
Joe Perchese0d975b2014-12-10 15:51:49 -08002216# Check if MAINTAINERS is being updated. If so, there's probably no need to
2217# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2218 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2219 $reported_maintainer_file = 1;
2220 }
2221
Joe Perches20112472011-07-25 17:13:23 -07002222# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002223 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002224 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002225 my $space_before = $1;
2226 my $sign_off = $2;
2227 my $space_after = $3;
2228 my $email = $4;
2229 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2230
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002231 if ($sign_off !~ /$signature_tags/) {
2232 WARN("BAD_SIGN_OFF",
2233 "Non-standard signature: $sign_off\n" . $herecurr);
2234 }
Joe Perches20112472011-07-25 17:13:23 -07002235 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002236 if (WARN("BAD_SIGN_OFF",
2237 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2238 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002239 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002240 "$ucfirst_sign_off $email";
2241 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002242 }
Joe Perches20112472011-07-25 17:13:23 -07002243 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002244 if (WARN("BAD_SIGN_OFF",
2245 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2246 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002247 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002248 "$ucfirst_sign_off $email";
2249 }
2250
Joe Perches20112472011-07-25 17:13:23 -07002251 }
2252 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002253 if (WARN("BAD_SIGN_OFF",
2254 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2255 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002256 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002257 "$ucfirst_sign_off $email";
2258 }
Joe Perches20112472011-07-25 17:13:23 -07002259 }
2260
2261 my ($email_name, $email_address, $comment) = parse_email($email);
2262 my $suggested_email = format_email(($email_name, $email_address));
2263 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002264 ERROR("BAD_SIGN_OFF",
2265 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002266 } else {
2267 my $dequoted = $suggested_email;
2268 $dequoted =~ s/^"//;
2269 $dequoted =~ s/" </ </;
2270 # Don't force email to have quotes
2271 # Allow just an angle bracketed address
2272 if ("$dequoted$comment" ne $email &&
2273 "<$email_address>$comment" ne $email &&
2274 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002275 WARN("BAD_SIGN_OFF",
2276 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002277 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002278 }
Joe Perches7e51f192013-09-11 14:23:57 -07002279
2280# Check for duplicate signatures
2281 my $sig_nospace = $line;
2282 $sig_nospace =~ s/\s//g;
2283 $sig_nospace = lc($sig_nospace);
2284 if (defined $signatures{$sig_nospace}) {
2285 WARN("BAD_SIGN_OFF",
2286 "Duplicate signature\n" . $herecurr);
2287 } else {
2288 $signatures{$sig_nospace} = 1;
2289 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002290 }
2291
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002292# Check email subject for common tools that don't need to be mentioned
2293 if ($in_header_lines &&
2294 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2295 WARN("EMAIL_SUBJECT",
2296 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2297 }
2298
Joe Perches9b3189e2014-06-04 16:12:10 -07002299# Check for old stable address
2300 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2301 ERROR("STABLE_ADDRESS",
2302 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2303 }
2304
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002305# Check for unwanted Gerrit info
2306 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2307 ERROR("GERRIT_CHANGE_ID",
2308 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2309 }
2310
Joe Perches2a076f42015-04-16 12:44:28 -07002311# Check for line lengths > 75 in commit log, warn once
2312 if ($in_commit_log && !$commit_log_long_line &&
2313 length($line) > 75) {
2314 WARN("COMMIT_LOG_LONG_LINE",
2315 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2316 $commit_log_long_line = 1;
2317 }
2318
Joe Perches0d7835f2015-02-13 14:38:35 -08002319# Check for git id commit length and improperly formed commit descriptions
Joe Perchesfe043ea2015-09-09 15:37:25 -07002320 if ($in_commit_log &&
2321 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
2322 $line =~ /\b[0-9a-f]{12,40}\b/i)) {
2323 my $init_char = "c";
2324 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002325 my $short = 1;
2326 my $long = 0;
2327 my $case = 1;
2328 my $space = 1;
2329 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002330 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002331 my $id = '0123456789ab';
2332 my $orig_desc = "commit description";
2333 my $description = "";
2334
Joe Perchesfe043ea2015-09-09 15:37:25 -07002335 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2336 $init_char = $1;
2337 $orig_commit = lc($2);
2338 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2339 $orig_commit = lc($1);
2340 }
2341
Joe Perches0d7835f2015-02-13 14:38:35 -08002342 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2343 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2344 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2345 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2346 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2347 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002348 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002349 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2350 defined $rawlines[$linenr] &&
2351 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2352 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002353 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002354 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2355 defined $rawlines[$linenr] &&
2356 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2357 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2358 $orig_desc = $1;
2359 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2360 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002361 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002362 }
2363
2364 ($id, $description) = git_commit_info($orig_commit,
2365 $id, $orig_desc);
2366
Joe Perches19c146a2015-02-13 14:39:00 -08002367 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002368 ERROR("GIT_COMMIT_ID",
2369 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2370 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002371 }
2372
Joe Perches13f19372014-08-06 16:10:59 -07002373# Check for added, moved or deleted files
2374 if (!$reported_maintainer_file && !$in_commit_log &&
2375 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2376 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2377 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2378 (defined($1) || defined($2))))) {
2379 $reported_maintainer_file = 1;
2380 WARN("FILE_PATH_CHANGES",
2381 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2382 }
2383
Andy Whitcroft00df3442007-06-08 13:47:06 -07002384# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002385 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002386 ERROR("CORRUPTED_PATCH",
2387 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002388 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002389 }
2390
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002391# Check for absolute kernel paths.
2392 if ($tree) {
2393 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2394 my $file = $1;
2395
2396 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2397 check_absolute_file($1, $herecurr)) {
2398 #
2399 } else {
2400 check_absolute_file($file, $herecurr);
2401 }
2402 }
2403 }
2404
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002405# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2406 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002407 $rawline !~ m/^$UTF8*$/) {
2408 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2409
2410 my $blank = copy_spacing($rawline);
2411 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2412 my $hereptr = "$hereline$ptr\n";
2413
Joe Perches34d99212011-07-25 17:13:26 -07002414 CHK("INVALID_UTF8",
2415 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002416 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002417
Joe Perches15662b32011-10-31 17:13:12 -07002418# Check if it's the start of a commit log
2419# (not a header line and we haven't seen the patch filename)
2420 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002421 !($rawline =~ /^\s+\S/ ||
2422 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002423 $in_header_lines = 0;
2424 $in_commit_log = 1;
2425 }
2426
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002427# Check if there is UTF-8 in a commit log when a mail header has explicitly
2428# declined it, i.e defined some charset where it is missing.
2429 if ($in_header_lines &&
2430 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2431 $1 !~ /utf-8/i) {
2432 $non_utf8_charset = 1;
2433 }
2434
2435 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002436 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002437 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002438 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2439 }
2440
Kees Cook66b47b42014-10-13 15:51:57 -07002441# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002442 if (defined($misspellings) &&
2443 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002444 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002445 my $typo = $1;
2446 my $typo_fix = $spelling_fix{lc($typo)};
2447 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2448 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2449 my $msg_type = \&WARN;
2450 $msg_type = \&CHK if ($file);
2451 if (&{$msg_type}("TYPO_SPELLING",
2452 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2453 $fix) {
2454 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2455 }
2456 }
2457 }
2458
Andy Whitcroft306708542008-10-15 22:02:28 -07002459# ignore non-hunk lines and lines being removed
2460 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002461
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002462#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002463 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002464 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002465 if (ERROR("DOS_LINE_ENDINGS",
2466 "DOS line endings\n" . $herevet) &&
2467 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002468 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002469 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002470 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2471 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002472 if (ERROR("TRAILING_WHITESPACE",
2473 "trailing whitespace\n" . $herevet) &&
2474 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002475 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002476 }
2477
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002478 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002479 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002480
Josh Triplett4783f892013-11-12 15:10:12 -08002481# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002482 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002483 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2484 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002485 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2486 my $msg_type = \&ERROR;
2487 $msg_type = \&CHK if ($file);
2488 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002489 "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)
Josh Triplett4783f892013-11-12 15:10:12 -08002490 }
2491
Andi Kleen33549572010-05-24 14:33:29 -07002492# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002493# Only applies when adding the entry originally, after that we do not have
2494# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002495 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002496 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002497 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002498 my $cnt = $realcnt;
2499 my $ln = $linenr + 1;
2500 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002501 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002502 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002503 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002504 $f = $lines[$ln - 1];
2505 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2506 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002507
2508 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002509 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002510
Joe Perches8d73e0e2014-08-06 16:10:46 -07002511 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002512 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002513 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002514 $length = -1;
2515 }
2516
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002517 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002518 $f =~ s/#.*//;
2519 $f =~ s/^\s+//;
2520 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002521 if ($f =~ /^\s*config\s/) {
2522 $is_end = 1;
2523 last;
2524 }
Andi Kleen33549572010-05-24 14:33:29 -07002525 $length++;
2526 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002527 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2528 WARN("CONFIG_DESCRIPTION",
2529 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2530 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002531 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002532 }
2533
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002534# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2535 if ($realfile =~ /Kconfig/ &&
2536 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2537 WARN("CONFIG_EXPERIMENTAL",
2538 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2539 }
2540
Christoph Jaeger327953e2015-02-13 14:38:29 -08002541# discourage the use of boolean for type definition attributes of Kconfig options
2542 if ($realfile =~ /Kconfig/ &&
2543 $line =~ /^\+\s*\bboolean\b/) {
2544 WARN("CONFIG_TYPE_BOOLEAN",
2545 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2546 }
2547
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002548 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2549 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2550 my $flag = $1;
2551 my $replacement = {
2552 'EXTRA_AFLAGS' => 'asflags-y',
2553 'EXTRA_CFLAGS' => 'ccflags-y',
2554 'EXTRA_CPPFLAGS' => 'cppflags-y',
2555 'EXTRA_LDFLAGS' => 'ldflags-y',
2556 };
2557
2558 WARN("DEPRECATED_VARIABLE",
2559 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2560 }
2561
Rob Herringbff5da42014-01-23 15:54:51 -08002562# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002563 if (defined $root &&
2564 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2565 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2566
Rob Herringbff5da42014-01-23 15:54:51 -08002567 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2568
Florian Vaussardcc933192014-04-03 14:49:27 -07002569 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2570 my $vp_file = $dt_path . "vendor-prefixes.txt";
2571
Rob Herringbff5da42014-01-23 15:54:51 -08002572 foreach my $compat (@compats) {
2573 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002574 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2575 my $compat3 = $compat;
2576 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2577 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002578 if ( $? >> 8 ) {
2579 WARN("UNDOCUMENTED_DT_STRING",
2580 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2581 }
2582
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002583 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2584 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002585 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002586 if ( $? >> 8 ) {
2587 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002588 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002589 }
2590 }
2591 }
2592
Andy Whitcroft5368df22008-10-15 22:02:27 -07002593# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002594 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002595
Joe Perches47e0c882015-06-25 15:02:57 -07002596# line length limit (with some exclusions)
2597#
2598# There are a few types of lines that may extend beyond $max_line_length:
2599# logging functions like pr_info that end in a string
2600# lines with a single string
2601# #defines that are a single string
2602#
2603# There are 3 different line length message types:
2604# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2605# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2606# LONG_LINE all other lines longer than $max_line_length
2607#
2608# if LONG_LINE is ignored, the other 2 types are also ignored
2609#
2610
Joe Perchesb4749e92015-07-17 16:24:01 -07002611 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002612 my $msg_type = "LONG_LINE";
2613
2614 # Check the allowed long line types first
2615
2616 # logging functions that end in a string that starts
2617 # before $max_line_length
2618 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2619 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2620 $msg_type = "";
2621
2622 # lines with only strings (w/ possible termination)
2623 # #defines with only strings
2624 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2625 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2626 $msg_type = "";
2627
2628 # Otherwise set the alternate message types
2629
2630 # a comment starts before $max_line_length
2631 } elsif ($line =~ /($;[\s$;]*)$/ &&
2632 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2633 $msg_type = "LONG_LINE_COMMENT"
2634
2635 # a quoted string starts before $max_line_length
2636 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2637 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2638 $msg_type = "LONG_LINE_STRING"
2639 }
2640
2641 if ($msg_type ne "" &&
2642 (show_type("LONG_LINE") || show_type($msg_type))) {
2643 WARN($msg_type,
2644 "line over $max_line_length characters\n" . $herecurr);
2645 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002646 }
2647
Andy Whitcroft8905a672007-11-28 16:21:06 -08002648# check for adding lines without a newline.
2649 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002650 WARN("MISSING_EOF_NEWLINE",
2651 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002652 }
2653
Mike Frysinger42e41c52009-09-21 17:04:40 -07002654# Blackfin: use hi/lo macros
2655 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2656 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2657 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002658 ERROR("LO_MACRO",
2659 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002660 }
2661 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2662 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002663 ERROR("HI_MACRO",
2664 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002665 }
2666 }
2667
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002668# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002669 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002670
2671# at the beginning of a line any tabs must come first and anything
2672# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002673 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2674 $rawline =~ /^\+\s* \s*/) {
2675 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002676 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002677 if (ERROR("CODE_INDENT",
2678 "code indent should use tabs where possible\n" . $herevet) &&
2679 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002680 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002681 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002682 }
2683
Alberto Panizzo08e44362010-03-05 13:43:54 -08002684# check for space before tabs.
2685 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2686 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002687 if (WARN("SPACE_BEFORE_TAB",
2688 "please, no space before tabs\n" . $herevet) &&
2689 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002690 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002691 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002692 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002693 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002694 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002695 }
2696
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002697# check for && or || at the start of a line
2698 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2699 CHK("LOGICAL_CONTINUATIONS",
2700 "Logical continuations should be on the previous line\n" . $hereprev);
2701 }
2702
2703# check multi-line statement indentation matches previous line
2704 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002705 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002706 $prevline =~ /^\+(\t*)(.*)$/;
2707 my $oldindent = $1;
2708 my $rest = $2;
2709
2710 my $pos = pos_last_openparen($rest);
2711 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002712 $line =~ /^(\+| )([ \t]*)/;
2713 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002714
2715 my $goodtabindent = $oldindent .
2716 "\t" x ($pos / 8) .
2717 " " x ($pos % 8);
2718 my $goodspaceindent = $oldindent . " " x $pos;
2719
2720 if ($newindent ne $goodtabindent &&
2721 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002722
2723 if (CHK("PARENTHESIS_ALIGNMENT",
2724 "Alignment should match open parenthesis\n" . $hereprev) &&
2725 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002726 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002727 s/^\+[ \t]*/\+$goodtabindent/;
2728 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002729 }
2730 }
2731 }
2732
Joe Perches6ab3a972015-04-16 12:44:05 -07002733# check for space after cast like "(int) foo" or "(struct foo) bar"
2734# avoid checking a few false positives:
2735# "sizeof(<type>)" or "__alignof__(<type>)"
2736# function pointer declarations like "(*foo)(int) = bar;"
2737# structure definitions like "(struct foo) { 0 };"
2738# multiline macros that define functions
2739# known attributes or the __attribute__ keyword
2740 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2741 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002742 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002743 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002744 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002745 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002746 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002747 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002748 }
2749
Joe Perches05880602012-10-04 17:13:35 -07002750 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002751 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002752 $rawline =~ /^\+[ \t]*\*/ &&
2753 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002754 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2755 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2756 }
2757
2758 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002759 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2760 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002761 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002762 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2763 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2764 "networking block comments start with * on subsequent lines\n" . $hereprev);
2765 }
2766
2767 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002768 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2769 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2770 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2771 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002772 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2773 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2774 }
2775
Joe Perches7f619192014-08-06 16:10:39 -07002776# check for missing blank lines after struct/union declarations
2777# with exceptions for various attributes and macros
2778 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2779 $line =~ /^\+/ &&
2780 !($line =~ /^\+\s*$/ ||
2781 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2782 $line =~ /^\+\s*MODULE_/i ||
2783 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2784 $line =~ /^\+[a-z_]*init/ ||
2785 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2786 $line =~ /^\+\s*DECLARE/ ||
2787 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002788 if (CHK("LINE_SPACING",
2789 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2790 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002791 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002792 }
Joe Perches7f619192014-08-06 16:10:39 -07002793 }
2794
Joe Perches365dd4e2014-08-06 16:10:42 -07002795# check for multiple consecutive blank lines
2796 if ($prevline =~ /^[\+ ]\s*$/ &&
2797 $line =~ /^\+\s*$/ &&
2798 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002799 if (CHK("LINE_SPACING",
2800 "Please don't use multiple blank lines\n" . $hereprev) &&
2801 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002802 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002803 }
2804
Joe Perches365dd4e2014-08-06 16:10:42 -07002805 $last_blank_line = $linenr;
2806 }
2807
Joe Perches3b617e32014-04-03 14:49:28 -07002808# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002809 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2810 # actual declarations
2811 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002812 # function pointer declarations
2813 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002814 # foo bar; where foo is some local typedef or #define
2815 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2816 # known declaration macros
2817 $prevline =~ /^\+\s+$declaration_macros/) &&
2818 # for "else if" which can look like "$Ident $Ident"
2819 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2820 # other possible extensions of declaration lines
2821 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2822 # not starting a section or a macro "\" extended line
2823 $prevline =~ /(?:\{\s*|\\)$/) &&
2824 # looks like a declaration
2825 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002826 # function pointer declarations
2827 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002828 # foo bar; where foo is some local typedef or #define
2829 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2830 # known declaration macros
2831 $sline =~ /^\+\s+$declaration_macros/ ||
2832 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002833 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002834 # start or end of block or continuation of declaration
2835 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2836 # bitfield continuation
2837 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2838 # other possible extensions of declaration lines
2839 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2840 # indentation of previous and current line are the same
2841 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002842 if (WARN("LINE_SPACING",
2843 "Missing a blank line after declarations\n" . $hereprev) &&
2844 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002845 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002846 }
Joe Perches3b617e32014-04-03 14:49:28 -07002847 }
2848
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002849# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002850# Exceptions:
2851# 1) within comments
2852# 2) indented preprocessor commands
2853# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002854 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002855 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002856 if (WARN("LEADING_SPACE",
2857 "please, no spaces at the start of a line\n" . $herevet) &&
2858 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002859 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002860 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002861 }
2862
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002863# check we are in a valid C source file if not then ignore this hunk
2864 next if ($realfile !~ /\.(h|c)$/);
2865
Joe Perches032a4c02014-08-06 16:10:29 -07002866# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002867# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002868# if the previous line is a break or return and is indented 1 tab more...
2869 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2870 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002871 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2872 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2873 defined $lines[$linenr] &&
2874 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002875 WARN("UNNECESSARY_ELSE",
2876 "else is not generally useful after a break or return\n" . $hereprev);
2877 }
2878 }
2879
Joe Perchesc00df192014-08-06 16:11:01 -07002880# check indentation of a line with a break;
2881# if the previous line is a goto or return and is indented the same # of tabs
2882 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2883 my $tabs = $1;
2884 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2885 WARN("UNNECESSARY_BREAK",
2886 "break is not useful after a goto or return\n" . $hereprev);
2887 }
2888 }
2889
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002890# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2891 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2892 WARN("CONFIG_EXPERIMENTAL",
2893 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2894 }
2895
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002896# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002897 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002898 WARN("CVS_KEYWORD",
2899 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002900 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002901
Mike Frysinger42e41c52009-09-21 17:04:40 -07002902# Blackfin: don't use __builtin_bfin_[cs]sync
2903 if ($line =~ /__builtin_bfin_csync/) {
2904 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002905 ERROR("CSYNC",
2906 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002907 }
2908 if ($line =~ /__builtin_bfin_ssync/) {
2909 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002910 ERROR("SSYNC",
2911 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002912 }
2913
Joe Perches56e77d72013-02-21 16:44:14 -08002914# check for old HOTPLUG __dev<foo> section markings
2915 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2916 WARN("HOTPLUG_SECTION",
2917 "Using $1 is unnecessary\n" . $herecurr);
2918 }
2919
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002920# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002921 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2922 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002923#print "LINE<$line>\n";
2924 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002925 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002926 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002927 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002928 $stat =~ s/\n./\n /g;
2929 $cond =~ s/\n./\n /g;
2930
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002931#print "linenr<$linenr> <$stat>\n";
2932 # If this statement has no statement boundaries within
2933 # it there is no point in retrying a statement scan
2934 # until we hit end of it.
2935 my $frag = $stat; $frag =~ s/;+\s*$//;
2936 if ($frag !~ /(?:{|;)/) {
2937#print "skip<$line_nr_next>\n";
2938 $suppress_statement = $line_nr_next;
2939 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002940
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002941 # Find the real next line.
2942 $realline_next = $line_nr_next;
2943 if (defined $realline_next &&
2944 (!defined $lines[$realline_next - 1] ||
2945 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2946 $realline_next++;
2947 }
2948
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002949 my $s = $stat;
2950 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002951
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002952 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002953 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002954
2955 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002956 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002957
Andy Whitcroft463f2862009-09-21 17:04:34 -07002958 } elsif ($s =~ /^.\s*else\b/s) {
2959
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002960 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002961 } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002962 my $type = $1;
2963 $type =~ s/\s+/ /g;
2964 possible($type, "A:" . $s);
2965
Andy Whitcroft8905a672007-11-28 16:21:06 -08002966 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002967 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002968 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002969 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002970
2971 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002972 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002973 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002974 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002975
2976 # Check for any sort of function declaration.
2977 # int foo(something bar, other baz);
2978 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002979 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002980 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002981
Andy Whitcroftcf655042008-03-04 14:28:20 -08002982 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002983 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002984 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002985
Andy Whitcroft8905a672007-11-28 16:21:06 -08002986 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002987 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002988
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002989 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002990 }
2991 }
2992 }
2993
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002994 }
2995
Andy Whitcroft653d4872007-06-23 17:16:34 -07002996#
2997# Checks which may be anchored in the context.
2998#
2999
3000# Check for switch () and associated case and default
3001# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003002 if ($line=~/\bswitch\s*\(.*\)/) {
3003 my $err = '';
3004 my $sep = '';
3005 my @ctx = ctx_block_outer($linenr, $realcnt);
3006 shift(@ctx);
3007 for my $ctx (@ctx) {
3008 my ($clen, $cindent) = line_stats($ctx);
3009 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3010 $indent != $cindent) {
3011 $err .= "$sep$ctx\n";
3012 $sep = '';
3013 } else {
3014 $sep = "[...]\n";
3015 }
3016 }
3017 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003018 ERROR("SWITCH_CASE_INDENT_LEVEL",
3019 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003020 }
3021 }
3022
3023# if/while/etc brace do not go on next line, unless defining a do while loop,
3024# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003025 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003026 my $pre_ctx = "$1$2";
3027
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003028 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003029
3030 if ($line =~ /^\+\t{6,}/) {
3031 WARN("DEEP_INDENTATION",
3032 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3033 }
3034
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003035 my $ctx_cnt = $realcnt - $#ctx - 1;
3036 my $ctx = join("\n", @ctx);
3037
Andy Whitcroft548596d2008-07-23 21:29:01 -07003038 my $ctx_ln = $linenr;
3039 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003040
Andy Whitcroft548596d2008-07-23 21:29:01 -07003041 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3042 defined $lines[$ctx_ln - 1] &&
3043 $lines[$ctx_ln - 1] =~ /^-/)) {
3044 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3045 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003046 $ctx_ln++;
3047 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003048
Andy Whitcroft53210162008-07-23 21:29:03 -07003049 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3050 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003051
Joe Perchesd752fcc2014-08-06 16:11:05 -07003052 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003053 ERROR("OPEN_BRACE",
3054 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003055 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003056 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003057 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3058 $ctx =~ /\)\s*\;\s*$/ &&
3059 defined $lines[$ctx_ln - 1])
3060 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003061 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3062 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003063 WARN("TRAILING_SEMICOLON",
3064 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003065 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003066 }
3067 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003068 }
3069
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003070# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003071 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003072 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3073 ctx_statement_block($linenr, $realcnt, 0)
3074 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003075 my ($s, $c) = ($stat, $cond);
3076
3077 substr($s, 0, length($c), '');
3078
3079 # Make sure we remove the line prefixes as we have
3080 # none on the first line, and are going to readd them
3081 # where necessary.
3082 $s =~ s/\n./\n/gs;
3083
3084 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003085 my @newlines = ($c =~ /\n/gs);
3086 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003087
3088 # We want to check the first line inside the block
3089 # starting at the end of the conditional, so remove:
3090 # 1) any blank line termination
3091 # 2) any opening brace { on end of the line
3092 # 3) any do (...) {
3093 my $continuation = 0;
3094 my $check = 0;
3095 $s =~ s/^.*\bdo\b//;
3096 $s =~ s/^\s*{//;
3097 if ($s =~ s/^\s*\\//) {
3098 $continuation = 1;
3099 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003100 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003101 $check = 1;
3102 $cond_lines++;
3103 }
3104
3105 # Also ignore a loop construct at the end of a
3106 # preprocessor statement.
3107 if (($prevline =~ /^.\s*#\s*define\s/ ||
3108 $prevline =~ /\\\s*$/) && $continuation == 0) {
3109 $check = 0;
3110 }
3111
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003112 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003113 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003114 while ($cond_ptr != $cond_lines) {
3115 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003116
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003117 # If we see an #else/#elif then the code
3118 # is not linear.
3119 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3120 $check = 0;
3121 }
3122
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003123 # Ignore:
3124 # 1) blank lines, they should be at 0,
3125 # 2) preprocessor lines, and
3126 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003127 if ($continuation ||
3128 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003129 $s =~ /^\s*#\s*?/ ||
3130 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003131 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003132 if ($s =~ s/^.*?\n//) {
3133 $cond_lines++;
3134 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003135 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003136 }
3137
3138 my (undef, $sindent) = line_stats("+" . $s);
3139 my $stat_real = raw_line($linenr, $cond_lines);
3140
3141 # Check if either of these lines are modified, else
3142 # this is not this patch's fault.
3143 if (!defined($stat_real) ||
3144 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3145 $check = 0;
3146 }
3147 if (defined($stat_real) && $cond_lines > 1) {
3148 $stat_real = "[...]\n$stat_real";
3149 }
3150
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003151 #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003152
3153 if ($check && (($sindent % 8) != 0 ||
3154 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003155 WARN("SUSPECT_CODE_INDENT",
3156 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003157 }
3158 }
3159
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003160 # Track the 'values' across context and added lines.
3161 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003162 my ($curr_values, $curr_vars) =
3163 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003164 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003165 if ($dbg_values) {
3166 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003167 print "$linenr > .$outline\n";
3168 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003169 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003170 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003171 $prev_values = substr($curr_values, -1);
3172
Andy Whitcroft00df3442007-06-08 13:47:06 -07003173#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003174 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003175
Andy Whitcroft653d4872007-06-23 17:16:34 -07003176# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003177 if ($dbg_type) {
3178 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003179 ERROR("TEST_TYPE",
3180 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003181 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003182 ERROR("TEST_NOT_TYPE",
3183 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003184 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003185 next;
3186 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003187# TEST: allow direct testing of the attribute matcher.
3188 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003189 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003190 ERROR("TEST_ATTR",
3191 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003192 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003193 ERROR("TEST_NOT_ATTR",
3194 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003195 }
3196 next;
3197 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003198
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003199# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003200 if ($line =~ /^.\s*{/ &&
3201 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003202 if (ERROR("OPEN_BRACE",
3203 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003204 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3205 fix_delete_line($fixlinenr - 1, $prevrawline);
3206 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003207 my $fixedline = $prevrawline;
3208 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003209 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003210 $fixedline = $line;
3211 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003212 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003213 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003214 }
3215
Andy Whitcroft653d4872007-06-23 17:16:34 -07003216#
3217# Checks which are anchored on the added line.
3218#
3219
3220# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003221 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003222 my $path = $1;
3223 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003224 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003225 "malformed #include filename\n" . $herecurr);
3226 }
3227 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3228 ERROR("UAPI_INCLUDE",
3229 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003230 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003231 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003232
3233# no C99 // comments
3234 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003235 if (ERROR("C99_COMMENTS",
3236 "do not use C99 // comments\n" . $herecurr) &&
3237 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003238 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003239 if ($line =~ /\/\/(.*)$/) {
3240 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003241 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003242 }
3243 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003244 }
3245 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003246 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003247 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003248
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003249# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3250# the whole statement.
3251#print "APW <$lines[$realline_next - 1]>\n";
3252 if (defined $realline_next &&
3253 exists $lines[$realline_next - 1] &&
3254 !defined $suppress_export{$realline_next} &&
3255 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3256 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003257 # Handle definitions which produce identifiers with
3258 # a prefix:
3259 # XXX(foo);
3260 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003261 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003262 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003263 $name =~ /^${Ident}_$2/) {
3264#print "FOO C name<$name>\n";
3265 $suppress_export{$realline_next} = 1;
3266
3267 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003268 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003269 ^.DEFINE_$Ident\(\Q$name\E\)|
3270 ^.DECLARE_$Ident\(\Q$name\E\)|
3271 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003272 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3273 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003274 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003275#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3276 $suppress_export{$realline_next} = 2;
3277 } else {
3278 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003279 }
3280 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003281 if (!defined $suppress_export{$linenr} &&
3282 $prevline =~ /^.\s*$/ &&
3283 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3284 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3285#print "FOO B <$lines[$linenr - 1]>\n";
3286 $suppress_export{$linenr} = 2;
3287 }
3288 if (defined $suppress_export{$linenr} &&
3289 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003290 WARN("EXPORT_SYMBOL",
3291 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003292 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003293
Joe Eloff5150bda2010-08-09 17:21:00 -07003294# check for global initialisers.
Joe Perches5129e872015-06-10 11:14:52 -07003295 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003296 if (ERROR("GLOBAL_INITIALISERS",
3297 "do not initialise globals to 0 or NULL\n" .
3298 $herecurr) &&
3299 $fix) {
Joe Perches5129e872015-06-10 11:14:52 -07003300 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003301 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003302 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003303# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003304 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3305 if (ERROR("INITIALISED_STATIC",
3306 "do not initialise statics to 0 or NULL\n" .
3307 $herecurr) &&
3308 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003309 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003310 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003311 }
3312
Joe Perches18130872014-08-06 16:11:22 -07003313# check for misordered declarations of char/short/int/long with signed/unsigned
3314 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3315 my $tmp = trim($1);
3316 WARN("MISORDERED_TYPE",
3317 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3318 }
3319
Joe Perchescb710ec2010-10-26 14:23:20 -07003320# check for static const char * arrays.
3321 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003322 WARN("STATIC_CONST_CHAR_ARRAY",
3323 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003324 $herecurr);
3325 }
3326
3327# check for static char foo[] = "bar" declarations.
3328 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003329 WARN("STATIC_CONST_CHAR_ARRAY",
3330 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003331 $herecurr);
3332 }
3333
Joe Perchesab7e23f2015-04-16 12:44:22 -07003334# check for const <foo> const where <foo> is not a pointer or array type
3335 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3336 my $found = $1;
3337 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3338 WARN("CONST_CONST",
3339 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3340 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3341 WARN("CONST_CONST",
3342 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3343 }
3344 }
3345
Joe Perches9b0fa602014-04-03 14:49:18 -07003346# check for non-global char *foo[] = {"bar", ...} declarations.
3347 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3348 WARN("STATIC_CONST_CHAR_ARRAY",
3349 "char * array declaration might be better as static const\n" .
3350 $herecurr);
3351 }
3352
Joe Perchesb598b672015-04-16 12:44:36 -07003353# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3354 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3355 my $array = $1;
3356 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3357 my $array_div = $1;
3358 if (WARN("ARRAY_SIZE",
3359 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3360 $fix) {
3361 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3362 }
3363 }
3364 }
3365
Joe Perchesb36190c2014-01-27 17:07:18 -08003366# check for function declarations without arguments like "int foo()"
3367 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3368 if (ERROR("FUNCTION_WITHOUT_ARGS",
3369 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3370 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003371 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003372 }
3373 }
3374
Joe Perches92e112f2013-12-13 11:36:22 -07003375# check for uses of DEFINE_PCI_DEVICE_TABLE
3376 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3377 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3378 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003380 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
Joe Perches92e112f2013-12-13 11:36:22 -07003381 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003382 }
3383
Andy Whitcroft653d4872007-06-23 17:16:34 -07003384# check for new typedefs, only function parameters and sparse annotations
3385# make sense.
3386 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003387 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003388 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003389 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003390 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003391 WARN("NEW_TYPEDEFS",
3392 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003393 }
3394
3395# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003396 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003397 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3398 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003399 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003400
Andy Whitcroft65863862009-01-06 14:41:21 -08003401 # Should start with a space.
3402 $to =~ s/^(\S)/ $1/;
3403 # Should not end with a space.
3404 $to =~ s/\s+$//;
3405 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003406 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003407 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003408
Joe Perches3705ce52013-07-03 15:05:31 -07003409## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003410 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003411 if (ERROR("POINTER_LOCATION",
3412 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3413 $fix) {
3414 my $sub_from = $ident;
3415 my $sub_to = $ident;
3416 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003417 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003418 s@\Q$sub_from\E@$sub_to@;
3419 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003420 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003421 }
3422 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3423 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003424 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003425
Andy Whitcroft65863862009-01-06 14:41:21 -08003426 # Should start with a space.
3427 $to =~ s/^(\S)/ $1/;
3428 # Should not end with a space.
3429 $to =~ s/\s+$//;
3430 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003431 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003432 }
3433 # Modifiers should have spaces.
3434 $to =~ s/(\b$Modifier$)/$1 /;
3435
Joe Perches3705ce52013-07-03 15:05:31 -07003436## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003437 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003438 if (ERROR("POINTER_LOCATION",
3439 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3440 $fix) {
3441
3442 my $sub_from = $match;
3443 my $sub_to = $match;
3444 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003445 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003446 s@\Q$sub_from\E@$sub_to@;
3447 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003448 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003449 }
3450
Joe Perches9d3e3c72015-09-09 15:37:27 -07003451# avoid BUG() or BUG_ON()
3452 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3453 my $msg_type = \&WARN;
3454 $msg_type = \&CHK if ($file);
3455 &{$msg_type}("AVOID_BUG",
3456 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3457 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003458
Joe Perches9d3e3c72015-09-09 15:37:27 -07003459# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003460 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003461 WARN("LINUX_VERSION_CODE",
3462 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003463 }
3464
Joe Perches17441222011-06-15 15:08:17 -07003465# check for uses of printk_ratelimit
3466 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003467 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003468 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003469 }
3470
Andy Whitcroft00df3442007-06-08 13:47:06 -07003471# printk should use KERN_* levels. Note that follow on printk's on the
3472# same line do not need a level, so we use the current block context
3473# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003474# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003475# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003476 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003477 my $ok = 0;
3478 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3479 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003480 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003481 # with "\n" ignore it, else it is to blame
3482 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3483 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3484 $ok = 1;
3485 }
3486 last;
3487 }
3488 }
3489 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003490 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3491 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003492 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003493 }
3494
Joe Perches243f3802012-05-31 16:26:09 -07003495 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3496 my $orig = $1;
3497 my $level = lc($orig);
3498 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003499 my $level2 = $level;
3500 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003501 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003502 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07003503 }
3504
3505 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003506 if (WARN("PREFER_PR_LEVEL",
3507 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3508 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003509 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003510 s/\bpr_warning\b/pr_warn/;
3511 }
Joe Perches243f3802012-05-31 16:26:09 -07003512 }
3513
Joe Perchesdc139312013-02-21 16:44:13 -08003514 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3515 my $orig = $1;
3516 my $level = lc($orig);
3517 $level = "warn" if ($level eq "warning");
3518 $level = "dbg" if ($level eq "debug");
3519 WARN("PREFER_DEV_LEVEL",
3520 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3521 }
3522
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003523# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3524# number of false positives, but assembly files are not checked, so at
3525# least the arch entry code will not trigger this warning.
3526 if ($line =~ /\bENOSYS\b/) {
3527 WARN("ENOSYS",
3528 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3529 }
3530
Andy Whitcroft653d4872007-06-23 17:16:34 -07003531# function brace can't be on same line, except for #defines of do while,
3532# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003533 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003534 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003535 if (ERROR("OPEN_BRACE",
3536 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3537 $fix) {
3538 fix_delete_line($fixlinenr, $rawline);
3539 my $fixed_line = $rawline;
3540 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3541 my $line1 = $1;
3542 my $line2 = $2;
3543 fix_insert_line($fixlinenr, ltrim($line1));
3544 fix_insert_line($fixlinenr, "\+{");
3545 if ($line2 !~ /^\s*$/) {
3546 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3547 }
3548 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003549 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003550
Andy Whitcroft8905a672007-11-28 16:21:06 -08003551# open braces for enum, union and struct go on the same line.
3552 if ($line =~ /^.\s*{/ &&
3553 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003554 if (ERROR("OPEN_BRACE",
3555 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3556 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3557 fix_delete_line($fixlinenr - 1, $prevrawline);
3558 fix_delete_line($fixlinenr, $rawline);
3559 my $fixedline = rtrim($prevrawline) . " {";
3560 fix_insert_line($fixlinenr, $fixedline);
3561 $fixedline = $rawline;
3562 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3563 if ($fixedline !~ /^\+\s*$/) {
3564 fix_insert_line($fixlinenr, $fixedline);
3565 }
3566 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003567 }
3568
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003569# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003570 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3571 if (WARN("SPACING",
3572 "missing space after $1 definition\n" . $herecurr) &&
3573 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003574 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003575 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3576 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003577 }
3578
Joe Perches31070b52014-01-23 15:54:49 -08003579# Function pointer declarations
3580# check spacing between type, funcptr, and args
3581# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003582 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003583 my $declare = $1;
3584 my $pre_pointer_space = $2;
3585 my $post_pointer_space = $3;
3586 my $funcname = $4;
3587 my $post_funcname_space = $5;
3588 my $pre_args_space = $6;
3589
Joe Perches91f72e92014-04-03 14:49:12 -07003590# the $Declare variable will capture all spaces after the type
3591# so check it for a missing trailing missing space but pointer return types
3592# don't need a space so don't warn for those.
3593 my $post_declare_space = "";
3594 if ($declare =~ /(\s+)$/) {
3595 $post_declare_space = $1;
3596 $declare = rtrim($declare);
3597 }
3598 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003599 WARN("SPACING",
3600 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003601 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003602 }
3603
3604# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003605# This test is not currently implemented because these declarations are
3606# equivalent to
3607# int foo(int bar, ...)
3608# and this is form shouldn't/doesn't generate a checkpatch warning.
3609#
3610# elsif ($declare =~ /\s{2,}$/) {
3611# WARN("SPACING",
3612# "Multiple spaces after return type\n" . $herecurr);
3613# }
Joe Perches31070b52014-01-23 15:54:49 -08003614
3615# unnecessary space "type ( *funcptr)(args...)"
3616 if (defined $pre_pointer_space &&
3617 $pre_pointer_space =~ /^\s/) {
3618 WARN("SPACING",
3619 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3620 }
3621
3622# unnecessary space "type (* funcptr)(args...)"
3623 if (defined $post_pointer_space &&
3624 $post_pointer_space =~ /^\s/) {
3625 WARN("SPACING",
3626 "Unnecessary space before function pointer name\n" . $herecurr);
3627 }
3628
3629# unnecessary space "type (*funcptr )(args...)"
3630 if (defined $post_funcname_space &&
3631 $post_funcname_space =~ /^\s/) {
3632 WARN("SPACING",
3633 "Unnecessary space after function pointer name\n" . $herecurr);
3634 }
3635
3636# unnecessary space "type (*funcptr) (args...)"
3637 if (defined $pre_args_space &&
3638 $pre_args_space =~ /^\s/) {
3639 WARN("SPACING",
3640 "Unnecessary space before function pointer arguments\n" . $herecurr);
3641 }
3642
3643 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003644 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003645 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003646 }
3647 }
3648
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003649# check for spacing round square brackets; allowed:
3650# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003651# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3652# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003653 while ($line =~ /(.*?\s)\[/g) {
3654 my ($where, $prefix) = ($-[1], $1);
3655 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003656 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003657 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003658 if (ERROR("BRACKET_SPACE",
3659 "space prohibited before open square bracket '['\n" . $herecurr) &&
3660 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003661 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003662 s/^(\+.*?)\s+\[/$1\[/;
3663 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003664 }
3665 }
3666
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003667# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003668 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003669 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003670 my $ctx_before = substr($line, 0, $-[1]);
3671 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003672
3673 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003674 if ($name =~ /^(?:
3675 if|for|while|switch|return|case|
3676 volatile|__volatile__|
3677 __attribute__|format|__extension__|
3678 asm|__asm__)$/x)
3679 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003680 # cpp #define statements have non-optional spaces, ie
3681 # if there is a space between the name and the open
3682 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003683 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003684
3685 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003686 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003687
3688 # If this whole things ends with a type its most
3689 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003690 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003691
3692 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003693 if (WARN("SPACING",
3694 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3695 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003696 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003697 s/\b$name\s+\(/$name\(/;
3698 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003699 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003700 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003701
Andy Whitcroft653d4872007-06-23 17:16:34 -07003702# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003703 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003704 my $fixed_line = "";
3705 my $line_fixed = 0;
3706
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003707 my $ops = qr{
3708 <<=|>>=|<=|>=|==|!=|
3709 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3710 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003711 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003712 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003713 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003714 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003715
3716## print("element count: <" . $#elements . ">\n");
3717## foreach my $el (@elements) {
3718## print("el: <$el>\n");
3719## }
3720
3721 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003722 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003723
Joe Perches3705ce52013-07-03 15:05:31 -07003724 foreach my $el (@elements) {
3725 push(@fix_elements, substr($rawline, $off, length($el)));
3726 $off += length($el);
3727 }
3728
3729 $off = 0;
3730
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003731 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003732 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003733
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003734 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003735
3736 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3737
3738## print("n: <$n> good: <$good>\n");
3739
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003740 $off += length($elements[$n]);
3741
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003742 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003743 my $ca = substr($opline, 0, $off);
3744 my $cc = '';
3745 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3746 $cc = substr($opline, $off + length($elements[$n + 1]));
3747 }
3748 my $cb = "$ca$;$cc";
3749
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003750 my $a = '';
3751 $a = 'V' if ($elements[$n] ne '');
3752 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003753 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003754 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3755 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003756 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003757
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003758 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003759
3760 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003761 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003762 $c = 'V' if ($elements[$n + 2] ne '');
3763 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003764 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003765 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3766 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003767 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003768 } else {
3769 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003770 }
3771
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003772 my $ctx = "${a}x${c}";
3773
3774 my $at = "(ctx:$ctx)";
3775
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003776 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003777 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003778
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003779 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003780 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003781
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003782 # Get the full operator variant.
3783 my $opv = $op . substr($curr_vars, $off, 1);
3784
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003785 # Ignore operators passed as parameters.
3786 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003787 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003788
Andy Whitcroftcf655042008-03-04 14:28:20 -08003789# # Ignore comments
3790# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003791
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003792 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003793 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003794 if ($ctx !~ /.x[WEBC]/ &&
3795 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003796 if (ERROR("SPACING",
3797 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003798 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003799 $line_fixed = 1;
3800 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003801 }
3802
3803 # // is a comment
3804 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003805
Joe Perchesb00e4812014-04-03 14:49:33 -07003806 # : when part of a bitfield
3807 } elsif ($opv eq ':B') {
3808 # skip the bitfield test for now
3809
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003810 # No spaces for:
3811 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003812 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003813 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003814 if (ERROR("SPACING",
3815 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003816 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003817 if (defined $fix_elements[$n + 2]) {
3818 $fix_elements[$n + 2] =~ s/^\s+//;
3819 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003820 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003821 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003822 }
3823
Joe Perches23810972014-12-10 15:51:32 -08003824 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003825 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003826 my $rtrim_before = 0;
3827 my $space_after = 0;
3828 if ($ctx =~ /Wx./) {
3829 if (ERROR("SPACING",
3830 "space prohibited before that '$op' $at\n" . $hereptr)) {
3831 $line_fixed = 1;
3832 $rtrim_before = 1;
3833 }
3834 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003835 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003836 if (ERROR("SPACING",
3837 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003838 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003839 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003840 $space_after = 1;
3841 }
3842 }
3843 if ($rtrim_before || $space_after) {
3844 if ($rtrim_before) {
3845 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3846 } else {
3847 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3848 }
3849 if ($space_after) {
3850 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003851 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003852 }
3853
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003854 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003855 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003856 #warn "'*' is part of type\n";
3857
3858 # unary operators should have a space before and
3859 # none after. May be left adjacent to another
3860 # unary operator, or a cast
3861 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003862 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003863 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003864 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003865 if (ERROR("SPACING",
3866 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003867 if ($n != $last_after + 2) {
3868 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3869 $line_fixed = 1;
3870 }
Joe Perches3705ce52013-07-03 15:05:31 -07003871 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003872 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003873 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003874 # A unary '*' may be const
3875
3876 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003877 if (ERROR("SPACING",
3878 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003879 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003880 if (defined $fix_elements[$n + 2]) {
3881 $fix_elements[$n + 2] =~ s/^\s+//;
3882 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003883 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003884 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003885 }
3886
3887 # unary ++ and unary -- are allowed no space on one side.
3888 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003889 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003890 if (ERROR("SPACING",
3891 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003892 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003893 $line_fixed = 1;
3894 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003895 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003896 if ($ctx =~ /Wx[BE]/ ||
3897 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003898 if (ERROR("SPACING",
3899 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003900 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003901 $line_fixed = 1;
3902 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003903 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003904 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003905 if (ERROR("SPACING",
3906 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003907 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003908 if (defined $fix_elements[$n + 2]) {
3909 $fix_elements[$n + 2] =~ s/^\s+//;
3910 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003911 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003912 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003913 }
3914
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003915 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003916 } elsif ($op eq '<<' or $op eq '>>' or
3917 $op eq '&' or $op eq '^' or $op eq '|' or
3918 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003919 $op eq '*' or $op eq '/' or
3920 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003921 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08003922 if ($check) {
3923 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3924 if (CHK("SPACING",
3925 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3926 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3927 $fix_elements[$n + 2] =~ s/^\s+//;
3928 $line_fixed = 1;
3929 }
3930 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3931 if (CHK("SPACING",
3932 "space preferred before that '$op' $at\n" . $hereptr)) {
3933 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3934 $line_fixed = 1;
3935 }
3936 }
3937 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003938 if (ERROR("SPACING",
3939 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003940 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3941 if (defined $fix_elements[$n + 2]) {
3942 $fix_elements[$n + 2] =~ s/^\s+//;
3943 }
Joe Perches3705ce52013-07-03 15:05:31 -07003944 $line_fixed = 1;
3945 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003946 }
3947
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003948 # A colon needs no spaces before when it is
3949 # terminating a case value or a label.
3950 } elsif ($opv eq ':C' || $opv eq ':L') {
3951 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003952 if (ERROR("SPACING",
3953 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003954 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003955 $line_fixed = 1;
3956 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003957 }
3958
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003959 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003960 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003961 my $ok = 0;
3962
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003963 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003964 if (($op eq '<' &&
3965 $cc =~ /^\S+\@\S+>/) ||
3966 ($op eq '>' &&
3967 $ca =~ /<\S+\@\S+$/))
3968 {
3969 $ok = 1;
3970 }
3971
Joe Perchese0df7e12015-04-16 12:44:53 -07003972 # for asm volatile statements
3973 # ignore a colon with another
3974 # colon immediately before or after
3975 if (($op eq ':') &&
3976 ($ca =~ /:$/ || $cc =~ /^:/)) {
3977 $ok = 1;
3978 }
3979
Joe Perches84731622013-11-12 15:10:05 -08003980 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003981 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003982 my $msg_type = \&ERROR;
3983 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3984
3985 if (&{$msg_type}("SPACING",
3986 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003987 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3988 if (defined $fix_elements[$n + 2]) {
3989 $fix_elements[$n + 2] =~ s/^\s+//;
3990 }
Joe Perches3705ce52013-07-03 15:05:31 -07003991 $line_fixed = 1;
3992 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003993 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003994 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003995 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003996
3997## print("n: <$n> GOOD: <$good>\n");
3998
3999 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004000 }
Joe Perches3705ce52013-07-03 15:05:31 -07004001
4002 if (($#elements % 2) == 0) {
4003 $fixed_line = $fixed_line . $fix_elements[$#elements];
4004 }
4005
Joe Perches194f66f2014-08-06 16:11:03 -07004006 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4007 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004008 }
4009
4010
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004011 }
4012
Joe Perches786b6322013-07-03 15:05:32 -07004013# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004014 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004015 if (WARN("SPACING",
4016 "space prohibited before semicolon\n" . $herecurr) &&
4017 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004018 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004019 s/^(\+.*\S)\s+;/$1;/;
4020 }
4021 }
4022
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004023# check for multiple assignments
4024 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004025 CHK("MULTIPLE_ASSIGNMENTS",
4026 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004027 }
4028
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004029## # check for multiple declarations, allowing for a function declaration
4030## # continuation.
4031## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4032## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4033##
4034## # Remove any bracketed sections to ensure we do not
4035## # falsly report the parameters of functions.
4036## my $ln = $line;
4037## while ($ln =~ s/\([^\(\)]*\)//g) {
4038## }
4039## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004040## WARN("MULTIPLE_DECLARATION",
4041## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004042## }
4043## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004044
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004045#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004046 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
4047 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004048 if (ERROR("SPACING",
4049 "space required before the open brace '{'\n" . $herecurr) &&
4050 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004051 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004052 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004053 }
4054
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004055## # check for blank lines before declarations
4056## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4057## $prevrawline =~ /^.\s*$/) {
4058## WARN("SPACING",
4059## "No blank lines before declarations\n" . $hereprev);
4060## }
4061##
4062
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004063# closing brace should have a space following it when it has anything
4064# on the line
4065 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004066 if (ERROR("SPACING",
4067 "space required after that close brace '}'\n" . $herecurr) &&
4068 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004069 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004070 s/}((?!(?:,|;|\)))\S)/} $1/;
4071 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004072 }
4073
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004074# check spacing on square brackets
4075 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004076 if (ERROR("SPACING",
4077 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4078 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004079 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004080 s/\[\s+/\[/;
4081 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004082 }
4083 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004084 if (ERROR("SPACING",
4085 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4086 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004087 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004088 s/\s+\]/\]/;
4089 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004090 }
4091
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004092# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004093 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4094 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004095 if (ERROR("SPACING",
4096 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4097 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004098 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004099 s/\(\s+/\(/;
4100 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004101 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004102 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004103 $line !~ /for\s*\(.*;\s+\)/ &&
4104 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004105 if (ERROR("SPACING",
4106 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4107 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004108 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004109 s/\s+\)/\)/;
4110 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004111 }
4112
Joe Perchese2826fd2014-08-06 16:10:48 -07004113# check unnecessary parentheses around addressof/dereference single $Lvals
4114# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4115
4116 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004117 my $var = $1;
4118 if (CHK("UNNECESSARY_PARENTHESES",
4119 "Unnecessary parentheses around $var\n" . $herecurr) &&
4120 $fix) {
4121 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4122 }
4123 }
4124
4125# check for unnecessary parentheses around function pointer uses
4126# ie: (foo->bar)(); should be foo->bar();
4127# but not "if (foo->bar) (" to avoid some false positives
4128 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4129 my $var = $2;
4130 if (CHK("UNNECESSARY_PARENTHESES",
4131 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4132 $fix) {
4133 my $var2 = deparenthesize($var);
4134 $var2 =~ s/\s//g;
4135 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4136 }
4137 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004138
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004139#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004140 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004141 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004142 if (WARN("INDENTED_LABEL",
4143 "labels should not be indented\n" . $herecurr) &&
4144 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004145 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004146 s/^(.)\s+/$1/;
4147 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004148 }
4149
Joe Perches5b9553a2014-04-03 14:49:21 -07004150# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004151 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004152 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004153 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004154 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4155 my $value = $1;
4156 $value = deparenthesize($value);
4157 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4158 ERROR("RETURN_PARENTHESES",
4159 "return is not a function, parentheses are not required\n" . $herecurr);
4160 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004161 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004162 ERROR("SPACING",
4163 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004164 }
4165 }
Joe Perches507e5142013-11-12 15:10:13 -08004166
Joe Perchesb43ae212014-06-23 13:22:07 -07004167# unnecessary return in a void function
4168# at end-of-function, with the previous line a single leading tab, then return;
4169# and the line before that not a goto label target like "out:"
4170 if ($sline =~ /^[ \+]}\s*$/ &&
4171 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4172 $linenr >= 3 &&
4173 $lines[$linenr - 3] =~ /^[ +]/ &&
4174 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004175 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004176 "void function return statements are not generally useful\n" . $hereprev);
4177 }
Joe Perches9819cf22014-06-04 16:12:09 -07004178
Joe Perches189248d2014-01-23 15:54:47 -08004179# if statements using unnecessary parentheses - ie: if ((foo == bar))
4180 if ($^V && $^V ge 5.10.0 &&
4181 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4182 my $openparens = $1;
4183 my $count = $openparens =~ tr@\(@\(@;
4184 my $msg = "";
4185 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4186 my $comp = $4; #Not $1 because of $LvalOrFunc
4187 $msg = " - maybe == should be = ?" if ($comp eq "==");
4188 WARN("UNNECESSARY_PARENTHESES",
4189 "Unnecessary parentheses$msg\n" . $herecurr);
4190 }
4191 }
4192
Joe Perchesf34e4a42015-04-16 12:44:19 -07004193# Return of what appears to be an errno should normally be negative
4194 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004195 my $name = $1;
4196 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004197 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004198 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004199 }
4200 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004201
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004202# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004203 if ($line =~ /\b(if|while|for|switch)\(/) {
4204 if (ERROR("SPACING",
4205 "space required before the open parenthesis '('\n" . $herecurr) &&
4206 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004207 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004208 s/\b(if|while|for|switch)\(/$1 \(/;
4209 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004210 }
4211
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004212# Check for illegal assignment in if conditional -- and check for trailing
4213# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004214 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004215 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4216 ctx_statement_block($linenr, $realcnt, 0)
4217 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004218 my ($stat_next) = ctx_statement_block($line_nr_next,
4219 $remain_next, $off_next);
4220 $stat_next =~ s/\n./\n /g;
4221 ##print "stat<$stat> stat_next<$stat_next>\n";
4222
4223 if ($stat_next =~ /^\s*while\b/) {
4224 # If the statement carries leading newlines,
4225 # then count those as offsets.
4226 my ($whitespace) =
4227 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4228 my $offset =
4229 statement_rawlines($whitespace) - 1;
4230
4231 $suppress_whiletrailers{$line_nr_next +
4232 $offset} = 1;
4233 }
4234 }
4235 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004236 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004237 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004238 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004239
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004240 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004241 ERROR("ASSIGN_IN_IF",
4242 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004243 }
4244
4245 # Find out what is on the end of the line after the
4246 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004247 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004248 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004249 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004250 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4251 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004252 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004253 # Find out how long the conditional actually is.
4254 my @newlines = ($c =~ /\n/gs);
4255 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004256 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004257
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004258 $stat_real = raw_line($linenr, $cond_lines)
4259 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004260 if (defined($stat_real) && $cond_lines > 1) {
4261 $stat_real = "[...]\n$stat_real";
4262 }
4263
Joe Perches000d1cc12011-07-25 17:13:25 -07004264 ERROR("TRAILING_STATEMENTS",
4265 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004266 }
4267 }
4268
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004269# Check for bitwise tests written as boolean
4270 if ($line =~ /
4271 (?:
4272 (?:\[|\(|\&\&|\|\|)
4273 \s*0[xX][0-9]+\s*
4274 (?:\&\&|\|\|)
4275 |
4276 (?:\&\&|\|\|)
4277 \s*0[xX][0-9]+\s*
4278 (?:\&\&|\|\||\)|\])
4279 )/x)
4280 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004281 WARN("HEXADECIMAL_BOOLEAN_TEST",
4282 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004283 }
4284
Andy Whitcroft8905a672007-11-28 16:21:06 -08004285# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004286 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4287 my $s = $1;
4288 $s =~ s/$;//g; # Remove any comments
4289 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004290 ERROR("TRAILING_STATEMENTS",
4291 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004292 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004293 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004294# if should not continue a brace
4295 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004296 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004297 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004298 $herecurr);
4299 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004300# case and default should not have general statements after them
4301 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4302 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004303 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004304 \s*return\s+
4305 )/xg)
4306 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004307 ERROR("TRAILING_STATEMENTS",
4308 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004309 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004310
4311 # Check for }<nl>else {, these must be at the same
4312 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004313 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4314 $previndent == $indent) {
4315 if (ERROR("ELSE_AFTER_BRACE",
4316 "else should follow close brace '}'\n" . $hereprev) &&
4317 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4318 fix_delete_line($fixlinenr - 1, $prevrawline);
4319 fix_delete_line($fixlinenr, $rawline);
4320 my $fixedline = $prevrawline;
4321 $fixedline =~ s/}\s*$//;
4322 if ($fixedline !~ /^\+\s*$/) {
4323 fix_insert_line($fixlinenr, $fixedline);
4324 }
4325 $fixedline = $rawline;
4326 $fixedline =~ s/^(.\s*)else/$1} else/;
4327 fix_insert_line($fixlinenr, $fixedline);
4328 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004329 }
4330
Joe Perches8b8856f2014-08-06 16:11:14 -07004331 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4332 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004333 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4334
4335 # Find out what is on the end of the line after the
4336 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004337 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004338 $s =~ s/\n.*//g;
4339
4340 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004341 if (ERROR("WHILE_AFTER_BRACE",
4342 "while should follow close brace '}'\n" . $hereprev) &&
4343 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4344 fix_delete_line($fixlinenr - 1, $prevrawline);
4345 fix_delete_line($fixlinenr, $rawline);
4346 my $fixedline = $prevrawline;
4347 my $trailing = $rawline;
4348 $trailing =~ s/^\+//;
4349 $trailing = trim($trailing);
4350 $fixedline =~ s/}\s*$/} $trailing/;
4351 fix_insert_line($fixlinenr, $fixedline);
4352 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004353 }
4354 }
4355
Joe Perches95e2c602013-07-03 15:05:20 -07004356#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004357 while ($line =~ m{($Constant|$Lval)}g) {
4358 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004359
4360#gcc binary extension
4361 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004362 if (WARN("GCC_BINARY_CONSTANT",
4363 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4364 $fix) {
4365 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004366 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004367 s/\b$var\b/$hexval/;
4368 }
Joe Perches95e2c602013-07-03 15:05:20 -07004369 }
4370
4371#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004372 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004373 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004374#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004375 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004376#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004377 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4378#Ignore some three character SI units explicitly, like MiB and KHz
4379 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004380 while ($var =~ m{($Ident)}g) {
4381 my $word = $1;
4382 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004383 if ($check) {
4384 seed_camelcase_includes();
4385 if (!$file && !$camelcase_file_seeded) {
4386 seed_camelcase_file($realfile);
4387 $camelcase_file_seeded = 1;
4388 }
4389 }
Joe Perches7e781f62013-09-11 14:23:55 -07004390 if (!defined $camelcase{$word}) {
4391 $camelcase{$word} = 1;
4392 CHK("CAMELCASE",
4393 "Avoid CamelCase: <$word>\n" . $herecurr);
4394 }
Joe Perches34456862013-07-03 15:05:34 -07004395 }
Joe Perches323c1262012-12-17 16:02:07 -08004396 }
4397 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004398
4399#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004400 if ($line =~ /\#\s*define.*\\\s+$/) {
4401 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4402 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4403 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004404 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004405 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004406 }
4407
Fabian Frederick0e212e02015-04-16 12:44:25 -07004408# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4409# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004410 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004411 my $file = "$1.h";
4412 my $checkfile = "include/linux/$file";
4413 if (-f "$root/$checkfile" &&
4414 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004415 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004416 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004417 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4418 if ($asminclude > 0) {
4419 if ($realfile =~ m{^arch/}) {
4420 CHK("ARCH_INCLUDE_LINUX",
4421 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4422 } else {
4423 WARN("INCLUDE_LINUX",
4424 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4425 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004426 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004427 }
4428 }
4429
Andy Whitcroft653d4872007-06-23 17:16:34 -07004430# multi-statement macros should be enclosed in a do while loop, grab the
4431# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004432# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004433 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4434 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004435 my $ln = $linenr;
4436 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004437 my ($off, $dstat, $dcond, $rest);
4438 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004439 my $has_flow_statement = 0;
4440 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004441 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004442 ctx_statement_block($linenr, $realcnt, 0);
4443 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004444 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004445 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004446
Joe Perches08a28432014-10-13 15:51:55 -07004447 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4448 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4449
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004450 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004451 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004452 $dstat =~ s/\\\n.//g;
4453 $dstat =~ s/^\s*//s;
4454 $dstat =~ s/\s*$//s;
4455
4456 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004457 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4458 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004459 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004460 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004461 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004462
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004463 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004464 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4465 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004466 {
4467 }
4468
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004469 my $exceptions = qr{
4470 $Declare|
4471 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004472 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004473 DECLARE_PER_CPU|
4474 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004475 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004476 union|
4477 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004478 \.$Ident\s*=\s*|
4479 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004480 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004481 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004482 if ($dstat ne '' &&
4483 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4484 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004485 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004486 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004487 $dstat !~ /$exceptions/ &&
4488 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004489 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004490 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004491 $dstat !~ /^for\s*$Constant$/ && # for (...)
4492 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4493 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004494 $dstat !~ /^\({/ && # ({...
4495 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004496 {
4497 $ctx =~ s/\n*$//;
4498 my $herectx = $here . "\n";
4499 my $cnt = statement_rawlines($ctx);
4500
4501 for (my $n = 0; $n < $cnt; $n++) {
4502 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004503 }
4504
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004505 if ($dstat =~ /;/) {
4506 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4507 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4508 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004509 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004510 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004511 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004512 }
Joe Perches5023d342012-12-17 16:01:47 -08004513
Joe Perches08a28432014-10-13 15:51:55 -07004514# check for macros with flow control, but without ## concatenation
4515# ## concatenation is commonly a macro that defines a function so ignore those
4516 if ($has_flow_statement && !$has_arg_concat) {
4517 my $herectx = $here . "\n";
4518 my $cnt = statement_rawlines($ctx);
4519
4520 for (my $n = 0; $n < $cnt; $n++) {
4521 $herectx .= raw_line($linenr, $n) . "\n";
4522 }
4523 WARN("MACRO_WITH_FLOW_CONTROL",
4524 "Macros with flow control statements should be avoided\n" . "$herectx");
4525 }
4526
Joe Perches481eb482012-12-17 16:01:56 -08004527# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004528
4529 } else {
4530 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004531 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4532 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004533 $line =~ /^\+.*\\$/) {
4534 WARN("LINE_CONTINUATIONS",
4535 "Avoid unnecessary line continuations\n" . $herecurr);
4536 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004537 }
4538
Joe Perchesb13edf72012-07-30 14:41:24 -07004539# do {} while (0) macro tests:
4540# single-statement macros do not need to be enclosed in do while (0) loop,
4541# macro should not end with a semicolon
4542 if ($^V && $^V ge 5.10.0 &&
4543 $realfile !~ m@/vmlinux.lds.h$@ &&
4544 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4545 my $ln = $linenr;
4546 my $cnt = $realcnt;
4547 my ($off, $dstat, $dcond, $rest);
4548 my $ctx = '';
4549 ($dstat, $dcond, $ln, $cnt, $off) =
4550 ctx_statement_block($linenr, $realcnt, 0);
4551 $ctx = $dstat;
4552
4553 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004554 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004555
4556 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4557 my $stmts = $2;
4558 my $semis = $3;
4559
4560 $ctx =~ s/\n*$//;
4561 my $cnt = statement_rawlines($ctx);
4562 my $herectx = $here . "\n";
4563
4564 for (my $n = 0; $n < $cnt; $n++) {
4565 $herectx .= raw_line($linenr, $n) . "\n";
4566 }
4567
Joe Perchesac8e97f2012-08-21 16:15:53 -07004568 if (($stmts =~ tr/;/;/) == 1 &&
4569 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004570 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4571 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4572 }
4573 if (defined $semis && $semis ne "") {
4574 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4575 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4576 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004577 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4578 $ctx =~ s/\n*$//;
4579 my $cnt = statement_rawlines($ctx);
4580 my $herectx = $here . "\n";
4581
4582 for (my $n = 0; $n < $cnt; $n++) {
4583 $herectx .= raw_line($linenr, $n) . "\n";
4584 }
4585
4586 WARN("TRAILING_SEMICOLON",
4587 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004588 }
4589 }
4590
Mike Frysinger080ba922009-01-06 14:41:25 -08004591# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4592# all assignments may have only one of the following with an assignment:
4593# .
4594# ALIGN(...)
4595# VMLINUX_SYMBOL(...)
4596 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004597 WARN("MISSING_VMLINUX_SYMBOL",
4598 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004599 }
4600
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004601# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004602 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4603 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004604 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004605 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004606 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4607 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004608 my @allowed = ();
4609 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004610 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004611 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004612 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004613 for my $chunk (@chunks) {
4614 my ($cond, $block) = @{$chunk};
4615
Andy Whitcroft773647a2008-03-28 14:15:58 -07004616 # If the condition carries leading newlines, then count those as offsets.
4617 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4618 my $offset = statement_rawlines($whitespace) - 1;
4619
Joe Perchesaad4f612012-03-23 15:02:19 -07004620 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004621 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4622
4623 # We have looked at and allowed this specific line.
4624 $suppress_ifbraces{$ln + $offset} = 1;
4625
4626 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004627 $ln += statement_rawlines($block) - 1;
4628
Andy Whitcroft773647a2008-03-28 14:15:58 -07004629 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004630
4631 $seen++ if ($block =~ /^\s*{/);
4632
Joe Perchesaad4f612012-03-23 15:02:19 -07004633 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004634 if (statement_lines($cond) > 1) {
4635 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004636 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004637 }
4638 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004639 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004640 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004641 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004642 if (statement_block_size($block) > 1) {
4643 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004644 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004645 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004646 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004647 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004648 if ($seen) {
4649 my $sum_allowed = 0;
4650 foreach (@allowed) {
4651 $sum_allowed += $_;
4652 }
4653 if ($sum_allowed == 0) {
4654 WARN("BRACES",
4655 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4656 } elsif ($sum_allowed != $allow &&
4657 $seen != $allow) {
4658 CHK("BRACES",
4659 "braces {} should be used on all arms of this statement\n" . $herectx);
4660 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004661 }
4662 }
4663 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004664 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004665 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004666 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004667
Andy Whitcroftcf655042008-03-04 14:28:20 -08004668 # Check the pre-context.
4669 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4670 #print "APW: ALLOWED: pre<$1>\n";
4671 $allowed = 1;
4672 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004673
4674 my ($level, $endln, @chunks) =
4675 ctx_statement_full($linenr, $realcnt, $-[0]);
4676
Andy Whitcroftcf655042008-03-04 14:28:20 -08004677 # Check the condition.
4678 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004679 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004680 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004681 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004682 }
4683 if (statement_lines($cond) > 1) {
4684 #print "APW: ALLOWED: cond<$cond>\n";
4685 $allowed = 1;
4686 }
4687 if ($block =~/\b(?:if|for|while)\b/) {
4688 #print "APW: ALLOWED: block<$block>\n";
4689 $allowed = 1;
4690 }
4691 if (statement_block_size($block) > 1) {
4692 #print "APW: ALLOWED: lines block<$block>\n";
4693 $allowed = 1;
4694 }
4695 # Check the post-context.
4696 if (defined $chunks[1]) {
4697 my ($cond, $block) = @{$chunks[1]};
4698 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004699 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004700 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004701 if ($block =~ /^\s*\{/) {
4702 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4703 $allowed = 1;
4704 }
4705 }
4706 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004707 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004708 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004709
Andy Whitcroftf0556632008-10-15 22:02:23 -07004710 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004711 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004712 }
4713
Joe Perches000d1cc12011-07-25 17:13:25 -07004714 WARN("BRACES",
4715 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004716 }
4717 }
4718
Joe Perches0979ae62012-12-17 16:01:59 -08004719# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004720 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004721 if (CHK("BRACES",
4722 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4723 $fix && $prevrawline =~ /^\+/) {
4724 fix_delete_line($fixlinenr - 1, $prevrawline);
4725 }
Joe Perches0979ae62012-12-17 16:01:59 -08004726 }
Joe Perches77b9a532013-07-03 15:05:29 -07004727 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004728 if (CHK("BRACES",
4729 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4730 $fix) {
4731 fix_delete_line($fixlinenr, $rawline);
4732 }
Joe Perches0979ae62012-12-17 16:01:59 -08004733 }
4734
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004735# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004736 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4737 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004738 WARN("VOLATILE",
4739 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004740 }
4741
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004742# Check for user-visible strings broken across lines, which breaks the ability
4743# to grep for the string. Make exceptions when the previous string ends in a
4744# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4745# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004746 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004747 $prevline =~ /"\s*$/ &&
4748 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4749 if (WARN("SPLIT_STRING",
4750 "quoted string split across lines\n" . $hereprev) &&
4751 $fix &&
4752 $prevrawline =~ /^\+.*"\s*$/ &&
4753 $last_coalesced_string_linenr != $linenr - 1) {
4754 my $extracted_string = get_quoted_string($line, $rawline);
4755 my $comma_close = "";
4756 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4757 $comma_close = $1;
4758 }
4759
4760 fix_delete_line($fixlinenr - 1, $prevrawline);
4761 fix_delete_line($fixlinenr, $rawline);
4762 my $fixedline = $prevrawline;
4763 $fixedline =~ s/"\s*$//;
4764 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4765 fix_insert_line($fixlinenr - 1, $fixedline);
4766 $fixedline = $rawline;
4767 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4768 if ($fixedline !~ /\+\s*$/) {
4769 fix_insert_line($fixlinenr, $fixedline);
4770 }
4771 $last_coalesced_string_linenr = $linenr;
4772 }
4773 }
4774
4775# check for missing a space in a string concatenation
4776 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4777 WARN('MISSING_SPACE',
4778 "break quoted strings at a space character\n" . $hereprev);
4779 }
4780
4781# check for spaces before a quoted newline
4782 if ($rawline =~ /^.*\".*\s\\n/) {
4783 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4784 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4785 $fix) {
4786 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4787 }
4788
4789 }
4790
Joe Perchesf17dba42014-10-13 15:51:51 -07004791# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07004792 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07004793 CHK("CONCATENATED_STRING",
4794 "Concatenated strings should use spaces between elements\n" . $herecurr);
4795 }
4796
Joe Perches90ad30e2014-12-10 15:51:59 -08004797# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07004798 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08004799 WARN("STRING_FRAGMENTS",
4800 "Consecutive strings are generally better as a single string\n" . $herecurr);
4801 }
4802
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004803# check for %L{u,d,i} in strings
4804 my $string;
4805 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4806 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4807 $string =~ s/%%/__/g;
4808 if ($string =~ /(?<!%)%L[udi]/) {
4809 WARN("PRINTF_L",
4810 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4811 last;
4812 }
4813 }
4814
4815# check for line continuations in quoted strings with odd counts of "
4816 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4817 WARN("LINE_CONTINUATIONS",
4818 "Avoid line continuations in quoted strings\n" . $herecurr);
4819 }
4820
Andy Whitcroft00df3442007-06-08 13:47:06 -07004821# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004822 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004823 CHK("REDUNDANT_CODE",
4824 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004825 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004826 }
4827
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004828# check for needless "if (<foo>) fn(<foo>)" uses
4829 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4830 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4831 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4832 WARN('NEEDLESS_IF',
Fabio Estevam15160f92014-12-10 15:51:40 -08004833 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004834 }
4835 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004836
Joe Perchesebfdc402014-08-06 16:10:27 -07004837# check for unnecessary "Out of Memory" messages
4838 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4839 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4840 (defined $1 || defined $3) &&
4841 $linenr > 3) {
4842 my $testval = $2;
4843 my $testline = $lines[$linenr - 3];
4844
4845 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4846# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4847
4848 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4849 WARN("OOM_MESSAGE",
4850 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4851 }
4852 }
4853
Joe Perchesf78d98f2014-10-13 15:52:01 -07004854# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08004855 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07004856 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4857 my $level = $1;
4858 if (WARN("UNNECESSARY_KERN_LEVEL",
4859 "Possible unnecessary $level\n" . $herecurr) &&
4860 $fix) {
4861 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4862 }
4863 }
4864
Joe Perchesabb08a52014-12-10 15:51:46 -08004865# check for mask then right shift without a parentheses
4866 if ($^V && $^V ge 5.10.0 &&
4867 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4868 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4869 WARN("MASK_THEN_SHIFT",
4870 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4871 }
4872
Joe Perchesb75ac612014-12-10 15:52:02 -08004873# check for pointer comparisons to NULL
4874 if ($^V && $^V ge 5.10.0) {
4875 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4876 my $val = $1;
4877 my $equal = "!";
4878 $equal = "" if ($4 eq "!=");
4879 if (CHK("COMPARISON_TO_NULL",
4880 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4881 $fix) {
4882 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4883 }
4884 }
4885 }
4886
Joe Perches8716de32013-09-11 14:24:05 -07004887# check for bad placement of section $InitAttribute (e.g.: __initdata)
4888 if ($line =~ /(\b$InitAttribute\b)/) {
4889 my $attr = $1;
4890 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4891 my $ptr = $1;
4892 my $var = $2;
4893 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4894 ERROR("MISPLACED_INIT",
4895 "$attr should be placed after $var\n" . $herecurr)) ||
4896 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4897 WARN("MISPLACED_INIT",
4898 "$attr should be placed after $var\n" . $herecurr))) &&
4899 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004900 $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;
Joe Perches8716de32013-09-11 14:24:05 -07004901 }
4902 }
4903 }
4904
Joe Perchese970b882013-11-12 15:10:10 -08004905# check for $InitAttributeData (ie: __initdata) with const
4906 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4907 my $attr = $1;
4908 $attr =~ /($InitAttributePrefix)(.*)/;
4909 my $attr_prefix = $1;
4910 my $attr_type = $2;
4911 if (ERROR("INIT_ATTRIBUTE",
4912 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4913 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004914 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004915 s/$InitAttributeData/${attr_prefix}initconst/;
4916 }
4917 }
4918
4919# check for $InitAttributeConst (ie: __initconst) without const
4920 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4921 my $attr = $1;
4922 if (ERROR("INIT_ATTRIBUTE",
4923 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4924 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004925 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004926 /(^\+\s*(?:static\s+))/;
4927 $lead = rtrim($1);
4928 $lead = "$lead " if ($lead !~ /^\+$/);
4929 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004930 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08004931 }
4932 }
4933
Joe Perchesc17893c2015-04-16 12:44:42 -07004934# check for __read_mostly with const non-pointer (should just be const)
4935 if ($line =~ /\b__read_mostly\b/ &&
4936 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
4937 if (ERROR("CONST_READ_MOSTLY",
4938 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
4939 $fix) {
4940 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
4941 }
4942 }
4943
Joe Perchesfbdb8132014-04-03 14:49:14 -07004944# don't use __constant_<foo> functions outside of include/uapi/
4945 if ($realfile !~ m@^include/uapi/@ &&
4946 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4947 my $constant_func = $1;
4948 my $func = $constant_func;
4949 $func =~ s/^__constant_//;
4950 if (WARN("CONSTANT_CONVERSION",
4951 "$constant_func should be $func\n" . $herecurr) &&
4952 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004953 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004954 }
4955 }
4956
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004957# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004958 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004959 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004960 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004961 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004962 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004963 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4964 }
4965 if ($delay > 2000) {
4966 WARN("LONG_UDELAY",
4967 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004968 }
4969 }
4970
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004971# warn about unexpectedly long msleep's
4972 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4973 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004974 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004975 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004976 }
4977 }
4978
Joe Perches36ec1932013-07-03 15:05:25 -07004979# check for comparisons of jiffies
4980 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4981 WARN("JIFFIES_COMPARISON",
4982 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4983 }
4984
Joe Perches9d7a34a2013-07-03 15:05:26 -07004985# check for comparisons of get_jiffies_64()
4986 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4987 WARN("JIFFIES_COMPARISON",
4988 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4989 }
4990
Andy Whitcroft00df3442007-06-08 13:47:06 -07004991# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004992# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004993# print "#ifdef in C files should be avoided\n";
4994# print "$herecurr";
4995# $clean = 0;
4996# }
4997
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004998# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004999 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005000 if (ERROR("SPACING",
5001 "exactly one space required after that #$1\n" . $herecurr) &&
5002 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005003 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005004 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5005 }
5006
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005007 }
5008
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005009# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005010 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5011 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005012 my $which = $1;
5013 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005014 CHK("UNCOMMENTED_DEFINITION",
5015 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005016 }
5017 }
5018# check for memory barriers without a comment.
5019 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5020 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005021 WARN("MEMORY_BARRIER",
5022 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005023 }
5024 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005025
Joe Perchescb426e92015-06-25 15:02:46 -07005026# check for waitqueue_active without a comment.
5027 if ($line =~ /\bwaitqueue_active\s*\(/) {
5028 if (!ctx_has_comment($first_line, $linenr)) {
5029 WARN("WAITQUEUE_ACTIVE",
5030 "waitqueue_active without comment\n" . $herecurr);
5031 }
5032 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005033
5034# Check for expedited grace periods that interrupt non-idle non-nohz
5035# online CPUs. These expedited can therefore degrade real-time response
5036# if used carelessly, and should be avoided where not absolutely
5037# needed. It is always OK to use synchronize_rcu_expedited() and
5038# synchronize_sched_expedited() at boot time (before real-time applications
5039# start) and in error situations where real-time response is compromised in
5040# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5041# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5042# Of course, nothing comes for free, and srcu_read_lock() and
5043# srcu_read_unlock() do contain full memory barriers in payment for
5044# synchronize_srcu_expedited() non-interruption properties.
5045 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5046 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5047 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5048
5049 }
5050
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005051# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005052 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005053 CHK("ARCH_DEFINES",
5054 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005055 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005056
Tobias Klauserd4977c72010-05-24 14:33:30 -07005057# Check that the storage class is at the beginning of a declaration
5058 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005059 WARN("STORAGE_CLASS",
5060 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005061 }
5062
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005063# check the location of the inline attribute, that it is between
5064# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005065 if ($line =~ /\b$Type\s+$Inline\b/ ||
5066 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005067 ERROR("INLINE_LOCATION",
5068 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005069 }
5070
Andy Whitcroft8905a672007-11-28 16:21:06 -08005071# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005072 if ($realfile !~ m@\binclude/uapi/@ &&
5073 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005074 if (WARN("INLINE",
5075 "plain inline is preferred over $1\n" . $herecurr) &&
5076 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005077 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005078
5079 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005080 }
5081
Joe Perches3d130fd2011-01-12 17:00:00 -08005082# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005083 if ($realfile !~ m@\binclude/uapi/@ &&
5084 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005085 WARN("PREFER_PACKED",
5086 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005087 }
5088
Joe Perches39b7e282011-07-25 17:13:24 -07005089# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005090 if ($realfile !~ m@\binclude/uapi/@ &&
5091 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005092 WARN("PREFER_ALIGNED",
5093 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005094 }
5095
Joe Perches5f14d3b2012-01-10 15:09:52 -08005096# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005097 if ($realfile !~ m@\binclude/uapi/@ &&
5098 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005099 if (WARN("PREFER_PRINTF",
5100 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5101 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005102 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005103
5104 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005105 }
5106
Joe Perches6061d942012-03-23 15:02:16 -07005107# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005108 if ($realfile !~ m@\binclude/uapi/@ &&
5109 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005110 if (WARN("PREFER_SCANF",
5111 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5112 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005113 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005114 }
Joe Perches6061d942012-03-23 15:02:16 -07005115 }
5116
Joe Perches619a9082014-12-10 15:51:35 -08005117# Check for __attribute__ weak, or __weak declarations (may have link issues)
5118 if ($^V && $^V ge 5.10.0 &&
5119 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5120 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5121 $line =~ /\b__weak\b/)) {
5122 ERROR("WEAK_DECLARATION",
5123 "Using weak declarations can have unintended link defects\n" . $herecurr);
5124 }
5125
Joe Perchese6176fa2015-06-25 15:02:49 -07005126# check for c99 types like uint8_t used outside of uapi/
5127 if ($realfile !~ m@\binclude/uapi/@ &&
5128 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5129 my $type = $1;
5130 if ($type =~ /\b($typeC99Typedefs)\b/) {
5131 $type = $1;
5132 my $kernel_type = 'u';
5133 $kernel_type = 's' if ($type =~ /^_*[si]/);
5134 $type =~ /(\d+)/;
5135 $kernel_type .= $1;
5136 if (CHK("PREFER_KERNEL_TYPES",
5137 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5138 $fix) {
5139 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5140 }
5141 }
5142 }
5143
Joe Perches8f53a9b2010-03-05 13:43:48 -08005144# check for sizeof(&)
5145 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005146 WARN("SIZEOF_ADDRESS",
5147 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005148 }
5149
Joe Perches66c80b62012-07-30 14:41:22 -07005150# check for sizeof without parenthesis
5151 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005152 if (WARN("SIZEOF_PARENTHESIS",
5153 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5154 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005155 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005156 }
Joe Perches66c80b62012-07-30 14:41:22 -07005157 }
5158
Joe Perches88982fe2012-12-17 16:02:00 -08005159# check for struct spinlock declarations
5160 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5161 WARN("USE_SPINLOCK_T",
5162 "struct spinlock should be spinlock_t\n" . $herecurr);
5163 }
5164
Joe Perchesa6962d72013-04-29 16:18:13 -07005165# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005166 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005167 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005168 $fmt =~ s/%%//g;
5169 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005170 if (WARN("PREFER_SEQ_PUTS",
5171 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5172 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005173 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005174 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005175 }
5176 }
5177
Andy Whitcroft554e1652012-01-10 15:09:57 -08005178# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005179 if ($^V && $^V ge 5.10.0 &&
5180 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005181 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005182
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005183 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005184 my $ms_val = $7;
5185 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005186
Andy Whitcroft554e1652012-01-10 15:09:57 -08005187 if ($ms_size =~ /^(0x|)0$/i) {
5188 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005189 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005190 } elsif ($ms_size =~ /^(0x|)1$/i) {
5191 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005192 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5193 }
5194 }
5195
Joe Perches98a9bba2014-01-23 15:54:52 -08005196# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5197 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005198 defined $stat &&
5199 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005200 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005201 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
Joe Perches98a9bba2014-01-23 15:54:52 -08005202 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005203 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
Joe Perches98a9bba2014-01-23 15:54:52 -08005204 }
5205 }
5206
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005207# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5208 if ($^V && $^V ge 5.10.0 &&
5209 defined $stat &&
5210 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5211 WARN("PREFER_ETHER_ADDR_EQUAL",
5212 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5213 }
5214
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005215# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5216# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5217 if ($^V && $^V ge 5.10.0 &&
5218 defined $stat &&
5219 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5220
5221 my $ms_val = $7;
5222
5223 if ($ms_val =~ /^(?:0x|)0+$/i) {
5224 if (WARN("PREFER_ETH_ZERO_ADDR",
5225 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5226 $fix) {
5227 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5228 }
5229 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5230 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5231 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5232 $fix) {
5233 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5234 }
5235 }
5236 }
5237
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005238# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005239 if ($^V && $^V ge 5.10.0 &&
5240 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005241 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005242 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005243 my $call = $1;
5244 my $cast1 = deparenthesize($2);
5245 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005246 my $cast2 = deparenthesize($7);
5247 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005248 my $cast;
5249
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005250 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005251 $cast = "$cast1 or $cast2";
5252 } elsif ($cast1 ne "") {
5253 $cast = $cast1;
5254 } else {
5255 $cast = $cast2;
5256 }
5257 WARN("MINMAX",
5258 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005259 }
5260 }
5261
Joe Perches4a273192012-07-30 14:41:20 -07005262# check usleep_range arguments
5263 if ($^V && $^V ge 5.10.0 &&
5264 defined $stat &&
5265 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5266 my $min = $1;
5267 my $max = $7;
5268 if ($min eq $max) {
5269 WARN("USLEEP_RANGE",
5270 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5271 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5272 $min > $max) {
5273 WARN("USLEEP_RANGE",
5274 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5275 }
5276 }
5277
Joe Perches823b7942013-11-12 15:10:15 -08005278# check for naked sscanf
5279 if ($^V && $^V ge 5.10.0 &&
5280 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005281 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005282 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5283 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5284 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5285 my $lc = $stat =~ tr@\n@@;
5286 $lc = $lc + $linenr;
5287 my $stat_real = raw_line($linenr, 0);
5288 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5289 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5290 }
5291 WARN("NAKED_SSCANF",
5292 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5293 }
5294
Joe Perchesafc819a2014-06-04 16:12:08 -07005295# check for simple sscanf that should be kstrto<foo>
5296 if ($^V && $^V ge 5.10.0 &&
5297 defined $stat &&
5298 $line =~ /\bsscanf\b/) {
5299 my $lc = $stat =~ tr@\n@@;
5300 $lc = $lc + $linenr;
5301 my $stat_real = raw_line($linenr, 0);
5302 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5303 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5304 }
5305 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5306 my $format = $6;
5307 my $count = $format =~ tr@%@%@;
5308 if ($count == 1 &&
5309 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5310 WARN("SSCANF_TO_KSTRTO",
5311 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5312 }
5313 }
5314 }
5315
Joe Perches70dc8a42013-09-11 14:23:58 -07005316# check for new externs in .h files.
5317 if ($realfile =~ /\.h$/ &&
5318 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005319 if (CHK("AVOID_EXTERNS",
5320 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005321 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005322 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005323 }
5324 }
5325
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005326# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005327 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005328 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005329 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005330 my $function_name = $1;
5331 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005332
5333 my $s = $stat;
5334 if (defined $cond) {
5335 substr($s, 0, length($cond), '');
5336 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005337 if ($s =~ /^\s*;/ &&
5338 $function_name ne 'uninitialized_var')
5339 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005340 WARN("AVOID_EXTERNS",
5341 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005342 }
5343
5344 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005345 WARN("FUNCTION_ARGUMENTS",
5346 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005347 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005348
5349 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5350 $stat =~ /^.\s*extern\s+/)
5351 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005352 WARN("AVOID_EXTERNS",
5353 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005354 }
5355
5356# checks for new __setup's
5357 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5358 my $name = $1;
5359
5360 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005361 CHK("UNDOCUMENTED_SETUP",
5362 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005363 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005364 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005365
5366# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005367 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005368 WARN("UNNECESSARY_CASTS",
5369 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005370 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005371
Joe Perchesa640d252013-07-03 15:05:21 -07005372# alloc style
5373# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5374 if ($^V && $^V ge 5.10.0 &&
5375 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5376 CHK("ALLOC_SIZEOF_STRUCT",
5377 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5378 }
5379
Joe Perches60a55362014-06-04 16:12:07 -07005380# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5381 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005382 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07005383 my $oldfunc = $3;
5384 my $a1 = $4;
5385 my $a2 = $10;
5386 my $newfunc = "kmalloc_array";
5387 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005388 my $r1 = $a1;
5389 my $r2 = $a2;
5390 if ($a1 =~ /^sizeof\s*\S/) {
5391 $r1 = $a2;
5392 $r2 = $a1;
5393 }
5394 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5395 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005396 if (WARN("ALLOC_WITH_MULTIPLY",
5397 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5398 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005399 $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;
Joe Perches60a55362014-06-04 16:12:07 -07005400
5401 }
5402 }
5403 }
5404
Joe Perches972fdea2013-04-29 16:18:12 -07005405# check for krealloc arg reuse
5406 if ($^V && $^V ge 5.10.0 &&
5407 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5408 WARN("KREALLOC_ARG_REUSE",
5409 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5410 }
5411
Joe Perches5ce59ae2013-02-21 16:44:18 -08005412# check for alloc argument mismatch
5413 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5414 WARN("ALLOC_ARRAY_ARGS",
5415 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5416 }
5417
Joe Perchescaf2a542011-01-12 16:59:56 -08005418# check for multiple semicolons
5419 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005420 if (WARN("ONE_SEMICOLON",
5421 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005423 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005424 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005425 }
5426
Joe Perches0ab90192014-12-10 15:51:57 -08005427# check for #defines like: 1 << <digit> that could be BIT(digit)
5428 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5429 my $ull = "";
5430 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5431 if (CHK("BIT_MACRO",
5432 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5433 $fix) {
5434 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5435 }
5436 }
5437
Joe Perchese81f2392014-08-06 16:11:25 -07005438# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005439 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5440 my $has_break = 0;
5441 my $has_statement = 0;
5442 my $count = 0;
5443 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005444 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005445 $prevline--;
5446 my $rline = $rawlines[$prevline - 1];
5447 my $fline = $lines[$prevline - 1];
5448 last if ($fline =~ /^\@\@/);
5449 next if ($fline =~ /^\-/);
5450 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5451 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5452 next if ($fline =~ /^.[\s$;]*$/);
5453 $has_statement = 1;
5454 $count++;
5455 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5456 }
5457 if (!$has_break && $has_statement) {
5458 WARN("MISSING_BREAK",
5459 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5460 }
5461 }
5462
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005463# check for switch/default statements without a break;
5464 if ($^V && $^V ge 5.10.0 &&
5465 defined $stat &&
5466 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5467 my $ctx = '';
5468 my $herectx = $here . "\n";
5469 my $cnt = statement_rawlines($stat);
5470 for (my $n = 0; $n < $cnt; $n++) {
5471 $herectx .= raw_line($linenr, $n) . "\n";
5472 }
5473 WARN("DEFAULT_NO_BREAK",
5474 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005475 }
5476
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005477# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005478 if ($line =~ /\b__FUNCTION__\b/) {
5479 if (WARN("USE_FUNC",
5480 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5481 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005482 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005483 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005484 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005485
Joe Perches62ec8182015-02-13 14:38:18 -08005486# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5487 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5488 ERROR("DATE_TIME",
5489 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5490 }
5491
Joe Perches2c924882012-03-23 15:02:20 -07005492# check for use of yield()
5493 if ($line =~ /\byield\s*\(\s*\)/) {
5494 WARN("YIELD",
5495 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5496 }
5497
Joe Perches179f8f42013-07-03 15:05:30 -07005498# check for comparisons against true and false
5499 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5500 my $lead = $1;
5501 my $arg = $2;
5502 my $test = $3;
5503 my $otype = $4;
5504 my $trail = $5;
5505 my $op = "!";
5506
5507 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5508
5509 my $type = lc($otype);
5510 if ($type =~ /^(?:true|false)$/) {
5511 if (("$test" eq "==" && "$type" eq "true") ||
5512 ("$test" eq "!=" && "$type" eq "false")) {
5513 $op = "";
5514 }
5515
5516 CHK("BOOL_COMPARISON",
5517 "Using comparison to $otype is error prone\n" . $herecurr);
5518
5519## maybe suggesting a correct construct would better
5520## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5521
5522 }
5523 }
5524
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005525# check for semaphores initialized locked
5526 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005527 WARN("CONSIDER_COMPLETION",
5528 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005529 }
Joe Perches6712d852012-03-23 15:02:20 -07005530
Joe Perches67d0a072011-10-31 17:13:10 -07005531# recommend kstrto* over simple_strto* and strict_strto*
5532 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005533 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005534 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005535 }
Joe Perches6712d852012-03-23 15:02:20 -07005536
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005537# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005538 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005539 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005540 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07005541 }
Joe Perches6712d852012-03-23 15:02:20 -07005542
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005543# check for various structs that are normally const (ops, kgdb, device_tree)
5544 my $const_structs = qr{
5545 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005546 address_space_operations|
5547 backlight_ops|
5548 block_device_operations|
5549 dentry_operations|
5550 dev_pm_ops|
5551 dma_map_ops|
5552 extent_io_ops|
5553 file_lock_operations|
5554 file_operations|
5555 hv_ops|
5556 ide_dma_ops|
5557 intel_dvo_dev_ops|
5558 item_operations|
5559 iwl_ops|
5560 kgdb_arch|
5561 kgdb_io|
5562 kset_uevent_ops|
5563 lock_manager_operations|
5564 microcode_ops|
5565 mtrr_ops|
5566 neigh_ops|
5567 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005568 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005569 pci_raw_ops|
5570 pipe_buf_operations|
5571 platform_hibernation_ops|
5572 platform_suspend_ops|
5573 proto_ops|
5574 rpc_pipe_ops|
5575 seq_operations|
5576 snd_ac97_build_ops|
5577 soc_pcmcia_socket_ops|
5578 stacktrace_ops|
5579 sysfs_ops|
5580 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005581 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005582 usb_mon_operations|
5583 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005584 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005585 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005586 WARN("CONST_STRUCT",
5587 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005588 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005589 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005590
5591# use of NR_CPUS is usually wrong
5592# ignore definitions of NR_CPUS and usage to define arrays as likely right
5593 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005594 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5595 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005596 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5597 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5598 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005599 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005600 WARN("NR_CPUS",
5601 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005602 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005603
Joe Perches52ea8502013-11-12 15:10:09 -08005604# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5605 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5606 ERROR("DEFINE_ARCH_HAS",
5607 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5608 }
5609
Joe Perchesacd93622015-02-13 14:38:38 -08005610# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5611 if ($^V && $^V ge 5.10.0 &&
5612 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5613 WARN("LIKELY_MISUSE",
5614 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5615 }
5616
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005617# whine mightly about in_atomic
5618 if ($line =~ /\bin_atomic\s*\(/) {
5619 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005620 ERROR("IN_ATOMIC",
5621 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005622 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005623 WARN("IN_ATOMIC",
5624 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005625 }
5626 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005627
5628# check for lockdep_set_novalidate_class
5629 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5630 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5631 if ($realfile !~ m@^kernel/lockdep@ &&
5632 $realfile !~ m@^include/linux/lockdep@ &&
5633 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005634 ERROR("LOCKDEP",
5635 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005636 }
5637 }
Dave Jones88f88312011-01-12 16:59:59 -08005638
Joe Perchesb392c642015-04-16 12:44:16 -07005639 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5640 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005641 WARN("EXPORTED_WORLD_WRITABLE",
5642 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005643 }
Joe Perches24358802014-04-03 14:49:13 -07005644
Joe Perches515a2352014-04-03 14:49:24 -07005645# Mode permission misuses where it seems decimal should be octal
5646# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5647 if ($^V && $^V ge 5.10.0 &&
5648 $line =~ /$mode_perms_search/) {
5649 foreach my $entry (@mode_permission_funcs) {
5650 my $func = $entry->[0];
5651 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005652
Joe Perches515a2352014-04-03 14:49:24 -07005653 my $skip_args = "";
5654 if ($arg_pos > 1) {
5655 $arg_pos--;
5656 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5657 }
5658 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5659 if ($line =~ /$test/) {
5660 my $val = $1;
5661 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005662
Joe Perches515a2352014-04-03 14:49:24 -07005663 if ($val !~ /^0$/ &&
5664 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5665 length($val) ne 4)) {
5666 ERROR("NON_OCTAL_PERMISSIONS",
5667 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005668 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5669 ERROR("EXPORTED_WORLD_WRITABLE",
5670 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07005671 }
Joe Perches24358802014-04-03 14:49:13 -07005672 }
5673 }
5674 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07005675
5676# validate content of MODULE_LICENSE against list from include/linux/module.h
5677 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5678 my $extracted_string = get_quoted_string($line, $rawline);
5679 my $valid_licenses = qr{
5680 GPL|
5681 GPL\ v2|
5682 GPL\ and\ additional\ rights|
5683 Dual\ BSD/GPL|
5684 Dual\ MIT/GPL|
5685 Dual\ MPL/GPL|
5686 Proprietary
5687 }x;
5688 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5689 WARN("MODULE_LICENSE",
5690 "unknown module license " . $extracted_string . "\n" . $herecurr);
5691 }
5692 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005693 }
5694
5695 # If we have no input at all, then there is nothing to report on
5696 # so just keep quiet.
5697 if ($#rawlines == -1) {
5698 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005699 }
5700
Andy Whitcroft8905a672007-11-28 16:21:06 -08005701 # In mailback mode only produce a report in the negative, for
5702 # things that appear to be patches.
5703 if ($mailback && ($clean == 1 || !$is_patch)) {
5704 exit(0);
5705 }
5706
5707 # This is not a patch, and we are are in 'no-patch' mode so
5708 # just keep quiet.
5709 if (!$chk_patch && !$is_patch) {
5710 exit(0);
5711 }
5712
Joe Perches06330fc2015-06-25 15:03:11 -07005713 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005714 ERROR("NOT_UNIFIED_DIFF",
5715 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005716 }
Joe Perches34d88152015-06-25 15:03:05 -07005717 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005718 ERROR("MISSING_SIGN_OFF",
5719 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005720 }
5721
Andy Whitcroft8905a672007-11-28 16:21:06 -08005722 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005723 if ($summary && !($clean == 1 && $quiet == 1)) {
5724 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005725 print "total: $cnt_error errors, $cnt_warn warnings, " .
5726 (($check)? "$cnt_chk checks, " : "") .
5727 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005728 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005729
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005730 if ($quiet == 0) {
5731 # If there were whitespace errors which cleanpatch can fix
5732 # then suggest that.
5733 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07005734 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07005735 print << "EOM"
5736
5737NOTE: Whitespace errors detected.
5738 You may wish to use scripts/cleanpatch or scripts/cleanfile
5739EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005740 }
5741 }
5742
Joe Perchesd752fcc2014-08-06 16:11:05 -07005743 if ($clean == 0 && $fix &&
5744 ("@rawlines" ne "@fixed" ||
5745 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005746 my $newfile = $filename;
5747 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005748 my $linecount = 0;
5749 my $f;
5750
Joe Perchesd752fcc2014-08-06 16:11:05 -07005751 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5752
Joe Perches3705ce52013-07-03 15:05:31 -07005753 open($f, '>', $newfile)
5754 or die "$P: Can't open $newfile for write\n";
5755 foreach my $fixed_line (@fixed) {
5756 $linecount++;
5757 if ($file) {
5758 if ($linecount > 3) {
5759 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005760 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005761 }
5762 } else {
5763 print $f $fixed_line . "\n";
5764 }
5765 }
5766 close($f);
5767
5768 if (!$quiet) {
5769 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07005770
Joe Perches3705ce52013-07-03 15:05:31 -07005771Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5772
5773Do _NOT_ trust the results written to this file.
5774Do _NOT_ submit these changes without inspecting them for correctness.
5775
5776This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5777No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07005778EOM
5779 }
5780 }
5781
Joe Perchesd8469f12015-06-25 15:03:00 -07005782 if ($quiet == 0) {
5783 print "\n";
5784 if ($clean == 1) {
5785 print "$vname has no obvious style problems and is ready for submission.\n";
5786 } else {
5787 print "$vname has style problems, please review.\n";
5788 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005789 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005790 return $clean;
5791}