blob: 2d88cbf9f884d6fbf8c74e9bb2038b9bc5a6bddf [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 Perches3c816e42015-06-25 15:03:29 -0700206 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700207 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700208 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700209 print " $word";
210 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700211 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700212 }
213}
214
215hash_save_array_words(\%ignore_type, \@ignore);
216hash_save_array_words(\%use_type, \@use);
217
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800218my $dbg_values = 0;
219my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700220my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700221my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800222for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800223 ## no critic
224 eval "\${dbg_$key} = '$debug{$key}';";
225 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800226}
227
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700228my $rpt_cleaners = 0;
229
Andy Whitcroft8905a672007-11-28 16:21:06 -0800230if ($terse) {
231 $emacs = 1;
232 $quiet++;
233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235if ($tree) {
236 if (defined $root) {
237 if (!top_of_kernel_tree($root)) {
238 die "$P: $root: --root does not point at a valid tree\n";
239 }
240 } else {
241 if (top_of_kernel_tree('.')) {
242 $root = '.';
243 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
244 top_of_kernel_tree($1)) {
245 $root = $1;
246 }
247 }
248
249 if (!defined $root) {
250 print "Must be run from the top-level dir. of a kernel tree\n";
251 exit(2);
252 }
Andy 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|
Joe Perches54507b52015-09-09 15:37:55 -0700267 __pmem|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700268 __must_check|
269 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800270 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700271 __ref|
272 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700273 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800274our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
275our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
276our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
277our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
278our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700279
Wolfram Sang52131292010-03-05 13:43:51 -0800280# Notes to $Attribute:
281# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282our $Attribute = qr{
283 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700284 __percpu|
285 __nocast|
286 __safe|
287 __bitwise__|
288 __packed__|
289 __packed2__|
290 __naked|
291 __maybe_unused|
292 __always_unused|
293 __noreturn|
294 __used|
295 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800296 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700297 __noclone|
298 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700299 __read_mostly|
300 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700301 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700302 ____cacheline_aligned|
303 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800304 ____cacheline_internodealigned_in_smp|
305 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700306 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700307our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700308our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700309our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
310our $Lval = qr{$Ident(?:$Member)*};
311
Joe Perches95e2c602013-07-03 15:05:20 -0700312our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
313our $Binary = qr{(?i)0b[01]+$Int_type?};
314our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
315our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700316our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800317our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800318our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
319our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
320our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800321our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700322our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800323our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700324our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700325our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700326our $Operators = qr{
327 <=|>=|==|!=|
328 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700329 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700330 }x;
331
Joe Perches91cb5192014-04-03 14:49:32 -0700332our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
333
Joe Perchesab7e23f2015-04-16 12:44:22 -0700334our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800335our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700336our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700337our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800338our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700339our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800340our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700341our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800342
Joe Perches15662b32011-10-31 17:13:12 -0700343our $NON_ASCII_UTF8 = qr{
344 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700345 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
346 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
347 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
348 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
349 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
350 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
351}x;
352
Joe Perches15662b32011-10-31 17:13:12 -0700353our $UTF8 = qr{
354 [\x09\x0A\x0D\x20-\x7E] # ASCII
355 | $NON_ASCII_UTF8
356}x;
357
Joe Perchese6176fa2015-06-25 15:02:49 -0700358our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800359our $typeOtherOSTypedefs = qr{(?x:
360 u_(?:char|short|int|long) | # bsd
361 u(?:nchar|short|int|long) # sysv
362)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700363our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700364 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700365 atomic_t
366)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700367our $typeTypedefs = qr{(?x:
368 $typeC99Typedefs\b|
369 $typeOtherOSTypedefs\b|
370 $typeKernelTypedefs\b
371)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700372
Joe Perches691e6692010-03-05 13:43:51 -0800373our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700374 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700375 (?:[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 -0700376 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700377 panic|
Joe Perches06668722013-11-12 15:10:07 -0800378 MODULE_[A-Z_]+|
379 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800380)};
381
Joe Perches20112472011-07-25 17:13:23 -0700382our $signature_tags = qr{(?xi:
383 Signed-off-by:|
384 Acked-by:|
385 Tested-by:|
386 Reviewed-by:|
387 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700388 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700389 To:|
390 Cc:
391)};
392
Joe Perches18130872014-08-06 16:11:22 -0700393our @typeListMisordered = (
394 qr{char\s+(?:un)?signed},
395 qr{int\s+(?:(?:un)?signed\s+)?short\s},
396 qr{int\s+short(?:\s+(?:un)?signed)},
397 qr{short\s+int(?:\s+(?:un)?signed)},
398 qr{(?:un)?signed\s+int\s+short},
399 qr{short\s+(?:un)?signed},
400 qr{long\s+int\s+(?:un)?signed},
401 qr{int\s+long\s+(?:un)?signed},
402 qr{long\s+(?:un)?signed\s+int},
403 qr{int\s+(?:un)?signed\s+long},
404 qr{int\s+(?:un)?signed},
405 qr{int\s+long\s+long\s+(?:un)?signed},
406 qr{long\s+long\s+int\s+(?:un)?signed},
407 qr{long\s+long\s+(?:un)?signed\s+int},
408 qr{long\s+long\s+(?:un)?signed},
409 qr{long\s+(?:un)?signed},
410);
411
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412our @typeList = (
413 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700414 qr{(?:(?:un)?signed\s+)?char},
415 qr{(?:(?:un)?signed\s+)?short\s+int},
416 qr{(?:(?:un)?signed\s+)?short},
417 qr{(?:(?:un)?signed\s+)?int},
418 qr{(?:(?:un)?signed\s+)?long\s+int},
419 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
420 qr{(?:(?:un)?signed\s+)?long\s+long},
421 qr{(?:(?:un)?signed\s+)?long},
422 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800423 qr{float},
424 qr{double},
425 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426 qr{struct\s+$Ident},
427 qr{union\s+$Ident},
428 qr{enum\s+$Ident},
429 qr{${Ident}_t},
430 qr{${Ident}_handler},
431 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700432 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800433);
Alex Dowad485ff232015-06-25 15:02:52 -0700434our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700435our @typeListWithAttr = (
436 @typeList,
437 qr{struct\s+$InitAttribute\s+$Ident},
438 qr{union\s+$InitAttribute\s+$Ident},
439);
440
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700441our @modifierList = (
442 qr{fastcall},
443);
Alex Dowad485ff232015-06-25 15:02:52 -0700444our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800445
Joe Perches24358802014-04-03 14:49:13 -0700446our @mode_permission_funcs = (
447 ["module_param", 3],
448 ["module_param_(?:array|named|string)", 4],
449 ["module_param_array_named", 5],
450 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
451 ["proc_create(?:_data|)", 2],
452 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
453);
454
Joe Perches515a2352014-04-03 14:49:24 -0700455#Create a search pattern for all these functions to speed up a loop below
456our $mode_perms_search = "";
457foreach my $entry (@mode_permission_funcs) {
458 $mode_perms_search .= '|' if ($mode_perms_search ne "");
459 $mode_perms_search .= $entry->[0];
460}
461
Joe Perchesb392c642015-04-16 12:44:16 -0700462our $mode_perms_world_writable = qr{
463 S_IWUGO |
464 S_IWOTH |
465 S_IRWXUGO |
466 S_IALLUGO |
467 0[0-7][0-7][2367]
468}x;
469
Wolfram Sang7840a942010-08-09 17:20:57 -0700470our $allowed_asm_includes = qr{(?x:
471 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700472 memory|
473 time|
474 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700475)};
476# memory.h: ARM has a custom one
477
Kees Cook66b47b42014-10-13 15:51:57 -0700478# Load common spelling mistakes and build regular expression list.
479my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700480my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700481
Joe Perches36061e32014-12-10 15:51:43 -0800482if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800483 while (<$spelling>) {
484 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700485
Joe Perches36061e32014-12-10 15:51:43 -0800486 $line =~ s/\s*\n?$//g;
487 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700488
Joe Perches36061e32014-12-10 15:51:43 -0800489 next if ($line =~ m/^\s*#/);
490 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700491
Joe Perches36061e32014-12-10 15:51:43 -0800492 my ($suspect, $fix) = split(/\|\|/, $line);
493
Joe Perches36061e32014-12-10 15:51:43 -0800494 $spelling_fix{$suspect} = $fix;
495 }
496 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800497} else {
498 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700499}
Kees Cook66b47b42014-10-13 15:51:57 -0700500
Joe Perchesebfd7d62015-04-16 12:44:14 -0700501if ($codespell) {
502 if (open(my $spelling, '<', $codespellfile)) {
503 while (<$spelling>) {
504 my $line = $_;
505
506 $line =~ s/\s*\n?$//g;
507 $line =~ s/^\s*//g;
508
509 next if ($line =~ m/^\s*#/);
510 next if ($line =~ m/^\s*$/);
511 next if ($line =~ m/, disabled/i);
512
513 $line =~ s/,.*$//;
514
515 my ($suspect, $fix) = split(/->/, $line);
516
517 $spelling_fix{$suspect} = $fix;
518 }
519 close($spelling);
520 } else {
521 warn "No codespell typos will be found - file '$codespellfile': $!\n";
522 }
523}
524
525$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
526
Andy Whitcroft8905a672007-11-28 16:21:06 -0800527sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700528 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
529 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700530 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700531 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700532 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700533 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700534 (?:$typeTypedefs\b)|
535 (?:${all}\b)
536 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800537 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700538 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800539 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800540 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700541 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700542 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800543 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700544 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800545 }x;
Joe Perches18130872014-08-06 16:11:22 -0700546 $NonptrTypeMisordered = qr{
547 (?:$Modifier\s+|const\s+)*
548 (?:
549 (?:${Misordered}\b)
550 )
551 (?:\s+$Modifier|\s+const)*
552 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700553 $NonptrTypeWithAttr = qr{
554 (?:$Modifier\s+|const\s+)*
555 (?:
556 (?:typeof|__typeof__)\s*\([^\)]*\)|
557 (?:$typeTypedefs\b)|
558 (?:${allWithAttr}\b)
559 )
560 (?:\s+$Modifier|\s+const)*
561 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800562 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700563 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700564 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700565 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800566 }x;
Joe Perches18130872014-08-06 16:11:22 -0700567 $TypeMisordered = qr{
568 $NonptrTypeMisordered
569 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
570 (?:\s+$Inline|\s+$Modifier)*
571 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700572 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700573 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800574}
575build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700576
Joe Perches7d2367a2011-07-25 17:13:22 -0700577our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700578
579# Using $balanced_parens, $LvalOrFunc, or $FuncArg
580# requires at least perl version v5.10.0
581# Any use must be runtime checked with $^V
582
583our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700584our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800585our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700586
Joe Perchesf8422302014-08-06 16:11:31 -0700587our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700588 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700589 (?:$Storage\s+)?LIST_HEAD\s*\(|
590 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
591)};
592
Joe Perches7d2367a2011-07-25 17:13:22 -0700593sub deparenthesize {
594 my ($string) = @_;
595 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700596
597 while ($string =~ /^\s*\(.*\)\s*$/) {
598 $string =~ s@^\s*\(\s*@@;
599 $string =~ s@\s*\)\s*$@@;
600 }
601
Joe Perches7d2367a2011-07-25 17:13:22 -0700602 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700603
Joe Perches7d2367a2011-07-25 17:13:22 -0700604 return $string;
605}
606
Joe Perches34456862013-07-03 15:05:34 -0700607sub seed_camelcase_file {
608 my ($file) = @_;
609
610 return if (!(-f $file));
611
612 local $/;
613
614 open(my $include_file, '<', "$file")
615 or warn "$P: Can't read '$file' $!\n";
616 my $text = <$include_file>;
617 close($include_file);
618
619 my @lines = split('\n', $text);
620
621 foreach my $line (@lines) {
622 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
623 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
624 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800625 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
626 $camelcase{$1} = 1;
627 } 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 -0700628 $camelcase{$1} = 1;
629 }
630 }
631}
632
633my $camelcase_seeded = 0;
634sub seed_camelcase_includes {
635 return if ($camelcase_seeded);
636
637 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700638 my $camelcase_cache = "";
639 my @include_files = ();
640
641 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700642
Richard Genoud3645e322014-02-10 14:25:32 -0800643 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700644 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
645 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700646 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700647 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700648 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700649 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700650 @include_files = split('\n', $files);
651 foreach my $file (@include_files) {
652 my $date = POSIX::strftime("%Y%m%d%H%M",
653 localtime((stat $file)[9]));
654 $last_mod_date = $date if ($last_mod_date < $date);
655 }
656 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700657 }
Joe Perchesc707a812013-07-08 16:00:43 -0700658
659 if ($camelcase_cache ne "" && -f $camelcase_cache) {
660 open(my $camelcase_file, '<', "$camelcase_cache")
661 or warn "$P: Can't read '$camelcase_cache' $!\n";
662 while (<$camelcase_file>) {
663 chomp;
664 $camelcase{$_} = 1;
665 }
666 close($camelcase_file);
667
668 return;
669 }
670
Richard Genoud3645e322014-02-10 14:25:32 -0800671 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700672 $files = `git ls-files "include/*.h"`;
673 @include_files = split('\n', $files);
674 }
675
Joe Perches34456862013-07-03 15:05:34 -0700676 foreach my $file (@include_files) {
677 seed_camelcase_file($file);
678 }
Joe Perches351b2a12013-07-03 15:05:36 -0700679
Joe Perchesc707a812013-07-08 16:00:43 -0700680 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700681 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700682 open(my $camelcase_file, '>', "$camelcase_cache")
683 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700684 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
685 print $camelcase_file ("$_\n");
686 }
687 close($camelcase_file);
688 }
Joe Perches34456862013-07-03 15:05:34 -0700689}
690
Joe Perchesd311cd42014-08-06 16:10:57 -0700691sub git_commit_info {
692 my ($commit, $id, $desc) = @_;
693
694 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
695
696 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
697 $output =~ s/^\s*//gm;
698 my @lines = split("\n", $output);
699
Joe Perches0d7835f2015-02-13 14:38:35 -0800700 return ($id, $desc) if ($#lines < 0);
701
Joe Perchesd311cd42014-08-06 16:10:57 -0700702 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
703# Maybe one day convert this block of bash into something that returns
704# all matching commit ids, but it's very slow...
705#
706# echo "checking commits $1..."
707# git rev-list --remotes | grep -i "^$1" |
708# while read line ; do
709# git log --format='%H %s' -1 $line |
710# echo "commit $(cut -c 1-12,41-)"
711# done
712 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
713 } else {
714 $id = substr($lines[0], 0, 12);
715 $desc = substr($lines[0], 41);
716 }
717
718 return ($id, $desc);
719}
720
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700721$chk_signoff = 0 if ($file);
722
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700723my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800724my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700725my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700726my @fixed_inserted = ();
727my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700728my $fixlinenr = -1;
729
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800730my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700731for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800732 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700733 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800734 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700735 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800736 } elsif ($filename eq '-') {
737 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700738 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800739 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700740 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700741 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800742 if ($filename eq '-') {
743 $vname = 'Your patch';
744 } else {
745 $vname = $filename;
746 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800747 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700748 chomp;
749 push(@rawlines, $_);
750 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800751 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700752
753 if ($#ARGV > 0 && $quiet == 0) {
754 print '-' x length($vname) . "\n";
755 print "$vname\n";
756 print '-' x length($vname) . "\n";
757 }
758
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800759 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700760 $exit = 1;
761 }
762 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800763 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700764 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700765 @fixed_inserted = ();
766 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700767 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700768 @modifierListFile = ();
769 @typeListFile = ();
770 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700771}
772
Joe Perchesd8469f12015-06-25 15:03:00 -0700773if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700774 hash_show_words(\%use_type, "Used");
775 hash_show_words(\%ignore_type, "Ignored");
776
Joe Perchesd8469f12015-06-25 15:03:00 -0700777 if ($^V lt 5.10.0) {
778 print << "EOM"
779
780NOTE: perl $^V is not modern enough to detect all possible issues.
781 An upgrade to at least perl v5.10.0 is suggested.
782EOM
783 }
784 if ($exit) {
785 print << "EOM"
786
787NOTE: If any of the errors are false positives, please report
788 them to the maintainer, see CHECKPATCH in MAINTAINERS.
789EOM
790 }
791}
792
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700793exit($exit);
794
795sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700796 my ($root) = @_;
797
798 my @tree_check = (
799 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
800 "README", "Documentation", "arch", "include", "drivers",
801 "fs", "init", "ipc", "kernel", "lib", "scripts",
802 );
803
804 foreach my $check (@tree_check) {
805 if (! -e $root . '/' . $check) {
806 return 0;
807 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700808 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700809 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700810}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700811
Joe Perches20112472011-07-25 17:13:23 -0700812sub parse_email {
813 my ($formatted_email) = @_;
814
815 my $name = "";
816 my $address = "";
817 my $comment = "";
818
819 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
820 $name = $1;
821 $address = $2;
822 $comment = $3 if defined $3;
823 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
824 $address = $1;
825 $comment = $2 if defined $2;
826 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
827 $address = $1;
828 $comment = $2 if defined $2;
829 $formatted_email =~ s/$address.*$//;
830 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700831 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700832 $name =~ s/^\"|\"$//g;
833 # If there's a name left after stripping spaces and
834 # leading quotes, and the address doesn't have both
835 # leading and trailing angle brackets, the address
836 # is invalid. ie:
837 # "joe smith joe@smith.com" bad
838 # "joe smith <joe@smith.com" bad
839 if ($name ne "" && $address !~ /^<[^>]+>$/) {
840 $name = "";
841 $address = "";
842 $comment = "";
843 }
844 }
845
Joe Perches3705ce52013-07-03 15:05:31 -0700846 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700847 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700848 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700849 $address =~ s/^\<|\>$//g;
850
851 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
852 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
853 $name = "\"$name\"";
854 }
855
856 return ($name, $address, $comment);
857}
858
859sub format_email {
860 my ($name, $address) = @_;
861
862 my $formatted_email;
863
Joe Perches3705ce52013-07-03 15:05:31 -0700864 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700865 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700866 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700867
868 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
869 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
870 $name = "\"$name\"";
871 }
872
873 if ("$name" eq "") {
874 $formatted_email = "$address";
875 } else {
876 $formatted_email = "$name <$address>";
877 }
878
879 return $formatted_email;
880}
881
Joe Perchesd311cd42014-08-06 16:10:57 -0700882sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700883 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700884
Joe Perchesbd474ca2014-08-06 16:11:10 -0700885 foreach my $path (split(/:/, $ENV{PATH})) {
886 if (-e "$path/$bin") {
887 return "$path/$bin";
888 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700889 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700890
Joe Perchesbd474ca2014-08-06 16:11:10 -0700891 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700892}
893
Joe Perches000d1cc12011-07-25 17:13:25 -0700894sub which_conf {
895 my ($conf) = @_;
896
897 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
898 if (-e "$path/$conf") {
899 return "$path/$conf";
900 }
901 }
902
903 return "";
904}
905
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700906sub expand_tabs {
907 my ($str) = @_;
908
909 my $res = '';
910 my $n = 0;
911 for my $c (split(//, $str)) {
912 if ($c eq "\t") {
913 $res .= ' ';
914 $n++;
915 for (; ($n % 8) != 0; $n++) {
916 $res .= ' ';
917 }
918 next;
919 }
920 $res .= $c;
921 $n++;
922 }
923
924 return $res;
925}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700926sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700927 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700928 return $res;
929}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700930
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700931sub line_stats {
932 my ($line) = @_;
933
934 # Drop the diff line leader and expand tabs
935 $line =~ s/^.//;
936 $line = expand_tabs($line);
937
938 # Pick the indent from the front of the line.
939 my ($white) = ($line =~ /^(\s*)/);
940
941 return (length($line), length($white));
942}
943
Andy Whitcroft773647a2008-03-28 14:15:58 -0700944my $sanitise_quote = '';
945
946sub sanitise_line_reset {
947 my ($in_comment) = @_;
948
949 if ($in_comment) {
950 $sanitise_quote = '*/';
951 } else {
952 $sanitise_quote = '';
953 }
954}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700955sub sanitise_line {
956 my ($line) = @_;
957
958 my $res = '';
959 my $l = '';
960
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800961 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700962 my $off = 0;
963 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700964
Andy Whitcroft773647a2008-03-28 14:15:58 -0700965 # Always copy over the diff marker.
966 $res = substr($line, 0, 1);
967
968 for ($off = 1; $off < length($line); $off++) {
969 $c = substr($line, $off, 1);
970
971 # Comments we are wacking completly including the begin
972 # and end, all to $;.
973 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
974 $sanitise_quote = '*/';
975
976 substr($res, $off, 2, "$;$;");
977 $off++;
978 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800979 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700980 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700981 $sanitise_quote = '';
982 substr($res, $off, 2, "$;$;");
983 $off++;
984 next;
985 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700986 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
987 $sanitise_quote = '//';
988
989 substr($res, $off, 2, $sanitise_quote);
990 $off++;
991 next;
992 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700993
994 # A \ in a string means ignore the next character.
995 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
996 $c eq "\\") {
997 substr($res, $off, 2, 'XX');
998 $off++;
999 next;
1000 }
1001 # Regular quotes.
1002 if ($c eq "'" || $c eq '"') {
1003 if ($sanitise_quote eq '') {
1004 $sanitise_quote = $c;
1005
1006 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001007 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001008 } elsif ($sanitise_quote eq $c) {
1009 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001010 }
1011 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001012
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001013 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001014 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1015 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001016 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1017 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001018 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1019 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001020 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001021 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001022 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001023 }
1024
Daniel Walker113f04a2009-09-21 17:04:35 -07001025 if ($sanitise_quote eq '//') {
1026 $sanitise_quote = '';
1027 }
1028
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001029 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001030 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001031 my $clean = 'X' x length($1);
1032 $res =~ s@\<.*\>@<$clean>@;
1033
1034 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001035 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001036 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001037 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001038 }
1039
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001040 return $res;
1041}
1042
Joe Perchesa6962d72013-04-29 16:18:13 -07001043sub get_quoted_string {
1044 my ($line, $rawline) = @_;
1045
Joe Perches33acb542015-06-25 15:02:54 -07001046 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001047 return substr($rawline, $-[0], $+[0] - $-[0]);
1048}
1049
Andy Whitcroft8905a672007-11-28 16:21:06 -08001050sub ctx_statement_block {
1051 my ($linenr, $remain, $off) = @_;
1052 my $line = $linenr - 1;
1053 my $blk = '';
1054 my $soff = $off;
1055 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001056 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001057
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001058 my $loff = 0;
1059
Andy Whitcroft8905a672007-11-28 16:21:06 -08001060 my $type = '';
1061 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001062 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001063 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001064 my $c;
1065 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001066
1067 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001068 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001069 @stack = (['', 0]) if ($#stack == -1);
1070
Andy Whitcroft773647a2008-03-28 14:15:58 -07001071 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001072 # If we are about to drop off the end, pull in more
1073 # context.
1074 if ($off >= $len) {
1075 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001076 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001077 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001078 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001079 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001080 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001081 $len = length($blk);
1082 $line++;
1083 last;
1084 }
1085 # Bail if there is no further context.
1086 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001087 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001088 last;
1089 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001090 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1091 $level++;
1092 $type = '#';
1093 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001094 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001095 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001096 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001097 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001098
Andy Whitcroft773647a2008-03-28 14:15:58 -07001099 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001100
1101 # Handle nested #if/#else.
1102 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1103 push(@stack, [ $type, $level ]);
1104 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1105 ($type, $level) = @{$stack[$#stack - 1]};
1106 } elsif ($remainder =~ /^#\s*endif\b/) {
1107 ($type, $level) = @{pop(@stack)};
1108 }
1109
Andy Whitcroft8905a672007-11-28 16:21:06 -08001110 # Statement ends at the ';' or a close '}' at the
1111 # outermost level.
1112 if ($level == 0 && $c eq ';') {
1113 last;
1114 }
1115
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001116 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001117 if ($level == 0 && $coff_set == 0 &&
1118 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1119 $remainder =~ /^(else)(?:\s|{)/ &&
1120 $remainder !~ /^else\s+if\b/) {
1121 $coff = $off + length($1) - 1;
1122 $coff_set = 1;
1123 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1124 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001125 }
1126
Andy Whitcroft8905a672007-11-28 16:21:06 -08001127 if (($type eq '' || $type eq '(') && $c eq '(') {
1128 $level++;
1129 $type = '(';
1130 }
1131 if ($type eq '(' && $c eq ')') {
1132 $level--;
1133 $type = ($level != 0)? '(' : '';
1134
1135 if ($level == 0 && $coff < $soff) {
1136 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001137 $coff_set = 1;
1138 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001139 }
1140 }
1141 if (($type eq '' || $type eq '{') && $c eq '{') {
1142 $level++;
1143 $type = '{';
1144 }
1145 if ($type eq '{' && $c eq '}') {
1146 $level--;
1147 $type = ($level != 0)? '{' : '';
1148
1149 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001150 if (substr($blk, $off + 1, 1) eq ';') {
1151 $off++;
1152 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001153 last;
1154 }
1155 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001156 # Preprocessor commands end at the newline unless escaped.
1157 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1158 $level--;
1159 $type = '';
1160 $off++;
1161 last;
1162 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001163 $off++;
1164 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001165 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001166 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001167 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001168 $line++;
1169 $remain--;
1170 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001171
1172 my $statement = substr($blk, $soff, $off - $soff + 1);
1173 my $condition = substr($blk, $soff, $coff - $soff + 1);
1174
1175 #warn "STATEMENT<$statement>\n";
1176 #warn "CONDITION<$condition>\n";
1177
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001179
1180 return ($statement, $condition,
1181 $line, $remain + 1, $off - $loff + 1, $level);
1182}
1183
Andy Whitcroftcf655042008-03-04 14:28:20 -08001184sub statement_lines {
1185 my ($stmt) = @_;
1186
1187 # Strip the diff line prefixes and rip blank lines at start and end.
1188 $stmt =~ s/(^|\n)./$1/g;
1189 $stmt =~ s/^\s*//;
1190 $stmt =~ s/\s*$//;
1191
1192 my @stmt_lines = ($stmt =~ /\n/g);
1193
1194 return $#stmt_lines + 2;
1195}
1196
1197sub statement_rawlines {
1198 my ($stmt) = @_;
1199
1200 my @stmt_lines = ($stmt =~ /\n/g);
1201
1202 return $#stmt_lines + 2;
1203}
1204
1205sub statement_block_size {
1206 my ($stmt) = @_;
1207
1208 $stmt =~ s/(^|\n)./$1/g;
1209 $stmt =~ s/^\s*{//;
1210 $stmt =~ s/}\s*$//;
1211 $stmt =~ s/^\s*//;
1212 $stmt =~ s/\s*$//;
1213
1214 my @stmt_lines = ($stmt =~ /\n/g);
1215 my @stmt_statements = ($stmt =~ /;/g);
1216
1217 my $stmt_lines = $#stmt_lines + 2;
1218 my $stmt_statements = $#stmt_statements + 1;
1219
1220 if ($stmt_lines > $stmt_statements) {
1221 return $stmt_lines;
1222 } else {
1223 return $stmt_statements;
1224 }
1225}
1226
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001227sub ctx_statement_full {
1228 my ($linenr, $remain, $off) = @_;
1229 my ($statement, $condition, $level);
1230
1231 my (@chunks);
1232
Andy Whitcroftcf655042008-03-04 14:28:20 -08001233 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001234 ($statement, $condition, $linenr, $remain, $off, $level) =
1235 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001236 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001237 push(@chunks, [ $condition, $statement ]);
1238 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1239 return ($level, $linenr, @chunks);
1240 }
1241
1242 # Pull in the following conditional/block pairs and see if they
1243 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001244 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001245 ($statement, $condition, $linenr, $remain, $off, $level) =
1246 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001247 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001248 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001249 #print "C: push\n";
1250 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001251 }
1252
1253 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001254}
1255
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001256sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001257 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001258 my $line;
1259 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001260 my $blk = '';
1261 my @o;
1262 my @c;
1263 my @res = ();
1264
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001265 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001266 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001267 for ($line = $start; $remain > 0; $line++) {
1268 next if ($rawlines[$line] =~ /^-/);
1269 $remain--;
1270
1271 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001272
1273 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001274 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001275 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001276 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001277 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001278 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001279 $level = pop(@stack);
1280 }
1281
Andy Whitcroft01464f32010-10-26 14:23:19 -07001282 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001283 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1284 if ($off > 0) {
1285 $off--;
1286 next;
1287 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001288
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001289 if ($c eq $close && $level > 0) {
1290 $level--;
1291 last if ($level == 0);
1292 } elsif ($c eq $open) {
1293 $level++;
1294 }
1295 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001296
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001297 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001298 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001299 }
1300
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001301 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001302 }
1303
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001304 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001305}
1306sub ctx_block_outer {
1307 my ($linenr, $remain) = @_;
1308
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001309 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1310 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001311}
1312sub ctx_block {
1313 my ($linenr, $remain) = @_;
1314
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001315 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1316 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001317}
1318sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001319 my ($linenr, $remain, $off) = @_;
1320
1321 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1322 return @r;
1323}
1324sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001325 my ($linenr, $remain) = @_;
1326
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001327 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001328}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001329sub ctx_statement_level {
1330 my ($linenr, $remain, $off) = @_;
1331
1332 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1333}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001334
1335sub ctx_locate_comment {
1336 my ($first_line, $end_line) = @_;
1337
1338 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001339 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001340 return $current_comment if (defined $current_comment);
1341
1342 # Look through the context and try and figure out if there is a
1343 # comment.
1344 my $in_comment = 0;
1345 $current_comment = '';
1346 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001347 my $line = $rawlines[$linenr - 1];
1348 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001349 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1350 $in_comment = 1;
1351 }
1352 if ($line =~ m@/\*@) {
1353 $in_comment = 1;
1354 }
1355 if (!$in_comment && $current_comment ne '') {
1356 $current_comment = '';
1357 }
1358 $current_comment .= $line . "\n" if ($in_comment);
1359 if ($line =~ m@\*/@) {
1360 $in_comment = 0;
1361 }
1362 }
1363
1364 chomp($current_comment);
1365 return($current_comment);
1366}
1367sub ctx_has_comment {
1368 my ($first_line, $end_line) = @_;
1369 my $cmt = ctx_locate_comment($first_line, $end_line);
1370
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001371 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001372 ##print "CMMT: $cmt\n";
1373
1374 return ($cmt ne '');
1375}
1376
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001377sub raw_line {
1378 my ($linenr, $cnt) = @_;
1379
1380 my $offset = $linenr - 1;
1381 $cnt++;
1382
1383 my $line;
1384 while ($cnt) {
1385 $line = $rawlines[$offset++];
1386 next if (defined($line) && $line =~ /^-/);
1387 $cnt--;
1388 }
1389
1390 return $line;
1391}
1392
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001393sub cat_vet {
1394 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001395 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001396
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001397 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001398 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1399 $res .= $1;
1400 if ($2 ne '') {
1401 $coded = sprintf("^%c", unpack('C', $2) + 64);
1402 $res .= $coded;
1403 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001404 }
1405 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001406
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001407 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001408}
1409
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001410my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001411my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001412my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001413my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001414
1415sub annotate_reset {
1416 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001417 $av_pending = '_';
1418 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001419 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001420}
1421
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001422sub annotate_values {
1423 my ($stream, $type) = @_;
1424
1425 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001426 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001427 my $cur = $stream;
1428
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001429 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001430
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001431 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001432 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001433 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001434 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001435 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001436 print "WS($1)\n" if ($dbg_values > 1);
1437 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001438 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001439 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001440 }
1441
Florian Micklerc023e4732011-01-12 16:59:58 -08001442 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001443 print "CAST($1)\n" if ($dbg_values > 1);
1444 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001445 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001446
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001447 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001448 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001449 $type = 'T';
1450
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001451 } elsif ($cur =~ /^($Modifier)\s*/) {
1452 print "MODIFIER($1)\n" if ($dbg_values > 1);
1453 $type = 'T';
1454
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001455 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001456 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001457 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001458 push(@av_paren_type, $type);
1459 if ($2 ne '') {
1460 $av_pending = 'N';
1461 }
1462 $type = 'E';
1463
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001464 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001465 print "UNDEF($1)\n" if ($dbg_values > 1);
1466 $av_preprocessor = 1;
1467 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001468
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001469 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001470 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001471 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001472
1473 push(@av_paren_type, $type);
1474 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001475 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001476
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001477 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001478 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1479 $av_preprocessor = 1;
1480
1481 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1482
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001483 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001484
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001485 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001486 print "PRE_END($1)\n" if ($dbg_values > 1);
1487
1488 $av_preprocessor = 1;
1489
1490 # Assume all arms of the conditional end as this
1491 # one does, and continue as if the #endif was not here.
1492 pop(@av_paren_type);
1493 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001494 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001495
1496 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001497 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001498
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001499 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1500 print "ATTR($1)\n" if ($dbg_values > 1);
1501 $av_pending = $type;
1502 $type = 'N';
1503
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001504 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001505 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001506 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001507 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001508 }
1509 $type = 'N';
1510
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001511 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001512 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001513 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001514 $type = 'N';
1515
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001516 } elsif ($cur =~/^(case)/o) {
1517 print "CASE($1)\n" if ($dbg_values > 1);
1518 $av_pend_colon = 'C';
1519 $type = 'N';
1520
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001521 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001522 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001523 $type = 'N';
1524
1525 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001526 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001527 push(@av_paren_type, $av_pending);
1528 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001529 $type = 'N';
1530
1531 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001532 my $new_type = pop(@av_paren_type);
1533 if ($new_type ne '_') {
1534 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001535 print "PAREN('$1') -> $type\n"
1536 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001537 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001538 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001539 }
1540
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001541 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001542 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001543 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001544 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001545
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001546 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1547 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001548 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001549 } elsif ($type eq 'E') {
1550 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001551 }
1552 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1553 $type = 'V';
1554
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001555 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001556 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001557 $type = 'V';
1558
1559 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001560 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001561 $type = 'N';
1562
Andy Whitcroftcf655042008-03-04 14:28:20 -08001563 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001564 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001565 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001566 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001567
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001568 } elsif ($cur =~/^(,)/) {
1569 print "COMMA($1)\n" if ($dbg_values > 1);
1570 $type = 'C';
1571
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001572 } elsif ($cur =~ /^(\?)/o) {
1573 print "QUESTION($1)\n" if ($dbg_values > 1);
1574 $type = 'N';
1575
1576 } elsif ($cur =~ /^(:)/o) {
1577 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1578
1579 substr($var, length($res), 1, $av_pend_colon);
1580 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1581 $type = 'E';
1582 } else {
1583 $type = 'N';
1584 }
1585 $av_pend_colon = 'O';
1586
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001587 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001588 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001589 $type = 'N';
1590
Andy Whitcroft0d413862008-10-15 22:02:16 -07001591 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001592 my $variant;
1593
1594 print "OPV($1)\n" if ($dbg_values > 1);
1595 if ($type eq 'V') {
1596 $variant = 'B';
1597 } else {
1598 $variant = 'U';
1599 }
1600
1601 substr($var, length($res), 1, $variant);
1602 $type = 'N';
1603
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001604 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001605 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001606 if ($1 ne '++' && $1 ne '--') {
1607 $type = 'N';
1608 }
1609
1610 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001611 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001612 }
1613 if (defined $1) {
1614 $cur = substr($cur, length($1));
1615 $res .= $type x length($1);
1616 }
1617 }
1618
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001619 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001620}
1621
Andy Whitcroft8905a672007-11-28 16:21:06 -08001622sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001623 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001624 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001625 ^(?:
1626 $Modifier|
1627 $Storage|
1628 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001629 DEFINE_\S+
1630 )$|
1631 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001632 goto|
1633 return|
1634 case|
1635 else|
1636 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001637 do|
1638 \#|
1639 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001640 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001641 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001642 )}x;
1643 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1644 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001645 # Check for modifiers.
1646 $possible =~ s/\s*$Storage\s*//g;
1647 $possible =~ s/\s*$Sparse\s*//g;
1648 if ($possible =~ /^\s*$/) {
1649
1650 } elsif ($possible =~ /\s/) {
1651 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001652 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001653 if ($modifier !~ $notPermitted) {
1654 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001655 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001656 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001657 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001658
1659 } else {
1660 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001661 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001662 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001663 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001664 } else {
1665 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001666 }
1667}
1668
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001669my $prefix = '';
1670
Joe Perches000d1cc12011-07-25 17:13:25 -07001671sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001672 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001673
Joe Perchescbec18a2014-04-03 14:49:19 -07001674 return defined $use_type{$type} if (scalar keys %use_type > 0);
1675
1676 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001677}
1678
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001679sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001680 my ($level, $type, $msg) = @_;
1681
1682 if (!show_type($type) ||
1683 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001684 return 0;
1685 }
Joe Perches57230292015-06-25 15:03:03 -07001686 my $output = '';
1687 if (-t STDOUT && $color) {
1688 if ($level eq 'ERROR') {
1689 $output .= RED;
1690 } elsif ($level eq 'WARNING') {
1691 $output .= YELLOW;
1692 } else {
1693 $output .= GREEN;
1694 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001695 }
Joe Perches57230292015-06-25 15:03:03 -07001696 $output .= $prefix . $level . ':';
1697 if ($show_types) {
1698 $output .= BLUE if (-t STDOUT && $color);
1699 $output .= "$type:";
1700 }
1701 $output .= RESET if (-t STDOUT && $color);
1702 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001703
1704 if ($showfile) {
1705 my @lines = split("\n", $output, -1);
1706 splice(@lines, 1, 1);
1707 $output = join("\n", @lines);
1708 }
Joe Perches57230292015-06-25 15:03:03 -07001709 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001710
Joe Perches57230292015-06-25 15:03:03 -07001711 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001712
1713 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001714}
Joe Perchescbec18a2014-04-03 14:49:19 -07001715
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001716sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001717 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001718}
Joe Perches000d1cc12011-07-25 17:13:25 -07001719
Joe Perchesd752fcc2014-08-06 16:11:05 -07001720sub fixup_current_range {
1721 my ($lineRef, $offset, $length) = @_;
1722
1723 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1724 my $o = $1;
1725 my $l = $2;
1726 my $no = $o + $offset;
1727 my $nl = $l + $length;
1728 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1729 }
1730}
1731
1732sub fix_inserted_deleted_lines {
1733 my ($linesRef, $insertedRef, $deletedRef) = @_;
1734
1735 my $range_last_linenr = 0;
1736 my $delta_offset = 0;
1737
1738 my $old_linenr = 0;
1739 my $new_linenr = 0;
1740
1741 my $next_insert = 0;
1742 my $next_delete = 0;
1743
1744 my @lines = ();
1745
1746 my $inserted = @{$insertedRef}[$next_insert++];
1747 my $deleted = @{$deletedRef}[$next_delete++];
1748
1749 foreach my $old_line (@{$linesRef}) {
1750 my $save_line = 1;
1751 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001752 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001753 $delta_offset = 0;
1754 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1755 $range_last_linenr = $new_linenr;
1756 fixup_current_range(\$line, $delta_offset, 0);
1757 }
1758
1759 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1760 $deleted = @{$deletedRef}[$next_delete++];
1761 $save_line = 0;
1762 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1763 }
1764
1765 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1766 push(@lines, ${$inserted}{'LINE'});
1767 $inserted = @{$insertedRef}[$next_insert++];
1768 $new_linenr++;
1769 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1770 }
1771
1772 if ($save_line) {
1773 push(@lines, $line);
1774 $new_linenr++;
1775 }
1776
1777 $old_linenr++;
1778 }
1779
1780 return @lines;
1781}
1782
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001783sub fix_insert_line {
1784 my ($linenr, $line) = @_;
1785
1786 my $inserted = {
1787 LINENR => $linenr,
1788 LINE => $line,
1789 };
1790 push(@fixed_inserted, $inserted);
1791}
1792
1793sub fix_delete_line {
1794 my ($linenr, $line) = @_;
1795
1796 my $deleted = {
1797 LINENR => $linenr,
1798 LINE => $line,
1799 };
1800
1801 push(@fixed_deleted, $deleted);
1802}
1803
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001804sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001805 my ($type, $msg) = @_;
1806
1807 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001808 our $clean = 0;
1809 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001810 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001811 }
Joe Perches3705ce52013-07-03 15:05:31 -07001812 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001813}
1814sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001815 my ($type, $msg) = @_;
1816
1817 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001818 our $clean = 0;
1819 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001820 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001821 }
Joe Perches3705ce52013-07-03 15:05:31 -07001822 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001823}
1824sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001825 my ($type, $msg) = @_;
1826
1827 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001828 our $clean = 0;
1829 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001830 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001831 }
Joe Perches3705ce52013-07-03 15:05:31 -07001832 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001833}
1834
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001835sub check_absolute_file {
1836 my ($absolute, $herecurr) = @_;
1837 my $file = $absolute;
1838
1839 ##print "absolute<$absolute>\n";
1840
1841 # See if any suffix of this path is a path within the tree.
1842 while ($file =~ s@^[^/]*/@@) {
1843 if (-f "$root/$file") {
1844 ##print "file<$file>\n";
1845 last;
1846 }
1847 }
1848 if (! -f _) {
1849 return 0;
1850 }
1851
1852 # It is, so see if the prefix is acceptable.
1853 my $prefix = $absolute;
1854 substr($prefix, -length($file)) = '';
1855
1856 ##print "prefix<$prefix>\n";
1857 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001858 WARN("USE_RELATIVE_PATH",
1859 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001860 }
1861}
1862
Joe Perches3705ce52013-07-03 15:05:31 -07001863sub trim {
1864 my ($string) = @_;
1865
Joe Perchesb34c6482013-09-11 14:24:01 -07001866 $string =~ s/^\s+|\s+$//g;
1867
1868 return $string;
1869}
1870
1871sub ltrim {
1872 my ($string) = @_;
1873
1874 $string =~ s/^\s+//;
1875
1876 return $string;
1877}
1878
1879sub rtrim {
1880 my ($string) = @_;
1881
1882 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001883
1884 return $string;
1885}
1886
Joe Perches52ea8502013-11-12 15:10:09 -08001887sub string_find_replace {
1888 my ($string, $find, $replace) = @_;
1889
1890 $string =~ s/$find/$replace/g;
1891
1892 return $string;
1893}
1894
Joe Perches3705ce52013-07-03 15:05:31 -07001895sub tabify {
1896 my ($leading) = @_;
1897
1898 my $source_indent = 8;
1899 my $max_spaces_before_tab = $source_indent - 1;
1900 my $spaces_to_tab = " " x $source_indent;
1901
1902 #convert leading spaces to tabs
1903 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1904 #Remove spaces before a tab
1905 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1906
1907 return "$leading";
1908}
1909
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001910sub pos_last_openparen {
1911 my ($line) = @_;
1912
1913 my $pos = 0;
1914
1915 my $opens = $line =~ tr/\(/\(/;
1916 my $closes = $line =~ tr/\)/\)/;
1917
1918 my $last_openparen = 0;
1919
1920 if (($opens == 0) || ($closes >= $opens)) {
1921 return -1;
1922 }
1923
1924 my $len = length($line);
1925
1926 for ($pos = 0; $pos < $len; $pos++) {
1927 my $string = substr($line, $pos);
1928 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1929 $pos += length($1) - 1;
1930 } elsif (substr($line, $pos, 1) eq '(') {
1931 $last_openparen = $pos;
1932 } elsif (index($string, '(') == -1) {
1933 last;
1934 }
1935 }
1936
Joe Perches91cb5192014-04-03 14:49:32 -07001937 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001938}
1939
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001940sub process {
1941 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001942
1943 my $linenr=0;
1944 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001945 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001946 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001947 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001948
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001949 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001950 my $indent;
1951 my $previndent=0;
1952 my $stashindent=0;
1953
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001954 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001955 my $signoff = 0;
1956 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07001957 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001958 my $in_commit_log = 0; #Scanning lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07001959 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07001960 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07001961 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07001962 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001963 my $non_utf8_charset = 0;
1964
Joe Perches365dd4e2014-08-06 16:10:42 -07001965 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08001966 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07001967
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001968 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001969 our $cnt_lines = 0;
1970 our $cnt_error = 0;
1971 our $cnt_warn = 0;
1972 our $cnt_chk = 0;
1973
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001974 # Trace the real file/line as we go.
1975 my $realfile = '';
1976 my $realline = 0;
1977 my $realcnt = 0;
1978 my $here = '';
1979 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001980 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001981 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001982 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001983
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001984 my $prev_values = 'E';
1985
1986 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001987 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001988 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001989 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001990 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001991
Joe Perches7e51f192013-09-11 14:23:57 -07001992 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001993
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001994 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001995 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001996 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001997 my @setup_docs = ();
1998 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001999
Joe Perchesd8b07712013-11-12 15:10:06 -08002000 my $camelcase_file_seeded = 0;
2001
Andy Whitcroft773647a2008-03-28 14:15:58 -07002002 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002003 my $line;
2004 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002005 $linenr++;
2006 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002007
Joe Perches3705ce52013-07-03 15:05:31 -07002008 push(@fixed, $rawline) if ($fix);
2009
Andy Whitcroft773647a2008-03-28 14:15:58 -07002010 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002011 $setup_docs = 0;
2012 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2013 $setup_docs = 1;
2014 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002015 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002016 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002017 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2018 $realline=$1-1;
2019 if (defined $2) {
2020 $realcnt=$3+1;
2021 } else {
2022 $realcnt=1+1;
2023 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002024 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002025
2026 # Guestimate if this is a continuing comment. Run
2027 # the context looking for a comment "edge". If this
2028 # edge is a close comment then we must be in a comment
2029 # at context start.
2030 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002031 my $cnt = $realcnt;
2032 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2033 next if (defined $rawlines[$ln - 1] &&
2034 $rawlines[$ln - 1] =~ /^-/);
2035 $cnt--;
2036 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002037 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002038 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2039 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2040 ($edge) = $1;
2041 last;
2042 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002043 }
2044 if (defined $edge && $edge eq '*/') {
2045 $in_comment = 1;
2046 }
2047
2048 # Guestimate if this is a continuing comment. If this
2049 # is the start of a diff block and this line starts
2050 # ' *' then it is very likely a comment.
2051 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002052 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002053 {
2054 $in_comment = 1;
2055 }
2056
2057 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2058 sanitise_line_reset($in_comment);
2059
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002060 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002061 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002062 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002063 $line = sanitise_line($rawline);
2064 }
2065 push(@lines, $line);
2066
2067 if ($realcnt > 1) {
2068 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2069 } else {
2070 $realcnt = 0;
2071 }
2072
2073 #print "==>$rawline\n";
2074 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002075
2076 if ($setup_docs && $line =~ /^\+/) {
2077 push(@setup_docs, $line);
2078 }
2079 }
2080
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002081 $prefix = '';
2082
Andy Whitcroft773647a2008-03-28 14:15:58 -07002083 $realcnt = 0;
2084 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002085 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002086 foreach my $line (@lines) {
2087 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002088 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002089 my $sline = $line; #copy of $line
2090 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002091
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002092 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002093
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002094#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002095 if (!$in_commit_log &&
2096 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002097 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002098 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002099 $realline=$1-1;
2100 if (defined $2) {
2101 $realcnt=$3+1;
2102 } else {
2103 $realcnt=1+1;
2104 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002105 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002106 $prev_values = 'E';
2107
Andy Whitcroft773647a2008-03-28 14:15:58 -07002108 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002109 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002110 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002111 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002112 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002113
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002114# track the line number as we move through the hunk, note that
2115# new versions of GNU diff omit the leading space on completely
2116# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002117 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002118 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002119 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002120
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002121 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002122 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002123
2124 # Track the previous line.
2125 ($prevline, $stashline) = ($stashline, $line);
2126 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002127 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2128
Andy Whitcroft773647a2008-03-28 14:15:58 -07002129 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002130
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002131 } elsif ($realcnt == 1) {
2132 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002133 }
2134
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002135 my $hunk_line = ($realcnt != 0);
2136
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002137 $here = "#$linenr: " if (!$file);
2138 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002139
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002140 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002141 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002142 if ($line =~ /^diff --git.*?(\S+)$/) {
2143 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002144 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002145 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002146 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002147 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002148 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002149 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002150 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002151
2152 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002153 if (!$file && $tree && $p1_prefix ne '' &&
2154 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002155 WARN("PATCH_PREFIX",
2156 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002157 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002158
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002159 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002160 ERROR("MODIFIED_INCLUDE_ASM",
2161 "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 -07002162 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002163 $found_file = 1;
2164 }
2165
Joe Perches34d88152015-06-25 15:03:05 -07002166#make up the handle for any error we report on this line
2167 if ($showfile) {
2168 $prefix = "$realfile:$realline: "
2169 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002170 if ($file) {
2171 $prefix = "$filename:$realline: ";
2172 } else {
2173 $prefix = "$filename:$linenr: ";
2174 }
Joe Perches34d88152015-06-25 15:03:05 -07002175 }
2176
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002177 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002178 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002179 $check = 1;
2180 } else {
2181 $check = $check_orig;
2182 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002183 next;
2184 }
2185
Randy Dunlap389834b2007-06-08 13:47:03 -07002186 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002187
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002188 my $hereline = "$here\n$rawline\n";
2189 my $herecurr = "$here\n$rawline\n";
2190 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002191
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002192 $cnt_lines++ if ($realcnt != 0);
2193
Joe Perchese518e9a2015-06-25 15:03:27 -07002194# Check if the commit log has what seems like a diff which can confuse patch
2195 if ($in_commit_log && !$commit_log_has_diff &&
2196 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2197 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2198 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2199 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2200 ERROR("DIFF_IN_COMMIT_MSG",
2201 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2202 $commit_log_has_diff = 1;
2203 }
2204
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002205# Check for incorrect file permissions
2206 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2207 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002208 if ($realfile !~ m@scripts/@ &&
2209 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002210 ERROR("EXECUTE_PERMISSIONS",
2211 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002212 }
2213 }
2214
Joe Perches20112472011-07-25 17:13:23 -07002215# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002216 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002217 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002218 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002219 }
2220
Joe Perchese0d975b2014-12-10 15:51:49 -08002221# Check if MAINTAINERS is being updated. If so, there's probably no need to
2222# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2223 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2224 $reported_maintainer_file = 1;
2225 }
2226
Joe Perches20112472011-07-25 17:13:23 -07002227# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002228 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002229 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002230 my $space_before = $1;
2231 my $sign_off = $2;
2232 my $space_after = $3;
2233 my $email = $4;
2234 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2235
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002236 if ($sign_off !~ /$signature_tags/) {
2237 WARN("BAD_SIGN_OFF",
2238 "Non-standard signature: $sign_off\n" . $herecurr);
2239 }
Joe Perches20112472011-07-25 17:13:23 -07002240 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002241 if (WARN("BAD_SIGN_OFF",
2242 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2243 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002244 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002245 "$ucfirst_sign_off $email";
2246 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002247 }
Joe Perches20112472011-07-25 17:13:23 -07002248 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002249 if (WARN("BAD_SIGN_OFF",
2250 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2251 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002252 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002253 "$ucfirst_sign_off $email";
2254 }
2255
Joe Perches20112472011-07-25 17:13:23 -07002256 }
2257 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002258 if (WARN("BAD_SIGN_OFF",
2259 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2260 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002261 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002262 "$ucfirst_sign_off $email";
2263 }
Joe Perches20112472011-07-25 17:13:23 -07002264 }
2265
2266 my ($email_name, $email_address, $comment) = parse_email($email);
2267 my $suggested_email = format_email(($email_name, $email_address));
2268 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002269 ERROR("BAD_SIGN_OFF",
2270 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002271 } else {
2272 my $dequoted = $suggested_email;
2273 $dequoted =~ s/^"//;
2274 $dequoted =~ s/" </ </;
2275 # Don't force email to have quotes
2276 # Allow just an angle bracketed address
2277 if ("$dequoted$comment" ne $email &&
2278 "<$email_address>$comment" ne $email &&
2279 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002280 WARN("BAD_SIGN_OFF",
2281 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002282 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002283 }
Joe Perches7e51f192013-09-11 14:23:57 -07002284
2285# Check for duplicate signatures
2286 my $sig_nospace = $line;
2287 $sig_nospace =~ s/\s//g;
2288 $sig_nospace = lc($sig_nospace);
2289 if (defined $signatures{$sig_nospace}) {
2290 WARN("BAD_SIGN_OFF",
2291 "Duplicate signature\n" . $herecurr);
2292 } else {
2293 $signatures{$sig_nospace} = 1;
2294 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002295 }
2296
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002297# Check email subject for common tools that don't need to be mentioned
2298 if ($in_header_lines &&
2299 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2300 WARN("EMAIL_SUBJECT",
2301 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2302 }
2303
Joe Perches9b3189eb2014-06-04 16:12:10 -07002304# Check for old stable address
2305 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2306 ERROR("STABLE_ADDRESS",
2307 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2308 }
2309
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002310# Check for unwanted Gerrit info
2311 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2312 ERROR("GERRIT_CHANGE_ID",
2313 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2314 }
2315
Joe Perches369c8dd2015-11-06 16:31:34 -08002316# Check if the commit log is in a possible stack dump
2317 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2318 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2319 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2320 # timestamp
2321 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2322 # stack dump address
2323 $commit_log_possible_stack_dump = 1;
2324 }
2325
Joe Perches2a076f42015-04-16 12:44:28 -07002326# Check for line lengths > 75 in commit log, warn once
2327 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002328 length($line) > 75 &&
2329 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2330 # file delta changes
2331 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2332 # filename then :
2333 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2334 # A Fixes: or Link: line
2335 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002336 WARN("COMMIT_LOG_LONG_LINE",
2337 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2338 $commit_log_long_line = 1;
2339 }
2340
Joe Perchesbf4daf12015-09-09 15:37:50 -07002341# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002342 if ($in_commit_log && $commit_log_possible_stack_dump &&
2343 $line =~ /^\s*$/) {
2344 $commit_log_possible_stack_dump = 0;
2345 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002346
Joe Perches0d7835f2015-02-13 14:38:35 -08002347# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002348 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002349 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perches369c8dd2015-11-06 16:31:34 -08002350 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2351 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2352 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002353 my $init_char = "c";
2354 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002355 my $short = 1;
2356 my $long = 0;
2357 my $case = 1;
2358 my $space = 1;
2359 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002360 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002361 my $id = '0123456789ab';
2362 my $orig_desc = "commit description";
2363 my $description = "";
2364
Joe Perchesfe043ea2015-09-09 15:37:25 -07002365 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2366 $init_char = $1;
2367 $orig_commit = lc($2);
2368 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2369 $orig_commit = lc($1);
2370 }
2371
Joe Perches0d7835f2015-02-13 14:38:35 -08002372 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2373 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2374 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2375 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2376 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2377 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002378 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002379 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2380 defined $rawlines[$linenr] &&
2381 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2382 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002383 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002384 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2385 defined $rawlines[$linenr] &&
2386 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2387 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2388 $orig_desc = $1;
2389 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2390 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002391 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002392 }
2393
2394 ($id, $description) = git_commit_info($orig_commit,
2395 $id, $orig_desc);
2396
Joe Perches19c146a2015-02-13 14:39:00 -08002397 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002398 ERROR("GIT_COMMIT_ID",
2399 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2400 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002401 }
2402
Joe Perches13f19372014-08-06 16:10:59 -07002403# Check for added, moved or deleted files
2404 if (!$reported_maintainer_file && !$in_commit_log &&
2405 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2406 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2407 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2408 (defined($1) || defined($2))))) {
2409 $reported_maintainer_file = 1;
2410 WARN("FILE_PATH_CHANGES",
2411 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2412 }
2413
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002414# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002415 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002416 ERROR("CORRUPTED_PATCH",
2417 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002418 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002419 }
2420
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002421# Check for absolute kernel paths.
2422 if ($tree) {
2423 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2424 my $file = $1;
2425
2426 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2427 check_absolute_file($1, $herecurr)) {
2428 #
2429 } else {
2430 check_absolute_file($file, $herecurr);
2431 }
2432 }
2433 }
2434
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002435# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2436 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002437 $rawline !~ m/^$UTF8*$/) {
2438 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2439
2440 my $blank = copy_spacing($rawline);
2441 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2442 my $hereptr = "$hereline$ptr\n";
2443
Joe Perches34d99212011-07-25 17:13:26 -07002444 CHK("INVALID_UTF8",
2445 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002446 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002447
Joe Perches15662b32011-10-31 17:13:12 -07002448# Check if it's the start of a commit log
2449# (not a header line and we haven't seen the patch filename)
2450 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002451 !($rawline =~ /^\s+\S/ ||
2452 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002453 $in_header_lines = 0;
2454 $in_commit_log = 1;
2455 }
2456
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002457# Check if there is UTF-8 in a commit log when a mail header has explicitly
2458# declined it, i.e defined some charset where it is missing.
2459 if ($in_header_lines &&
2460 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2461 $1 !~ /utf-8/i) {
2462 $non_utf8_charset = 1;
2463 }
2464
2465 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002466 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002467 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002468 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2469 }
2470
Kees Cook66b47b42014-10-13 15:51:57 -07002471# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002472 if (defined($misspellings) &&
2473 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002474 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002475 my $typo = $1;
2476 my $typo_fix = $spelling_fix{lc($typo)};
2477 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2478 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2479 my $msg_type = \&WARN;
2480 $msg_type = \&CHK if ($file);
2481 if (&{$msg_type}("TYPO_SPELLING",
2482 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2483 $fix) {
2484 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2485 }
2486 }
2487 }
2488
Andy Whitcroft306708542008-10-15 22:02:28 -07002489# ignore non-hunk lines and lines being removed
2490 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002491
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002492#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002493 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002494 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002495 if (ERROR("DOS_LINE_ENDINGS",
2496 "DOS line endings\n" . $herevet) &&
2497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002498 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002499 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002500 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2501 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002502 if (ERROR("TRAILING_WHITESPACE",
2503 "trailing whitespace\n" . $herevet) &&
2504 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002505 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002506 }
2507
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002508 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002509 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002510
Josh Triplett4783f892013-11-12 15:10:12 -08002511# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002512 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002513 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2514 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002515 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2516 my $msg_type = \&ERROR;
2517 $msg_type = \&CHK if ($file);
2518 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002519 "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 -08002520 }
2521
Andi Kleen33549572010-05-24 14:33:29 -07002522# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002523# Only applies when adding the entry originally, after that we do not have
2524# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002525 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002526 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002527 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002528 my $cnt = $realcnt;
2529 my $ln = $linenr + 1;
2530 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002531 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002532 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002533 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002534 $f = $lines[$ln - 1];
2535 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2536 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002537
2538 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002539 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002540
Joe Perches8d73e0e2014-08-06 16:10:46 -07002541 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002542 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002543 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002544 $length = -1;
2545 }
2546
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002547 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002548 $f =~ s/#.*//;
2549 $f =~ s/^\s+//;
2550 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002551 if ($f =~ /^\s*config\s/) {
2552 $is_end = 1;
2553 last;
2554 }
Andi Kleen33549572010-05-24 14:33:29 -07002555 $length++;
2556 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002557 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2558 WARN("CONFIG_DESCRIPTION",
2559 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2560 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002561 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002562 }
2563
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002564# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2565 if ($realfile =~ /Kconfig/ &&
2566 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2567 WARN("CONFIG_EXPERIMENTAL",
2568 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2569 }
2570
Christoph Jaeger327953e2015-02-13 14:38:29 -08002571# discourage the use of boolean for type definition attributes of Kconfig options
2572 if ($realfile =~ /Kconfig/ &&
2573 $line =~ /^\+\s*\bboolean\b/) {
2574 WARN("CONFIG_TYPE_BOOLEAN",
2575 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2576 }
2577
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002578 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2579 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2580 my $flag = $1;
2581 my $replacement = {
2582 'EXTRA_AFLAGS' => 'asflags-y',
2583 'EXTRA_CFLAGS' => 'ccflags-y',
2584 'EXTRA_CPPFLAGS' => 'cppflags-y',
2585 'EXTRA_LDFLAGS' => 'ldflags-y',
2586 };
2587
2588 WARN("DEPRECATED_VARIABLE",
2589 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2590 }
2591
Rob Herringbff5da42014-01-23 15:54:51 -08002592# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002593 if (defined $root &&
2594 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2595 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2596
Rob Herringbff5da42014-01-23 15:54:51 -08002597 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2598
Florian Vaussardcc933192014-04-03 14:49:27 -07002599 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2600 my $vp_file = $dt_path . "vendor-prefixes.txt";
2601
Rob Herringbff5da42014-01-23 15:54:51 -08002602 foreach my $compat (@compats) {
2603 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002604 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2605 my $compat3 = $compat;
2606 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2607 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002608 if ( $? >> 8 ) {
2609 WARN("UNDOCUMENTED_DT_STRING",
2610 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2611 }
2612
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002613 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2614 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002615 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002616 if ( $? >> 8 ) {
2617 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002618 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002619 }
2620 }
2621 }
2622
Andy Whitcroft5368df202008-10-15 22:02:27 -07002623# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002624 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002625
Joe Perches47e0c882015-06-25 15:02:57 -07002626# line length limit (with some exclusions)
2627#
2628# There are a few types of lines that may extend beyond $max_line_length:
2629# logging functions like pr_info that end in a string
2630# lines with a single string
2631# #defines that are a single string
2632#
2633# There are 3 different line length message types:
2634# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2635# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2636# LONG_LINE all other lines longer than $max_line_length
2637#
2638# if LONG_LINE is ignored, the other 2 types are also ignored
2639#
2640
Joe Perchesb4749e92015-07-17 16:24:01 -07002641 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002642 my $msg_type = "LONG_LINE";
2643
2644 # Check the allowed long line types first
2645
2646 # logging functions that end in a string that starts
2647 # before $max_line_length
2648 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2649 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2650 $msg_type = "";
2651
2652 # lines with only strings (w/ possible termination)
2653 # #defines with only strings
2654 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2655 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2656 $msg_type = "";
2657
2658 # Otherwise set the alternate message types
2659
2660 # a comment starts before $max_line_length
2661 } elsif ($line =~ /($;[\s$;]*)$/ &&
2662 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2663 $msg_type = "LONG_LINE_COMMENT"
2664
2665 # a quoted string starts before $max_line_length
2666 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2667 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2668 $msg_type = "LONG_LINE_STRING"
2669 }
2670
2671 if ($msg_type ne "" &&
2672 (show_type("LONG_LINE") || show_type($msg_type))) {
2673 WARN($msg_type,
2674 "line over $max_line_length characters\n" . $herecurr);
2675 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002676 }
2677
Andy Whitcroft8905a672007-11-28 16:21:06 -08002678# check for adding lines without a newline.
2679 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002680 WARN("MISSING_EOF_NEWLINE",
2681 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002682 }
2683
Mike Frysinger42e41c52009-09-21 17:04:40 -07002684# Blackfin: use hi/lo macros
2685 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2686 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2687 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002688 ERROR("LO_MACRO",
2689 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002690 }
2691 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2692 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002693 ERROR("HI_MACRO",
2694 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002695 }
2696 }
2697
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002698# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002699 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002700
2701# at the beginning of a line any tabs must come first and anything
2702# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002703 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2704 $rawline =~ /^\+\s* \s*/) {
2705 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002706 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002707 if (ERROR("CODE_INDENT",
2708 "code indent should use tabs where possible\n" . $herevet) &&
2709 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002710 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002711 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002712 }
2713
Alberto Panizzo08e44362010-03-05 13:43:54 -08002714# check for space before tabs.
2715 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2716 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002717 if (WARN("SPACE_BEFORE_TAB",
2718 "please, no space before tabs\n" . $herevet) &&
2719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002720 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002721 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002722 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002723 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002724 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002725 }
2726
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002727# check for && or || at the start of a line
2728 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2729 CHK("LOGICAL_CONTINUATIONS",
2730 "Logical continuations should be on the previous line\n" . $hereprev);
2731 }
2732
2733# check multi-line statement indentation matches previous line
2734 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002735 $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 -07002736 $prevline =~ /^\+(\t*)(.*)$/;
2737 my $oldindent = $1;
2738 my $rest = $2;
2739
2740 my $pos = pos_last_openparen($rest);
2741 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002742 $line =~ /^(\+| )([ \t]*)/;
2743 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002744
2745 my $goodtabindent = $oldindent .
2746 "\t" x ($pos / 8) .
2747 " " x ($pos % 8);
2748 my $goodspaceindent = $oldindent . " " x $pos;
2749
2750 if ($newindent ne $goodtabindent &&
2751 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002752
2753 if (CHK("PARENTHESIS_ALIGNMENT",
2754 "Alignment should match open parenthesis\n" . $hereprev) &&
2755 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002756 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002757 s/^\+[ \t]*/\+$goodtabindent/;
2758 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002759 }
2760 }
2761 }
2762
Joe Perches6ab3a972015-04-16 12:44:05 -07002763# check for space after cast like "(int) foo" or "(struct foo) bar"
2764# avoid checking a few false positives:
2765# "sizeof(<type>)" or "__alignof__(<type>)"
2766# function pointer declarations like "(*foo)(int) = bar;"
2767# structure definitions like "(struct foo) { 0 };"
2768# multiline macros that define functions
2769# known attributes or the __attribute__ keyword
2770 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2771 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002772 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002773 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002774 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002775 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002776 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002777 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002778 }
2779
Joe Perches86406b12015-09-09 15:37:41 -07002780# Block comment styles
2781# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002782 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002783 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002784 $rawline =~ /^\+[ \t]*\*/ &&
2785 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002786 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2787 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2788 }
2789
Joe Perches86406b12015-09-09 15:37:41 -07002790# Block comments use * on subsequent lines
2791 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2792 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002793 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002794 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002795 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002796 WARN("BLOCK_COMMENT_STYLE",
2797 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002798 }
2799
Joe Perches86406b12015-09-09 15:37:41 -07002800# Block comments use */ on trailing lines
2801 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002802 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2803 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2804 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002805 WARN("BLOCK_COMMENT_STYLE",
2806 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002807 }
2808
Joe Perches7f619192014-08-06 16:10:39 -07002809# check for missing blank lines after struct/union declarations
2810# with exceptions for various attributes and macros
2811 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2812 $line =~ /^\+/ &&
2813 !($line =~ /^\+\s*$/ ||
2814 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2815 $line =~ /^\+\s*MODULE_/i ||
2816 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2817 $line =~ /^\+[a-z_]*init/ ||
2818 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2819 $line =~ /^\+\s*DECLARE/ ||
2820 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002821 if (CHK("LINE_SPACING",
2822 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2823 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002824 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002825 }
Joe Perches7f619192014-08-06 16:10:39 -07002826 }
2827
Joe Perches365dd4e2014-08-06 16:10:42 -07002828# check for multiple consecutive blank lines
2829 if ($prevline =~ /^[\+ ]\s*$/ &&
2830 $line =~ /^\+\s*$/ &&
2831 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002832 if (CHK("LINE_SPACING",
2833 "Please don't use multiple blank lines\n" . $hereprev) &&
2834 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002835 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002836 }
2837
Joe Perches365dd4e2014-08-06 16:10:42 -07002838 $last_blank_line = $linenr;
2839 }
2840
Joe Perches3b617e32014-04-03 14:49:28 -07002841# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002842 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2843 # actual declarations
2844 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002845 # function pointer declarations
2846 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002847 # foo bar; where foo is some local typedef or #define
2848 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2849 # known declaration macros
2850 $prevline =~ /^\+\s+$declaration_macros/) &&
2851 # for "else if" which can look like "$Ident $Ident"
2852 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2853 # other possible extensions of declaration lines
2854 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2855 # not starting a section or a macro "\" extended line
2856 $prevline =~ /(?:\{\s*|\\)$/) &&
2857 # looks like a declaration
2858 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002859 # function pointer declarations
2860 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002861 # foo bar; where foo is some local typedef or #define
2862 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2863 # known declaration macros
2864 $sline =~ /^\+\s+$declaration_macros/ ||
2865 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002866 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002867 # start or end of block or continuation of declaration
2868 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2869 # bitfield continuation
2870 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2871 # other possible extensions of declaration lines
2872 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2873 # indentation of previous and current line are the same
2874 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002875 if (WARN("LINE_SPACING",
2876 "Missing a blank line after declarations\n" . $hereprev) &&
2877 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002878 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002879 }
Joe Perches3b617e32014-04-03 14:49:28 -07002880 }
2881
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002882# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002883# Exceptions:
2884# 1) within comments
2885# 2) indented preprocessor commands
2886# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002887 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002888 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002889 if (WARN("LEADING_SPACE",
2890 "please, no spaces at the start of a line\n" . $herevet) &&
2891 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002892 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002893 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002894 }
2895
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002896# check we are in a valid C source file if not then ignore this hunk
2897 next if ($realfile !~ /\.(h|c)$/);
2898
Joe Perches032a4c02014-08-06 16:10:29 -07002899# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002900# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002901# if the previous line is a break or return and is indented 1 tab more...
2902 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2903 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002904 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2905 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2906 defined $lines[$linenr] &&
2907 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002908 WARN("UNNECESSARY_ELSE",
2909 "else is not generally useful after a break or return\n" . $hereprev);
2910 }
2911 }
2912
Joe Perchesc00df192014-08-06 16:11:01 -07002913# check indentation of a line with a break;
2914# if the previous line is a goto or return and is indented the same # of tabs
2915 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2916 my $tabs = $1;
2917 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2918 WARN("UNNECESSARY_BREAK",
2919 "break is not useful after a goto or return\n" . $hereprev);
2920 }
2921 }
2922
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002923# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2924 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2925 WARN("CONFIG_EXPERIMENTAL",
2926 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2927 }
2928
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002929# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002930 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002931 WARN("CVS_KEYWORD",
2932 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002933 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002934
Mike Frysinger42e41c52009-09-21 17:04:40 -07002935# Blackfin: don't use __builtin_bfin_[cs]sync
2936 if ($line =~ /__builtin_bfin_csync/) {
2937 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002938 ERROR("CSYNC",
2939 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002940 }
2941 if ($line =~ /__builtin_bfin_ssync/) {
2942 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002943 ERROR("SSYNC",
2944 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002945 }
2946
Joe Perches56e77d72013-02-21 16:44:14 -08002947# check for old HOTPLUG __dev<foo> section markings
2948 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2949 WARN("HOTPLUG_SECTION",
2950 "Using $1 is unnecessary\n" . $herecurr);
2951 }
2952
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002953# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002954 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2955 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002956#print "LINE<$line>\n";
2957 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002958 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002959 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002960 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002961 $stat =~ s/\n./\n /g;
2962 $cond =~ s/\n./\n /g;
2963
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002964#print "linenr<$linenr> <$stat>\n";
2965 # If this statement has no statement boundaries within
2966 # it there is no point in retrying a statement scan
2967 # until we hit end of it.
2968 my $frag = $stat; $frag =~ s/;+\s*$//;
2969 if ($frag !~ /(?:{|;)/) {
2970#print "skip<$line_nr_next>\n";
2971 $suppress_statement = $line_nr_next;
2972 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002973
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002974 # Find the real next line.
2975 $realline_next = $line_nr_next;
2976 if (defined $realline_next &&
2977 (!defined $lines[$realline_next - 1] ||
2978 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2979 $realline_next++;
2980 }
2981
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002982 my $s = $stat;
2983 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002984
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002985 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002986 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002987
2988 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002989 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002990
Andy Whitcroft463f2862009-09-21 17:04:34 -07002991 } elsif ($s =~ /^.\s*else\b/s) {
2992
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002993 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002994 } 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 -07002995 my $type = $1;
2996 $type =~ s/\s+/ /g;
2997 possible($type, "A:" . $s);
2998
Andy Whitcroft8905a672007-11-28 16:21:06 -08002999 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003000 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003001 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003002 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003003
3004 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003005 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003006 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003007 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003008
3009 # Check for any sort of function declaration.
3010 # int foo(something bar, other baz);
3011 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003012 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 -08003013 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003014
Andy Whitcroftcf655042008-03-04 14:28:20 -08003015 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003016 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003017 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003018
Andy Whitcroft8905a672007-11-28 16:21:06 -08003019 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003020 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003021
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003022 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003023 }
3024 }
3025 }
3026
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003027 }
3028
Andy Whitcroft653d4872007-06-23 17:16:34 -07003029#
3030# Checks which may be anchored in the context.
3031#
3032
3033# Check for switch () and associated case and default
3034# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003035 if ($line=~/\bswitch\s*\(.*\)/) {
3036 my $err = '';
3037 my $sep = '';
3038 my @ctx = ctx_block_outer($linenr, $realcnt);
3039 shift(@ctx);
3040 for my $ctx (@ctx) {
3041 my ($clen, $cindent) = line_stats($ctx);
3042 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3043 $indent != $cindent) {
3044 $err .= "$sep$ctx\n";
3045 $sep = '';
3046 } else {
3047 $sep = "[...]\n";
3048 }
3049 }
3050 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003051 ERROR("SWITCH_CASE_INDENT_LEVEL",
3052 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003053 }
3054 }
3055
3056# if/while/etc brace do not go on next line, unless defining a do while loop,
3057# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003058 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 -07003059 my $pre_ctx = "$1$2";
3060
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003061 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003062
3063 if ($line =~ /^\+\t{6,}/) {
3064 WARN("DEEP_INDENTATION",
3065 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3066 }
3067
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003068 my $ctx_cnt = $realcnt - $#ctx - 1;
3069 my $ctx = join("\n", @ctx);
3070
Andy Whitcroft548596d2008-07-23 21:29:01 -07003071 my $ctx_ln = $linenr;
3072 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003073
Andy Whitcroft548596d2008-07-23 21:29:01 -07003074 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3075 defined $lines[$ctx_ln - 1] &&
3076 $lines[$ctx_ln - 1] =~ /^-/)) {
3077 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3078 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003079 $ctx_ln++;
3080 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003081
Andy Whitcroft53210162008-07-23 21:29:03 -07003082 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3083 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003084
Joe Perchesd752fcc2014-08-06 16:11:05 -07003085 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003086 ERROR("OPEN_BRACE",
3087 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003088 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003089 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003090 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3091 $ctx =~ /\)\s*\;\s*$/ &&
3092 defined $lines[$ctx_ln - 1])
3093 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003094 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3095 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003096 WARN("TRAILING_SEMICOLON",
3097 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003098 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003099 }
3100 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003101 }
3102
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003103# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003104 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 -08003105 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3106 ctx_statement_block($linenr, $realcnt, 0)
3107 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003108 my ($s, $c) = ($stat, $cond);
3109
3110 substr($s, 0, length($c), '');
3111
Joe Perches9f5af482015-09-09 15:37:30 -07003112 # remove inline comments
3113 $s =~ s/$;/ /g;
3114 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003115
3116 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003117 my @newlines = ($c =~ /\n/gs);
3118 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003119
Joe Perches9f5af482015-09-09 15:37:30 -07003120 # Make sure we remove the line prefixes as we have
3121 # none on the first line, and are going to readd them
3122 # where necessary.
3123 $s =~ s/\n./\n/gs;
3124 while ($s =~ /\n\s+\\\n/) {
3125 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3126 }
3127
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003128 # We want to check the first line inside the block
3129 # starting at the end of the conditional, so remove:
3130 # 1) any blank line termination
3131 # 2) any opening brace { on end of the line
3132 # 3) any do (...) {
3133 my $continuation = 0;
3134 my $check = 0;
3135 $s =~ s/^.*\bdo\b//;
3136 $s =~ s/^\s*{//;
3137 if ($s =~ s/^\s*\\//) {
3138 $continuation = 1;
3139 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003140 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003141 $check = 1;
3142 $cond_lines++;
3143 }
3144
3145 # Also ignore a loop construct at the end of a
3146 # preprocessor statement.
3147 if (($prevline =~ /^.\s*#\s*define\s/ ||
3148 $prevline =~ /\\\s*$/) && $continuation == 0) {
3149 $check = 0;
3150 }
3151
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003152 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003153 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003154 while ($cond_ptr != $cond_lines) {
3155 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003156
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003157 # If we see an #else/#elif then the code
3158 # is not linear.
3159 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3160 $check = 0;
3161 }
3162
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003163 # Ignore:
3164 # 1) blank lines, they should be at 0,
3165 # 2) preprocessor lines, and
3166 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003167 if ($continuation ||
3168 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003169 $s =~ /^\s*#\s*?/ ||
3170 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003171 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003172 if ($s =~ s/^.*?\n//) {
3173 $cond_lines++;
3174 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003175 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003176 }
3177
3178 my (undef, $sindent) = line_stats("+" . $s);
3179 my $stat_real = raw_line($linenr, $cond_lines);
3180
3181 # Check if either of these lines are modified, else
3182 # this is not this patch's fault.
3183 if (!defined($stat_real) ||
3184 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3185 $check = 0;
3186 }
3187 if (defined($stat_real) && $cond_lines > 1) {
3188 $stat_real = "[...]\n$stat_real";
3189 }
3190
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003191 #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 -07003192
Joe Perches9f5af482015-09-09 15:37:30 -07003193 if ($check && $s ne '' &&
3194 (($sindent % 8) != 0 ||
3195 ($sindent < $indent) ||
3196 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003197 WARN("SUSPECT_CODE_INDENT",
3198 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003199 }
3200 }
3201
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003202 # Track the 'values' across context and added lines.
3203 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003204 my ($curr_values, $curr_vars) =
3205 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003206 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003207 if ($dbg_values) {
3208 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003209 print "$linenr > .$outline\n";
3210 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003211 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003212 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003213 $prev_values = substr($curr_values, -1);
3214
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003215#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003216 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003217
Andy Whitcroft653d4872007-06-23 17:16:34 -07003218# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003219 if ($dbg_type) {
3220 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003221 ERROR("TEST_TYPE",
3222 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003223 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003224 ERROR("TEST_NOT_TYPE",
3225 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003226 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003227 next;
3228 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003229# TEST: allow direct testing of the attribute matcher.
3230 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003231 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003232 ERROR("TEST_ATTR",
3233 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003234 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003235 ERROR("TEST_NOT_ATTR",
3236 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003237 }
3238 next;
3239 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003240
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003241# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003242 if ($line =~ /^.\s*{/ &&
3243 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003244 if (ERROR("OPEN_BRACE",
3245 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003246 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3247 fix_delete_line($fixlinenr - 1, $prevrawline);
3248 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003249 my $fixedline = $prevrawline;
3250 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003251 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003252 $fixedline = $line;
3253 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003254 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003255 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003256 }
3257
Andy Whitcroft653d4872007-06-23 17:16:34 -07003258#
3259# Checks which are anchored on the added line.
3260#
3261
3262# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003263 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003264 my $path = $1;
3265 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003266 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003267 "malformed #include filename\n" . $herecurr);
3268 }
3269 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3270 ERROR("UAPI_INCLUDE",
3271 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003272 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003273 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003274
3275# no C99 // comments
3276 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003277 if (ERROR("C99_COMMENTS",
3278 "do not use C99 // comments\n" . $herecurr) &&
3279 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003280 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003281 if ($line =~ /\/\/(.*)$/) {
3282 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003283 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003284 }
3285 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003286 }
3287 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003288 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003289 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003290
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003291# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3292# the whole statement.
3293#print "APW <$lines[$realline_next - 1]>\n";
3294 if (defined $realline_next &&
3295 exists $lines[$realline_next - 1] &&
3296 !defined $suppress_export{$realline_next} &&
3297 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3298 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003299 # Handle definitions which produce identifiers with
3300 # a prefix:
3301 # XXX(foo);
3302 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003303 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003304 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003305 $name =~ /^${Ident}_$2/) {
3306#print "FOO C name<$name>\n";
3307 $suppress_export{$realline_next} = 1;
3308
3309 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003310 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003311 ^.DEFINE_$Ident\(\Q$name\E\)|
3312 ^.DECLARE_$Ident\(\Q$name\E\)|
3313 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003314 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3315 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003316 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003317#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3318 $suppress_export{$realline_next} = 2;
3319 } else {
3320 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003321 }
3322 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003323 if (!defined $suppress_export{$linenr} &&
3324 $prevline =~ /^.\s*$/ &&
3325 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3326 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3327#print "FOO B <$lines[$linenr - 1]>\n";
3328 $suppress_export{$linenr} = 2;
3329 }
3330 if (defined $suppress_export{$linenr} &&
3331 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003332 WARN("EXPORT_SYMBOL",
3333 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003334 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003335
Joe Eloff5150bda2010-08-09 17:21:00 -07003336# check for global initialisers.
Joe Perches5129e872015-06-10 11:14:52 -07003337 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*(?:0|NULL|false)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003338 if (ERROR("GLOBAL_INITIALISERS",
3339 "do not initialise globals to 0 or NULL\n" .
3340 $herecurr) &&
3341 $fix) {
Joe Perches5129e872015-06-10 11:14:52 -07003342 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003343 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003344 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003345# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003346 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3347 if (ERROR("INITIALISED_STATIC",
3348 "do not initialise statics to 0 or NULL\n" .
3349 $herecurr) &&
3350 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003351 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003352 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003353 }
3354
Joe Perches18130872014-08-06 16:11:22 -07003355# check for misordered declarations of char/short/int/long with signed/unsigned
3356 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3357 my $tmp = trim($1);
3358 WARN("MISORDERED_TYPE",
3359 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3360 }
3361
Joe Perchescb710ec2010-10-26 14:23:20 -07003362# check for static const char * arrays.
3363 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003364 WARN("STATIC_CONST_CHAR_ARRAY",
3365 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003366 $herecurr);
3367 }
3368
3369# check for static char foo[] = "bar" declarations.
3370 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003371 WARN("STATIC_CONST_CHAR_ARRAY",
3372 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003373 $herecurr);
3374 }
3375
Joe Perchesab7e23f2015-04-16 12:44:22 -07003376# check for const <foo> const where <foo> is not a pointer or array type
3377 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3378 my $found = $1;
3379 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3380 WARN("CONST_CONST",
3381 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3382 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3383 WARN("CONST_CONST",
3384 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3385 }
3386 }
3387
Joe Perches9b0fa602014-04-03 14:49:18 -07003388# check for non-global char *foo[] = {"bar", ...} declarations.
3389 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3390 WARN("STATIC_CONST_CHAR_ARRAY",
3391 "char * array declaration might be better as static const\n" .
3392 $herecurr);
3393 }
3394
Joe Perchesb598b672015-04-16 12:44:36 -07003395# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3396 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3397 my $array = $1;
3398 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3399 my $array_div = $1;
3400 if (WARN("ARRAY_SIZE",
3401 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3402 $fix) {
3403 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3404 }
3405 }
3406 }
3407
Joe Perchesb36190c2014-01-27 17:07:18 -08003408# check for function declarations without arguments like "int foo()"
3409 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3410 if (ERROR("FUNCTION_WITHOUT_ARGS",
3411 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3412 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003413 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003414 }
3415 }
3416
Joe Perches92e112f2013-12-13 11:36:22 -07003417# check for uses of DEFINE_PCI_DEVICE_TABLE
3418 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3419 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3420 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3421 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003422 $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 -07003423 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003424 }
3425
Andy Whitcroft653d4872007-06-23 17:16:34 -07003426# check for new typedefs, only function parameters and sparse annotations
3427# make sense.
3428 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003429 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003430 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003431 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003432 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003433 WARN("NEW_TYPEDEFS",
3434 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003435 }
3436
3437# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003438 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003439 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3440 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003441 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003442
Andy Whitcroft65863862009-01-06 14:41:21 -08003443 # Should start with a space.
3444 $to =~ s/^(\S)/ $1/;
3445 # Should not end with a space.
3446 $to =~ s/\s+$//;
3447 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003448 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003449 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003450
Joe Perches3705ce52013-07-03 15:05:31 -07003451## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003452 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003453 if (ERROR("POINTER_LOCATION",
3454 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3455 $fix) {
3456 my $sub_from = $ident;
3457 my $sub_to = $ident;
3458 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003459 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003460 s@\Q$sub_from\E@$sub_to@;
3461 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003462 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003463 }
3464 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3465 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003466 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003467
Andy Whitcroft65863862009-01-06 14:41:21 -08003468 # Should start with a space.
3469 $to =~ s/^(\S)/ $1/;
3470 # Should not end with a space.
3471 $to =~ s/\s+$//;
3472 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003473 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003474 }
3475 # Modifiers should have spaces.
3476 $to =~ s/(\b$Modifier$)/$1 /;
3477
Joe Perches3705ce52013-07-03 15:05:31 -07003478## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003479 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003480 if (ERROR("POINTER_LOCATION",
3481 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3482 $fix) {
3483
3484 my $sub_from = $match;
3485 my $sub_to = $match;
3486 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003487 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003488 s@\Q$sub_from\E@$sub_to@;
3489 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003490 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003491 }
3492
Joe Perches9d3e3c72015-09-09 15:37:27 -07003493# avoid BUG() or BUG_ON()
3494 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3495 my $msg_type = \&WARN;
3496 $msg_type = \&CHK if ($file);
3497 &{$msg_type}("AVOID_BUG",
3498 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3499 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003500
Joe Perches9d3e3c72015-09-09 15:37:27 -07003501# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003502 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003503 WARN("LINUX_VERSION_CODE",
3504 "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 -08003505 }
3506
Joe Perches17441222011-06-15 15:08:17 -07003507# check for uses of printk_ratelimit
3508 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003509 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003510 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003511 }
3512
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003513# printk should use KERN_* levels. Note that follow on printk's on the
3514# same line do not need a level, so we use the current block context
3515# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003516# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003517# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003518 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003519 my $ok = 0;
3520 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3521 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003522 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003523 # with "\n" ignore it, else it is to blame
3524 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3525 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3526 $ok = 1;
3527 }
3528 last;
3529 }
3530 }
3531 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003532 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3533 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003534 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003535 }
3536
Joe Perches243f3802012-05-31 16:26:09 -07003537 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3538 my $orig = $1;
3539 my $level = lc($orig);
3540 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003541 my $level2 = $level;
3542 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003543 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003544 "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 -07003545 }
3546
3547 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003548 if (WARN("PREFER_PR_LEVEL",
3549 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3550 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003551 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003552 s/\bpr_warning\b/pr_warn/;
3553 }
Joe Perches243f3802012-05-31 16:26:09 -07003554 }
3555
Joe Perchesdc139312013-02-21 16:44:13 -08003556 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3557 my $orig = $1;
3558 my $level = lc($orig);
3559 $level = "warn" if ($level eq "warning");
3560 $level = "dbg" if ($level eq "debug");
3561 WARN("PREFER_DEV_LEVEL",
3562 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3563 }
3564
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003565# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3566# number of false positives, but assembly files are not checked, so at
3567# least the arch entry code will not trigger this warning.
3568 if ($line =~ /\bENOSYS\b/) {
3569 WARN("ENOSYS",
3570 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3571 }
3572
Andy Whitcroft653d4872007-06-23 17:16:34 -07003573# function brace can't be on same line, except for #defines of do while,
3574# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003575 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003576 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003577 if (ERROR("OPEN_BRACE",
3578 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3579 $fix) {
3580 fix_delete_line($fixlinenr, $rawline);
3581 my $fixed_line = $rawline;
3582 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3583 my $line1 = $1;
3584 my $line2 = $2;
3585 fix_insert_line($fixlinenr, ltrim($line1));
3586 fix_insert_line($fixlinenr, "\+{");
3587 if ($line2 !~ /^\s*$/) {
3588 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3589 }
3590 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003591 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003592
Andy Whitcroft8905a672007-11-28 16:21:06 -08003593# open braces for enum, union and struct go on the same line.
3594 if ($line =~ /^.\s*{/ &&
3595 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003596 if (ERROR("OPEN_BRACE",
3597 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3598 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3599 fix_delete_line($fixlinenr - 1, $prevrawline);
3600 fix_delete_line($fixlinenr, $rawline);
3601 my $fixedline = rtrim($prevrawline) . " {";
3602 fix_insert_line($fixlinenr, $fixedline);
3603 $fixedline = $rawline;
3604 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3605 if ($fixedline !~ /^\+\s*$/) {
3606 fix_insert_line($fixlinenr, $fixedline);
3607 }
3608 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003609 }
3610
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003611# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003612 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3613 if (WARN("SPACING",
3614 "missing space after $1 definition\n" . $herecurr) &&
3615 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003616 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003617 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3618 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003619 }
3620
Joe Perches31070b52014-01-23 15:54:49 -08003621# Function pointer declarations
3622# check spacing between type, funcptr, and args
3623# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003624 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003625 my $declare = $1;
3626 my $pre_pointer_space = $2;
3627 my $post_pointer_space = $3;
3628 my $funcname = $4;
3629 my $post_funcname_space = $5;
3630 my $pre_args_space = $6;
3631
Joe Perches91f72e92014-04-03 14:49:12 -07003632# the $Declare variable will capture all spaces after the type
3633# so check it for a missing trailing missing space but pointer return types
3634# don't need a space so don't warn for those.
3635 my $post_declare_space = "";
3636 if ($declare =~ /(\s+)$/) {
3637 $post_declare_space = $1;
3638 $declare = rtrim($declare);
3639 }
3640 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003641 WARN("SPACING",
3642 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003643 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003644 }
3645
3646# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003647# This test is not currently implemented because these declarations are
3648# equivalent to
3649# int foo(int bar, ...)
3650# and this is form shouldn't/doesn't generate a checkpatch warning.
3651#
3652# elsif ($declare =~ /\s{2,}$/) {
3653# WARN("SPACING",
3654# "Multiple spaces after return type\n" . $herecurr);
3655# }
Joe Perches31070b52014-01-23 15:54:49 -08003656
3657# unnecessary space "type ( *funcptr)(args...)"
3658 if (defined $pre_pointer_space &&
3659 $pre_pointer_space =~ /^\s/) {
3660 WARN("SPACING",
3661 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3662 }
3663
3664# unnecessary space "type (* funcptr)(args...)"
3665 if (defined $post_pointer_space &&
3666 $post_pointer_space =~ /^\s/) {
3667 WARN("SPACING",
3668 "Unnecessary space before function pointer name\n" . $herecurr);
3669 }
3670
3671# unnecessary space "type (*funcptr )(args...)"
3672 if (defined $post_funcname_space &&
3673 $post_funcname_space =~ /^\s/) {
3674 WARN("SPACING",
3675 "Unnecessary space after function pointer name\n" . $herecurr);
3676 }
3677
3678# unnecessary space "type (*funcptr) (args...)"
3679 if (defined $pre_args_space &&
3680 $pre_args_space =~ /^\s/) {
3681 WARN("SPACING",
3682 "Unnecessary space before function pointer arguments\n" . $herecurr);
3683 }
3684
3685 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003686 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003687 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003688 }
3689 }
3690
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003691# check for spacing round square brackets; allowed:
3692# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003693# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3694# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003695 while ($line =~ /(.*?\s)\[/g) {
3696 my ($where, $prefix) = ($-[1], $1);
3697 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003698 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003699 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003700 if (ERROR("BRACKET_SPACE",
3701 "space prohibited before open square bracket '['\n" . $herecurr) &&
3702 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003703 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003704 s/^(\+.*?)\s+\[/$1\[/;
3705 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003706 }
3707 }
3708
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003709# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003710 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003711 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003712 my $ctx_before = substr($line, 0, $-[1]);
3713 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003714
3715 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003716 if ($name =~ /^(?:
3717 if|for|while|switch|return|case|
3718 volatile|__volatile__|
3719 __attribute__|format|__extension__|
3720 asm|__asm__)$/x)
3721 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003722 # cpp #define statements have non-optional spaces, ie
3723 # if there is a space between the name and the open
3724 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003725 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003726
3727 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003728 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003729
3730 # If this whole things ends with a type its most
3731 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003732 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003733
3734 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003735 if (WARN("SPACING",
3736 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3737 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003738 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003739 s/\b$name\s+\(/$name\(/;
3740 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003741 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003742 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003743
Andy Whitcroft653d4872007-06-23 17:16:34 -07003744# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003745 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003746 my $fixed_line = "";
3747 my $line_fixed = 0;
3748
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003749 my $ops = qr{
3750 <<=|>>=|<=|>=|==|!=|
3751 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3752 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003753 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003754 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003755 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003756 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003757
3758## print("element count: <" . $#elements . ">\n");
3759## foreach my $el (@elements) {
3760## print("el: <$el>\n");
3761## }
3762
3763 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003764 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003765
Joe Perches3705ce52013-07-03 15:05:31 -07003766 foreach my $el (@elements) {
3767 push(@fix_elements, substr($rawline, $off, length($el)));
3768 $off += length($el);
3769 }
3770
3771 $off = 0;
3772
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003773 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003774 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003775
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003776 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003777
3778 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3779
3780## print("n: <$n> good: <$good>\n");
3781
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003782 $off += length($elements[$n]);
3783
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003784 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003785 my $ca = substr($opline, 0, $off);
3786 my $cc = '';
3787 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3788 $cc = substr($opline, $off + length($elements[$n + 1]));
3789 }
3790 my $cb = "$ca$;$cc";
3791
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003792 my $a = '';
3793 $a = 'V' if ($elements[$n] ne '');
3794 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003795 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003796 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3797 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003798 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003799
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003800 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003801
3802 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003803 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003804 $c = 'V' if ($elements[$n + 2] ne '');
3805 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003806 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003807 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3808 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003809 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003810 } else {
3811 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003812 }
3813
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003814 my $ctx = "${a}x${c}";
3815
3816 my $at = "(ctx:$ctx)";
3817
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003818 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003819 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003820
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003821 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003822 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003823
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003824 # Get the full operator variant.
3825 my $opv = $op . substr($curr_vars, $off, 1);
3826
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003827 # Ignore operators passed as parameters.
3828 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003829 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003830
Andy Whitcroftcf655042008-03-04 14:28:20 -08003831# # Ignore comments
3832# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003833
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003834 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003835 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003836 if ($ctx !~ /.x[WEBC]/ &&
3837 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003838 if (ERROR("SPACING",
3839 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003840 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003841 $line_fixed = 1;
3842 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003843 }
3844
3845 # // is a comment
3846 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003847
Joe Perchesb00e4812014-04-03 14:49:33 -07003848 # : when part of a bitfield
3849 } elsif ($opv eq ':B') {
3850 # skip the bitfield test for now
3851
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003852 # No spaces for:
3853 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003854 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003855 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003856 if (ERROR("SPACING",
3857 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003858 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003859 if (defined $fix_elements[$n + 2]) {
3860 $fix_elements[$n + 2] =~ s/^\s+//;
3861 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003862 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003863 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003864 }
3865
Joe Perches23810972014-12-10 15:51:32 -08003866 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003867 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003868 my $rtrim_before = 0;
3869 my $space_after = 0;
3870 if ($ctx =~ /Wx./) {
3871 if (ERROR("SPACING",
3872 "space prohibited before that '$op' $at\n" . $hereptr)) {
3873 $line_fixed = 1;
3874 $rtrim_before = 1;
3875 }
3876 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003877 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003878 if (ERROR("SPACING",
3879 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003880 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003881 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003882 $space_after = 1;
3883 }
3884 }
3885 if ($rtrim_before || $space_after) {
3886 if ($rtrim_before) {
3887 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3888 } else {
3889 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3890 }
3891 if ($space_after) {
3892 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003893 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003894 }
3895
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003896 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003897 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003898 #warn "'*' is part of type\n";
3899
3900 # unary operators should have a space before and
3901 # none after. May be left adjacent to another
3902 # unary operator, or a cast
3903 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003904 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003905 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003906 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003907 if (ERROR("SPACING",
3908 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003909 if ($n != $last_after + 2) {
3910 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3911 $line_fixed = 1;
3912 }
Joe Perches3705ce52013-07-03 15:05:31 -07003913 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003914 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003915 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003916 # A unary '*' may be const
3917
3918 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003919 if (ERROR("SPACING",
3920 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003921 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003922 if (defined $fix_elements[$n + 2]) {
3923 $fix_elements[$n + 2] =~ s/^\s+//;
3924 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003925 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003926 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003927 }
3928
3929 # unary ++ and unary -- are allowed no space on one side.
3930 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003931 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003932 if (ERROR("SPACING",
3933 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003934 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003935 $line_fixed = 1;
3936 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003937 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003938 if ($ctx =~ /Wx[BE]/ ||
3939 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003940 if (ERROR("SPACING",
3941 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003942 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003943 $line_fixed = 1;
3944 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003945 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003946 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003947 if (ERROR("SPACING",
3948 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003949 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003950 if (defined $fix_elements[$n + 2]) {
3951 $fix_elements[$n + 2] =~ s/^\s+//;
3952 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003953 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003954 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003955 }
3956
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003957 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003958 } elsif ($op eq '<<' or $op eq '>>' or
3959 $op eq '&' or $op eq '^' or $op eq '|' or
3960 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003961 $op eq '*' or $op eq '/' or
3962 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003963 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08003964 if ($check) {
3965 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3966 if (CHK("SPACING",
3967 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3968 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3969 $fix_elements[$n + 2] =~ s/^\s+//;
3970 $line_fixed = 1;
3971 }
3972 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3973 if (CHK("SPACING",
3974 "space preferred before that '$op' $at\n" . $hereptr)) {
3975 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3976 $line_fixed = 1;
3977 }
3978 }
3979 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003980 if (ERROR("SPACING",
3981 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003982 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3983 if (defined $fix_elements[$n + 2]) {
3984 $fix_elements[$n + 2] =~ s/^\s+//;
3985 }
Joe Perches3705ce52013-07-03 15:05:31 -07003986 $line_fixed = 1;
3987 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003988 }
3989
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003990 # A colon needs no spaces before when it is
3991 # terminating a case value or a label.
3992 } elsif ($opv eq ':C' || $opv eq ':L') {
3993 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003994 if (ERROR("SPACING",
3995 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003996 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003997 $line_fixed = 1;
3998 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003999 }
4000
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004001 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004002 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004003 my $ok = 0;
4004
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004005 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004006 if (($op eq '<' &&
4007 $cc =~ /^\S+\@\S+>/) ||
4008 ($op eq '>' &&
4009 $ca =~ /<\S+\@\S+$/))
4010 {
4011 $ok = 1;
4012 }
4013
Joe Perchese0df7e12015-04-16 12:44:53 -07004014 # for asm volatile statements
4015 # ignore a colon with another
4016 # colon immediately before or after
4017 if (($op eq ':') &&
4018 ($ca =~ /:$/ || $cc =~ /^:/)) {
4019 $ok = 1;
4020 }
4021
Joe Perches84731622013-11-12 15:10:05 -08004022 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004023 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004024 my $msg_type = \&ERROR;
4025 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4026
4027 if (&{$msg_type}("SPACING",
4028 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004029 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4030 if (defined $fix_elements[$n + 2]) {
4031 $fix_elements[$n + 2] =~ s/^\s+//;
4032 }
Joe Perches3705ce52013-07-03 15:05:31 -07004033 $line_fixed = 1;
4034 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004035 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004036 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004037 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004038
4039## print("n: <$n> GOOD: <$good>\n");
4040
4041 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004042 }
Joe Perches3705ce52013-07-03 15:05:31 -07004043
4044 if (($#elements % 2) == 0) {
4045 $fixed_line = $fixed_line . $fix_elements[$#elements];
4046 }
4047
Joe Perches194f66f2014-08-06 16:11:03 -07004048 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4049 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004050 }
4051
4052
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004053 }
4054
Joe Perches786b6322013-07-03 15:05:32 -07004055# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004056 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004057 if (WARN("SPACING",
4058 "space prohibited before semicolon\n" . $herecurr) &&
4059 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004060 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004061 s/^(\+.*\S)\s+;/$1;/;
4062 }
4063 }
4064
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004065# check for multiple assignments
4066 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004067 CHK("MULTIPLE_ASSIGNMENTS",
4068 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004069 }
4070
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004071## # check for multiple declarations, allowing for a function declaration
4072## # continuation.
4073## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4074## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4075##
4076## # Remove any bracketed sections to ensure we do not
4077## # falsly report the parameters of functions.
4078## my $ln = $line;
4079## while ($ln =~ s/\([^\(\)]*\)//g) {
4080## }
4081## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004082## WARN("MULTIPLE_DECLARATION",
4083## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004084## }
4085## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004086
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004087#need space before brace following if, while, etc
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004088 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\){/) ||
4089 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004090 if (ERROR("SPACING",
4091 "space required before the open brace '{'\n" . $herecurr) &&
4092 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004093 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004094 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004095 }
4096
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004097## # check for blank lines before declarations
4098## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4099## $prevrawline =~ /^.\s*$/) {
4100## WARN("SPACING",
4101## "No blank lines before declarations\n" . $hereprev);
4102## }
4103##
4104
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004105# closing brace should have a space following it when it has anything
4106# on the line
4107 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004108 if (ERROR("SPACING",
4109 "space required after that close brace '}'\n" . $herecurr) &&
4110 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004111 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004112 s/}((?!(?:,|;|\)))\S)/} $1/;
4113 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004114 }
4115
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004116# check spacing on square brackets
4117 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004118 if (ERROR("SPACING",
4119 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4120 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004121 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004122 s/\[\s+/\[/;
4123 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004124 }
4125 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004126 if (ERROR("SPACING",
4127 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4128 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004129 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004130 s/\s+\]/\]/;
4131 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004132 }
4133
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004134# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004135 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4136 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004137 if (ERROR("SPACING",
4138 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4139 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004140 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004141 s/\(\s+/\(/;
4142 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004143 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004144 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004145 $line !~ /for\s*\(.*;\s+\)/ &&
4146 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004147 if (ERROR("SPACING",
4148 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4149 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004150 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004151 s/\s+\)/\)/;
4152 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004153 }
4154
Joe Perchese2826fd2014-08-06 16:10:48 -07004155# check unnecessary parentheses around addressof/dereference single $Lvals
4156# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4157
4158 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004159 my $var = $1;
4160 if (CHK("UNNECESSARY_PARENTHESES",
4161 "Unnecessary parentheses around $var\n" . $herecurr) &&
4162 $fix) {
4163 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4164 }
4165 }
4166
4167# check for unnecessary parentheses around function pointer uses
4168# ie: (foo->bar)(); should be foo->bar();
4169# but not "if (foo->bar) (" to avoid some false positives
4170 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4171 my $var = $2;
4172 if (CHK("UNNECESSARY_PARENTHESES",
4173 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4174 $fix) {
4175 my $var2 = deparenthesize($var);
4176 $var2 =~ s/\s//g;
4177 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4178 }
4179 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004180
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004181#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004182 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004183 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004184 if (WARN("INDENTED_LABEL",
4185 "labels should not be indented\n" . $herecurr) &&
4186 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004187 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004188 s/^(.)\s+/$1/;
4189 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004190 }
4191
Joe Perches5b9553a2014-04-03 14:49:21 -07004192# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004193 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004194 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004195 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004196 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4197 my $value = $1;
4198 $value = deparenthesize($value);
4199 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4200 ERROR("RETURN_PARENTHESES",
4201 "return is not a function, parentheses are not required\n" . $herecurr);
4202 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004203 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004204 ERROR("SPACING",
4205 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004206 }
4207 }
Joe Perches507e5142013-11-12 15:10:13 -08004208
Joe Perchesb43ae212014-06-23 13:22:07 -07004209# unnecessary return in a void function
4210# at end-of-function, with the previous line a single leading tab, then return;
4211# and the line before that not a goto label target like "out:"
4212 if ($sline =~ /^[ \+]}\s*$/ &&
4213 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4214 $linenr >= 3 &&
4215 $lines[$linenr - 3] =~ /^[ +]/ &&
4216 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004217 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004218 "void function return statements are not generally useful\n" . $hereprev);
4219 }
Joe Perches9819cf22014-06-04 16:12:09 -07004220
Joe Perches189248d2014-01-23 15:54:47 -08004221# if statements using unnecessary parentheses - ie: if ((foo == bar))
4222 if ($^V && $^V ge 5.10.0 &&
4223 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4224 my $openparens = $1;
4225 my $count = $openparens =~ tr@\(@\(@;
4226 my $msg = "";
4227 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4228 my $comp = $4; #Not $1 because of $LvalOrFunc
4229 $msg = " - maybe == should be = ?" if ($comp eq "==");
4230 WARN("UNNECESSARY_PARENTHESES",
4231 "Unnecessary parentheses$msg\n" . $herecurr);
4232 }
4233 }
4234
Joe Perchesc5595fa2015-09-09 15:37:58 -07004235# comparisons with a constant or upper case identifier on the left
4236# avoid cases like "foo + BAR < baz"
4237# only fix matches surrounded by parentheses to avoid incorrect
4238# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4239 if ($^V && $^V ge 5.10.0 &&
4240 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4241 my $lead = $1;
4242 my $const = $2;
4243 my $comp = $3;
4244 my $to = $4;
4245 my $newcomp = $comp;
4246 if ($lead !~ /$Operators\s*$/ &&
4247 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4248 WARN("CONSTANT_COMPARISON",
4249 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4250 $fix) {
4251 if ($comp eq "<") {
4252 $newcomp = ">";
4253 } elsif ($comp eq "<=") {
4254 $newcomp = ">=";
4255 } elsif ($comp eq ">") {
4256 $newcomp = "<";
4257 } elsif ($comp eq ">=") {
4258 $newcomp = "<=";
4259 }
4260 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4261 }
4262 }
4263
Joe Perchesf34e4a42015-04-16 12:44:19 -07004264# Return of what appears to be an errno should normally be negative
4265 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004266 my $name = $1;
4267 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004268 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004269 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004270 }
4271 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004272
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004273# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004274 if ($line =~ /\b(if|while|for|switch)\(/) {
4275 if (ERROR("SPACING",
4276 "space required before the open parenthesis '('\n" . $herecurr) &&
4277 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004278 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004279 s/\b(if|while|for|switch)\(/$1 \(/;
4280 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004281 }
4282
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004283# Check for illegal assignment in if conditional -- and check for trailing
4284# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004285 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004286 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4287 ctx_statement_block($linenr, $realcnt, 0)
4288 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004289 my ($stat_next) = ctx_statement_block($line_nr_next,
4290 $remain_next, $off_next);
4291 $stat_next =~ s/\n./\n /g;
4292 ##print "stat<$stat> stat_next<$stat_next>\n";
4293
4294 if ($stat_next =~ /^\s*while\b/) {
4295 # If the statement carries leading newlines,
4296 # then count those as offsets.
4297 my ($whitespace) =
4298 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4299 my $offset =
4300 statement_rawlines($whitespace) - 1;
4301
4302 $suppress_whiletrailers{$line_nr_next +
4303 $offset} = 1;
4304 }
4305 }
4306 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004307 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004308 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004309 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004310
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004311 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004312 ERROR("ASSIGN_IN_IF",
4313 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004314 }
4315
4316 # Find out what is on the end of the line after the
4317 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004318 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004319 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004320 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004321 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4322 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004323 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004324 # Find out how long the conditional actually is.
4325 my @newlines = ($c =~ /\n/gs);
4326 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004327 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004328
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004329 $stat_real = raw_line($linenr, $cond_lines)
4330 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004331 if (defined($stat_real) && $cond_lines > 1) {
4332 $stat_real = "[...]\n$stat_real";
4333 }
4334
Joe Perches000d1cc12011-07-25 17:13:25 -07004335 ERROR("TRAILING_STATEMENTS",
4336 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004337 }
4338 }
4339
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004340# Check for bitwise tests written as boolean
4341 if ($line =~ /
4342 (?:
4343 (?:\[|\(|\&\&|\|\|)
4344 \s*0[xX][0-9]+\s*
4345 (?:\&\&|\|\|)
4346 |
4347 (?:\&\&|\|\|)
4348 \s*0[xX][0-9]+\s*
4349 (?:\&\&|\|\||\)|\])
4350 )/x)
4351 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004352 WARN("HEXADECIMAL_BOOLEAN_TEST",
4353 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004354 }
4355
Andy Whitcroft8905a672007-11-28 16:21:06 -08004356# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004357 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4358 my $s = $1;
4359 $s =~ s/$;//g; # Remove any comments
4360 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004361 ERROR("TRAILING_STATEMENTS",
4362 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004363 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004364 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004365# if should not continue a brace
4366 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004367 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004368 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004369 $herecurr);
4370 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004371# case and default should not have general statements after them
4372 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4373 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004374 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004375 \s*return\s+
4376 )/xg)
4377 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004378 ERROR("TRAILING_STATEMENTS",
4379 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004380 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004381
4382 # Check for }<nl>else {, these must be at the same
4383 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004384 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4385 $previndent == $indent) {
4386 if (ERROR("ELSE_AFTER_BRACE",
4387 "else should follow close brace '}'\n" . $hereprev) &&
4388 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4389 fix_delete_line($fixlinenr - 1, $prevrawline);
4390 fix_delete_line($fixlinenr, $rawline);
4391 my $fixedline = $prevrawline;
4392 $fixedline =~ s/}\s*$//;
4393 if ($fixedline !~ /^\+\s*$/) {
4394 fix_insert_line($fixlinenr, $fixedline);
4395 }
4396 $fixedline = $rawline;
4397 $fixedline =~ s/^(.\s*)else/$1} else/;
4398 fix_insert_line($fixlinenr, $fixedline);
4399 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004400 }
4401
Joe Perches8b8856f2014-08-06 16:11:14 -07004402 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4403 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004404 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4405
4406 # Find out what is on the end of the line after the
4407 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004408 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004409 $s =~ s/\n.*//g;
4410
4411 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004412 if (ERROR("WHILE_AFTER_BRACE",
4413 "while should follow close brace '}'\n" . $hereprev) &&
4414 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4415 fix_delete_line($fixlinenr - 1, $prevrawline);
4416 fix_delete_line($fixlinenr, $rawline);
4417 my $fixedline = $prevrawline;
4418 my $trailing = $rawline;
4419 $trailing =~ s/^\+//;
4420 $trailing = trim($trailing);
4421 $fixedline =~ s/}\s*$/} $trailing/;
4422 fix_insert_line($fixlinenr, $fixedline);
4423 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004424 }
4425 }
4426
Joe Perches95e2c602013-07-03 15:05:20 -07004427#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004428 while ($line =~ m{($Constant|$Lval)}g) {
4429 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004430
4431#gcc binary extension
4432 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004433 if (WARN("GCC_BINARY_CONSTANT",
4434 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4435 $fix) {
4436 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004437 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004438 s/\b$var\b/$hexval/;
4439 }
Joe Perches95e2c602013-07-03 15:05:20 -07004440 }
4441
4442#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004443 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004444 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004445#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004446 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004447#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004448 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4449#Ignore some three character SI units explicitly, like MiB and KHz
4450 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004451 while ($var =~ m{($Ident)}g) {
4452 my $word = $1;
4453 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004454 if ($check) {
4455 seed_camelcase_includes();
4456 if (!$file && !$camelcase_file_seeded) {
4457 seed_camelcase_file($realfile);
4458 $camelcase_file_seeded = 1;
4459 }
4460 }
Joe Perches7e781f62013-09-11 14:23:55 -07004461 if (!defined $camelcase{$word}) {
4462 $camelcase{$word} = 1;
4463 CHK("CAMELCASE",
4464 "Avoid CamelCase: <$word>\n" . $herecurr);
4465 }
Joe Perches34456862013-07-03 15:05:34 -07004466 }
Joe Perches323c1262012-12-17 16:02:07 -08004467 }
4468 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004469
4470#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004471 if ($line =~ /\#\s*define.*\\\s+$/) {
4472 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4473 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4474 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004475 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004476 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004477 }
4478
Fabian Frederick0e212e02015-04-16 12:44:25 -07004479# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4480# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004481 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004482 my $file = "$1.h";
4483 my $checkfile = "include/linux/$file";
4484 if (-f "$root/$checkfile" &&
4485 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004486 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004487 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004488 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4489 if ($asminclude > 0) {
4490 if ($realfile =~ m{^arch/}) {
4491 CHK("ARCH_INCLUDE_LINUX",
4492 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4493 } else {
4494 WARN("INCLUDE_LINUX",
4495 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4496 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004497 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004498 }
4499 }
4500
Andy Whitcroft653d4872007-06-23 17:16:34 -07004501# multi-statement macros should be enclosed in a do while loop, grab the
4502# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004503# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004504 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4505 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004506 my $ln = $linenr;
4507 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004508 my ($off, $dstat, $dcond, $rest);
4509 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004510 my $has_flow_statement = 0;
4511 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004512 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004513 ctx_statement_block($linenr, $realcnt, 0);
4514 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004515 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004516 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004517
Joe Perches08a28432014-10-13 15:51:55 -07004518 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4519 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4520
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004521 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004522 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004523 $dstat =~ s/\\\n.//g;
4524 $dstat =~ s/^\s*//s;
4525 $dstat =~ s/\s*$//s;
4526
4527 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004528 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4529 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004530 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004531 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004532 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004533
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004534 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004535 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4536 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004537 {
4538 }
4539
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004540 my $exceptions = qr{
4541 $Declare|
4542 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004543 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004544 DECLARE_PER_CPU|
4545 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004546 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004547 union|
4548 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004549 \.$Ident\s*=\s*|
4550 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004551 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004552 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004553 if ($dstat ne '' &&
4554 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4555 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004556 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004557 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004558 $dstat !~ /$exceptions/ &&
4559 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004560 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004561 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004562 $dstat !~ /^for\s*$Constant$/ && # for (...)
4563 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4564 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004565 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004566 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004567 {
4568 $ctx =~ s/\n*$//;
4569 my $herectx = $here . "\n";
4570 my $cnt = statement_rawlines($ctx);
4571
4572 for (my $n = 0; $n < $cnt; $n++) {
4573 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004574 }
4575
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004576 if ($dstat =~ /;/) {
4577 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4578 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4579 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004580 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004581 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004582 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004583 }
Joe Perches5023d342012-12-17 16:01:47 -08004584
Joe Perches08a28432014-10-13 15:51:55 -07004585# check for macros with flow control, but without ## concatenation
4586# ## concatenation is commonly a macro that defines a function so ignore those
4587 if ($has_flow_statement && !$has_arg_concat) {
4588 my $herectx = $here . "\n";
4589 my $cnt = statement_rawlines($ctx);
4590
4591 for (my $n = 0; $n < $cnt; $n++) {
4592 $herectx .= raw_line($linenr, $n) . "\n";
4593 }
4594 WARN("MACRO_WITH_FLOW_CONTROL",
4595 "Macros with flow control statements should be avoided\n" . "$herectx");
4596 }
4597
Joe Perches481eb482012-12-17 16:01:56 -08004598# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004599
4600 } else {
4601 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004602 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4603 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004604 $line =~ /^\+.*\\$/) {
4605 WARN("LINE_CONTINUATIONS",
4606 "Avoid unnecessary line continuations\n" . $herecurr);
4607 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004608 }
4609
Joe Perchesb13edf72012-07-30 14:41:24 -07004610# do {} while (0) macro tests:
4611# single-statement macros do not need to be enclosed in do while (0) loop,
4612# macro should not end with a semicolon
4613 if ($^V && $^V ge 5.10.0 &&
4614 $realfile !~ m@/vmlinux.lds.h$@ &&
4615 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4616 my $ln = $linenr;
4617 my $cnt = $realcnt;
4618 my ($off, $dstat, $dcond, $rest);
4619 my $ctx = '';
4620 ($dstat, $dcond, $ln, $cnt, $off) =
4621 ctx_statement_block($linenr, $realcnt, 0);
4622 $ctx = $dstat;
4623
4624 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004625 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004626
4627 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4628 my $stmts = $2;
4629 my $semis = $3;
4630
4631 $ctx =~ s/\n*$//;
4632 my $cnt = statement_rawlines($ctx);
4633 my $herectx = $here . "\n";
4634
4635 for (my $n = 0; $n < $cnt; $n++) {
4636 $herectx .= raw_line($linenr, $n) . "\n";
4637 }
4638
Joe Perchesac8e97f2012-08-21 16:15:53 -07004639 if (($stmts =~ tr/;/;/) == 1 &&
4640 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004641 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4642 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4643 }
4644 if (defined $semis && $semis ne "") {
4645 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4646 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4647 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004648 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4649 $ctx =~ s/\n*$//;
4650 my $cnt = statement_rawlines($ctx);
4651 my $herectx = $here . "\n";
4652
4653 for (my $n = 0; $n < $cnt; $n++) {
4654 $herectx .= raw_line($linenr, $n) . "\n";
4655 }
4656
4657 WARN("TRAILING_SEMICOLON",
4658 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004659 }
4660 }
4661
Mike Frysinger080ba922009-01-06 14:41:25 -08004662# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4663# all assignments may have only one of the following with an assignment:
4664# .
4665# ALIGN(...)
4666# VMLINUX_SYMBOL(...)
4667 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004668 WARN("MISSING_VMLINUX_SYMBOL",
4669 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004670 }
4671
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004672# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004673 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4674 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004675 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004676 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004677 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4678 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004679 my @allowed = ();
4680 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004681 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004682 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004683 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004684 for my $chunk (@chunks) {
4685 my ($cond, $block) = @{$chunk};
4686
Andy Whitcroft773647a2008-03-28 14:15:58 -07004687 # If the condition carries leading newlines, then count those as offsets.
4688 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4689 my $offset = statement_rawlines($whitespace) - 1;
4690
Joe Perchesaad4f612012-03-23 15:02:19 -07004691 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004692 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4693
4694 # We have looked at and allowed this specific line.
4695 $suppress_ifbraces{$ln + $offset} = 1;
4696
4697 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004698 $ln += statement_rawlines($block) - 1;
4699
Andy Whitcroft773647a2008-03-28 14:15:58 -07004700 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004701
4702 $seen++ if ($block =~ /^\s*{/);
4703
Joe Perchesaad4f612012-03-23 15:02:19 -07004704 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004705 if (statement_lines($cond) > 1) {
4706 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004707 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004708 }
4709 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004710 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004711 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004712 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004713 if (statement_block_size($block) > 1) {
4714 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004715 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004716 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004717 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004718 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004719 if ($seen) {
4720 my $sum_allowed = 0;
4721 foreach (@allowed) {
4722 $sum_allowed += $_;
4723 }
4724 if ($sum_allowed == 0) {
4725 WARN("BRACES",
4726 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4727 } elsif ($sum_allowed != $allow &&
4728 $seen != $allow) {
4729 CHK("BRACES",
4730 "braces {} should be used on all arms of this statement\n" . $herectx);
4731 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004732 }
4733 }
4734 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004735 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004736 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004737 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004738
Andy Whitcroftcf655042008-03-04 14:28:20 -08004739 # Check the pre-context.
4740 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4741 #print "APW: ALLOWED: pre<$1>\n";
4742 $allowed = 1;
4743 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004744
4745 my ($level, $endln, @chunks) =
4746 ctx_statement_full($linenr, $realcnt, $-[0]);
4747
Andy Whitcroftcf655042008-03-04 14:28:20 -08004748 # Check the condition.
4749 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004750 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004751 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004752 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004753 }
4754 if (statement_lines($cond) > 1) {
4755 #print "APW: ALLOWED: cond<$cond>\n";
4756 $allowed = 1;
4757 }
4758 if ($block =~/\b(?:if|for|while)\b/) {
4759 #print "APW: ALLOWED: block<$block>\n";
4760 $allowed = 1;
4761 }
4762 if (statement_block_size($block) > 1) {
4763 #print "APW: ALLOWED: lines block<$block>\n";
4764 $allowed = 1;
4765 }
4766 # Check the post-context.
4767 if (defined $chunks[1]) {
4768 my ($cond, $block) = @{$chunks[1]};
4769 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004770 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004771 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004772 if ($block =~ /^\s*\{/) {
4773 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4774 $allowed = 1;
4775 }
4776 }
4777 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004778 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004779 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004780
Andy Whitcroftf0556632008-10-15 22:02:23 -07004781 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004782 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004783 }
4784
Joe Perches000d1cc12011-07-25 17:13:25 -07004785 WARN("BRACES",
4786 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004787 }
4788 }
4789
Joe Perches0979ae62012-12-17 16:01:59 -08004790# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004791 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004792 if (CHK("BRACES",
4793 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4794 $fix && $prevrawline =~ /^\+/) {
4795 fix_delete_line($fixlinenr - 1, $prevrawline);
4796 }
Joe Perches0979ae62012-12-17 16:01:59 -08004797 }
Joe Perches77b9a532013-07-03 15:05:29 -07004798 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004799 if (CHK("BRACES",
4800 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4801 $fix) {
4802 fix_delete_line($fixlinenr, $rawline);
4803 }
Joe Perches0979ae62012-12-17 16:01:59 -08004804 }
4805
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004806# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004807 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4808 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004809 WARN("VOLATILE",
4810 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004811 }
4812
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004813# Check for user-visible strings broken across lines, which breaks the ability
4814# to grep for the string. Make exceptions when the previous string ends in a
4815# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4816# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004817 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004818 $prevline =~ /"\s*$/ &&
4819 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4820 if (WARN("SPLIT_STRING",
4821 "quoted string split across lines\n" . $hereprev) &&
4822 $fix &&
4823 $prevrawline =~ /^\+.*"\s*$/ &&
4824 $last_coalesced_string_linenr != $linenr - 1) {
4825 my $extracted_string = get_quoted_string($line, $rawline);
4826 my $comma_close = "";
4827 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4828 $comma_close = $1;
4829 }
4830
4831 fix_delete_line($fixlinenr - 1, $prevrawline);
4832 fix_delete_line($fixlinenr, $rawline);
4833 my $fixedline = $prevrawline;
4834 $fixedline =~ s/"\s*$//;
4835 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4836 fix_insert_line($fixlinenr - 1, $fixedline);
4837 $fixedline = $rawline;
4838 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4839 if ($fixedline !~ /\+\s*$/) {
4840 fix_insert_line($fixlinenr, $fixedline);
4841 }
4842 $last_coalesced_string_linenr = $linenr;
4843 }
4844 }
4845
4846# check for missing a space in a string concatenation
4847 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4848 WARN('MISSING_SPACE',
4849 "break quoted strings at a space character\n" . $hereprev);
4850 }
4851
4852# check for spaces before a quoted newline
4853 if ($rawline =~ /^.*\".*\s\\n/) {
4854 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4855 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4856 $fix) {
4857 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4858 }
4859
4860 }
4861
Joe Perchesf17dba42014-10-13 15:51:51 -07004862# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07004863 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07004864 CHK("CONCATENATED_STRING",
4865 "Concatenated strings should use spaces between elements\n" . $herecurr);
4866 }
4867
Joe Perches90ad30e2014-12-10 15:51:59 -08004868# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07004869 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08004870 WARN("STRING_FRAGMENTS",
4871 "Consecutive strings are generally better as a single string\n" . $herecurr);
4872 }
4873
Joe Perches6e300752015-09-09 15:37:47 -07004874# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004875 my $string;
4876 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4877 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4878 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07004879 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004880 WARN("PRINTF_L",
4881 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4882 last;
4883 }
Joe Perches6e300752015-09-09 15:37:47 -07004884 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
4885 ERROR("PRINTF_0xDECIMAL",
4886 "Prefixing 0x with decimal output is defective\n" . $herecurr);
4887 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004888 }
4889
4890# check for line continuations in quoted strings with odd counts of "
4891 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4892 WARN("LINE_CONTINUATIONS",
4893 "Avoid line continuations in quoted strings\n" . $herecurr);
4894 }
4895
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004896# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004897 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004898 CHK("REDUNDANT_CODE",
4899 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004900 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004901 }
4902
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004903# check for needless "if (<foo>) fn(<foo>)" uses
4904 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07004905 my $tested = quotemeta($1);
4906 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
4907 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4908 my $func = $1;
4909 if (WARN('NEEDLESS_IF',
4910 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
4911 $fix) {
4912 my $do_fix = 1;
4913 my $leading_tabs = "";
4914 my $new_leading_tabs = "";
4915 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
4916 $leading_tabs = $1;
4917 } else {
4918 $do_fix = 0;
4919 }
4920 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
4921 $new_leading_tabs = $1;
4922 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
4923 $do_fix = 0;
4924 }
4925 } else {
4926 $do_fix = 0;
4927 }
4928 if ($do_fix) {
4929 fix_delete_line($fixlinenr - 1, $prevrawline);
4930 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
4931 }
4932 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004933 }
4934 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004935
Joe Perchesebfdc402014-08-06 16:10:27 -07004936# check for unnecessary "Out of Memory" messages
4937 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4938 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4939 (defined $1 || defined $3) &&
4940 $linenr > 3) {
4941 my $testval = $2;
4942 my $testline = $lines[$linenr - 3];
4943
4944 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4945# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4946
4947 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4948 WARN("OOM_MESSAGE",
4949 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4950 }
4951 }
4952
Joe Perchesf78d98f2014-10-13 15:52:01 -07004953# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08004954 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07004955 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4956 my $level = $1;
4957 if (WARN("UNNECESSARY_KERN_LEVEL",
4958 "Possible unnecessary $level\n" . $herecurr) &&
4959 $fix) {
4960 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4961 }
4962 }
4963
Joe Perchesabb08a52014-12-10 15:51:46 -08004964# check for mask then right shift without a parentheses
4965 if ($^V && $^V ge 5.10.0 &&
4966 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4967 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4968 WARN("MASK_THEN_SHIFT",
4969 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4970 }
4971
Joe Perchesb75ac612014-12-10 15:52:02 -08004972# check for pointer comparisons to NULL
4973 if ($^V && $^V ge 5.10.0) {
4974 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4975 my $val = $1;
4976 my $equal = "!";
4977 $equal = "" if ($4 eq "!=");
4978 if (CHK("COMPARISON_TO_NULL",
4979 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4980 $fix) {
4981 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4982 }
4983 }
4984 }
4985
Joe Perches8716de32013-09-11 14:24:05 -07004986# check for bad placement of section $InitAttribute (e.g.: __initdata)
4987 if ($line =~ /(\b$InitAttribute\b)/) {
4988 my $attr = $1;
4989 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4990 my $ptr = $1;
4991 my $var = $2;
4992 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4993 ERROR("MISPLACED_INIT",
4994 "$attr should be placed after $var\n" . $herecurr)) ||
4995 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4996 WARN("MISPLACED_INIT",
4997 "$attr should be placed after $var\n" . $herecurr))) &&
4998 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004999 $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 -07005000 }
5001 }
5002 }
5003
Joe Perchese970b8842013-11-12 15:10:10 -08005004# check for $InitAttributeData (ie: __initdata) with const
5005 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5006 my $attr = $1;
5007 $attr =~ /($InitAttributePrefix)(.*)/;
5008 my $attr_prefix = $1;
5009 my $attr_type = $2;
5010 if (ERROR("INIT_ATTRIBUTE",
5011 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5012 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005013 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005014 s/$InitAttributeData/${attr_prefix}initconst/;
5015 }
5016 }
5017
5018# check for $InitAttributeConst (ie: __initconst) without const
5019 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5020 my $attr = $1;
5021 if (ERROR("INIT_ATTRIBUTE",
5022 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5023 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005024 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005025 /(^\+\s*(?:static\s+))/;
5026 $lead = rtrim($1);
5027 $lead = "$lead " if ($lead !~ /^\+$/);
5028 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005029 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005030 }
5031 }
5032
Joe Perchesc17893c2015-04-16 12:44:42 -07005033# check for __read_mostly with const non-pointer (should just be const)
5034 if ($line =~ /\b__read_mostly\b/ &&
5035 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5036 if (ERROR("CONST_READ_MOSTLY",
5037 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5038 $fix) {
5039 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5040 }
5041 }
5042
Joe Perchesfbdb8132014-04-03 14:49:14 -07005043# don't use __constant_<foo> functions outside of include/uapi/
5044 if ($realfile !~ m@^include/uapi/@ &&
5045 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5046 my $constant_func = $1;
5047 my $func = $constant_func;
5048 $func =~ s/^__constant_//;
5049 if (WARN("CONSTANT_CONVERSION",
5050 "$constant_func should be $func\n" . $herecurr) &&
5051 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005052 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005053 }
5054 }
5055
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005056# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005057 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005058 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005059 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005060 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005061 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005062 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5063 }
5064 if ($delay > 2000) {
5065 WARN("LONG_UDELAY",
5066 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005067 }
5068 }
5069
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005070# warn about unexpectedly long msleep's
5071 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5072 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005073 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005074 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005075 }
5076 }
5077
Joe Perches36ec1932013-07-03 15:05:25 -07005078# check for comparisons of jiffies
5079 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5080 WARN("JIFFIES_COMPARISON",
5081 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5082 }
5083
Joe Perches9d7a34a2013-07-03 15:05:26 -07005084# check for comparisons of get_jiffies_64()
5085 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5086 WARN("JIFFIES_COMPARISON",
5087 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5088 }
5089
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005090# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005091# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005092# print "#ifdef in C files should be avoided\n";
5093# print "$herecurr";
5094# $clean = 0;
5095# }
5096
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005097# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005098 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005099 if (ERROR("SPACING",
5100 "exactly one space required after that #$1\n" . $herecurr) &&
5101 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005102 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005103 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5104 }
5105
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005106 }
5107
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005108# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005109 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5110 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005111 my $which = $1;
5112 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005113 CHK("UNCOMMENTED_DEFINITION",
5114 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005115 }
5116 }
5117# check for memory barriers without a comment.
5118 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5119 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005120 WARN("MEMORY_BARRIER",
5121 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005122 }
5123 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005124
Joe Perchescb426e92015-06-25 15:02:46 -07005125# check for waitqueue_active without a comment.
5126 if ($line =~ /\bwaitqueue_active\s*\(/) {
5127 if (!ctx_has_comment($first_line, $linenr)) {
5128 WARN("WAITQUEUE_ACTIVE",
5129 "waitqueue_active without comment\n" . $herecurr);
5130 }
5131 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005132
5133# Check for expedited grace periods that interrupt non-idle non-nohz
5134# online CPUs. These expedited can therefore degrade real-time response
5135# if used carelessly, and should be avoided where not absolutely
5136# needed. It is always OK to use synchronize_rcu_expedited() and
5137# synchronize_sched_expedited() at boot time (before real-time applications
5138# start) and in error situations where real-time response is compromised in
5139# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5140# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5141# Of course, nothing comes for free, and srcu_read_lock() and
5142# srcu_read_unlock() do contain full memory barriers in payment for
5143# synchronize_srcu_expedited() non-interruption properties.
5144 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5145 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5146 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5147
5148 }
5149
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005150# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005151 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005152 CHK("ARCH_DEFINES",
5153 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005154 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005155
Tobias Klauserd4977c72010-05-24 14:33:30 -07005156# Check that the storage class is at the beginning of a declaration
5157 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005158 WARN("STORAGE_CLASS",
5159 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005160 }
5161
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005162# check the location of the inline attribute, that it is between
5163# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005164 if ($line =~ /\b$Type\s+$Inline\b/ ||
5165 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005166 ERROR("INLINE_LOCATION",
5167 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005168 }
5169
Andy Whitcroft8905a672007-11-28 16:21:06 -08005170# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005171 if ($realfile !~ m@\binclude/uapi/@ &&
5172 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005173 if (WARN("INLINE",
5174 "plain inline is preferred over $1\n" . $herecurr) &&
5175 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005176 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005177
5178 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005179 }
5180
Joe Perches3d130fd2011-01-12 17:00:00 -08005181# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005182 if ($realfile !~ m@\binclude/uapi/@ &&
5183 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005184 WARN("PREFER_PACKED",
5185 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005186 }
5187
Joe Perches39b7e282011-07-25 17:13:24 -07005188# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005189 if ($realfile !~ m@\binclude/uapi/@ &&
5190 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005191 WARN("PREFER_ALIGNED",
5192 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005193 }
5194
Joe Perches5f14d3b2012-01-10 15:09:52 -08005195# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005196 if ($realfile !~ m@\binclude/uapi/@ &&
5197 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005198 if (WARN("PREFER_PRINTF",
5199 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5200 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005201 $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 -07005202
5203 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005204 }
5205
Joe Perches6061d942012-03-23 15:02:16 -07005206# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005207 if ($realfile !~ m@\binclude/uapi/@ &&
5208 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005209 if (WARN("PREFER_SCANF",
5210 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5211 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005212 $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 -07005213 }
Joe Perches6061d942012-03-23 15:02:16 -07005214 }
5215
Joe Perches619a9082014-12-10 15:51:35 -08005216# Check for __attribute__ weak, or __weak declarations (may have link issues)
5217 if ($^V && $^V ge 5.10.0 &&
5218 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5219 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5220 $line =~ /\b__weak\b/)) {
5221 ERROR("WEAK_DECLARATION",
5222 "Using weak declarations can have unintended link defects\n" . $herecurr);
5223 }
5224
Joe Perchese6176fa2015-06-25 15:02:49 -07005225# check for c99 types like uint8_t used outside of uapi/
5226 if ($realfile !~ m@\binclude/uapi/@ &&
5227 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5228 my $type = $1;
5229 if ($type =~ /\b($typeC99Typedefs)\b/) {
5230 $type = $1;
5231 my $kernel_type = 'u';
5232 $kernel_type = 's' if ($type =~ /^_*[si]/);
5233 $type =~ /(\d+)/;
5234 $kernel_type .= $1;
5235 if (CHK("PREFER_KERNEL_TYPES",
5236 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5237 $fix) {
5238 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5239 }
5240 }
5241 }
5242
Joe Perches8f53a9b2010-03-05 13:43:48 -08005243# check for sizeof(&)
5244 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005245 WARN("SIZEOF_ADDRESS",
5246 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005247 }
5248
Joe Perches66c80b62012-07-30 14:41:22 -07005249# check for sizeof without parenthesis
5250 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005251 if (WARN("SIZEOF_PARENTHESIS",
5252 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5253 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005254 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005255 }
Joe Perches66c80b62012-07-30 14:41:22 -07005256 }
5257
Joe Perches88982fe2012-12-17 16:02:00 -08005258# check for struct spinlock declarations
5259 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5260 WARN("USE_SPINLOCK_T",
5261 "struct spinlock should be spinlock_t\n" . $herecurr);
5262 }
5263
Joe Perchesa6962d72013-04-29 16:18:13 -07005264# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005265 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005266 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005267 $fmt =~ s/%%//g;
5268 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005269 if (WARN("PREFER_SEQ_PUTS",
5270 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5271 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005272 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005273 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005274 }
5275 }
5276
Andy Whitcroft554e1652012-01-10 15:09:57 -08005277# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005278 if ($^V && $^V ge 5.10.0 &&
5279 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005280 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005281
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005282 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005283 my $ms_val = $7;
5284 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005285
Andy Whitcroft554e1652012-01-10 15:09:57 -08005286 if ($ms_size =~ /^(0x|)0$/i) {
5287 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005288 "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 -08005289 } elsif ($ms_size =~ /^(0x|)1$/i) {
5290 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005291 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5292 }
5293 }
5294
Joe Perches98a9bba2014-01-23 15:54:52 -08005295# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5296 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005297 defined $stat &&
5298 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005299 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005300 "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 -08005301 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005302 $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 -08005303 }
5304 }
5305
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005306# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5307 if ($^V && $^V ge 5.10.0 &&
5308 defined $stat &&
5309 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5310 WARN("PREFER_ETHER_ADDR_EQUAL",
5311 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5312 }
5313
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005314# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5315# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5316 if ($^V && $^V ge 5.10.0 &&
5317 defined $stat &&
5318 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5319
5320 my $ms_val = $7;
5321
5322 if ($ms_val =~ /^(?:0x|)0+$/i) {
5323 if (WARN("PREFER_ETH_ZERO_ADDR",
5324 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5325 $fix) {
5326 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5327 }
5328 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5329 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5330 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5331 $fix) {
5332 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5333 }
5334 }
5335 }
5336
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005337# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005338 if ($^V && $^V ge 5.10.0 &&
5339 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005340 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005341 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005342 my $call = $1;
5343 my $cast1 = deparenthesize($2);
5344 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005345 my $cast2 = deparenthesize($7);
5346 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005347 my $cast;
5348
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005349 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005350 $cast = "$cast1 or $cast2";
5351 } elsif ($cast1 ne "") {
5352 $cast = $cast1;
5353 } else {
5354 $cast = $cast2;
5355 }
5356 WARN("MINMAX",
5357 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005358 }
5359 }
5360
Joe Perches4a273192012-07-30 14:41:20 -07005361# check usleep_range arguments
5362 if ($^V && $^V ge 5.10.0 &&
5363 defined $stat &&
5364 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5365 my $min = $1;
5366 my $max = $7;
5367 if ($min eq $max) {
5368 WARN("USLEEP_RANGE",
5369 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5370 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5371 $min > $max) {
5372 WARN("USLEEP_RANGE",
5373 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5374 }
5375 }
5376
Joe Perches823b7942013-11-12 15:10:15 -08005377# check for naked sscanf
5378 if ($^V && $^V ge 5.10.0 &&
5379 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005380 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005381 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5382 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5383 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5384 my $lc = $stat =~ tr@\n@@;
5385 $lc = $lc + $linenr;
5386 my $stat_real = raw_line($linenr, 0);
5387 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5388 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5389 }
5390 WARN("NAKED_SSCANF",
5391 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5392 }
5393
Joe Perchesafc819a2014-06-04 16:12:08 -07005394# check for simple sscanf that should be kstrto<foo>
5395 if ($^V && $^V ge 5.10.0 &&
5396 defined $stat &&
5397 $line =~ /\bsscanf\b/) {
5398 my $lc = $stat =~ tr@\n@@;
5399 $lc = $lc + $linenr;
5400 my $stat_real = raw_line($linenr, 0);
5401 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5402 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5403 }
5404 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5405 my $format = $6;
5406 my $count = $format =~ tr@%@%@;
5407 if ($count == 1 &&
5408 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5409 WARN("SSCANF_TO_KSTRTO",
5410 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5411 }
5412 }
5413 }
5414
Joe Perches70dc8a42013-09-11 14:23:58 -07005415# check for new externs in .h files.
5416 if ($realfile =~ /\.h$/ &&
5417 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005418 if (CHK("AVOID_EXTERNS",
5419 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005420 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005421 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005422 }
5423 }
5424
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005425# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005426 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005427 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005428 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005429 my $function_name = $1;
5430 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005431
5432 my $s = $stat;
5433 if (defined $cond) {
5434 substr($s, 0, length($cond), '');
5435 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005436 if ($s =~ /^\s*;/ &&
5437 $function_name ne 'uninitialized_var')
5438 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005439 WARN("AVOID_EXTERNS",
5440 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005441 }
5442
5443 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005444 WARN("FUNCTION_ARGUMENTS",
5445 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005446 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005447
5448 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5449 $stat =~ /^.\s*extern\s+/)
5450 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005451 WARN("AVOID_EXTERNS",
5452 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005453 }
5454
5455# checks for new __setup's
5456 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5457 my $name = $1;
5458
5459 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005460 CHK("UNDOCUMENTED_SETUP",
5461 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005462 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005463 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005464
5465# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005466 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005467 WARN("UNNECESSARY_CASTS",
5468 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005469 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005470
Joe Perchesa640d252013-07-03 15:05:21 -07005471# alloc style
5472# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5473 if ($^V && $^V ge 5.10.0 &&
5474 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5475 CHK("ALLOC_SIZEOF_STRUCT",
5476 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5477 }
5478
Joe Perches60a55362014-06-04 16:12:07 -07005479# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5480 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005481 $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 -07005482 my $oldfunc = $3;
5483 my $a1 = $4;
5484 my $a2 = $10;
5485 my $newfunc = "kmalloc_array";
5486 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005487 my $r1 = $a1;
5488 my $r2 = $a2;
5489 if ($a1 =~ /^sizeof\s*\S/) {
5490 $r1 = $a2;
5491 $r2 = $a1;
5492 }
5493 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5494 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005495 if (WARN("ALLOC_WITH_MULTIPLY",
5496 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005498 $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 -07005499
5500 }
5501 }
5502 }
5503
Joe Perches972fdea2013-04-29 16:18:12 -07005504# check for krealloc arg reuse
5505 if ($^V && $^V ge 5.10.0 &&
5506 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5507 WARN("KREALLOC_ARG_REUSE",
5508 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5509 }
5510
Joe Perches5ce59ae2013-02-21 16:44:18 -08005511# check for alloc argument mismatch
5512 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5513 WARN("ALLOC_ARRAY_ARGS",
5514 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5515 }
5516
Joe Perchescaf2a542011-01-12 16:59:56 -08005517# check for multiple semicolons
5518 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005519 if (WARN("ONE_SEMICOLON",
5520 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5521 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005522 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005523 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005524 }
5525
Joe Perches0ab90192014-12-10 15:51:57 -08005526# check for #defines like: 1 << <digit> that could be BIT(digit)
5527 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5528 my $ull = "";
5529 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5530 if (CHK("BIT_MACRO",
5531 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5532 $fix) {
5533 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5534 }
5535 }
5536
Joe Perchese81f2392014-08-06 16:11:25 -07005537# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005538 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5539 my $has_break = 0;
5540 my $has_statement = 0;
5541 my $count = 0;
5542 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005543 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005544 $prevline--;
5545 my $rline = $rawlines[$prevline - 1];
5546 my $fline = $lines[$prevline - 1];
5547 last if ($fline =~ /^\@\@/);
5548 next if ($fline =~ /^\-/);
5549 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5550 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5551 next if ($fline =~ /^.[\s$;]*$/);
5552 $has_statement = 1;
5553 $count++;
5554 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5555 }
5556 if (!$has_break && $has_statement) {
5557 WARN("MISSING_BREAK",
5558 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5559 }
5560 }
5561
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005562# check for switch/default statements without a break;
5563 if ($^V && $^V ge 5.10.0 &&
5564 defined $stat &&
5565 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5566 my $ctx = '';
5567 my $herectx = $here . "\n";
5568 my $cnt = statement_rawlines($stat);
5569 for (my $n = 0; $n < $cnt; $n++) {
5570 $herectx .= raw_line($linenr, $n) . "\n";
5571 }
5572 WARN("DEFAULT_NO_BREAK",
5573 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005574 }
5575
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005576# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005577 if ($line =~ /\b__FUNCTION__\b/) {
5578 if (WARN("USE_FUNC",
5579 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5580 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005581 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005582 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005583 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005584
Joe Perches62ec8182015-02-13 14:38:18 -08005585# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5586 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5587 ERROR("DATE_TIME",
5588 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5589 }
5590
Joe Perches2c924882012-03-23 15:02:20 -07005591# check for use of yield()
5592 if ($line =~ /\byield\s*\(\s*\)/) {
5593 WARN("YIELD",
5594 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5595 }
5596
Joe Perches179f8f42013-07-03 15:05:30 -07005597# check for comparisons against true and false
5598 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5599 my $lead = $1;
5600 my $arg = $2;
5601 my $test = $3;
5602 my $otype = $4;
5603 my $trail = $5;
5604 my $op = "!";
5605
5606 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5607
5608 my $type = lc($otype);
5609 if ($type =~ /^(?:true|false)$/) {
5610 if (("$test" eq "==" && "$type" eq "true") ||
5611 ("$test" eq "!=" && "$type" eq "false")) {
5612 $op = "";
5613 }
5614
5615 CHK("BOOL_COMPARISON",
5616 "Using comparison to $otype is error prone\n" . $herecurr);
5617
5618## maybe suggesting a correct construct would better
5619## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5620
5621 }
5622 }
5623
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005624# check for semaphores initialized locked
5625 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005626 WARN("CONSIDER_COMPLETION",
5627 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005628 }
Joe Perches6712d852012-03-23 15:02:20 -07005629
Joe Perches67d0a072011-10-31 17:13:10 -07005630# recommend kstrto* over simple_strto* and strict_strto*
5631 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005632 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005633 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005634 }
Joe Perches6712d852012-03-23 15:02:20 -07005635
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005636# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005637 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005638 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005639 "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 -07005640 }
Joe Perches6712d852012-03-23 15:02:20 -07005641
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005642# check for various structs that are normally const (ops, kgdb, device_tree)
5643 my $const_structs = qr{
5644 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005645 address_space_operations|
5646 backlight_ops|
5647 block_device_operations|
5648 dentry_operations|
5649 dev_pm_ops|
5650 dma_map_ops|
5651 extent_io_ops|
5652 file_lock_operations|
5653 file_operations|
5654 hv_ops|
5655 ide_dma_ops|
5656 intel_dvo_dev_ops|
5657 item_operations|
5658 iwl_ops|
5659 kgdb_arch|
5660 kgdb_io|
5661 kset_uevent_ops|
5662 lock_manager_operations|
5663 microcode_ops|
5664 mtrr_ops|
5665 neigh_ops|
5666 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005667 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005668 pci_raw_ops|
5669 pipe_buf_operations|
5670 platform_hibernation_ops|
5671 platform_suspend_ops|
5672 proto_ops|
5673 rpc_pipe_ops|
5674 seq_operations|
5675 snd_ac97_build_ops|
5676 soc_pcmcia_socket_ops|
5677 stacktrace_ops|
5678 sysfs_ops|
5679 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005680 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005681 usb_mon_operations|
5682 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005683 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005684 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005685 WARN("CONST_STRUCT",
5686 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005687 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005688 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005689
5690# use of NR_CPUS is usually wrong
5691# ignore definitions of NR_CPUS and usage to define arrays as likely right
5692 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005693 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5694 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005695 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5696 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5697 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005698 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005699 WARN("NR_CPUS",
5700 "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 -07005701 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005702
Joe Perches52ea8502013-11-12 15:10:09 -08005703# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5704 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5705 ERROR("DEFINE_ARCH_HAS",
5706 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5707 }
5708
Joe Perchesacd93622015-02-13 14:38:38 -08005709# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5710 if ($^V && $^V ge 5.10.0 &&
5711 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5712 WARN("LIKELY_MISUSE",
5713 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5714 }
5715
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005716# whine mightly about in_atomic
5717 if ($line =~ /\bin_atomic\s*\(/) {
5718 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005719 ERROR("IN_ATOMIC",
5720 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005721 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005722 WARN("IN_ATOMIC",
5723 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005724 }
5725 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005726
5727# check for lockdep_set_novalidate_class
5728 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5729 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5730 if ($realfile !~ m@^kernel/lockdep@ &&
5731 $realfile !~ m@^include/linux/lockdep@ &&
5732 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005733 ERROR("LOCKDEP",
5734 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005735 }
5736 }
Dave Jones88f88312011-01-12 16:59:59 -08005737
Joe Perchesb392c642015-04-16 12:44:16 -07005738 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5739 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005740 WARN("EXPORTED_WORLD_WRITABLE",
5741 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005742 }
Joe Perches24358802014-04-03 14:49:13 -07005743
Joe Perches515a2352014-04-03 14:49:24 -07005744# Mode permission misuses where it seems decimal should be octal
5745# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5746 if ($^V && $^V ge 5.10.0 &&
5747 $line =~ /$mode_perms_search/) {
5748 foreach my $entry (@mode_permission_funcs) {
5749 my $func = $entry->[0];
5750 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005751
Joe Perches515a2352014-04-03 14:49:24 -07005752 my $skip_args = "";
5753 if ($arg_pos > 1) {
5754 $arg_pos--;
5755 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5756 }
5757 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5758 if ($line =~ /$test/) {
5759 my $val = $1;
5760 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005761
Joe Perches515a2352014-04-03 14:49:24 -07005762 if ($val !~ /^0$/ &&
5763 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5764 length($val) ne 4)) {
5765 ERROR("NON_OCTAL_PERMISSIONS",
5766 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005767 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5768 ERROR("EXPORTED_WORLD_WRITABLE",
5769 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07005770 }
Joe Perches24358802014-04-03 14:49:13 -07005771 }
5772 }
5773 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07005774
5775# validate content of MODULE_LICENSE against list from include/linux/module.h
5776 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
5777 my $extracted_string = get_quoted_string($line, $rawline);
5778 my $valid_licenses = qr{
5779 GPL|
5780 GPL\ v2|
5781 GPL\ and\ additional\ rights|
5782 Dual\ BSD/GPL|
5783 Dual\ MIT/GPL|
5784 Dual\ MPL/GPL|
5785 Proprietary
5786 }x;
5787 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
5788 WARN("MODULE_LICENSE",
5789 "unknown module license " . $extracted_string . "\n" . $herecurr);
5790 }
5791 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005792 }
5793
5794 # If we have no input at all, then there is nothing to report on
5795 # so just keep quiet.
5796 if ($#rawlines == -1) {
5797 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005798 }
5799
Andy Whitcroft8905a672007-11-28 16:21:06 -08005800 # In mailback mode only produce a report in the negative, for
5801 # things that appear to be patches.
5802 if ($mailback && ($clean == 1 || !$is_patch)) {
5803 exit(0);
5804 }
5805
5806 # This is not a patch, and we are are in 'no-patch' mode so
5807 # just keep quiet.
5808 if (!$chk_patch && !$is_patch) {
5809 exit(0);
5810 }
5811
Joe Perches06330fc2015-06-25 15:03:11 -07005812 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005813 ERROR("NOT_UNIFIED_DIFF",
5814 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005815 }
Joe Perches34d88152015-06-25 15:03:05 -07005816 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005817 ERROR("MISSING_SIGN_OFF",
5818 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005819 }
5820
Andy Whitcroft8905a672007-11-28 16:21:06 -08005821 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005822 if ($summary && !($clean == 1 && $quiet == 1)) {
5823 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005824 print "total: $cnt_error errors, $cnt_warn warnings, " .
5825 (($check)? "$cnt_chk checks, " : "") .
5826 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005827 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005828
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005829 if ($quiet == 0) {
5830 # If there were whitespace errors which cleanpatch can fix
5831 # then suggest that.
5832 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07005833 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07005834 print << "EOM"
5835
5836NOTE: Whitespace errors detected.
5837 You may wish to use scripts/cleanpatch or scripts/cleanfile
5838EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005839 }
5840 }
5841
Joe Perchesd752fcc2014-08-06 16:11:05 -07005842 if ($clean == 0 && $fix &&
5843 ("@rawlines" ne "@fixed" ||
5844 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005845 my $newfile = $filename;
5846 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005847 my $linecount = 0;
5848 my $f;
5849
Joe Perchesd752fcc2014-08-06 16:11:05 -07005850 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5851
Joe Perches3705ce52013-07-03 15:05:31 -07005852 open($f, '>', $newfile)
5853 or die "$P: Can't open $newfile for write\n";
5854 foreach my $fixed_line (@fixed) {
5855 $linecount++;
5856 if ($file) {
5857 if ($linecount > 3) {
5858 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005859 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005860 }
5861 } else {
5862 print $f $fixed_line . "\n";
5863 }
5864 }
5865 close($f);
5866
5867 if (!$quiet) {
5868 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07005869
Joe Perches3705ce52013-07-03 15:05:31 -07005870Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5871
5872Do _NOT_ trust the results written to this file.
5873Do _NOT_ submit these changes without inspecting them for correctness.
5874
5875This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5876No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07005877EOM
5878 }
5879 }
5880
Joe Perchesd8469f12015-06-25 15:03:00 -07005881 if ($quiet == 0) {
5882 print "\n";
5883 if ($clean == 1) {
5884 print "$vname has no obvious style problems and is ready for submission.\n";
5885 } else {
5886 print "$vname has style problems, please review.\n";
5887 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005888 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005889 return $clean;
5890}