blob: 4cf4473ebf17cfc433c5ebc3e0d02e8567d9195f [file] [log] [blame]
Andy Whitcroft0a920b5b2007-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 Whitcroft00df344f2007-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 Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700135GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700136 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700181if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700182 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-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 Perches58cb3cf2013-09-11 14:24:04 -0700206 if ($quiet == 0 && 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 Whitcroft0a920b5b2007-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 Perchese970b8842013-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 Whitcroft00df344f2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700770}
771
Joe Perchesd8469f12015-06-25 15:03:00 -0700772if (!$quiet) {
773 if ($^V lt 5.10.0) {
774 print << "EOM"
775
776NOTE: perl $^V is not modern enough to detect all possible issues.
777 An upgrade to at least perl v5.10.0 is suggested.
778EOM
779 }
780 if ($exit) {
781 print << "EOM"
782
783NOTE: If any of the errors are false positives, please report
784 them to the maintainer, see CHECKPATCH in MAINTAINERS.
785EOM
786 }
787}
788
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700789exit($exit);
790
791sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700792 my ($root) = @_;
793
794 my @tree_check = (
795 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
796 "README", "Documentation", "arch", "include", "drivers",
797 "fs", "init", "ipc", "kernel", "lib", "scripts",
798 );
799
800 foreach my $check (@tree_check) {
801 if (! -e $root . '/' . $check) {
802 return 0;
803 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700804 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700805 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700806}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700807
Joe Perches20112472011-07-25 17:13:23 -0700808sub parse_email {
809 my ($formatted_email) = @_;
810
811 my $name = "";
812 my $address = "";
813 my $comment = "";
814
815 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
816 $name = $1;
817 $address = $2;
818 $comment = $3 if defined $3;
819 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
820 $address = $1;
821 $comment = $2 if defined $2;
822 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
823 $address = $1;
824 $comment = $2 if defined $2;
825 $formatted_email =~ s/$address.*$//;
826 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700827 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700828 $name =~ s/^\"|\"$//g;
829 # If there's a name left after stripping spaces and
830 # leading quotes, and the address doesn't have both
831 # leading and trailing angle brackets, the address
832 # is invalid. ie:
833 # "joe smith joe@smith.com" bad
834 # "joe smith <joe@smith.com" bad
835 if ($name ne "" && $address !~ /^<[^>]+>$/) {
836 $name = "";
837 $address = "";
838 $comment = "";
839 }
840 }
841
Joe Perches3705ce52013-07-03 15:05:31 -0700842 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700843 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700844 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700845 $address =~ s/^\<|\>$//g;
846
847 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
848 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
849 $name = "\"$name\"";
850 }
851
852 return ($name, $address, $comment);
853}
854
855sub format_email {
856 my ($name, $address) = @_;
857
858 my $formatted_email;
859
Joe Perches3705ce52013-07-03 15:05:31 -0700860 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700861 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700862 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700863
864 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
865 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
866 $name = "\"$name\"";
867 }
868
869 if ("$name" eq "") {
870 $formatted_email = "$address";
871 } else {
872 $formatted_email = "$name <$address>";
873 }
874
875 return $formatted_email;
876}
877
Joe Perchesd311cd42014-08-06 16:10:57 -0700878sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700879 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700880
Joe Perchesbd474ca2014-08-06 16:11:10 -0700881 foreach my $path (split(/:/, $ENV{PATH})) {
882 if (-e "$path/$bin") {
883 return "$path/$bin";
884 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700885 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700886
Joe Perchesbd474ca2014-08-06 16:11:10 -0700887 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700888}
889
Joe Perches000d1cc12011-07-25 17:13:25 -0700890sub which_conf {
891 my ($conf) = @_;
892
893 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
894 if (-e "$path/$conf") {
895 return "$path/$conf";
896 }
897 }
898
899 return "";
900}
901
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700902sub expand_tabs {
903 my ($str) = @_;
904
905 my $res = '';
906 my $n = 0;
907 for my $c (split(//, $str)) {
908 if ($c eq "\t") {
909 $res .= ' ';
910 $n++;
911 for (; ($n % 8) != 0; $n++) {
912 $res .= ' ';
913 }
914 next;
915 }
916 $res .= $c;
917 $n++;
918 }
919
920 return $res;
921}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700922sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700923 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700924 return $res;
925}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700926
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700927sub line_stats {
928 my ($line) = @_;
929
930 # Drop the diff line leader and expand tabs
931 $line =~ s/^.//;
932 $line = expand_tabs($line);
933
934 # Pick the indent from the front of the line.
935 my ($white) = ($line =~ /^(\s*)/);
936
937 return (length($line), length($white));
938}
939
Andy Whitcroft773647a2008-03-28 14:15:58 -0700940my $sanitise_quote = '';
941
942sub sanitise_line_reset {
943 my ($in_comment) = @_;
944
945 if ($in_comment) {
946 $sanitise_quote = '*/';
947 } else {
948 $sanitise_quote = '';
949 }
950}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700951sub sanitise_line {
952 my ($line) = @_;
953
954 my $res = '';
955 my $l = '';
956
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800957 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700958 my $off = 0;
959 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700960
Andy Whitcroft773647a2008-03-28 14:15:58 -0700961 # Always copy over the diff marker.
962 $res = substr($line, 0, 1);
963
964 for ($off = 1; $off < length($line); $off++) {
965 $c = substr($line, $off, 1);
966
967 # Comments we are wacking completly including the begin
968 # and end, all to $;.
969 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
970 $sanitise_quote = '*/';
971
972 substr($res, $off, 2, "$;$;");
973 $off++;
974 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800975 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700976 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700977 $sanitise_quote = '';
978 substr($res, $off, 2, "$;$;");
979 $off++;
980 next;
981 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700982 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
983 $sanitise_quote = '//';
984
985 substr($res, $off, 2, $sanitise_quote);
986 $off++;
987 next;
988 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700989
990 # A \ in a string means ignore the next character.
991 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
992 $c eq "\\") {
993 substr($res, $off, 2, 'XX');
994 $off++;
995 next;
996 }
997 # Regular quotes.
998 if ($c eq "'" || $c eq '"') {
999 if ($sanitise_quote eq '') {
1000 $sanitise_quote = $c;
1001
1002 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001003 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001004 } elsif ($sanitise_quote eq $c) {
1005 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001006 }
1007 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001009 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001010 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1011 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001012 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1013 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001014 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1015 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001016 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001017 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001018 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001019 }
1020
Daniel Walker113f04a2009-09-21 17:04:35 -07001021 if ($sanitise_quote eq '//') {
1022 $sanitise_quote = '';
1023 }
1024
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001025 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001026 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001027 my $clean = 'X' x length($1);
1028 $res =~ s@\<.*\>@<$clean>@;
1029
1030 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001031 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001032 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001033 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001034 }
1035
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001036 return $res;
1037}
1038
Joe Perchesa6962d72013-04-29 16:18:13 -07001039sub get_quoted_string {
1040 my ($line, $rawline) = @_;
1041
Joe Perches33acb542015-06-25 15:02:54 -07001042 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001043 return substr($rawline, $-[0], $+[0] - $-[0]);
1044}
1045
Andy Whitcroft8905a672007-11-28 16:21:06 -08001046sub ctx_statement_block {
1047 my ($linenr, $remain, $off) = @_;
1048 my $line = $linenr - 1;
1049 my $blk = '';
1050 my $soff = $off;
1051 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001053
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001054 my $loff = 0;
1055
Andy Whitcroft8905a672007-11-28 16:21:06 -08001056 my $type = '';
1057 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001058 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001059 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001060 my $c;
1061 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001062
1063 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001064 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001065 @stack = (['', 0]) if ($#stack == -1);
1066
Andy Whitcroft773647a2008-03-28 14:15:58 -07001067 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001068 # If we are about to drop off the end, pull in more
1069 # context.
1070 if ($off >= $len) {
1071 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001072 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001073 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001074 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001075 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001076 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001077 $len = length($blk);
1078 $line++;
1079 last;
1080 }
1081 # Bail if there is no further context.
1082 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001083 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001084 last;
1085 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001086 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1087 $level++;
1088 $type = '#';
1089 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001090 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001091 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001092 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001093 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001094
Andy Whitcroft773647a2008-03-28 14:15:58 -07001095 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001096
1097 # Handle nested #if/#else.
1098 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1099 push(@stack, [ $type, $level ]);
1100 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1101 ($type, $level) = @{$stack[$#stack - 1]};
1102 } elsif ($remainder =~ /^#\s*endif\b/) {
1103 ($type, $level) = @{pop(@stack)};
1104 }
1105
Andy Whitcroft8905a672007-11-28 16:21:06 -08001106 # Statement ends at the ';' or a close '}' at the
1107 # outermost level.
1108 if ($level == 0 && $c eq ';') {
1109 last;
1110 }
1111
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001112 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001113 if ($level == 0 && $coff_set == 0 &&
1114 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1115 $remainder =~ /^(else)(?:\s|{)/ &&
1116 $remainder !~ /^else\s+if\b/) {
1117 $coff = $off + length($1) - 1;
1118 $coff_set = 1;
1119 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1120 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001121 }
1122
Andy Whitcroft8905a672007-11-28 16:21:06 -08001123 if (($type eq '' || $type eq '(') && $c eq '(') {
1124 $level++;
1125 $type = '(';
1126 }
1127 if ($type eq '(' && $c eq ')') {
1128 $level--;
1129 $type = ($level != 0)? '(' : '';
1130
1131 if ($level == 0 && $coff < $soff) {
1132 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001133 $coff_set = 1;
1134 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001135 }
1136 }
1137 if (($type eq '' || $type eq '{') && $c eq '{') {
1138 $level++;
1139 $type = '{';
1140 }
1141 if ($type eq '{' && $c eq '}') {
1142 $level--;
1143 $type = ($level != 0)? '{' : '';
1144
1145 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001146 if (substr($blk, $off + 1, 1) eq ';') {
1147 $off++;
1148 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001149 last;
1150 }
1151 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001152 # Preprocessor commands end at the newline unless escaped.
1153 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1154 $level--;
1155 $type = '';
1156 $off++;
1157 last;
1158 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001159 $off++;
1160 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001161 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001162 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001163 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001164 $line++;
1165 $remain--;
1166 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001167
1168 my $statement = substr($blk, $soff, $off - $soff + 1);
1169 my $condition = substr($blk, $soff, $coff - $soff + 1);
1170
1171 #warn "STATEMENT<$statement>\n";
1172 #warn "CONDITION<$condition>\n";
1173
Andy Whitcroft773647a2008-03-28 14:15:58 -07001174 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001175
1176 return ($statement, $condition,
1177 $line, $remain + 1, $off - $loff + 1, $level);
1178}
1179
Andy Whitcroftcf655042008-03-04 14:28:20 -08001180sub statement_lines {
1181 my ($stmt) = @_;
1182
1183 # Strip the diff line prefixes and rip blank lines at start and end.
1184 $stmt =~ s/(^|\n)./$1/g;
1185 $stmt =~ s/^\s*//;
1186 $stmt =~ s/\s*$//;
1187
1188 my @stmt_lines = ($stmt =~ /\n/g);
1189
1190 return $#stmt_lines + 2;
1191}
1192
1193sub statement_rawlines {
1194 my ($stmt) = @_;
1195
1196 my @stmt_lines = ($stmt =~ /\n/g);
1197
1198 return $#stmt_lines + 2;
1199}
1200
1201sub statement_block_size {
1202 my ($stmt) = @_;
1203
1204 $stmt =~ s/(^|\n)./$1/g;
1205 $stmt =~ s/^\s*{//;
1206 $stmt =~ s/}\s*$//;
1207 $stmt =~ s/^\s*//;
1208 $stmt =~ s/\s*$//;
1209
1210 my @stmt_lines = ($stmt =~ /\n/g);
1211 my @stmt_statements = ($stmt =~ /;/g);
1212
1213 my $stmt_lines = $#stmt_lines + 2;
1214 my $stmt_statements = $#stmt_statements + 1;
1215
1216 if ($stmt_lines > $stmt_statements) {
1217 return $stmt_lines;
1218 } else {
1219 return $stmt_statements;
1220 }
1221}
1222
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001223sub ctx_statement_full {
1224 my ($linenr, $remain, $off) = @_;
1225 my ($statement, $condition, $level);
1226
1227 my (@chunks);
1228
Andy Whitcroftcf655042008-03-04 14:28:20 -08001229 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001230 ($statement, $condition, $linenr, $remain, $off, $level) =
1231 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001232 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001233 push(@chunks, [ $condition, $statement ]);
1234 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1235 return ($level, $linenr, @chunks);
1236 }
1237
1238 # Pull in the following conditional/block pairs and see if they
1239 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001240 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001241 ($statement, $condition, $linenr, $remain, $off, $level) =
1242 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001243 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001244 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001245 #print "C: push\n";
1246 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001247 }
1248
1249 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001250}
1251
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001252sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001253 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001254 my $line;
1255 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001256 my $blk = '';
1257 my @o;
1258 my @c;
1259 my @res = ();
1260
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001261 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001262 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001263 for ($line = $start; $remain > 0; $line++) {
1264 next if ($rawlines[$line] =~ /^-/);
1265 $remain--;
1266
1267 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001268
1269 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001270 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001271 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001272 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001273 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001274 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001275 $level = pop(@stack);
1276 }
1277
Andy Whitcroft01464f32010-10-26 14:23:19 -07001278 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001279 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1280 if ($off > 0) {
1281 $off--;
1282 next;
1283 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001284
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001285 if ($c eq $close && $level > 0) {
1286 $level--;
1287 last if ($level == 0);
1288 } elsif ($c eq $open) {
1289 $level++;
1290 }
1291 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001292
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001293 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001294 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001295 }
1296
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001297 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001298 }
1299
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001300 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001301}
1302sub ctx_block_outer {
1303 my ($linenr, $remain) = @_;
1304
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001305 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1306 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001307}
1308sub ctx_block {
1309 my ($linenr, $remain) = @_;
1310
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001311 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1312 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001313}
1314sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001315 my ($linenr, $remain, $off) = @_;
1316
1317 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1318 return @r;
1319}
1320sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001321 my ($linenr, $remain) = @_;
1322
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001323 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001324}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001325sub ctx_statement_level {
1326 my ($linenr, $remain, $off) = @_;
1327
1328 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1329}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001330
1331sub ctx_locate_comment {
1332 my ($first_line, $end_line) = @_;
1333
1334 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001335 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001336 return $current_comment if (defined $current_comment);
1337
1338 # Look through the context and try and figure out if there is a
1339 # comment.
1340 my $in_comment = 0;
1341 $current_comment = '';
1342 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001343 my $line = $rawlines[$linenr - 1];
1344 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001345 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1346 $in_comment = 1;
1347 }
1348 if ($line =~ m@/\*@) {
1349 $in_comment = 1;
1350 }
1351 if (!$in_comment && $current_comment ne '') {
1352 $current_comment = '';
1353 }
1354 $current_comment .= $line . "\n" if ($in_comment);
1355 if ($line =~ m@\*/@) {
1356 $in_comment = 0;
1357 }
1358 }
1359
1360 chomp($current_comment);
1361 return($current_comment);
1362}
1363sub ctx_has_comment {
1364 my ($first_line, $end_line) = @_;
1365 my $cmt = ctx_locate_comment($first_line, $end_line);
1366
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001367 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001368 ##print "CMMT: $cmt\n";
1369
1370 return ($cmt ne '');
1371}
1372
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001373sub raw_line {
1374 my ($linenr, $cnt) = @_;
1375
1376 my $offset = $linenr - 1;
1377 $cnt++;
1378
1379 my $line;
1380 while ($cnt) {
1381 $line = $rawlines[$offset++];
1382 next if (defined($line) && $line =~ /^-/);
1383 $cnt--;
1384 }
1385
1386 return $line;
1387}
1388
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001389sub cat_vet {
1390 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001391 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001392
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001393 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001394 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1395 $res .= $1;
1396 if ($2 ne '') {
1397 $coded = sprintf("^%c", unpack('C', $2) + 64);
1398 $res .= $coded;
1399 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001400 }
1401 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001402
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001403 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001404}
1405
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001406my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001407my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001408my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001409my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001410
1411sub annotate_reset {
1412 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001413 $av_pending = '_';
1414 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001415 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001416}
1417
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001418sub annotate_values {
1419 my ($stream, $type) = @_;
1420
1421 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001422 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001423 my $cur = $stream;
1424
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001425 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001426
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001427 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001428 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001429 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001430 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001431 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001432 print "WS($1)\n" if ($dbg_values > 1);
1433 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001434 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001435 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001436 }
1437
Florian Micklerc023e4732011-01-12 16:59:58 -08001438 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001439 print "CAST($1)\n" if ($dbg_values > 1);
1440 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001441 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001442
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001443 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001444 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001445 $type = 'T';
1446
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001447 } elsif ($cur =~ /^($Modifier)\s*/) {
1448 print "MODIFIER($1)\n" if ($dbg_values > 1);
1449 $type = 'T';
1450
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001451 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001452 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001453 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001454 push(@av_paren_type, $type);
1455 if ($2 ne '') {
1456 $av_pending = 'N';
1457 }
1458 $type = 'E';
1459
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001460 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001461 print "UNDEF($1)\n" if ($dbg_values > 1);
1462 $av_preprocessor = 1;
1463 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001464
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001465 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001466 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001467 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001468
1469 push(@av_paren_type, $type);
1470 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001471 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001472
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001473 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001474 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1475 $av_preprocessor = 1;
1476
1477 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1478
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001479 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001480
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001481 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001482 print "PRE_END($1)\n" if ($dbg_values > 1);
1483
1484 $av_preprocessor = 1;
1485
1486 # Assume all arms of the conditional end as this
1487 # one does, and continue as if the #endif was not here.
1488 pop(@av_paren_type);
1489 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001490 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001491
1492 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001493 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001494
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001495 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1496 print "ATTR($1)\n" if ($dbg_values > 1);
1497 $av_pending = $type;
1498 $type = 'N';
1499
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001500 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001501 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001502 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001503 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001504 }
1505 $type = 'N';
1506
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001507 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001508 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001509 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001510 $type = 'N';
1511
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001512 } elsif ($cur =~/^(case)/o) {
1513 print "CASE($1)\n" if ($dbg_values > 1);
1514 $av_pend_colon = 'C';
1515 $type = 'N';
1516
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001517 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001518 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001519 $type = 'N';
1520
1521 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001522 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001523 push(@av_paren_type, $av_pending);
1524 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001525 $type = 'N';
1526
1527 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001528 my $new_type = pop(@av_paren_type);
1529 if ($new_type ne '_') {
1530 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001531 print "PAREN('$1') -> $type\n"
1532 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001533 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001534 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001535 }
1536
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001537 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001538 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001539 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001540 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001541
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001542 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1543 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001544 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001545 } elsif ($type eq 'E') {
1546 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001547 }
1548 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1549 $type = 'V';
1550
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001551 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001552 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553 $type = 'V';
1554
1555 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001556 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001557 $type = 'N';
1558
Andy Whitcroftcf655042008-03-04 14:28:20 -08001559 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001560 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001561 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001562 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001563
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001564 } elsif ($cur =~/^(,)/) {
1565 print "COMMA($1)\n" if ($dbg_values > 1);
1566 $type = 'C';
1567
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001568 } elsif ($cur =~ /^(\?)/o) {
1569 print "QUESTION($1)\n" if ($dbg_values > 1);
1570 $type = 'N';
1571
1572 } elsif ($cur =~ /^(:)/o) {
1573 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1574
1575 substr($var, length($res), 1, $av_pend_colon);
1576 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1577 $type = 'E';
1578 } else {
1579 $type = 'N';
1580 }
1581 $av_pend_colon = 'O';
1582
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001583 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001584 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001585 $type = 'N';
1586
Andy Whitcroft0d413862008-10-15 22:02:16 -07001587 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001588 my $variant;
1589
1590 print "OPV($1)\n" if ($dbg_values > 1);
1591 if ($type eq 'V') {
1592 $variant = 'B';
1593 } else {
1594 $variant = 'U';
1595 }
1596
1597 substr($var, length($res), 1, $variant);
1598 $type = 'N';
1599
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001600 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001601 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001602 if ($1 ne '++' && $1 ne '--') {
1603 $type = 'N';
1604 }
1605
1606 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001607 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001608 }
1609 if (defined $1) {
1610 $cur = substr($cur, length($1));
1611 $res .= $type x length($1);
1612 }
1613 }
1614
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001615 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001616}
1617
Andy Whitcroft8905a672007-11-28 16:21:06 -08001618sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001619 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001620 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001621 ^(?:
1622 $Modifier|
1623 $Storage|
1624 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001625 DEFINE_\S+
1626 )$|
1627 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001628 goto|
1629 return|
1630 case|
1631 else|
1632 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001633 do|
1634 \#|
1635 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001636 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001637 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001638 )}x;
1639 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1640 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001641 # Check for modifiers.
1642 $possible =~ s/\s*$Storage\s*//g;
1643 $possible =~ s/\s*$Sparse\s*//g;
1644 if ($possible =~ /^\s*$/) {
1645
1646 } elsif ($possible =~ /\s/) {
1647 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001648 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001649 if ($modifier !~ $notPermitted) {
1650 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001651 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001652 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001653 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001654
1655 } else {
1656 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001657 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001658 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001659 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001660 } else {
1661 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001662 }
1663}
1664
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001665my $prefix = '';
1666
Joe Perches000d1cc12011-07-25 17:13:25 -07001667sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001668 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001669
Joe Perchescbec18a2014-04-03 14:49:19 -07001670 return defined $use_type{$type} if (scalar keys %use_type > 0);
1671
1672 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001673}
1674
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001675sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001676 my ($level, $type, $msg) = @_;
1677
1678 if (!show_type($type) ||
1679 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001680 return 0;
1681 }
Joe Perches57230292015-06-25 15:03:03 -07001682 my $output = '';
1683 if (-t STDOUT && $color) {
1684 if ($level eq 'ERROR') {
1685 $output .= RED;
1686 } elsif ($level eq 'WARNING') {
1687 $output .= YELLOW;
1688 } else {
1689 $output .= GREEN;
1690 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001691 }
Joe Perches57230292015-06-25 15:03:03 -07001692 $output .= $prefix . $level . ':';
1693 if ($show_types) {
1694 $output .= BLUE if (-t STDOUT && $color);
1695 $output .= "$type:";
1696 }
1697 $output .= RESET if (-t STDOUT && $color);
1698 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001699
1700 if ($showfile) {
1701 my @lines = split("\n", $output, -1);
1702 splice(@lines, 1, 1);
1703 $output = join("\n", @lines);
1704 }
Joe Perches57230292015-06-25 15:03:03 -07001705 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001706
Joe Perches57230292015-06-25 15:03:03 -07001707 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001708
1709 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001710}
Joe Perchescbec18a2014-04-03 14:49:19 -07001711
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001712sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001713 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001714}
Joe Perches000d1cc12011-07-25 17:13:25 -07001715
Joe Perchesd752fcc2014-08-06 16:11:05 -07001716sub fixup_current_range {
1717 my ($lineRef, $offset, $length) = @_;
1718
1719 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1720 my $o = $1;
1721 my $l = $2;
1722 my $no = $o + $offset;
1723 my $nl = $l + $length;
1724 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1725 }
1726}
1727
1728sub fix_inserted_deleted_lines {
1729 my ($linesRef, $insertedRef, $deletedRef) = @_;
1730
1731 my $range_last_linenr = 0;
1732 my $delta_offset = 0;
1733
1734 my $old_linenr = 0;
1735 my $new_linenr = 0;
1736
1737 my $next_insert = 0;
1738 my $next_delete = 0;
1739
1740 my @lines = ();
1741
1742 my $inserted = @{$insertedRef}[$next_insert++];
1743 my $deleted = @{$deletedRef}[$next_delete++];
1744
1745 foreach my $old_line (@{$linesRef}) {
1746 my $save_line = 1;
1747 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001748 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001749 $delta_offset = 0;
1750 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1751 $range_last_linenr = $new_linenr;
1752 fixup_current_range(\$line, $delta_offset, 0);
1753 }
1754
1755 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1756 $deleted = @{$deletedRef}[$next_delete++];
1757 $save_line = 0;
1758 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1759 }
1760
1761 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1762 push(@lines, ${$inserted}{'LINE'});
1763 $inserted = @{$insertedRef}[$next_insert++];
1764 $new_linenr++;
1765 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1766 }
1767
1768 if ($save_line) {
1769 push(@lines, $line);
1770 $new_linenr++;
1771 }
1772
1773 $old_linenr++;
1774 }
1775
1776 return @lines;
1777}
1778
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001779sub fix_insert_line {
1780 my ($linenr, $line) = @_;
1781
1782 my $inserted = {
1783 LINENR => $linenr,
1784 LINE => $line,
1785 };
1786 push(@fixed_inserted, $inserted);
1787}
1788
1789sub fix_delete_line {
1790 my ($linenr, $line) = @_;
1791
1792 my $deleted = {
1793 LINENR => $linenr,
1794 LINE => $line,
1795 };
1796
1797 push(@fixed_deleted, $deleted);
1798}
1799
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001800sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001801 my ($type, $msg) = @_;
1802
1803 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001804 our $clean = 0;
1805 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001806 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 }
Joe Perches3705ce52013-07-03 15:05:31 -07001808 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001809}
1810sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001811 my ($type, $msg) = @_;
1812
1813 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001814 our $clean = 0;
1815 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001816 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 }
Joe Perches3705ce52013-07-03 15:05:31 -07001818 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001819}
1820sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001821 my ($type, $msg) = @_;
1822
1823 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001824 our $clean = 0;
1825 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001826 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001827 }
Joe Perches3705ce52013-07-03 15:05:31 -07001828 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001829}
1830
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001831sub check_absolute_file {
1832 my ($absolute, $herecurr) = @_;
1833 my $file = $absolute;
1834
1835 ##print "absolute<$absolute>\n";
1836
1837 # See if any suffix of this path is a path within the tree.
1838 while ($file =~ s@^[^/]*/@@) {
1839 if (-f "$root/$file") {
1840 ##print "file<$file>\n";
1841 last;
1842 }
1843 }
1844 if (! -f _) {
1845 return 0;
1846 }
1847
1848 # It is, so see if the prefix is acceptable.
1849 my $prefix = $absolute;
1850 substr($prefix, -length($file)) = '';
1851
1852 ##print "prefix<$prefix>\n";
1853 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001854 WARN("USE_RELATIVE_PATH",
1855 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001856 }
1857}
1858
Joe Perches3705ce52013-07-03 15:05:31 -07001859sub trim {
1860 my ($string) = @_;
1861
Joe Perchesb34c6482013-09-11 14:24:01 -07001862 $string =~ s/^\s+|\s+$//g;
1863
1864 return $string;
1865}
1866
1867sub ltrim {
1868 my ($string) = @_;
1869
1870 $string =~ s/^\s+//;
1871
1872 return $string;
1873}
1874
1875sub rtrim {
1876 my ($string) = @_;
1877
1878 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001879
1880 return $string;
1881}
1882
Joe Perches52ea8502013-11-12 15:10:09 -08001883sub string_find_replace {
1884 my ($string, $find, $replace) = @_;
1885
1886 $string =~ s/$find/$replace/g;
1887
1888 return $string;
1889}
1890
Joe Perches3705ce52013-07-03 15:05:31 -07001891sub tabify {
1892 my ($leading) = @_;
1893
1894 my $source_indent = 8;
1895 my $max_spaces_before_tab = $source_indent - 1;
1896 my $spaces_to_tab = " " x $source_indent;
1897
1898 #convert leading spaces to tabs
1899 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1900 #Remove spaces before a tab
1901 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1902
1903 return "$leading";
1904}
1905
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001906sub pos_last_openparen {
1907 my ($line) = @_;
1908
1909 my $pos = 0;
1910
1911 my $opens = $line =~ tr/\(/\(/;
1912 my $closes = $line =~ tr/\)/\)/;
1913
1914 my $last_openparen = 0;
1915
1916 if (($opens == 0) || ($closes >= $opens)) {
1917 return -1;
1918 }
1919
1920 my $len = length($line);
1921
1922 for ($pos = 0; $pos < $len; $pos++) {
1923 my $string = substr($line, $pos);
1924 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1925 $pos += length($1) - 1;
1926 } elsif (substr($line, $pos, 1) eq '(') {
1927 $last_openparen = $pos;
1928 } elsif (index($string, '(') == -1) {
1929 last;
1930 }
1931 }
1932
Joe Perches91cb5192014-04-03 14:49:32 -07001933 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001934}
1935
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001936sub process {
1937 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001938
1939 my $linenr=0;
1940 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001941 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001942 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001943 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001944
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001945 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001946 my $indent;
1947 my $previndent=0;
1948 my $stashindent=0;
1949
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001950 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001951 my $signoff = 0;
1952 my $is_patch = 0;
1953
Joe Perches29ee1b02014-08-06 16:10:35 -07001954 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001955 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches2a076f42015-04-16 12:44:28 -07001956 my $commit_log_long_line = 0;
Joe Perches13f19372014-08-06 16:10:59 -07001957 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001958 my $non_utf8_charset = 0;
1959
Joe Perches365dd4e2014-08-06 16:10:42 -07001960 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08001961 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07001962
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001963 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001964 our $cnt_lines = 0;
1965 our $cnt_error = 0;
1966 our $cnt_warn = 0;
1967 our $cnt_chk = 0;
1968
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001969 # Trace the real file/line as we go.
1970 my $realfile = '';
1971 my $realline = 0;
1972 my $realcnt = 0;
1973 my $here = '';
1974 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001975 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001976 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001977 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001978
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001979 my $prev_values = 'E';
1980
1981 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001982 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001983 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001984 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001985 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001986
Joe Perches7e51f192013-09-11 14:23:57 -07001987 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001988
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001989 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001990 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001991 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001992 my @setup_docs = ();
1993 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001994
Joe Perchesd8b07712013-11-12 15:10:06 -08001995 my $camelcase_file_seeded = 0;
1996
Andy Whitcroft773647a2008-03-28 14:15:58 -07001997 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001998 my $line;
1999 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002000 $linenr++;
2001 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002002
Joe Perches3705ce52013-07-03 15:05:31 -07002003 push(@fixed, $rawline) if ($fix);
2004
Andy Whitcroft773647a2008-03-28 14:15:58 -07002005 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002006 $setup_docs = 0;
2007 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2008 $setup_docs = 1;
2009 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002010 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002011 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002012 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2013 $realline=$1-1;
2014 if (defined $2) {
2015 $realcnt=$3+1;
2016 } else {
2017 $realcnt=1+1;
2018 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002019 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002020
2021 # Guestimate if this is a continuing comment. Run
2022 # the context looking for a comment "edge". If this
2023 # edge is a close comment then we must be in a comment
2024 # at context start.
2025 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002026 my $cnt = $realcnt;
2027 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2028 next if (defined $rawlines[$ln - 1] &&
2029 $rawlines[$ln - 1] =~ /^-/);
2030 $cnt--;
2031 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002032 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002033 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2034 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2035 ($edge) = $1;
2036 last;
2037 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002038 }
2039 if (defined $edge && $edge eq '*/') {
2040 $in_comment = 1;
2041 }
2042
2043 # Guestimate if this is a continuing comment. If this
2044 # is the start of a diff block and this line starts
2045 # ' *' then it is very likely a comment.
2046 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002047 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002048 {
2049 $in_comment = 1;
2050 }
2051
2052 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2053 sanitise_line_reset($in_comment);
2054
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002055 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002056 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002057 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002058 $line = sanitise_line($rawline);
2059 }
2060 push(@lines, $line);
2061
2062 if ($realcnt > 1) {
2063 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2064 } else {
2065 $realcnt = 0;
2066 }
2067
2068 #print "==>$rawline\n";
2069 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002070
2071 if ($setup_docs && $line =~ /^\+/) {
2072 push(@setup_docs, $line);
2073 }
2074 }
2075
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002076 $prefix = '';
2077
Andy Whitcroft773647a2008-03-28 14:15:58 -07002078 $realcnt = 0;
2079 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002080 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002081 foreach my $line (@lines) {
2082 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002083 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002084 my $sline = $line; #copy of $line
2085 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002086
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002087 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002088
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002089#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002090 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002091 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002092 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002093 $realline=$1-1;
2094 if (defined $2) {
2095 $realcnt=$3+1;
2096 } else {
2097 $realcnt=1+1;
2098 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002099 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002100 $prev_values = 'E';
2101
Andy Whitcroft773647a2008-03-28 14:15:58 -07002102 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002103 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002104 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002105 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002106 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002107
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002108# track the line number as we move through the hunk, note that
2109# new versions of GNU diff omit the leading space on completely
2110# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002111 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002112 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002113 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002114
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002115 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002116 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002117
2118 # Track the previous line.
2119 ($prevline, $stashline) = ($stashline, $line);
2120 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002121 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2122
Andy Whitcroft773647a2008-03-28 14:15:58 -07002123 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002124
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002125 } elsif ($realcnt == 1) {
2126 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002127 }
2128
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002129 my $hunk_line = ($realcnt != 0);
2130
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002131 $here = "#$linenr: " if (!$file);
2132 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002133
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002134 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002135 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002136 if ($line =~ /^diff --git.*?(\S+)$/) {
2137 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002138 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002139 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002140 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002141 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002142 $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;
Wolfram Sang1e855722009-01-06 14:41:24 -08002145
2146 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002147 if (!$file && $tree && $p1_prefix ne '' &&
2148 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002149 WARN("PATCH_PREFIX",
2150 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002151 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002152
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002153 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002154 ERROR("MODIFIED_INCLUDE_ASM",
2155 "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 -07002156 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002157 $found_file = 1;
2158 }
2159
Joe Perches34d88152015-06-25 15:03:05 -07002160#make up the handle for any error we report on this line
2161 if ($showfile) {
2162 $prefix = "$realfile:$realline: "
2163 } elsif ($emacs) {
2164 $prefix = "$filename:$linenr: ";
2165 }
2166
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002167 if ($found_file) {
2168 if ($realfile =~ m@^(drivers/net/|net/)@) {
2169 $check = 1;
2170 } else {
2171 $check = $check_orig;
2172 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002173 next;
2174 }
2175
Randy Dunlap389834b2007-06-08 13:47:03 -07002176 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002177
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002178 my $hereline = "$here\n$rawline\n";
2179 my $herecurr = "$here\n$rawline\n";
2180 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002181
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002182 $cnt_lines++ if ($realcnt != 0);
2183
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002184# Check for incorrect file permissions
2185 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2186 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002187 if ($realfile !~ m@scripts/@ &&
2188 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002189 ERROR("EXECUTE_PERMISSIONS",
2190 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002191 }
2192 }
2193
Joe Perches20112472011-07-25 17:13:23 -07002194# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002195 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002196 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002197 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002198 }
2199
Joe Perchese0d975b2014-12-10 15:51:49 -08002200# Check if MAINTAINERS is being updated. If so, there's probably no need to
2201# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2202 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2203 $reported_maintainer_file = 1;
2204 }
2205
Joe Perches20112472011-07-25 17:13:23 -07002206# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002207 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002208 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002209 my $space_before = $1;
2210 my $sign_off = $2;
2211 my $space_after = $3;
2212 my $email = $4;
2213 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2214
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002215 if ($sign_off !~ /$signature_tags/) {
2216 WARN("BAD_SIGN_OFF",
2217 "Non-standard signature: $sign_off\n" . $herecurr);
2218 }
Joe Perches20112472011-07-25 17:13:23 -07002219 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002220 if (WARN("BAD_SIGN_OFF",
2221 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2222 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002223 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002224 "$ucfirst_sign_off $email";
2225 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002226 }
Joe Perches20112472011-07-25 17:13:23 -07002227 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002228 if (WARN("BAD_SIGN_OFF",
2229 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2230 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002231 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002232 "$ucfirst_sign_off $email";
2233 }
2234
Joe Perches20112472011-07-25 17:13:23 -07002235 }
2236 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002237 if (WARN("BAD_SIGN_OFF",
2238 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2239 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002240 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002241 "$ucfirst_sign_off $email";
2242 }
Joe Perches20112472011-07-25 17:13:23 -07002243 }
2244
2245 my ($email_name, $email_address, $comment) = parse_email($email);
2246 my $suggested_email = format_email(($email_name, $email_address));
2247 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002248 ERROR("BAD_SIGN_OFF",
2249 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002250 } else {
2251 my $dequoted = $suggested_email;
2252 $dequoted =~ s/^"//;
2253 $dequoted =~ s/" </ </;
2254 # Don't force email to have quotes
2255 # Allow just an angle bracketed address
2256 if ("$dequoted$comment" ne $email &&
2257 "<$email_address>$comment" ne $email &&
2258 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002259 WARN("BAD_SIGN_OFF",
2260 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002261 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002262 }
Joe Perches7e51f192013-09-11 14:23:57 -07002263
2264# Check for duplicate signatures
2265 my $sig_nospace = $line;
2266 $sig_nospace =~ s/\s//g;
2267 $sig_nospace = lc($sig_nospace);
2268 if (defined $signatures{$sig_nospace}) {
2269 WARN("BAD_SIGN_OFF",
2270 "Duplicate signature\n" . $herecurr);
2271 } else {
2272 $signatures{$sig_nospace} = 1;
2273 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002274 }
2275
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002276# Check email subject for common tools that don't need to be mentioned
2277 if ($in_header_lines &&
2278 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2279 WARN("EMAIL_SUBJECT",
2280 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2281 }
2282
Joe Perches9b3189eb2014-06-04 16:12:10 -07002283# Check for old stable address
2284 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2285 ERROR("STABLE_ADDRESS",
2286 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2287 }
2288
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002289# Check for unwanted Gerrit info
2290 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2291 ERROR("GERRIT_CHANGE_ID",
2292 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2293 }
2294
Joe Perches2a076f42015-04-16 12:44:28 -07002295# Check for line lengths > 75 in commit log, warn once
2296 if ($in_commit_log && !$commit_log_long_line &&
2297 length($line) > 75) {
2298 WARN("COMMIT_LOG_LONG_LINE",
2299 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2300 $commit_log_long_line = 1;
2301 }
2302
Joe Perches0d7835f2015-02-13 14:38:35 -08002303# Check for git id commit length and improperly formed commit descriptions
2304 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002305 my $init_char = $1;
2306 my $orig_commit = lc($2);
Joe Perches0d7835f2015-02-13 14:38:35 -08002307 my $short = 1;
2308 my $long = 0;
2309 my $case = 1;
2310 my $space = 1;
2311 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002312 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002313 my $id = '0123456789ab';
2314 my $orig_desc = "commit description";
2315 my $description = "";
2316
2317 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2318 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2319 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2320 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2321 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2322 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002323 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002324 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2325 defined $rawlines[$linenr] &&
2326 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2327 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002328 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002329 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2330 defined $rawlines[$linenr] &&
2331 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2332 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2333 $orig_desc = $1;
2334 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2335 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002336 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002337 }
2338
2339 ($id, $description) = git_commit_info($orig_commit,
2340 $id, $orig_desc);
2341
Joe Perches19c146a2015-02-13 14:39:00 -08002342 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002343 ERROR("GIT_COMMIT_ID",
2344 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2345 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002346 }
2347
Joe Perches13f19372014-08-06 16:10:59 -07002348# Check for added, moved or deleted files
2349 if (!$reported_maintainer_file && !$in_commit_log &&
2350 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2351 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2352 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2353 (defined($1) || defined($2))))) {
2354 $reported_maintainer_file = 1;
2355 WARN("FILE_PATH_CHANGES",
2356 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2357 }
2358
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002359# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002360 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002361 ERROR("CORRUPTED_PATCH",
2362 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002363 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002364 }
2365
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002366# Check for absolute kernel paths.
2367 if ($tree) {
2368 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2369 my $file = $1;
2370
2371 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2372 check_absolute_file($1, $herecurr)) {
2373 #
2374 } else {
2375 check_absolute_file($file, $herecurr);
2376 }
2377 }
2378 }
2379
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002380# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2381 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002382 $rawline !~ m/^$UTF8*$/) {
2383 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2384
2385 my $blank = copy_spacing($rawline);
2386 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2387 my $hereptr = "$hereline$ptr\n";
2388
Joe Perches34d99212011-07-25 17:13:26 -07002389 CHK("INVALID_UTF8",
2390 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002391 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002392
Joe Perches15662b32011-10-31 17:13:12 -07002393# Check if it's the start of a commit log
2394# (not a header line and we haven't seen the patch filename)
2395 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002396 !($rawline =~ /^\s+\S/ ||
2397 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002398 $in_header_lines = 0;
2399 $in_commit_log = 1;
2400 }
2401
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002402# Check if there is UTF-8 in a commit log when a mail header has explicitly
2403# declined it, i.e defined some charset where it is missing.
2404 if ($in_header_lines &&
2405 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2406 $1 !~ /utf-8/i) {
2407 $non_utf8_charset = 1;
2408 }
2409
2410 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002411 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002412 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002413 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2414 }
2415
Kees Cook66b47b42014-10-13 15:51:57 -07002416# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002417 if (defined($misspellings) &&
2418 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002419 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002420 my $typo = $1;
2421 my $typo_fix = $spelling_fix{lc($typo)};
2422 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2423 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2424 my $msg_type = \&WARN;
2425 $msg_type = \&CHK if ($file);
2426 if (&{$msg_type}("TYPO_SPELLING",
2427 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2428 $fix) {
2429 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2430 }
2431 }
2432 }
2433
Andy Whitcroft306708542008-10-15 22:02:28 -07002434# ignore non-hunk lines and lines being removed
2435 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002436
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002437#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002438 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002439 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002440 if (ERROR("DOS_LINE_ENDINGS",
2441 "DOS line endings\n" . $herevet) &&
2442 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002443 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002444 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002445 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2446 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002447 if (ERROR("TRAILING_WHITESPACE",
2448 "trailing whitespace\n" . $herevet) &&
2449 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002450 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002451 }
2452
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002453 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002454 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002455
Josh Triplett4783f892013-11-12 15:10:12 -08002456# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002457 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002458 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2459 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002460 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2461 my $msg_type = \&ERROR;
2462 $msg_type = \&CHK if ($file);
2463 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002464 "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 -08002465 }
2466
Andi Kleen33549572010-05-24 14:33:29 -07002467# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002468# Only applies when adding the entry originally, after that we do not have
2469# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002470 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002471 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002472 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002473 my $cnt = $realcnt;
2474 my $ln = $linenr + 1;
2475 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002476 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002477 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002478 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002479 $f = $lines[$ln - 1];
2480 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2481 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002482
2483 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002484 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002485
Joe Perches8d73e0e2014-08-06 16:10:46 -07002486 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002487 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002488 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002489 $length = -1;
2490 }
2491
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002492 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002493 $f =~ s/#.*//;
2494 $f =~ s/^\s+//;
2495 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002496 if ($f =~ /^\s*config\s/) {
2497 $is_end = 1;
2498 last;
2499 }
Andi Kleen33549572010-05-24 14:33:29 -07002500 $length++;
2501 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002502 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2503 WARN("CONFIG_DESCRIPTION",
2504 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2505 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002506 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002507 }
2508
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002509# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2510 if ($realfile =~ /Kconfig/ &&
2511 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2512 WARN("CONFIG_EXPERIMENTAL",
2513 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2514 }
2515
Christoph Jaeger327953e2015-02-13 14:38:29 -08002516# discourage the use of boolean for type definition attributes of Kconfig options
2517 if ($realfile =~ /Kconfig/ &&
2518 $line =~ /^\+\s*\bboolean\b/) {
2519 WARN("CONFIG_TYPE_BOOLEAN",
2520 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2521 }
2522
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002523 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2524 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2525 my $flag = $1;
2526 my $replacement = {
2527 'EXTRA_AFLAGS' => 'asflags-y',
2528 'EXTRA_CFLAGS' => 'ccflags-y',
2529 'EXTRA_CPPFLAGS' => 'cppflags-y',
2530 'EXTRA_LDFLAGS' => 'ldflags-y',
2531 };
2532
2533 WARN("DEPRECATED_VARIABLE",
2534 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2535 }
2536
Rob Herringbff5da42014-01-23 15:54:51 -08002537# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002538 if (defined $root &&
2539 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2540 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2541
Rob Herringbff5da42014-01-23 15:54:51 -08002542 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2543
Florian Vaussardcc933192014-04-03 14:49:27 -07002544 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2545 my $vp_file = $dt_path . "vendor-prefixes.txt";
2546
Rob Herringbff5da42014-01-23 15:54:51 -08002547 foreach my $compat (@compats) {
2548 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002549 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2550 my $compat3 = $compat;
2551 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2552 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002553 if ( $? >> 8 ) {
2554 WARN("UNDOCUMENTED_DT_STRING",
2555 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2556 }
2557
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002558 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2559 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002560 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002561 if ( $? >> 8 ) {
2562 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002563 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002564 }
2565 }
2566 }
2567
Andy Whitcroft5368df202008-10-15 22:02:27 -07002568# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002569 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002570
Joe Perches47e0c882015-06-25 15:02:57 -07002571# line length limit (with some exclusions)
2572#
2573# There are a few types of lines that may extend beyond $max_line_length:
2574# logging functions like pr_info that end in a string
2575# lines with a single string
2576# #defines that are a single string
2577#
2578# There are 3 different line length message types:
2579# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2580# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2581# LONG_LINE all other lines longer than $max_line_length
2582#
2583# if LONG_LINE is ignored, the other 2 types are also ignored
2584#
2585
2586 if ($length > $max_line_length) {
2587 my $msg_type = "LONG_LINE";
2588
2589 # Check the allowed long line types first
2590
2591 # logging functions that end in a string that starts
2592 # before $max_line_length
2593 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2594 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2595 $msg_type = "";
2596
2597 # lines with only strings (w/ possible termination)
2598 # #defines with only strings
2599 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2600 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2601 $msg_type = "";
2602
2603 # Otherwise set the alternate message types
2604
2605 # a comment starts before $max_line_length
2606 } elsif ($line =~ /($;[\s$;]*)$/ &&
2607 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2608 $msg_type = "LONG_LINE_COMMENT"
2609
2610 # a quoted string starts before $max_line_length
2611 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2612 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2613 $msg_type = "LONG_LINE_STRING"
2614 }
2615
2616 if ($msg_type ne "" &&
2617 (show_type("LONG_LINE") || show_type($msg_type))) {
2618 WARN($msg_type,
2619 "line over $max_line_length characters\n" . $herecurr);
2620 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002621 }
2622
Andy Whitcroft8905a672007-11-28 16:21:06 -08002623# check for adding lines without a newline.
2624 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002625 WARN("MISSING_EOF_NEWLINE",
2626 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002627 }
2628
Mike Frysinger42e41c52009-09-21 17:04:40 -07002629# Blackfin: use hi/lo macros
2630 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2631 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2632 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002633 ERROR("LO_MACRO",
2634 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002635 }
2636 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2637 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002638 ERROR("HI_MACRO",
2639 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002640 }
2641 }
2642
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002643# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002644 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002645
2646# at the beginning of a line any tabs must come first and anything
2647# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002648 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2649 $rawline =~ /^\+\s* \s*/) {
2650 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002651 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002652 if (ERROR("CODE_INDENT",
2653 "code indent should use tabs where possible\n" . $herevet) &&
2654 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002655 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002656 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002657 }
2658
Alberto Panizzo08e44362010-03-05 13:43:54 -08002659# check for space before tabs.
2660 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2661 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002662 if (WARN("SPACE_BEFORE_TAB",
2663 "please, no space before tabs\n" . $herevet) &&
2664 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002665 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002666 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002667 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002668 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002669 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002670 }
2671
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002672# check for && or || at the start of a line
2673 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2674 CHK("LOGICAL_CONTINUATIONS",
2675 "Logical continuations should be on the previous line\n" . $hereprev);
2676 }
2677
2678# check multi-line statement indentation matches previous line
2679 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002680 $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 -07002681 $prevline =~ /^\+(\t*)(.*)$/;
2682 my $oldindent = $1;
2683 my $rest = $2;
2684
2685 my $pos = pos_last_openparen($rest);
2686 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002687 $line =~ /^(\+| )([ \t]*)/;
2688 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002689
2690 my $goodtabindent = $oldindent .
2691 "\t" x ($pos / 8) .
2692 " " x ($pos % 8);
2693 my $goodspaceindent = $oldindent . " " x $pos;
2694
2695 if ($newindent ne $goodtabindent &&
2696 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002697
2698 if (CHK("PARENTHESIS_ALIGNMENT",
2699 "Alignment should match open parenthesis\n" . $hereprev) &&
2700 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002701 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002702 s/^\+[ \t]*/\+$goodtabindent/;
2703 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002704 }
2705 }
2706 }
2707
Joe Perches6ab3a972015-04-16 12:44:05 -07002708# check for space after cast like "(int) foo" or "(struct foo) bar"
2709# avoid checking a few false positives:
2710# "sizeof(<type>)" or "__alignof__(<type>)"
2711# function pointer declarations like "(*foo)(int) = bar;"
2712# structure definitions like "(struct foo) { 0 };"
2713# multiline macros that define functions
2714# known attributes or the __attribute__ keyword
2715 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2716 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002717 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002718 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002720 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002721 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002722 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002723 }
2724
Joe Perches05880602012-10-04 17:13:35 -07002725 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002726 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002727 $rawline =~ /^\+[ \t]*\*/ &&
2728 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002729 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2730 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2731 }
2732
2733 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002734 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2735 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002736 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002737 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2738 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2739 "networking block comments start with * on subsequent lines\n" . $hereprev);
2740 }
2741
2742 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002743 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2744 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2745 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2746 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002747 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2748 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2749 }
2750
Joe Perches7f619192014-08-06 16:10:39 -07002751# check for missing blank lines after struct/union declarations
2752# with exceptions for various attributes and macros
2753 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2754 $line =~ /^\+/ &&
2755 !($line =~ /^\+\s*$/ ||
2756 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2757 $line =~ /^\+\s*MODULE_/i ||
2758 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2759 $line =~ /^\+[a-z_]*init/ ||
2760 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2761 $line =~ /^\+\s*DECLARE/ ||
2762 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002763 if (CHK("LINE_SPACING",
2764 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2765 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002766 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002767 }
Joe Perches7f619192014-08-06 16:10:39 -07002768 }
2769
Joe Perches365dd4e2014-08-06 16:10:42 -07002770# check for multiple consecutive blank lines
2771 if ($prevline =~ /^[\+ ]\s*$/ &&
2772 $line =~ /^\+\s*$/ &&
2773 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002774 if (CHK("LINE_SPACING",
2775 "Please don't use multiple blank lines\n" . $hereprev) &&
2776 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002777 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002778 }
2779
Joe Perches365dd4e2014-08-06 16:10:42 -07002780 $last_blank_line = $linenr;
2781 }
2782
Joe Perches3b617e32014-04-03 14:49:28 -07002783# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002784 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2785 # actual declarations
2786 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002787 # function pointer declarations
2788 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002789 # foo bar; where foo is some local typedef or #define
2790 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2791 # known declaration macros
2792 $prevline =~ /^\+\s+$declaration_macros/) &&
2793 # for "else if" which can look like "$Ident $Ident"
2794 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2795 # other possible extensions of declaration lines
2796 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2797 # not starting a section or a macro "\" extended line
2798 $prevline =~ /(?:\{\s*|\\)$/) &&
2799 # looks like a declaration
2800 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002801 # function pointer declarations
2802 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002803 # foo bar; where foo is some local typedef or #define
2804 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2805 # known declaration macros
2806 $sline =~ /^\+\s+$declaration_macros/ ||
2807 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002808 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002809 # start or end of block or continuation of declaration
2810 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2811 # bitfield continuation
2812 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2813 # other possible extensions of declaration lines
2814 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2815 # indentation of previous and current line are the same
2816 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002817 if (WARN("LINE_SPACING",
2818 "Missing a blank line after declarations\n" . $hereprev) &&
2819 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002820 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002821 }
Joe Perches3b617e32014-04-03 14:49:28 -07002822 }
2823
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002824# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002825# Exceptions:
2826# 1) within comments
2827# 2) indented preprocessor commands
2828# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002829 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002830 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002831 if (WARN("LEADING_SPACE",
2832 "please, no spaces at the start of a line\n" . $herevet) &&
2833 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002834 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002835 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002836 }
2837
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002838# check we are in a valid C source file if not then ignore this hunk
2839 next if ($realfile !~ /\.(h|c)$/);
2840
Joe Perches032a4c02014-08-06 16:10:29 -07002841# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002842# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002843# if the previous line is a break or return and is indented 1 tab more...
2844 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2845 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002846 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2847 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2848 defined $lines[$linenr] &&
2849 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002850 WARN("UNNECESSARY_ELSE",
2851 "else is not generally useful after a break or return\n" . $hereprev);
2852 }
2853 }
2854
Joe Perchesc00df192014-08-06 16:11:01 -07002855# check indentation of a line with a break;
2856# if the previous line is a goto or return and is indented the same # of tabs
2857 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2858 my $tabs = $1;
2859 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2860 WARN("UNNECESSARY_BREAK",
2861 "break is not useful after a goto or return\n" . $hereprev);
2862 }
2863 }
2864
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002865# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2866 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2867 WARN("CONFIG_EXPERIMENTAL",
2868 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2869 }
2870
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002871# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002872 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002873 WARN("CVS_KEYWORD",
2874 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002875 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002876
Mike Frysinger42e41c52009-09-21 17:04:40 -07002877# Blackfin: don't use __builtin_bfin_[cs]sync
2878 if ($line =~ /__builtin_bfin_csync/) {
2879 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002880 ERROR("CSYNC",
2881 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002882 }
2883 if ($line =~ /__builtin_bfin_ssync/) {
2884 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002885 ERROR("SSYNC",
2886 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002887 }
2888
Joe Perches56e77d72013-02-21 16:44:14 -08002889# check for old HOTPLUG __dev<foo> section markings
2890 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2891 WARN("HOTPLUG_SECTION",
2892 "Using $1 is unnecessary\n" . $herecurr);
2893 }
2894
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002895# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002896 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2897 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002898#print "LINE<$line>\n";
2899 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002900 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002901 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002902 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002903 $stat =~ s/\n./\n /g;
2904 $cond =~ s/\n./\n /g;
2905
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002906#print "linenr<$linenr> <$stat>\n";
2907 # If this statement has no statement boundaries within
2908 # it there is no point in retrying a statement scan
2909 # until we hit end of it.
2910 my $frag = $stat; $frag =~ s/;+\s*$//;
2911 if ($frag !~ /(?:{|;)/) {
2912#print "skip<$line_nr_next>\n";
2913 $suppress_statement = $line_nr_next;
2914 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002915
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002916 # Find the real next line.
2917 $realline_next = $line_nr_next;
2918 if (defined $realline_next &&
2919 (!defined $lines[$realline_next - 1] ||
2920 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2921 $realline_next++;
2922 }
2923
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002924 my $s = $stat;
2925 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002926
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002927 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002928 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002929
2930 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002931 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002932
Andy Whitcroft463f2862009-09-21 17:04:34 -07002933 } elsif ($s =~ /^.\s*else\b/s) {
2934
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002935 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002936 } 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 -07002937 my $type = $1;
2938 $type =~ s/\s+/ /g;
2939 possible($type, "A:" . $s);
2940
Andy Whitcroft8905a672007-11-28 16:21:06 -08002941 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002942 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002943 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002944 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002945
2946 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002947 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002948 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002949 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002950
2951 # Check for any sort of function declaration.
2952 # int foo(something bar, other baz);
2953 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002954 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 -08002955 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002956
Andy Whitcroftcf655042008-03-04 14:28:20 -08002957 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002958 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002959 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002960
Andy Whitcroft8905a672007-11-28 16:21:06 -08002961 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002962 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002963
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002964 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002965 }
2966 }
2967 }
2968
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002969 }
2970
Andy Whitcroft653d4872007-06-23 17:16:34 -07002971#
2972# Checks which may be anchored in the context.
2973#
2974
2975# Check for switch () and associated case and default
2976# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002977 if ($line=~/\bswitch\s*\(.*\)/) {
2978 my $err = '';
2979 my $sep = '';
2980 my @ctx = ctx_block_outer($linenr, $realcnt);
2981 shift(@ctx);
2982 for my $ctx (@ctx) {
2983 my ($clen, $cindent) = line_stats($ctx);
2984 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2985 $indent != $cindent) {
2986 $err .= "$sep$ctx\n";
2987 $sep = '';
2988 } else {
2989 $sep = "[...]\n";
2990 }
2991 }
2992 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002993 ERROR("SWITCH_CASE_INDENT_LEVEL",
2994 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002995 }
2996 }
2997
2998# if/while/etc brace do not go on next line, unless defining a do while loop,
2999# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003000 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 -07003001 my $pre_ctx = "$1$2";
3002
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003003 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003004
3005 if ($line =~ /^\+\t{6,}/) {
3006 WARN("DEEP_INDENTATION",
3007 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3008 }
3009
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003010 my $ctx_cnt = $realcnt - $#ctx - 1;
3011 my $ctx = join("\n", @ctx);
3012
Andy Whitcroft548596d2008-07-23 21:29:01 -07003013 my $ctx_ln = $linenr;
3014 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003015
Andy Whitcroft548596d2008-07-23 21:29:01 -07003016 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3017 defined $lines[$ctx_ln - 1] &&
3018 $lines[$ctx_ln - 1] =~ /^-/)) {
3019 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3020 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003021 $ctx_ln++;
3022 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003023
Andy Whitcroft53210162008-07-23 21:29:03 -07003024 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3025 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003026
Joe Perchesd752fcc2014-08-06 16:11:05 -07003027 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003028 ERROR("OPEN_BRACE",
3029 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003030 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003031 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003032 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3033 $ctx =~ /\)\s*\;\s*$/ &&
3034 defined $lines[$ctx_ln - 1])
3035 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003036 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3037 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003038 WARN("TRAILING_SEMICOLON",
3039 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003040 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003041 }
3042 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003043 }
3044
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003045# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003046 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 -08003047 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3048 ctx_statement_block($linenr, $realcnt, 0)
3049 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003050 my ($s, $c) = ($stat, $cond);
3051
3052 substr($s, 0, length($c), '');
3053
3054 # Make sure we remove the line prefixes as we have
3055 # none on the first line, and are going to readd them
3056 # where necessary.
3057 $s =~ s/\n./\n/gs;
3058
3059 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003060 my @newlines = ($c =~ /\n/gs);
3061 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003062
3063 # We want to check the first line inside the block
3064 # starting at the end of the conditional, so remove:
3065 # 1) any blank line termination
3066 # 2) any opening brace { on end of the line
3067 # 3) any do (...) {
3068 my $continuation = 0;
3069 my $check = 0;
3070 $s =~ s/^.*\bdo\b//;
3071 $s =~ s/^\s*{//;
3072 if ($s =~ s/^\s*\\//) {
3073 $continuation = 1;
3074 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003075 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003076 $check = 1;
3077 $cond_lines++;
3078 }
3079
3080 # Also ignore a loop construct at the end of a
3081 # preprocessor statement.
3082 if (($prevline =~ /^.\s*#\s*define\s/ ||
3083 $prevline =~ /\\\s*$/) && $continuation == 0) {
3084 $check = 0;
3085 }
3086
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003087 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003088 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003089 while ($cond_ptr != $cond_lines) {
3090 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003091
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003092 # If we see an #else/#elif then the code
3093 # is not linear.
3094 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3095 $check = 0;
3096 }
3097
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003098 # Ignore:
3099 # 1) blank lines, they should be at 0,
3100 # 2) preprocessor lines, and
3101 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003102 if ($continuation ||
3103 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003104 $s =~ /^\s*#\s*?/ ||
3105 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003106 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003107 if ($s =~ s/^.*?\n//) {
3108 $cond_lines++;
3109 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003110 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003111 }
3112
3113 my (undef, $sindent) = line_stats("+" . $s);
3114 my $stat_real = raw_line($linenr, $cond_lines);
3115
3116 # Check if either of these lines are modified, else
3117 # this is not this patch's fault.
3118 if (!defined($stat_real) ||
3119 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3120 $check = 0;
3121 }
3122 if (defined($stat_real) && $cond_lines > 1) {
3123 $stat_real = "[...]\n$stat_real";
3124 }
3125
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003126 #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 -07003127
3128 if ($check && (($sindent % 8) != 0 ||
3129 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003130 WARN("SUSPECT_CODE_INDENT",
3131 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003132 }
3133 }
3134
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003135 # Track the 'values' across context and added lines.
3136 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003137 my ($curr_values, $curr_vars) =
3138 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003139 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003140 if ($dbg_values) {
3141 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003142 print "$linenr > .$outline\n";
3143 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003144 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003145 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003146 $prev_values = substr($curr_values, -1);
3147
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003148#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003149 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003150
Andy Whitcroft653d4872007-06-23 17:16:34 -07003151# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003152 if ($dbg_type) {
3153 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003154 ERROR("TEST_TYPE",
3155 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003156 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003157 ERROR("TEST_NOT_TYPE",
3158 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003159 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003160 next;
3161 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003162# TEST: allow direct testing of the attribute matcher.
3163 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003164 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003165 ERROR("TEST_ATTR",
3166 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003167 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003168 ERROR("TEST_NOT_ATTR",
3169 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003170 }
3171 next;
3172 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003173
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003174# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003175 if ($line =~ /^.\s*{/ &&
3176 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003177 if (ERROR("OPEN_BRACE",
3178 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003179 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3180 fix_delete_line($fixlinenr - 1, $prevrawline);
3181 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003182 my $fixedline = $prevrawline;
3183 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003184 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003185 $fixedline = $line;
3186 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003187 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003188 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003189 }
3190
Andy Whitcroft653d4872007-06-23 17:16:34 -07003191#
3192# Checks which are anchored on the added line.
3193#
3194
3195# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003196 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003197 my $path = $1;
3198 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003199 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003200 "malformed #include filename\n" . $herecurr);
3201 }
3202 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3203 ERROR("UAPI_INCLUDE",
3204 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003205 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003206 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003207
3208# no C99 // comments
3209 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003210 if (ERROR("C99_COMMENTS",
3211 "do not use C99 // comments\n" . $herecurr) &&
3212 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003213 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003214 if ($line =~ /\/\/(.*)$/) {
3215 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003216 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003217 }
3218 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003219 }
3220 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003221 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003222 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003223
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003224# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3225# the whole statement.
3226#print "APW <$lines[$realline_next - 1]>\n";
3227 if (defined $realline_next &&
3228 exists $lines[$realline_next - 1] &&
3229 !defined $suppress_export{$realline_next} &&
3230 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3231 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003232 # Handle definitions which produce identifiers with
3233 # a prefix:
3234 # XXX(foo);
3235 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003236 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003237 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003238 $name =~ /^${Ident}_$2/) {
3239#print "FOO C name<$name>\n";
3240 $suppress_export{$realline_next} = 1;
3241
3242 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003243 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003244 ^.DEFINE_$Ident\(\Q$name\E\)|
3245 ^.DECLARE_$Ident\(\Q$name\E\)|
3246 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003247 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3248 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003249 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003250#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3251 $suppress_export{$realline_next} = 2;
3252 } else {
3253 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003254 }
3255 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003256 if (!defined $suppress_export{$linenr} &&
3257 $prevline =~ /^.\s*$/ &&
3258 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3259 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3260#print "FOO B <$lines[$linenr - 1]>\n";
3261 $suppress_export{$linenr} = 2;
3262 }
3263 if (defined $suppress_export{$linenr} &&
3264 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003265 WARN("EXPORT_SYMBOL",
3266 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003267 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003268
Joe Eloff5150bda2010-08-09 17:21:00 -07003269# check for global initialisers.
Joe Perches5129e872015-06-10 11:14:52 -07003270 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003271 if (ERROR("GLOBAL_INITIALISERS",
3272 "do not initialise globals to 0 or NULL\n" .
3273 $herecurr) &&
3274 $fix) {
Joe Perches5129e872015-06-10 11:14:52 -07003275 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003276 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003277 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003278# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003279 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3280 if (ERROR("INITIALISED_STATIC",
3281 "do not initialise statics to 0 or NULL\n" .
3282 $herecurr) &&
3283 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003284 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003285 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003286 }
3287
Joe Perches18130872014-08-06 16:11:22 -07003288# check for misordered declarations of char/short/int/long with signed/unsigned
3289 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3290 my $tmp = trim($1);
3291 WARN("MISORDERED_TYPE",
3292 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3293 }
3294
Joe Perchescb710ec2010-10-26 14:23:20 -07003295# check for static const char * arrays.
3296 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003297 WARN("STATIC_CONST_CHAR_ARRAY",
3298 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003299 $herecurr);
3300 }
3301
3302# check for static char foo[] = "bar" declarations.
3303 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003304 WARN("STATIC_CONST_CHAR_ARRAY",
3305 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003306 $herecurr);
3307 }
3308
Joe Perchesab7e23f2015-04-16 12:44:22 -07003309# check for const <foo> const where <foo> is not a pointer or array type
3310 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3311 my $found = $1;
3312 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3313 WARN("CONST_CONST",
3314 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3315 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3316 WARN("CONST_CONST",
3317 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3318 }
3319 }
3320
Joe Perches9b0fa602014-04-03 14:49:18 -07003321# check for non-global char *foo[] = {"bar", ...} declarations.
3322 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3323 WARN("STATIC_CONST_CHAR_ARRAY",
3324 "char * array declaration might be better as static const\n" .
3325 $herecurr);
3326 }
3327
Joe Perchesb598b672015-04-16 12:44:36 -07003328# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3329 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3330 my $array = $1;
3331 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3332 my $array_div = $1;
3333 if (WARN("ARRAY_SIZE",
3334 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3335 $fix) {
3336 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3337 }
3338 }
3339 }
3340
Joe Perchesb36190c2014-01-27 17:07:18 -08003341# check for function declarations without arguments like "int foo()"
3342 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3343 if (ERROR("FUNCTION_WITHOUT_ARGS",
3344 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3345 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003346 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003347 }
3348 }
3349
Joe Perches92e112f2013-12-13 11:36:22 -07003350# check for uses of DEFINE_PCI_DEVICE_TABLE
3351 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3352 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3353 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3354 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003355 $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 -07003356 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003357 }
3358
Andy Whitcroft653d4872007-06-23 17:16:34 -07003359# check for new typedefs, only function parameters and sparse annotations
3360# make sense.
3361 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003362 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003363 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003364 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003365 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003366 WARN("NEW_TYPEDEFS",
3367 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003368 }
3369
3370# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003371 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003372 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3373 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003374 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003375
Andy Whitcroft65863862009-01-06 14:41:21 -08003376 # Should start with a space.
3377 $to =~ s/^(\S)/ $1/;
3378 # Should not end with a space.
3379 $to =~ s/\s+$//;
3380 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003381 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003382 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003383
Joe Perches3705ce52013-07-03 15:05:31 -07003384## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003385 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003386 if (ERROR("POINTER_LOCATION",
3387 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3388 $fix) {
3389 my $sub_from = $ident;
3390 my $sub_to = $ident;
3391 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003392 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003393 s@\Q$sub_from\E@$sub_to@;
3394 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003395 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003396 }
3397 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3398 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003399 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
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 }
3408 # Modifiers should have spaces.
3409 $to =~ s/(\b$Modifier$)/$1 /;
3410
Joe Perches3705ce52013-07-03 15:05:31 -07003411## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003412 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003413 if (ERROR("POINTER_LOCATION",
3414 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3415 $fix) {
3416
3417 my $sub_from = $match;
3418 my $sub_to = $match;
3419 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003420 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003421 s@\Q$sub_from\E@$sub_to@;
3422 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003423 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003424 }
3425
3426# # no BUG() or BUG_ON()
3427# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3428# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3429# print "$herecurr";
3430# $clean = 0;
3431# }
3432
Andy Whitcroft8905a672007-11-28 16:21:06 -08003433 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003434 WARN("LINUX_VERSION_CODE",
3435 "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 -08003436 }
3437
Joe Perches17441222011-06-15 15:08:17 -07003438# check for uses of printk_ratelimit
3439 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003440 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003441 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003442 }
3443
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003444# printk should use KERN_* levels. Note that follow on printk's on the
3445# same line do not need a level, so we use the current block context
3446# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003447# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003448# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003449 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003450 my $ok = 0;
3451 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3452 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003453 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003454 # with "\n" ignore it, else it is to blame
3455 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3456 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3457 $ok = 1;
3458 }
3459 last;
3460 }
3461 }
3462 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003463 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3464 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003465 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003466 }
3467
Joe Perches243f3802012-05-31 16:26:09 -07003468 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3469 my $orig = $1;
3470 my $level = lc($orig);
3471 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003472 my $level2 = $level;
3473 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003474 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003475 "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 -07003476 }
3477
3478 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003479 if (WARN("PREFER_PR_LEVEL",
3480 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3481 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003482 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003483 s/\bpr_warning\b/pr_warn/;
3484 }
Joe Perches243f3802012-05-31 16:26:09 -07003485 }
3486
Joe Perchesdc139312013-02-21 16:44:13 -08003487 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3488 my $orig = $1;
3489 my $level = lc($orig);
3490 $level = "warn" if ($level eq "warning");
3491 $level = "dbg" if ($level eq "debug");
3492 WARN("PREFER_DEV_LEVEL",
3493 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3494 }
3495
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003496# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3497# number of false positives, but assembly files are not checked, so at
3498# least the arch entry code will not trigger this warning.
3499 if ($line =~ /\bENOSYS\b/) {
3500 WARN("ENOSYS",
3501 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3502 }
3503
Andy Whitcroft653d4872007-06-23 17:16:34 -07003504# function brace can't be on same line, except for #defines of do while,
3505# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003506 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003507 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003508 if (ERROR("OPEN_BRACE",
3509 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3510 $fix) {
3511 fix_delete_line($fixlinenr, $rawline);
3512 my $fixed_line = $rawline;
3513 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3514 my $line1 = $1;
3515 my $line2 = $2;
3516 fix_insert_line($fixlinenr, ltrim($line1));
3517 fix_insert_line($fixlinenr, "\+{");
3518 if ($line2 !~ /^\s*$/) {
3519 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3520 }
3521 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003522 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003523
Andy Whitcroft8905a672007-11-28 16:21:06 -08003524# open braces for enum, union and struct go on the same line.
3525 if ($line =~ /^.\s*{/ &&
3526 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003527 if (ERROR("OPEN_BRACE",
3528 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3529 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3530 fix_delete_line($fixlinenr - 1, $prevrawline);
3531 fix_delete_line($fixlinenr, $rawline);
3532 my $fixedline = rtrim($prevrawline) . " {";
3533 fix_insert_line($fixlinenr, $fixedline);
3534 $fixedline = $rawline;
3535 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3536 if ($fixedline !~ /^\+\s*$/) {
3537 fix_insert_line($fixlinenr, $fixedline);
3538 }
3539 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003540 }
3541
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003542# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003543 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3544 if (WARN("SPACING",
3545 "missing space after $1 definition\n" . $herecurr) &&
3546 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003547 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003548 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3549 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003550 }
3551
Joe Perches31070b52014-01-23 15:54:49 -08003552# Function pointer declarations
3553# check spacing between type, funcptr, and args
3554# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003555 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003556 my $declare = $1;
3557 my $pre_pointer_space = $2;
3558 my $post_pointer_space = $3;
3559 my $funcname = $4;
3560 my $post_funcname_space = $5;
3561 my $pre_args_space = $6;
3562
Joe Perches91f72e92014-04-03 14:49:12 -07003563# the $Declare variable will capture all spaces after the type
3564# so check it for a missing trailing missing space but pointer return types
3565# don't need a space so don't warn for those.
3566 my $post_declare_space = "";
3567 if ($declare =~ /(\s+)$/) {
3568 $post_declare_space = $1;
3569 $declare = rtrim($declare);
3570 }
3571 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003572 WARN("SPACING",
3573 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003574 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003575 }
3576
3577# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003578# This test is not currently implemented because these declarations are
3579# equivalent to
3580# int foo(int bar, ...)
3581# and this is form shouldn't/doesn't generate a checkpatch warning.
3582#
3583# elsif ($declare =~ /\s{2,}$/) {
3584# WARN("SPACING",
3585# "Multiple spaces after return type\n" . $herecurr);
3586# }
Joe Perches31070b52014-01-23 15:54:49 -08003587
3588# unnecessary space "type ( *funcptr)(args...)"
3589 if (defined $pre_pointer_space &&
3590 $pre_pointer_space =~ /^\s/) {
3591 WARN("SPACING",
3592 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3593 }
3594
3595# unnecessary space "type (* funcptr)(args...)"
3596 if (defined $post_pointer_space &&
3597 $post_pointer_space =~ /^\s/) {
3598 WARN("SPACING",
3599 "Unnecessary space before function pointer name\n" . $herecurr);
3600 }
3601
3602# unnecessary space "type (*funcptr )(args...)"
3603 if (defined $post_funcname_space &&
3604 $post_funcname_space =~ /^\s/) {
3605 WARN("SPACING",
3606 "Unnecessary space after function pointer name\n" . $herecurr);
3607 }
3608
3609# unnecessary space "type (*funcptr) (args...)"
3610 if (defined $pre_args_space &&
3611 $pre_args_space =~ /^\s/) {
3612 WARN("SPACING",
3613 "Unnecessary space before function pointer arguments\n" . $herecurr);
3614 }
3615
3616 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003617 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003618 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003619 }
3620 }
3621
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003622# check for spacing round square brackets; allowed:
3623# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003624# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3625# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003626 while ($line =~ /(.*?\s)\[/g) {
3627 my ($where, $prefix) = ($-[1], $1);
3628 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003629 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003630 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003631 if (ERROR("BRACKET_SPACE",
3632 "space prohibited before open square bracket '['\n" . $herecurr) &&
3633 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003634 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003635 s/^(\+.*?)\s+\[/$1\[/;
3636 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003637 }
3638 }
3639
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003640# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003641 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003642 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003643 my $ctx_before = substr($line, 0, $-[1]);
3644 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003645
3646 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003647 if ($name =~ /^(?:
3648 if|for|while|switch|return|case|
3649 volatile|__volatile__|
3650 __attribute__|format|__extension__|
3651 asm|__asm__)$/x)
3652 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003653 # cpp #define statements have non-optional spaces, ie
3654 # if there is a space between the name and the open
3655 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003656 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003657
3658 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003659 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003660
3661 # If this whole things ends with a type its most
3662 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003663 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003664
3665 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003666 if (WARN("SPACING",
3667 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3668 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003669 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003670 s/\b$name\s+\(/$name\(/;
3671 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003672 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003673 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003674
Andy Whitcroft653d4872007-06-23 17:16:34 -07003675# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003676 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003677 my $fixed_line = "";
3678 my $line_fixed = 0;
3679
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003680 my $ops = qr{
3681 <<=|>>=|<=|>=|==|!=|
3682 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3683 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003684 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003685 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003686 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003687 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003688
3689## print("element count: <" . $#elements . ">\n");
3690## foreach my $el (@elements) {
3691## print("el: <$el>\n");
3692## }
3693
3694 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003695 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003696
Joe Perches3705ce52013-07-03 15:05:31 -07003697 foreach my $el (@elements) {
3698 push(@fix_elements, substr($rawline, $off, length($el)));
3699 $off += length($el);
3700 }
3701
3702 $off = 0;
3703
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003704 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003705 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003706
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003707 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003708
3709 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3710
3711## print("n: <$n> good: <$good>\n");
3712
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003713 $off += length($elements[$n]);
3714
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003715 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003716 my $ca = substr($opline, 0, $off);
3717 my $cc = '';
3718 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3719 $cc = substr($opline, $off + length($elements[$n + 1]));
3720 }
3721 my $cb = "$ca$;$cc";
3722
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003723 my $a = '';
3724 $a = 'V' if ($elements[$n] ne '');
3725 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003726 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003727 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3728 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003729 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003730
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003731 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003732
3733 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003734 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003735 $c = 'V' if ($elements[$n + 2] ne '');
3736 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003737 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003738 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3739 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003740 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003741 } else {
3742 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003743 }
3744
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003745 my $ctx = "${a}x${c}";
3746
3747 my $at = "(ctx:$ctx)";
3748
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003749 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003750 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003751
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003752 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003753 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003754
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003755 # Get the full operator variant.
3756 my $opv = $op . substr($curr_vars, $off, 1);
3757
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003758 # Ignore operators passed as parameters.
3759 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003760 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003761
Andy Whitcroftcf655042008-03-04 14:28:20 -08003762# # Ignore comments
3763# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003764
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003765 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003766 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003767 if ($ctx !~ /.x[WEBC]/ &&
3768 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003769 if (ERROR("SPACING",
3770 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003771 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003772 $line_fixed = 1;
3773 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003774 }
3775
3776 # // is a comment
3777 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003778
Joe Perchesb00e4812014-04-03 14:49:33 -07003779 # : when part of a bitfield
3780 } elsif ($opv eq ':B') {
3781 # skip the bitfield test for now
3782
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003783 # No spaces for:
3784 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003785 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003786 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003787 if (ERROR("SPACING",
3788 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003789 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003790 if (defined $fix_elements[$n + 2]) {
3791 $fix_elements[$n + 2] =~ s/^\s+//;
3792 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003793 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003794 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003795 }
3796
Joe Perches23810972014-12-10 15:51:32 -08003797 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003798 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003799 my $rtrim_before = 0;
3800 my $space_after = 0;
3801 if ($ctx =~ /Wx./) {
3802 if (ERROR("SPACING",
3803 "space prohibited before that '$op' $at\n" . $hereptr)) {
3804 $line_fixed = 1;
3805 $rtrim_before = 1;
3806 }
3807 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003808 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003809 if (ERROR("SPACING",
3810 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003811 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003812 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003813 $space_after = 1;
3814 }
3815 }
3816 if ($rtrim_before || $space_after) {
3817 if ($rtrim_before) {
3818 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3819 } else {
3820 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3821 }
3822 if ($space_after) {
3823 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003824 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003825 }
3826
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003827 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003828 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003829 #warn "'*' is part of type\n";
3830
3831 # unary operators should have a space before and
3832 # none after. May be left adjacent to another
3833 # unary operator, or a cast
3834 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003835 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003836 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003837 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003838 if (ERROR("SPACING",
3839 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003840 if ($n != $last_after + 2) {
3841 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3842 $line_fixed = 1;
3843 }
Joe Perches3705ce52013-07-03 15:05:31 -07003844 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003845 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003846 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003847 # A unary '*' may be const
3848
3849 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003850 if (ERROR("SPACING",
3851 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003852 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003853 if (defined $fix_elements[$n + 2]) {
3854 $fix_elements[$n + 2] =~ s/^\s+//;
3855 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003856 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003857 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003858 }
3859
3860 # unary ++ and unary -- are allowed no space on one side.
3861 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003862 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003863 if (ERROR("SPACING",
3864 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003865 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003866 $line_fixed = 1;
3867 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003868 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003869 if ($ctx =~ /Wx[BE]/ ||
3870 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003871 if (ERROR("SPACING",
3872 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003873 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003874 $line_fixed = 1;
3875 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003876 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003877 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003878 if (ERROR("SPACING",
3879 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003880 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003881 if (defined $fix_elements[$n + 2]) {
3882 $fix_elements[$n + 2] =~ s/^\s+//;
3883 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003884 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003885 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003886 }
3887
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003888 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003889 } elsif ($op eq '<<' or $op eq '>>' or
3890 $op eq '&' or $op eq '^' or $op eq '|' or
3891 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003892 $op eq '*' or $op eq '/' or
3893 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003894 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08003895 if ($check) {
3896 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3897 if (CHK("SPACING",
3898 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3899 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3900 $fix_elements[$n + 2] =~ s/^\s+//;
3901 $line_fixed = 1;
3902 }
3903 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3904 if (CHK("SPACING",
3905 "space preferred before that '$op' $at\n" . $hereptr)) {
3906 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3907 $line_fixed = 1;
3908 }
3909 }
3910 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003911 if (ERROR("SPACING",
3912 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003913 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3914 if (defined $fix_elements[$n + 2]) {
3915 $fix_elements[$n + 2] =~ s/^\s+//;
3916 }
Joe Perches3705ce52013-07-03 15:05:31 -07003917 $line_fixed = 1;
3918 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003919 }
3920
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003921 # A colon needs no spaces before when it is
3922 # terminating a case value or a label.
3923 } elsif ($opv eq ':C' || $opv eq ':L') {
3924 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003925 if (ERROR("SPACING",
3926 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003927 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003928 $line_fixed = 1;
3929 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003930 }
3931
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003932 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003933 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003934 my $ok = 0;
3935
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003936 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003937 if (($op eq '<' &&
3938 $cc =~ /^\S+\@\S+>/) ||
3939 ($op eq '>' &&
3940 $ca =~ /<\S+\@\S+$/))
3941 {
3942 $ok = 1;
3943 }
3944
Joe Perchese0df7e12015-04-16 12:44:53 -07003945 # for asm volatile statements
3946 # ignore a colon with another
3947 # colon immediately before or after
3948 if (($op eq ':') &&
3949 ($ca =~ /:$/ || $cc =~ /^:/)) {
3950 $ok = 1;
3951 }
3952
Joe Perches84731622013-11-12 15:10:05 -08003953 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003954 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003955 my $msg_type = \&ERROR;
3956 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3957
3958 if (&{$msg_type}("SPACING",
3959 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003960 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3961 if (defined $fix_elements[$n + 2]) {
3962 $fix_elements[$n + 2] =~ s/^\s+//;
3963 }
Joe Perches3705ce52013-07-03 15:05:31 -07003964 $line_fixed = 1;
3965 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003966 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003967 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003968 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003969
3970## print("n: <$n> GOOD: <$good>\n");
3971
3972 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003973 }
Joe Perches3705ce52013-07-03 15:05:31 -07003974
3975 if (($#elements % 2) == 0) {
3976 $fixed_line = $fixed_line . $fix_elements[$#elements];
3977 }
3978
Joe Perches194f66f2014-08-06 16:11:03 -07003979 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3980 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003981 }
3982
3983
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003984 }
3985
Joe Perches786b6322013-07-03 15:05:32 -07003986# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003987 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003988 if (WARN("SPACING",
3989 "space prohibited before semicolon\n" . $herecurr) &&
3990 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003991 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003992 s/^(\+.*\S)\s+;/$1;/;
3993 }
3994 }
3995
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003996# check for multiple assignments
3997 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003998 CHK("MULTIPLE_ASSIGNMENTS",
3999 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004000 }
4001
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004002## # check for multiple declarations, allowing for a function declaration
4003## # continuation.
4004## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4005## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4006##
4007## # Remove any bracketed sections to ensure we do not
4008## # falsly report the parameters of functions.
4009## my $ln = $line;
4010## while ($ln =~ s/\([^\(\)]*\)//g) {
4011## }
4012## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004013## WARN("MULTIPLE_DECLARATION",
4014## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004015## }
4016## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004017
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004018#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004019 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
4020 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004021 if (ERROR("SPACING",
4022 "space required before the open brace '{'\n" . $herecurr) &&
4023 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004024 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004025 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004026 }
4027
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004028## # check for blank lines before declarations
4029## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4030## $prevrawline =~ /^.\s*$/) {
4031## WARN("SPACING",
4032## "No blank lines before declarations\n" . $hereprev);
4033## }
4034##
4035
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004036# closing brace should have a space following it when it has anything
4037# on the line
4038 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004039 if (ERROR("SPACING",
4040 "space required after that close brace '}'\n" . $herecurr) &&
4041 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004042 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004043 s/}((?!(?:,|;|\)))\S)/} $1/;
4044 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004045 }
4046
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004047# check spacing on square brackets
4048 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004049 if (ERROR("SPACING",
4050 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4051 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004052 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004053 s/\[\s+/\[/;
4054 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004055 }
4056 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004057 if (ERROR("SPACING",
4058 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4059 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004060 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004061 s/\s+\]/\]/;
4062 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004063 }
4064
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004065# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004066 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4067 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004068 if (ERROR("SPACING",
4069 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4070 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004071 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004072 s/\(\s+/\(/;
4073 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004074 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004075 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004076 $line !~ /for\s*\(.*;\s+\)/ &&
4077 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004078 if (ERROR("SPACING",
4079 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4080 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004081 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004082 s/\s+\)/\)/;
4083 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004084 }
4085
Joe Perchese2826fd2014-08-06 16:10:48 -07004086# check unnecessary parentheses around addressof/dereference single $Lvals
4087# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4088
4089 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004090 my $var = $1;
4091 if (CHK("UNNECESSARY_PARENTHESES",
4092 "Unnecessary parentheses around $var\n" . $herecurr) &&
4093 $fix) {
4094 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4095 }
4096 }
4097
4098# check for unnecessary parentheses around function pointer uses
4099# ie: (foo->bar)(); should be foo->bar();
4100# but not "if (foo->bar) (" to avoid some false positives
4101 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4102 my $var = $2;
4103 if (CHK("UNNECESSARY_PARENTHESES",
4104 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4105 $fix) {
4106 my $var2 = deparenthesize($var);
4107 $var2 =~ s/\s//g;
4108 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4109 }
4110 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004111
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004112#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004113 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004114 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004115 if (WARN("INDENTED_LABEL",
4116 "labels should not be indented\n" . $herecurr) &&
4117 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004118 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004119 s/^(.)\s+/$1/;
4120 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004121 }
4122
Joe Perches5b9553a2014-04-03 14:49:21 -07004123# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004124 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004125 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004126 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004127 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4128 my $value = $1;
4129 $value = deparenthesize($value);
4130 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4131 ERROR("RETURN_PARENTHESES",
4132 "return is not a function, parentheses are not required\n" . $herecurr);
4133 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004134 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004135 ERROR("SPACING",
4136 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004137 }
4138 }
Joe Perches507e5142013-11-12 15:10:13 -08004139
Joe Perchesb43ae212014-06-23 13:22:07 -07004140# unnecessary return in a void function
4141# at end-of-function, with the previous line a single leading tab, then return;
4142# and the line before that not a goto label target like "out:"
4143 if ($sline =~ /^[ \+]}\s*$/ &&
4144 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4145 $linenr >= 3 &&
4146 $lines[$linenr - 3] =~ /^[ +]/ &&
4147 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004148 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004149 "void function return statements are not generally useful\n" . $hereprev);
4150 }
Joe Perches9819cf22014-06-04 16:12:09 -07004151
Joe Perches189248d2014-01-23 15:54:47 -08004152# if statements using unnecessary parentheses - ie: if ((foo == bar))
4153 if ($^V && $^V ge 5.10.0 &&
4154 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4155 my $openparens = $1;
4156 my $count = $openparens =~ tr@\(@\(@;
4157 my $msg = "";
4158 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4159 my $comp = $4; #Not $1 because of $LvalOrFunc
4160 $msg = " - maybe == should be = ?" if ($comp eq "==");
4161 WARN("UNNECESSARY_PARENTHESES",
4162 "Unnecessary parentheses$msg\n" . $herecurr);
4163 }
4164 }
4165
Joe Perchesf34e4a42015-04-16 12:44:19 -07004166# Return of what appears to be an errno should normally be negative
4167 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004168 my $name = $1;
4169 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004170 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004171 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004172 }
4173 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004174
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004175# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004176 if ($line =~ /\b(if|while|for|switch)\(/) {
4177 if (ERROR("SPACING",
4178 "space required before the open parenthesis '('\n" . $herecurr) &&
4179 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004180 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004181 s/\b(if|while|for|switch)\(/$1 \(/;
4182 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004183 }
4184
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004185# Check for illegal assignment in if conditional -- and check for trailing
4186# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004187 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004188 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4189 ctx_statement_block($linenr, $realcnt, 0)
4190 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004191 my ($stat_next) = ctx_statement_block($line_nr_next,
4192 $remain_next, $off_next);
4193 $stat_next =~ s/\n./\n /g;
4194 ##print "stat<$stat> stat_next<$stat_next>\n";
4195
4196 if ($stat_next =~ /^\s*while\b/) {
4197 # If the statement carries leading newlines,
4198 # then count those as offsets.
4199 my ($whitespace) =
4200 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4201 my $offset =
4202 statement_rawlines($whitespace) - 1;
4203
4204 $suppress_whiletrailers{$line_nr_next +
4205 $offset} = 1;
4206 }
4207 }
4208 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004209 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004210 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004211 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004212
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004213 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004214 ERROR("ASSIGN_IN_IF",
4215 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004216 }
4217
4218 # Find out what is on the end of the line after the
4219 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004220 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004221 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004222 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004223 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4224 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004225 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004226 # Find out how long the conditional actually is.
4227 my @newlines = ($c =~ /\n/gs);
4228 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004229 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004230
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004231 $stat_real = raw_line($linenr, $cond_lines)
4232 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004233 if (defined($stat_real) && $cond_lines > 1) {
4234 $stat_real = "[...]\n$stat_real";
4235 }
4236
Joe Perches000d1cc12011-07-25 17:13:25 -07004237 ERROR("TRAILING_STATEMENTS",
4238 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004239 }
4240 }
4241
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004242# Check for bitwise tests written as boolean
4243 if ($line =~ /
4244 (?:
4245 (?:\[|\(|\&\&|\|\|)
4246 \s*0[xX][0-9]+\s*
4247 (?:\&\&|\|\|)
4248 |
4249 (?:\&\&|\|\|)
4250 \s*0[xX][0-9]+\s*
4251 (?:\&\&|\|\||\)|\])
4252 )/x)
4253 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004254 WARN("HEXADECIMAL_BOOLEAN_TEST",
4255 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004256 }
4257
Andy Whitcroft8905a672007-11-28 16:21:06 -08004258# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004259 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4260 my $s = $1;
4261 $s =~ s/$;//g; # Remove any comments
4262 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004263 ERROR("TRAILING_STATEMENTS",
4264 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004265 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004266 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004267# if should not continue a brace
4268 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004269 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004270 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004271 $herecurr);
4272 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004273# case and default should not have general statements after them
4274 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4275 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004276 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004277 \s*return\s+
4278 )/xg)
4279 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004280 ERROR("TRAILING_STATEMENTS",
4281 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004282 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004283
4284 # Check for }<nl>else {, these must be at the same
4285 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004286 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4287 $previndent == $indent) {
4288 if (ERROR("ELSE_AFTER_BRACE",
4289 "else should follow close brace '}'\n" . $hereprev) &&
4290 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4291 fix_delete_line($fixlinenr - 1, $prevrawline);
4292 fix_delete_line($fixlinenr, $rawline);
4293 my $fixedline = $prevrawline;
4294 $fixedline =~ s/}\s*$//;
4295 if ($fixedline !~ /^\+\s*$/) {
4296 fix_insert_line($fixlinenr, $fixedline);
4297 }
4298 $fixedline = $rawline;
4299 $fixedline =~ s/^(.\s*)else/$1} else/;
4300 fix_insert_line($fixlinenr, $fixedline);
4301 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004302 }
4303
Joe Perches8b8856f2014-08-06 16:11:14 -07004304 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4305 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004306 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4307
4308 # Find out what is on the end of the line after the
4309 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004310 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004311 $s =~ s/\n.*//g;
4312
4313 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004314 if (ERROR("WHILE_AFTER_BRACE",
4315 "while should follow close brace '}'\n" . $hereprev) &&
4316 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4317 fix_delete_line($fixlinenr - 1, $prevrawline);
4318 fix_delete_line($fixlinenr, $rawline);
4319 my $fixedline = $prevrawline;
4320 my $trailing = $rawline;
4321 $trailing =~ s/^\+//;
4322 $trailing = trim($trailing);
4323 $fixedline =~ s/}\s*$/} $trailing/;
4324 fix_insert_line($fixlinenr, $fixedline);
4325 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004326 }
4327 }
4328
Joe Perches95e2c602013-07-03 15:05:20 -07004329#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004330 while ($line =~ m{($Constant|$Lval)}g) {
4331 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004332
4333#gcc binary extension
4334 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004335 if (WARN("GCC_BINARY_CONSTANT",
4336 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4337 $fix) {
4338 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004339 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004340 s/\b$var\b/$hexval/;
4341 }
Joe Perches95e2c602013-07-03 15:05:20 -07004342 }
4343
4344#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004345 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004346 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004347#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004348 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004349#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004350 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4351#Ignore some three character SI units explicitly, like MiB and KHz
4352 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004353 while ($var =~ m{($Ident)}g) {
4354 my $word = $1;
4355 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004356 if ($check) {
4357 seed_camelcase_includes();
4358 if (!$file && !$camelcase_file_seeded) {
4359 seed_camelcase_file($realfile);
4360 $camelcase_file_seeded = 1;
4361 }
4362 }
Joe Perches7e781f62013-09-11 14:23:55 -07004363 if (!defined $camelcase{$word}) {
4364 $camelcase{$word} = 1;
4365 CHK("CAMELCASE",
4366 "Avoid CamelCase: <$word>\n" . $herecurr);
4367 }
Joe Perches34456862013-07-03 15:05:34 -07004368 }
Joe Perches323c1262012-12-17 16:02:07 -08004369 }
4370 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004371
4372#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004373 if ($line =~ /\#\s*define.*\\\s+$/) {
4374 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4375 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4376 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004377 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004378 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004379 }
4380
Fabian Frederick0e212e02015-04-16 12:44:25 -07004381# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4382# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004383 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004384 my $file = "$1.h";
4385 my $checkfile = "include/linux/$file";
4386 if (-f "$root/$checkfile" &&
4387 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004388 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004389 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004390 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4391 if ($asminclude > 0) {
4392 if ($realfile =~ m{^arch/}) {
4393 CHK("ARCH_INCLUDE_LINUX",
4394 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4395 } else {
4396 WARN("INCLUDE_LINUX",
4397 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4398 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004399 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004400 }
4401 }
4402
Andy Whitcroft653d4872007-06-23 17:16:34 -07004403# multi-statement macros should be enclosed in a do while loop, grab the
4404# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004405# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004406 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4407 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004408 my $ln = $linenr;
4409 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004410 my ($off, $dstat, $dcond, $rest);
4411 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004412 my $has_flow_statement = 0;
4413 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004414 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004415 ctx_statement_block($linenr, $realcnt, 0);
4416 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004417 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004418 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004419
Joe Perches08a28432014-10-13 15:51:55 -07004420 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4421 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4422
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004423 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004424 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004425 $dstat =~ s/\\\n.//g;
4426 $dstat =~ s/^\s*//s;
4427 $dstat =~ s/\s*$//s;
4428
4429 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004430 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4431 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004432 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004433 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004434 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004435
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004436 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004437 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4438 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004439 {
4440 }
4441
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004442 my $exceptions = qr{
4443 $Declare|
4444 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004445 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004446 DECLARE_PER_CPU|
4447 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004448 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004449 union|
4450 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004451 \.$Ident\s*=\s*|
4452 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004453 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004454 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004455 if ($dstat ne '' &&
4456 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4457 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004458 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004459 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004460 $dstat !~ /$exceptions/ &&
4461 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004462 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004463 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004464 $dstat !~ /^for\s*$Constant$/ && # for (...)
4465 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4466 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004467 $dstat !~ /^\({/ && # ({...
4468 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004469 {
4470 $ctx =~ s/\n*$//;
4471 my $herectx = $here . "\n";
4472 my $cnt = statement_rawlines($ctx);
4473
4474 for (my $n = 0; $n < $cnt; $n++) {
4475 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004476 }
4477
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004478 if ($dstat =~ /;/) {
4479 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4480 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4481 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004482 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004483 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004484 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004485 }
Joe Perches5023d342012-12-17 16:01:47 -08004486
Joe Perches08a28432014-10-13 15:51:55 -07004487# check for macros with flow control, but without ## concatenation
4488# ## concatenation is commonly a macro that defines a function so ignore those
4489 if ($has_flow_statement && !$has_arg_concat) {
4490 my $herectx = $here . "\n";
4491 my $cnt = statement_rawlines($ctx);
4492
4493 for (my $n = 0; $n < $cnt; $n++) {
4494 $herectx .= raw_line($linenr, $n) . "\n";
4495 }
4496 WARN("MACRO_WITH_FLOW_CONTROL",
4497 "Macros with flow control statements should be avoided\n" . "$herectx");
4498 }
4499
Joe Perches481eb482012-12-17 16:01:56 -08004500# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004501
4502 } else {
4503 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004504 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4505 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004506 $line =~ /^\+.*\\$/) {
4507 WARN("LINE_CONTINUATIONS",
4508 "Avoid unnecessary line continuations\n" . $herecurr);
4509 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004510 }
4511
Joe Perchesb13edf72012-07-30 14:41:24 -07004512# do {} while (0) macro tests:
4513# single-statement macros do not need to be enclosed in do while (0) loop,
4514# macro should not end with a semicolon
4515 if ($^V && $^V ge 5.10.0 &&
4516 $realfile !~ m@/vmlinux.lds.h$@ &&
4517 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4518 my $ln = $linenr;
4519 my $cnt = $realcnt;
4520 my ($off, $dstat, $dcond, $rest);
4521 my $ctx = '';
4522 ($dstat, $dcond, $ln, $cnt, $off) =
4523 ctx_statement_block($linenr, $realcnt, 0);
4524 $ctx = $dstat;
4525
4526 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004527 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004528
4529 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4530 my $stmts = $2;
4531 my $semis = $3;
4532
4533 $ctx =~ s/\n*$//;
4534 my $cnt = statement_rawlines($ctx);
4535 my $herectx = $here . "\n";
4536
4537 for (my $n = 0; $n < $cnt; $n++) {
4538 $herectx .= raw_line($linenr, $n) . "\n";
4539 }
4540
Joe Perchesac8e97f2012-08-21 16:15:53 -07004541 if (($stmts =~ tr/;/;/) == 1 &&
4542 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004543 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4544 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4545 }
4546 if (defined $semis && $semis ne "") {
4547 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4548 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4549 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004550 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4551 $ctx =~ s/\n*$//;
4552 my $cnt = statement_rawlines($ctx);
4553 my $herectx = $here . "\n";
4554
4555 for (my $n = 0; $n < $cnt; $n++) {
4556 $herectx .= raw_line($linenr, $n) . "\n";
4557 }
4558
4559 WARN("TRAILING_SEMICOLON",
4560 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004561 }
4562 }
4563
Mike Frysinger080ba922009-01-06 14:41:25 -08004564# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4565# all assignments may have only one of the following with an assignment:
4566# .
4567# ALIGN(...)
4568# VMLINUX_SYMBOL(...)
4569 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004570 WARN("MISSING_VMLINUX_SYMBOL",
4571 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004572 }
4573
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004574# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004575 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4576 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004577 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004578 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004579 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4580 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004581 my @allowed = ();
4582 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004583 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004584 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004585 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004586 for my $chunk (@chunks) {
4587 my ($cond, $block) = @{$chunk};
4588
Andy Whitcroft773647a2008-03-28 14:15:58 -07004589 # If the condition carries leading newlines, then count those as offsets.
4590 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4591 my $offset = statement_rawlines($whitespace) - 1;
4592
Joe Perchesaad4f612012-03-23 15:02:19 -07004593 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004594 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4595
4596 # We have looked at and allowed this specific line.
4597 $suppress_ifbraces{$ln + $offset} = 1;
4598
4599 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004600 $ln += statement_rawlines($block) - 1;
4601
Andy Whitcroft773647a2008-03-28 14:15:58 -07004602 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004603
4604 $seen++ if ($block =~ /^\s*{/);
4605
Joe Perchesaad4f612012-03-23 15:02:19 -07004606 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004607 if (statement_lines($cond) > 1) {
4608 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004609 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004610 }
4611 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004612 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004613 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004614 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004615 if (statement_block_size($block) > 1) {
4616 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004617 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004618 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004619 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004620 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004621 if ($seen) {
4622 my $sum_allowed = 0;
4623 foreach (@allowed) {
4624 $sum_allowed += $_;
4625 }
4626 if ($sum_allowed == 0) {
4627 WARN("BRACES",
4628 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4629 } elsif ($sum_allowed != $allow &&
4630 $seen != $allow) {
4631 CHK("BRACES",
4632 "braces {} should be used on all arms of this statement\n" . $herectx);
4633 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004634 }
4635 }
4636 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004637 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004638 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004639 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004640
Andy Whitcroftcf655042008-03-04 14:28:20 -08004641 # Check the pre-context.
4642 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4643 #print "APW: ALLOWED: pre<$1>\n";
4644 $allowed = 1;
4645 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004646
4647 my ($level, $endln, @chunks) =
4648 ctx_statement_full($linenr, $realcnt, $-[0]);
4649
Andy Whitcroftcf655042008-03-04 14:28:20 -08004650 # Check the condition.
4651 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004652 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004653 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004654 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004655 }
4656 if (statement_lines($cond) > 1) {
4657 #print "APW: ALLOWED: cond<$cond>\n";
4658 $allowed = 1;
4659 }
4660 if ($block =~/\b(?:if|for|while)\b/) {
4661 #print "APW: ALLOWED: block<$block>\n";
4662 $allowed = 1;
4663 }
4664 if (statement_block_size($block) > 1) {
4665 #print "APW: ALLOWED: lines block<$block>\n";
4666 $allowed = 1;
4667 }
4668 # Check the post-context.
4669 if (defined $chunks[1]) {
4670 my ($cond, $block) = @{$chunks[1]};
4671 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004672 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004673 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004674 if ($block =~ /^\s*\{/) {
4675 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4676 $allowed = 1;
4677 }
4678 }
4679 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004680 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004681 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004682
Andy Whitcroftf0556632008-10-15 22:02:23 -07004683 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004684 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004685 }
4686
Joe Perches000d1cc12011-07-25 17:13:25 -07004687 WARN("BRACES",
4688 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004689 }
4690 }
4691
Joe Perches0979ae62012-12-17 16:01:59 -08004692# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004693 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004694 if (CHK("BRACES",
4695 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4696 $fix && $prevrawline =~ /^\+/) {
4697 fix_delete_line($fixlinenr - 1, $prevrawline);
4698 }
Joe Perches0979ae62012-12-17 16:01:59 -08004699 }
Joe Perches77b9a532013-07-03 15:05:29 -07004700 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004701 if (CHK("BRACES",
4702 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4703 $fix) {
4704 fix_delete_line($fixlinenr, $rawline);
4705 }
Joe Perches0979ae62012-12-17 16:01:59 -08004706 }
4707
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004708# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004709 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4710 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004711 WARN("VOLATILE",
4712 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004713 }
4714
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004715# Check for user-visible strings broken across lines, which breaks the ability
4716# to grep for the string. Make exceptions when the previous string ends in a
4717# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4718# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004719 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004720 $prevline =~ /"\s*$/ &&
4721 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4722 if (WARN("SPLIT_STRING",
4723 "quoted string split across lines\n" . $hereprev) &&
4724 $fix &&
4725 $prevrawline =~ /^\+.*"\s*$/ &&
4726 $last_coalesced_string_linenr != $linenr - 1) {
4727 my $extracted_string = get_quoted_string($line, $rawline);
4728 my $comma_close = "";
4729 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4730 $comma_close = $1;
4731 }
4732
4733 fix_delete_line($fixlinenr - 1, $prevrawline);
4734 fix_delete_line($fixlinenr, $rawline);
4735 my $fixedline = $prevrawline;
4736 $fixedline =~ s/"\s*$//;
4737 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4738 fix_insert_line($fixlinenr - 1, $fixedline);
4739 $fixedline = $rawline;
4740 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4741 if ($fixedline !~ /\+\s*$/) {
4742 fix_insert_line($fixlinenr, $fixedline);
4743 }
4744 $last_coalesced_string_linenr = $linenr;
4745 }
4746 }
4747
4748# check for missing a space in a string concatenation
4749 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4750 WARN('MISSING_SPACE',
4751 "break quoted strings at a space character\n" . $hereprev);
4752 }
4753
4754# check for spaces before a quoted newline
4755 if ($rawline =~ /^.*\".*\s\\n/) {
4756 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4757 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4758 $fix) {
4759 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4760 }
4761
4762 }
4763
Joe Perchesf17dba42014-10-13 15:51:51 -07004764# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07004765 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07004766 CHK("CONCATENATED_STRING",
4767 "Concatenated strings should use spaces between elements\n" . $herecurr);
4768 }
4769
Joe Perches90ad30e2014-12-10 15:51:59 -08004770# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07004771 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08004772 WARN("STRING_FRAGMENTS",
4773 "Consecutive strings are generally better as a single string\n" . $herecurr);
4774 }
4775
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004776# check for %L{u,d,i} in strings
4777 my $string;
4778 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4779 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4780 $string =~ s/%%/__/g;
4781 if ($string =~ /(?<!%)%L[udi]/) {
4782 WARN("PRINTF_L",
4783 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4784 last;
4785 }
4786 }
4787
4788# check for line continuations in quoted strings with odd counts of "
4789 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4790 WARN("LINE_CONTINUATIONS",
4791 "Avoid line continuations in quoted strings\n" . $herecurr);
4792 }
4793
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004794# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004795 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004796 CHK("REDUNDANT_CODE",
4797 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004798 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004799 }
4800
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004801# check for needless "if (<foo>) fn(<foo>)" uses
4802 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4803 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4804 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4805 WARN('NEEDLESS_IF',
Fabio Estevam15160f92014-12-10 15:51:40 -08004806 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004807 }
4808 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004809
Joe Perchesebfdc402014-08-06 16:10:27 -07004810# check for unnecessary "Out of Memory" messages
4811 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4812 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4813 (defined $1 || defined $3) &&
4814 $linenr > 3) {
4815 my $testval = $2;
4816 my $testline = $lines[$linenr - 3];
4817
4818 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4819# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4820
4821 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4822 WARN("OOM_MESSAGE",
4823 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4824 }
4825 }
4826
Joe Perchesf78d98f2014-10-13 15:52:01 -07004827# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08004828 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07004829 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4830 my $level = $1;
4831 if (WARN("UNNECESSARY_KERN_LEVEL",
4832 "Possible unnecessary $level\n" . $herecurr) &&
4833 $fix) {
4834 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4835 }
4836 }
4837
Joe Perchesabb08a52014-12-10 15:51:46 -08004838# check for mask then right shift without a parentheses
4839 if ($^V && $^V ge 5.10.0 &&
4840 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4841 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4842 WARN("MASK_THEN_SHIFT",
4843 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4844 }
4845
Joe Perchesb75ac612014-12-10 15:52:02 -08004846# check for pointer comparisons to NULL
4847 if ($^V && $^V ge 5.10.0) {
4848 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4849 my $val = $1;
4850 my $equal = "!";
4851 $equal = "" if ($4 eq "!=");
4852 if (CHK("COMPARISON_TO_NULL",
4853 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4854 $fix) {
4855 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4856 }
4857 }
4858 }
4859
Joe Perches8716de32013-09-11 14:24:05 -07004860# check for bad placement of section $InitAttribute (e.g.: __initdata)
4861 if ($line =~ /(\b$InitAttribute\b)/) {
4862 my $attr = $1;
4863 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4864 my $ptr = $1;
4865 my $var = $2;
4866 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4867 ERROR("MISPLACED_INIT",
4868 "$attr should be placed after $var\n" . $herecurr)) ||
4869 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4870 WARN("MISPLACED_INIT",
4871 "$attr should be placed after $var\n" . $herecurr))) &&
4872 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004873 $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 -07004874 }
4875 }
4876 }
4877
Joe Perchese970b8842013-11-12 15:10:10 -08004878# check for $InitAttributeData (ie: __initdata) with const
4879 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4880 my $attr = $1;
4881 $attr =~ /($InitAttributePrefix)(.*)/;
4882 my $attr_prefix = $1;
4883 my $attr_type = $2;
4884 if (ERROR("INIT_ATTRIBUTE",
4885 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4886 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004887 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004888 s/$InitAttributeData/${attr_prefix}initconst/;
4889 }
4890 }
4891
4892# check for $InitAttributeConst (ie: __initconst) without const
4893 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4894 my $attr = $1;
4895 if (ERROR("INIT_ATTRIBUTE",
4896 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4897 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004898 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004899 /(^\+\s*(?:static\s+))/;
4900 $lead = rtrim($1);
4901 $lead = "$lead " if ($lead !~ /^\+$/);
4902 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004903 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08004904 }
4905 }
4906
Joe Perchesc17893c2015-04-16 12:44:42 -07004907# check for __read_mostly with const non-pointer (should just be const)
4908 if ($line =~ /\b__read_mostly\b/ &&
4909 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
4910 if (ERROR("CONST_READ_MOSTLY",
4911 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
4912 $fix) {
4913 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
4914 }
4915 }
4916
Joe Perchesfbdb8132014-04-03 14:49:14 -07004917# don't use __constant_<foo> functions outside of include/uapi/
4918 if ($realfile !~ m@^include/uapi/@ &&
4919 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4920 my $constant_func = $1;
4921 my $func = $constant_func;
4922 $func =~ s/^__constant_//;
4923 if (WARN("CONSTANT_CONVERSION",
4924 "$constant_func should be $func\n" . $herecurr) &&
4925 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004926 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004927 }
4928 }
4929
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004930# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004931 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004932 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004933 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004934 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004935 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004936 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4937 }
4938 if ($delay > 2000) {
4939 WARN("LONG_UDELAY",
4940 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004941 }
4942 }
4943
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004944# warn about unexpectedly long msleep's
4945 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4946 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004947 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004948 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004949 }
4950 }
4951
Joe Perches36ec1932013-07-03 15:05:25 -07004952# check for comparisons of jiffies
4953 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4954 WARN("JIFFIES_COMPARISON",
4955 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4956 }
4957
Joe Perches9d7a34a2013-07-03 15:05:26 -07004958# check for comparisons of get_jiffies_64()
4959 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4960 WARN("JIFFIES_COMPARISON",
4961 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4962 }
4963
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004964# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004965# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004966# print "#ifdef in C files should be avoided\n";
4967# print "$herecurr";
4968# $clean = 0;
4969# }
4970
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004971# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004972 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004973 if (ERROR("SPACING",
4974 "exactly one space required after that #$1\n" . $herecurr) &&
4975 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004976 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004977 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4978 }
4979
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004980 }
4981
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004982# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004983 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4984 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004985 my $which = $1;
4986 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004987 CHK("UNCOMMENTED_DEFINITION",
4988 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004989 }
4990 }
4991# check for memory barriers without a comment.
4992 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4993 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004994 WARN("MEMORY_BARRIER",
4995 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004996 }
4997 }
Joe Perchescb426e92015-06-25 15:02:46 -07004998# check for waitqueue_active without a comment.
4999 if ($line =~ /\bwaitqueue_active\s*\(/) {
5000 if (!ctx_has_comment($first_line, $linenr)) {
5001 WARN("WAITQUEUE_ACTIVE",
5002 "waitqueue_active without comment\n" . $herecurr);
5003 }
5004 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005005# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005006 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005007 CHK("ARCH_DEFINES",
5008 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005009 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005010
Tobias Klauserd4977c72010-05-24 14:33:30 -07005011# Check that the storage class is at the beginning of a declaration
5012 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005013 WARN("STORAGE_CLASS",
5014 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005015 }
5016
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005017# check the location of the inline attribute, that it is between
5018# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005019 if ($line =~ /\b$Type\s+$Inline\b/ ||
5020 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005021 ERROR("INLINE_LOCATION",
5022 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005023 }
5024
Andy Whitcroft8905a672007-11-28 16:21:06 -08005025# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005026 if ($realfile !~ m@\binclude/uapi/@ &&
5027 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005028 if (WARN("INLINE",
5029 "plain inline is preferred over $1\n" . $herecurr) &&
5030 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005031 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005032
5033 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005034 }
5035
Joe Perches3d130fd2011-01-12 17:00:00 -08005036# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005037 if ($realfile !~ m@\binclude/uapi/@ &&
5038 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005039 WARN("PREFER_PACKED",
5040 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005041 }
5042
Joe Perches39b7e282011-07-25 17:13:24 -07005043# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005044 if ($realfile !~ m@\binclude/uapi/@ &&
5045 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005046 WARN("PREFER_ALIGNED",
5047 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005048 }
5049
Joe Perches5f14d3b2012-01-10 15:09:52 -08005050# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005051 if ($realfile !~ m@\binclude/uapi/@ &&
5052 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005053 if (WARN("PREFER_PRINTF",
5054 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5055 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005056 $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 -07005057
5058 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005059 }
5060
Joe Perches6061d942012-03-23 15:02:16 -07005061# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005062 if ($realfile !~ m@\binclude/uapi/@ &&
5063 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005064 if (WARN("PREFER_SCANF",
5065 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5066 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005067 $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 -07005068 }
Joe Perches6061d942012-03-23 15:02:16 -07005069 }
5070
Joe Perches619a9082014-12-10 15:51:35 -08005071# Check for __attribute__ weak, or __weak declarations (may have link issues)
5072 if ($^V && $^V ge 5.10.0 &&
5073 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5074 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5075 $line =~ /\b__weak\b/)) {
5076 ERROR("WEAK_DECLARATION",
5077 "Using weak declarations can have unintended link defects\n" . $herecurr);
5078 }
5079
Joe Perchese6176fa2015-06-25 15:02:49 -07005080# check for c99 types like uint8_t used outside of uapi/
5081 if ($realfile !~ m@\binclude/uapi/@ &&
5082 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5083 my $type = $1;
5084 if ($type =~ /\b($typeC99Typedefs)\b/) {
5085 $type = $1;
5086 my $kernel_type = 'u';
5087 $kernel_type = 's' if ($type =~ /^_*[si]/);
5088 $type =~ /(\d+)/;
5089 $kernel_type .= $1;
5090 if (CHK("PREFER_KERNEL_TYPES",
5091 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5092 $fix) {
5093 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5094 }
5095 }
5096 }
5097
Joe Perches8f53a9b2010-03-05 13:43:48 -08005098# check for sizeof(&)
5099 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005100 WARN("SIZEOF_ADDRESS",
5101 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005102 }
5103
Joe Perches66c80b62012-07-30 14:41:22 -07005104# check for sizeof without parenthesis
5105 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005106 if (WARN("SIZEOF_PARENTHESIS",
5107 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5108 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005109 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005110 }
Joe Perches66c80b62012-07-30 14:41:22 -07005111 }
5112
Joe Perches88982fe2012-12-17 16:02:00 -08005113# check for struct spinlock declarations
5114 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5115 WARN("USE_SPINLOCK_T",
5116 "struct spinlock should be spinlock_t\n" . $herecurr);
5117 }
5118
Joe Perchesa6962d72013-04-29 16:18:13 -07005119# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005120 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005121 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005122 $fmt =~ s/%%//g;
5123 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005124 if (WARN("PREFER_SEQ_PUTS",
5125 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5126 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005127 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005128 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005129 }
5130 }
5131
Andy Whitcroft554e1652012-01-10 15:09:57 -08005132# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005133 if ($^V && $^V ge 5.10.0 &&
5134 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005135 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005136
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005137 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005138 my $ms_val = $7;
5139 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005140
Andy Whitcroft554e1652012-01-10 15:09:57 -08005141 if ($ms_size =~ /^(0x|)0$/i) {
5142 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005143 "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 -08005144 } elsif ($ms_size =~ /^(0x|)1$/i) {
5145 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005146 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5147 }
5148 }
5149
Joe Perches98a9bba2014-01-23 15:54:52 -08005150# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5151 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005152 defined $stat &&
5153 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005154 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005155 "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 -08005156 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005157 $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 -08005158 }
5159 }
5160
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005161# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5162 if ($^V && $^V ge 5.10.0 &&
5163 defined $stat &&
5164 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5165 WARN("PREFER_ETHER_ADDR_EQUAL",
5166 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5167 }
5168
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005169# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5170# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5171 if ($^V && $^V ge 5.10.0 &&
5172 defined $stat &&
5173 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5174
5175 my $ms_val = $7;
5176
5177 if ($ms_val =~ /^(?:0x|)0+$/i) {
5178 if (WARN("PREFER_ETH_ZERO_ADDR",
5179 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5180 $fix) {
5181 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5182 }
5183 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5184 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5185 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5186 $fix) {
5187 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5188 }
5189 }
5190 }
5191
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005192# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005193 if ($^V && $^V ge 5.10.0 &&
5194 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005195 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005196 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005197 my $call = $1;
5198 my $cast1 = deparenthesize($2);
5199 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005200 my $cast2 = deparenthesize($7);
5201 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005202 my $cast;
5203
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005204 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005205 $cast = "$cast1 or $cast2";
5206 } elsif ($cast1 ne "") {
5207 $cast = $cast1;
5208 } else {
5209 $cast = $cast2;
5210 }
5211 WARN("MINMAX",
5212 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005213 }
5214 }
5215
Joe Perches4a273192012-07-30 14:41:20 -07005216# check usleep_range arguments
5217 if ($^V && $^V ge 5.10.0 &&
5218 defined $stat &&
5219 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5220 my $min = $1;
5221 my $max = $7;
5222 if ($min eq $max) {
5223 WARN("USLEEP_RANGE",
5224 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5225 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5226 $min > $max) {
5227 WARN("USLEEP_RANGE",
5228 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5229 }
5230 }
5231
Joe Perches823b7942013-11-12 15:10:15 -08005232# check for naked sscanf
5233 if ($^V && $^V ge 5.10.0 &&
5234 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005235 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005236 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5237 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5238 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5239 my $lc = $stat =~ tr@\n@@;
5240 $lc = $lc + $linenr;
5241 my $stat_real = raw_line($linenr, 0);
5242 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5243 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5244 }
5245 WARN("NAKED_SSCANF",
5246 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5247 }
5248
Joe Perchesafc819a2014-06-04 16:12:08 -07005249# check for simple sscanf that should be kstrto<foo>
5250 if ($^V && $^V ge 5.10.0 &&
5251 defined $stat &&
5252 $line =~ /\bsscanf\b/) {
5253 my $lc = $stat =~ tr@\n@@;
5254 $lc = $lc + $linenr;
5255 my $stat_real = raw_line($linenr, 0);
5256 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5257 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5258 }
5259 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5260 my $format = $6;
5261 my $count = $format =~ tr@%@%@;
5262 if ($count == 1 &&
5263 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5264 WARN("SSCANF_TO_KSTRTO",
5265 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5266 }
5267 }
5268 }
5269
Joe Perches70dc8a42013-09-11 14:23:58 -07005270# check for new externs in .h files.
5271 if ($realfile =~ /\.h$/ &&
5272 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005273 if (CHK("AVOID_EXTERNS",
5274 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005275 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005276 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005277 }
5278 }
5279
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005280# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005281 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005282 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005283 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005284 my $function_name = $1;
5285 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005286
5287 my $s = $stat;
5288 if (defined $cond) {
5289 substr($s, 0, length($cond), '');
5290 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005291 if ($s =~ /^\s*;/ &&
5292 $function_name ne 'uninitialized_var')
5293 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005294 WARN("AVOID_EXTERNS",
5295 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005296 }
5297
5298 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005299 WARN("FUNCTION_ARGUMENTS",
5300 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005301 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005302
5303 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5304 $stat =~ /^.\s*extern\s+/)
5305 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005306 WARN("AVOID_EXTERNS",
5307 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005308 }
5309
5310# checks for new __setup's
5311 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5312 my $name = $1;
5313
5314 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005315 CHK("UNDOCUMENTED_SETUP",
5316 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005317 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005318 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005319
5320# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005321 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005322 WARN("UNNECESSARY_CASTS",
5323 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005324 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005325
Joe Perchesa640d252013-07-03 15:05:21 -07005326# alloc style
5327# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5328 if ($^V && $^V ge 5.10.0 &&
5329 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5330 CHK("ALLOC_SIZEOF_STRUCT",
5331 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5332 }
5333
Joe Perches60a55362014-06-04 16:12:07 -07005334# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5335 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005336 $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 -07005337 my $oldfunc = $3;
5338 my $a1 = $4;
5339 my $a2 = $10;
5340 my $newfunc = "kmalloc_array";
5341 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005342 my $r1 = $a1;
5343 my $r2 = $a2;
5344 if ($a1 =~ /^sizeof\s*\S/) {
5345 $r1 = $a2;
5346 $r2 = $a1;
5347 }
5348 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5349 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005350 if (WARN("ALLOC_WITH_MULTIPLY",
5351 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5352 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005353 $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 -07005354
5355 }
5356 }
5357 }
5358
Joe Perches972fdea2013-04-29 16:18:12 -07005359# check for krealloc arg reuse
5360 if ($^V && $^V ge 5.10.0 &&
5361 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5362 WARN("KREALLOC_ARG_REUSE",
5363 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5364 }
5365
Joe Perches5ce59ae2013-02-21 16:44:18 -08005366# check for alloc argument mismatch
5367 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5368 WARN("ALLOC_ARRAY_ARGS",
5369 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5370 }
5371
Joe Perchescaf2a542011-01-12 16:59:56 -08005372# check for multiple semicolons
5373 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005374 if (WARN("ONE_SEMICOLON",
5375 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5376 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005377 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005378 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005379 }
5380
Joe Perches0ab90192014-12-10 15:51:57 -08005381# check for #defines like: 1 << <digit> that could be BIT(digit)
5382 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5383 my $ull = "";
5384 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5385 if (CHK("BIT_MACRO",
5386 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5387 $fix) {
5388 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5389 }
5390 }
5391
Joe Perchese81f2392014-08-06 16:11:25 -07005392# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005393 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5394 my $has_break = 0;
5395 my $has_statement = 0;
5396 my $count = 0;
5397 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005398 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005399 $prevline--;
5400 my $rline = $rawlines[$prevline - 1];
5401 my $fline = $lines[$prevline - 1];
5402 last if ($fline =~ /^\@\@/);
5403 next if ($fline =~ /^\-/);
5404 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5405 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5406 next if ($fline =~ /^.[\s$;]*$/);
5407 $has_statement = 1;
5408 $count++;
5409 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5410 }
5411 if (!$has_break && $has_statement) {
5412 WARN("MISSING_BREAK",
5413 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5414 }
5415 }
5416
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005417# check for switch/default statements without a break;
5418 if ($^V && $^V ge 5.10.0 &&
5419 defined $stat &&
5420 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5421 my $ctx = '';
5422 my $herectx = $here . "\n";
5423 my $cnt = statement_rawlines($stat);
5424 for (my $n = 0; $n < $cnt; $n++) {
5425 $herectx .= raw_line($linenr, $n) . "\n";
5426 }
5427 WARN("DEFAULT_NO_BREAK",
5428 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005429 }
5430
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005431# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005432 if ($line =~ /\b__FUNCTION__\b/) {
5433 if (WARN("USE_FUNC",
5434 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5435 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005436 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005437 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005438 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005439
Joe Perches62ec8182015-02-13 14:38:18 -08005440# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5441 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5442 ERROR("DATE_TIME",
5443 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5444 }
5445
Joe Perches2c924882012-03-23 15:02:20 -07005446# check for use of yield()
5447 if ($line =~ /\byield\s*\(\s*\)/) {
5448 WARN("YIELD",
5449 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5450 }
5451
Joe Perches179f8f42013-07-03 15:05:30 -07005452# check for comparisons against true and false
5453 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5454 my $lead = $1;
5455 my $arg = $2;
5456 my $test = $3;
5457 my $otype = $4;
5458 my $trail = $5;
5459 my $op = "!";
5460
5461 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5462
5463 my $type = lc($otype);
5464 if ($type =~ /^(?:true|false)$/) {
5465 if (("$test" eq "==" && "$type" eq "true") ||
5466 ("$test" eq "!=" && "$type" eq "false")) {
5467 $op = "";
5468 }
5469
5470 CHK("BOOL_COMPARISON",
5471 "Using comparison to $otype is error prone\n" . $herecurr);
5472
5473## maybe suggesting a correct construct would better
5474## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5475
5476 }
5477 }
5478
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005479# check for semaphores initialized locked
5480 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005481 WARN("CONSIDER_COMPLETION",
5482 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005483 }
Joe Perches6712d852012-03-23 15:02:20 -07005484
Joe Perches67d0a072011-10-31 17:13:10 -07005485# recommend kstrto* over simple_strto* and strict_strto*
5486 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005487 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005488 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005489 }
Joe Perches6712d852012-03-23 15:02:20 -07005490
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005491# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005492 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005493 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005494 "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 -07005495 }
Joe Perches6712d852012-03-23 15:02:20 -07005496
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005497# check for various structs that are normally const (ops, kgdb, device_tree)
5498 my $const_structs = qr{
5499 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005500 address_space_operations|
5501 backlight_ops|
5502 block_device_operations|
5503 dentry_operations|
5504 dev_pm_ops|
5505 dma_map_ops|
5506 extent_io_ops|
5507 file_lock_operations|
5508 file_operations|
5509 hv_ops|
5510 ide_dma_ops|
5511 intel_dvo_dev_ops|
5512 item_operations|
5513 iwl_ops|
5514 kgdb_arch|
5515 kgdb_io|
5516 kset_uevent_ops|
5517 lock_manager_operations|
5518 microcode_ops|
5519 mtrr_ops|
5520 neigh_ops|
5521 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005522 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005523 pci_raw_ops|
5524 pipe_buf_operations|
5525 platform_hibernation_ops|
5526 platform_suspend_ops|
5527 proto_ops|
5528 rpc_pipe_ops|
5529 seq_operations|
5530 snd_ac97_build_ops|
5531 soc_pcmcia_socket_ops|
5532 stacktrace_ops|
5533 sysfs_ops|
5534 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005535 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005536 usb_mon_operations|
5537 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005538 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005539 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005540 WARN("CONST_STRUCT",
5541 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005542 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005543 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005544
5545# use of NR_CPUS is usually wrong
5546# ignore definitions of NR_CPUS and usage to define arrays as likely right
5547 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005548 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5549 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005550 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5551 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5552 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005553 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005554 WARN("NR_CPUS",
5555 "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 -07005556 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005557
Joe Perches52ea8502013-11-12 15:10:09 -08005558# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5559 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5560 ERROR("DEFINE_ARCH_HAS",
5561 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5562 }
5563
Joe Perchesacd93622015-02-13 14:38:38 -08005564# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5565 if ($^V && $^V ge 5.10.0 &&
5566 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5567 WARN("LIKELY_MISUSE",
5568 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5569 }
5570
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005571# whine mightly about in_atomic
5572 if ($line =~ /\bin_atomic\s*\(/) {
5573 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005574 ERROR("IN_ATOMIC",
5575 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005576 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005577 WARN("IN_ATOMIC",
5578 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005579 }
5580 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005581
5582# check for lockdep_set_novalidate_class
5583 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5584 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5585 if ($realfile !~ m@^kernel/lockdep@ &&
5586 $realfile !~ m@^include/linux/lockdep@ &&
5587 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005588 ERROR("LOCKDEP",
5589 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005590 }
5591 }
Dave Jones88f88312011-01-12 16:59:59 -08005592
Joe Perchesb392c642015-04-16 12:44:16 -07005593 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5594 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005595 WARN("EXPORTED_WORLD_WRITABLE",
5596 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005597 }
Joe Perches24358802014-04-03 14:49:13 -07005598
Joe Perches515a2352014-04-03 14:49:24 -07005599# Mode permission misuses where it seems decimal should be octal
5600# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5601 if ($^V && $^V ge 5.10.0 &&
5602 $line =~ /$mode_perms_search/) {
5603 foreach my $entry (@mode_permission_funcs) {
5604 my $func = $entry->[0];
5605 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005606
Joe Perches515a2352014-04-03 14:49:24 -07005607 my $skip_args = "";
5608 if ($arg_pos > 1) {
5609 $arg_pos--;
5610 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5611 }
5612 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5613 if ($line =~ /$test/) {
5614 my $val = $1;
5615 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005616
Joe Perches515a2352014-04-03 14:49:24 -07005617 if ($val !~ /^0$/ &&
5618 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5619 length($val) ne 4)) {
5620 ERROR("NON_OCTAL_PERMISSIONS",
5621 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005622 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5623 ERROR("EXPORTED_WORLD_WRITABLE",
5624 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07005625 }
Joe Perches24358802014-04-03 14:49:13 -07005626 }
5627 }
5628 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07005629
5630# validate content of MODULE_LICENSE against list from include/linux/module.h
5631 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5632 my $extracted_string = get_quoted_string($line, $rawline);
5633 my $valid_licenses = qr{
5634 GPL|
5635 GPL\ v2|
5636 GPL\ and\ additional\ rights|
5637 Dual\ BSD/GPL|
5638 Dual\ MIT/GPL|
5639 Dual\ MPL/GPL|
5640 Proprietary
5641 }x;
5642 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5643 WARN("MODULE_LICENSE",
5644 "unknown module license " . $extracted_string . "\n" . $herecurr);
5645 }
5646 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005647 }
5648
5649 # If we have no input at all, then there is nothing to report on
5650 # so just keep quiet.
5651 if ($#rawlines == -1) {
5652 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005653 }
5654
Andy Whitcroft8905a672007-11-28 16:21:06 -08005655 # In mailback mode only produce a report in the negative, for
5656 # things that appear to be patches.
5657 if ($mailback && ($clean == 1 || !$is_patch)) {
5658 exit(0);
5659 }
5660
5661 # This is not a patch, and we are are in 'no-patch' mode so
5662 # just keep quiet.
5663 if (!$chk_patch && !$is_patch) {
5664 exit(0);
5665 }
5666
Joe Perches06330fc2015-06-25 15:03:11 -07005667 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005668 ERROR("NOT_UNIFIED_DIFF",
5669 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005670 }
Joe Perches34d88152015-06-25 15:03:05 -07005671 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005672 ERROR("MISSING_SIGN_OFF",
5673 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005674 }
5675
Andy Whitcroft8905a672007-11-28 16:21:06 -08005676 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005677 if ($summary && !($clean == 1 && $quiet == 1)) {
5678 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005679 print "total: $cnt_error errors, $cnt_warn warnings, " .
5680 (($check)? "$cnt_chk checks, " : "") .
5681 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005682 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005683
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005684 if ($quiet == 0) {
5685 # If there were whitespace errors which cleanpatch can fix
5686 # then suggest that.
5687 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07005688 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07005689 print << "EOM"
5690
5691NOTE: Whitespace errors detected.
5692 You may wish to use scripts/cleanpatch or scripts/cleanfile
5693EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005694 }
5695 }
5696
Joe Perches91bfe482013-09-11 14:23:59 -07005697 hash_show_words(\%use_type, "Used");
5698 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005699
Joe Perchesd752fcc2014-08-06 16:11:05 -07005700 if ($clean == 0 && $fix &&
5701 ("@rawlines" ne "@fixed" ||
5702 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005703 my $newfile = $filename;
5704 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005705 my $linecount = 0;
5706 my $f;
5707
Joe Perchesd752fcc2014-08-06 16:11:05 -07005708 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5709
Joe Perches3705ce52013-07-03 15:05:31 -07005710 open($f, '>', $newfile)
5711 or die "$P: Can't open $newfile for write\n";
5712 foreach my $fixed_line (@fixed) {
5713 $linecount++;
5714 if ($file) {
5715 if ($linecount > 3) {
5716 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005717 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005718 }
5719 } else {
5720 print $f $fixed_line . "\n";
5721 }
5722 }
5723 close($f);
5724
5725 if (!$quiet) {
5726 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07005727
Joe Perches3705ce52013-07-03 15:05:31 -07005728Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5729
5730Do _NOT_ trust the results written to this file.
5731Do _NOT_ submit these changes without inspecting them for correctness.
5732
5733This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5734No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07005735EOM
5736 }
5737 }
5738
Joe Perchesd8469f12015-06-25 15:03:00 -07005739 if ($quiet == 0) {
5740 print "\n";
5741 if ($clean == 1) {
5742 print "$vname has no obvious style problems and is ready for submission.\n";
5743 } else {
5744 print "$vname has style problems, please review.\n";
5745 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005746 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005747 return $clean;
5748}