blob: 421bbb47844f2285acdef392053ffd403328f312 [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 Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy 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';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070012
13my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080014my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070015
Joe Perches000d1cc12011-07-25 17:13:25 -070016my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070017
18use Getopt::Long qw(:config no_auto_abbrev);
19
20my $quiet = 0;
21my $tree = 1;
22my $chk_signoff = 1;
23my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070024my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080026my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070027my $file = 0;
28my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070029my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080030my $summary = 1;
31my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080032my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070033my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070034my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080035my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080037my %debug;
Joe Perches34456862013-07-03 15:05:34 -070038my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070039my %use_type = ();
40my @use = ();
41my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070042my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070043my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070044my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080045my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070046my $ignore_perl_version = 0;
47my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070048my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070049my $spelling_file = "$D/spelling.txt";
Hannes Eder77f5b102009-09-21 17:04:37 -070050
51sub help {
52 my ($exitcode) = @_;
53
54 print << "EOM";
55Usage: $P [OPTION]... [FILE]...
56Version: $V
57
58Options:
59 -q, --quiet quiet
60 --no-tree run without a kernel tree
61 --no-signoff do not check for 'Signed-off-by' line
62 --patch treat FILE as patchfile (default)
63 --emacs emacs compile window format
64 --terse one line per report
65 -f, --file treat FILE as regular source file
66 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070067 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070068 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080069 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070070 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070071 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070072 --root=PATH PATH to the kernel tree root
73 --no-summary suppress the per-file summary
74 --mailback only produce a report in case of warnings/errors
75 --summary-file include the filename in summary
76 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
77 'values', 'possible', 'type', and 'attr' (default
78 is all off)
79 --test-only=WORD report only warnings/errors containing WORD
80 literally
Joe Perches3705ce52013-07-03 15:05:31 -070081 --fix EXPERIMENTAL - may create horrible results
82 If correctable single-line errors exist, create
83 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
84 with potential errors corrected to the preferred
85 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080086 --fix-inplace EXPERIMENTAL - may create horrible results
87 Is the same as --fix, but overwrites the input
88 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070089 --ignore-perl-version override checking of perl version. expect
90 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070091 -h, --help, --version display this help and exit
92
93When FILE is - read standard input.
94EOM
95
96 exit($exitcode);
97}
98
Joe Perches000d1cc12011-07-25 17:13:25 -070099my $conf = which_conf($configuration_file);
100if (-f $conf) {
101 my @conf_args;
102 open(my $conffile, '<', "$conf")
103 or warn "$P: Can't find a readable $configuration_file file $!\n";
104
105 while (<$conffile>) {
106 my $line = $_;
107
108 $line =~ s/\s*\n?$//g;
109 $line =~ s/^\s*//g;
110 $line =~ s/\s+/ /g;
111
112 next if ($line =~ m/^\s*#/);
113 next if ($line =~ m/^\s*$/);
114
115 my @words = split(" ", $line);
116 foreach my $word (@words) {
117 last if ($word =~ m/^#/);
118 push (@conf_args, $word);
119 }
120 }
121 close($conffile);
122 unshift(@ARGV, @conf_args) if @conf_args;
123}
124
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700125GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700126 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700127 'tree!' => \$tree,
128 'signoff!' => \$chk_signoff,
129 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700130 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800131 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700132 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133 'subjective!' => \$check,
134 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700135 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700136 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700137 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800138 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700139 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700140 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800141 'summary!' => \$summary,
142 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800143 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700144 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800145 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700146 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800147 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700148 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700149 'h|help' => \$help,
150 'version' => \$help
151) or help(1);
152
153help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700154
Joe Perches9624b8d2014-01-23 15:54:44 -0800155$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700156$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800157
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700158my $exit = 0;
159
Dave Hansend62a2012013-09-11 14:23:56 -0700160if ($^V && $^V lt $minimum_perl_version) {
161 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
162 if (!$ignore_perl_version) {
163 exit(1);
164 }
165}
166
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700167if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700168 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700169 exit(1);
170}
171
Joe Perches91bfe482013-09-11 14:23:59 -0700172sub hash_save_array_words {
173 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700174
Joe Perches91bfe482013-09-11 14:23:59 -0700175 my @array = split(/,/, join(',', @$arrayRef));
176 foreach my $word (@array) {
177 $word =~ s/\s*\n?$//g;
178 $word =~ s/^\s*//g;
179 $word =~ s/\s+/ /g;
180 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700181
Joe Perches91bfe482013-09-11 14:23:59 -0700182 next if ($word =~ m/^\s*#/);
183 next if ($word =~ m/^\s*$/);
184
185 $hashRef->{$word}++;
186 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700187}
188
Joe Perches91bfe482013-09-11 14:23:59 -0700189sub hash_show_words {
190 my ($hashRef, $prefix) = @_;
191
Joe Perches58cb3cf2013-09-11 14:24:04 -0700192 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700193 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700194 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700195 print " $word";
196 }
197 print "\n\n";
198 }
199}
200
201hash_save_array_words(\%ignore_type, \@ignore);
202hash_save_array_words(\%use_type, \@use);
203
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800204my $dbg_values = 0;
205my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700206my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700207my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800208for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800209 ## no critic
210 eval "\${dbg_$key} = '$debug{$key}';";
211 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800212}
213
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700214my $rpt_cleaners = 0;
215
Andy Whitcroft8905a672007-11-28 16:21:06 -0800216if ($terse) {
217 $emacs = 1;
218 $quiet++;
219}
220
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700221if ($tree) {
222 if (defined $root) {
223 if (!top_of_kernel_tree($root)) {
224 die "$P: $root: --root does not point at a valid tree\n";
225 }
226 } else {
227 if (top_of_kernel_tree('.')) {
228 $root = '.';
229 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
230 top_of_kernel_tree($1)) {
231 $root = $1;
232 }
233 }
234
235 if (!defined $root) {
236 print "Must be run from the top-level dir. of a kernel tree\n";
237 exit(2);
238 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700239}
240
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241my $emitted_corrupt = 0;
242
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700243our $Ident = qr{
244 [A-Za-z_][A-Za-z\d_]*
245 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
246 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700247our $Storage = qr{extern|static|asmlinkage};
248our $Sparse = qr{
249 __user|
250 __kernel|
251 __force|
252 __iomem|
253 __must_check|
254 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800255 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700256 __ref|
257 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700258 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800259our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
260our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
261our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
262our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
263our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700264
Wolfram Sang52131292010-03-05 13:43:51 -0800265# Notes to $Attribute:
266# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700267our $Attribute = qr{
268 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700269 __percpu|
270 __nocast|
271 __safe|
272 __bitwise__|
273 __packed__|
274 __packed2__|
275 __naked|
276 __maybe_unused|
277 __always_unused|
278 __noreturn|
279 __used|
280 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800281 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700282 __noclone|
283 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 __read_mostly|
285 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700286 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700287 ____cacheline_aligned|
288 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800289 ____cacheline_internodealigned_in_smp|
290 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700291 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700292our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700293our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700294our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
295our $Lval = qr{$Ident(?:$Member)*};
296
Joe Perches95e2c602013-07-03 15:05:20 -0700297our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
298our $Binary = qr{(?i)0b[01]+$Int_type?};
299our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
300our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700301our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800302our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800303our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
304our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
305our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800306our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700307our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800308our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700309our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700310our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700311our $Operators = qr{
312 <=|>=|==|!=|
313 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700314 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700315 }x;
316
Joe Perches91cb5192014-04-03 14:49:32 -0700317our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
318
Andy Whitcroft8905a672007-11-28 16:21:06 -0800319our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700320our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700321our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800322our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700323our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800324our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700325our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800326
Joe Perches15662b32011-10-31 17:13:12 -0700327our $NON_ASCII_UTF8 = qr{
328 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700329 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
330 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
331 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
332 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
333 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
334 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
335}x;
336
Joe Perches15662b32011-10-31 17:13:12 -0700337our $UTF8 = qr{
338 [\x09\x0A\x0D\x20-\x7E] # ASCII
339 | $NON_ASCII_UTF8
340}x;
341
Joe Perches021158b2015-02-13 14:38:43 -0800342our $typeOtherOSTypedefs = qr{(?x:
343 u_(?:char|short|int|long) | # bsd
344 u(?:nchar|short|int|long) # sysv
345)};
346
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700347our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700348 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700349 atomic_t
350)};
351
Joe Perches691e6692010-03-05 13:43:51 -0800352our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700353 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700354 (?:[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 -0700355 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700356 panic|
Joe Perches06668722013-11-12 15:10:07 -0800357 MODULE_[A-Z_]+|
358 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800359)};
360
Joe Perches20112472011-07-25 17:13:23 -0700361our $signature_tags = qr{(?xi:
362 Signed-off-by:|
363 Acked-by:|
364 Tested-by:|
365 Reviewed-by:|
366 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700367 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700368 To:|
369 Cc:
370)};
371
Joe Perches18130872014-08-06 16:11:22 -0700372our @typeListMisordered = (
373 qr{char\s+(?:un)?signed},
374 qr{int\s+(?:(?:un)?signed\s+)?short\s},
375 qr{int\s+short(?:\s+(?:un)?signed)},
376 qr{short\s+int(?:\s+(?:un)?signed)},
377 qr{(?:un)?signed\s+int\s+short},
378 qr{short\s+(?:un)?signed},
379 qr{long\s+int\s+(?:un)?signed},
380 qr{int\s+long\s+(?:un)?signed},
381 qr{long\s+(?:un)?signed\s+int},
382 qr{int\s+(?:un)?signed\s+long},
383 qr{int\s+(?:un)?signed},
384 qr{int\s+long\s+long\s+(?:un)?signed},
385 qr{long\s+long\s+int\s+(?:un)?signed},
386 qr{long\s+long\s+(?:un)?signed\s+int},
387 qr{long\s+long\s+(?:un)?signed},
388 qr{long\s+(?:un)?signed},
389);
390
Andy Whitcroft8905a672007-11-28 16:21:06 -0800391our @typeList = (
392 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700393 qr{(?:(?:un)?signed\s+)?char},
394 qr{(?:(?:un)?signed\s+)?short\s+int},
395 qr{(?:(?:un)?signed\s+)?short},
396 qr{(?:(?:un)?signed\s+)?int},
397 qr{(?:(?:un)?signed\s+)?long\s+int},
398 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
399 qr{(?:(?:un)?signed\s+)?long\s+long},
400 qr{(?:(?:un)?signed\s+)?long},
401 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800402 qr{float},
403 qr{double},
404 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405 qr{struct\s+$Ident},
406 qr{union\s+$Ident},
407 qr{enum\s+$Ident},
408 qr{${Ident}_t},
409 qr{${Ident}_handler},
410 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700411 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800412);
Joe Perches8716de32013-09-11 14:24:05 -0700413our @typeListWithAttr = (
414 @typeList,
415 qr{struct\s+$InitAttribute\s+$Ident},
416 qr{union\s+$InitAttribute\s+$Ident},
417);
418
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700419our @modifierList = (
420 qr{fastcall},
421);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422
Joe Perches24358802014-04-03 14:49:13 -0700423our @mode_permission_funcs = (
424 ["module_param", 3],
425 ["module_param_(?:array|named|string)", 4],
426 ["module_param_array_named", 5],
427 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
428 ["proc_create(?:_data|)", 2],
429 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
430);
431
Joe Perches515a2352014-04-03 14:49:24 -0700432#Create a search pattern for all these functions to speed up a loop below
433our $mode_perms_search = "";
434foreach my $entry (@mode_permission_funcs) {
435 $mode_perms_search .= '|' if ($mode_perms_search ne "");
436 $mode_perms_search .= $entry->[0];
437}
438
Wolfram Sang7840a942010-08-09 17:20:57 -0700439our $allowed_asm_includes = qr{(?x:
440 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700441 memory|
442 time|
443 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700444)};
445# memory.h: ARM has a custom one
446
Kees Cook66b47b42014-10-13 15:51:57 -0700447# Load common spelling mistakes and build regular expression list.
448my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700449my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700450
Joe Perches36061e32014-12-10 15:51:43 -0800451if (open(my $spelling, '<', $spelling_file)) {
452 my @spelling_list;
453 while (<$spelling>) {
454 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700455
Joe Perches36061e32014-12-10 15:51:43 -0800456 $line =~ s/\s*\n?$//g;
457 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700458
Joe Perches36061e32014-12-10 15:51:43 -0800459 next if ($line =~ m/^\s*#/);
460 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700461
Joe Perches36061e32014-12-10 15:51:43 -0800462 my ($suspect, $fix) = split(/\|\|/, $line);
463
464 push(@spelling_list, $suspect);
465 $spelling_fix{$suspect} = $fix;
466 }
467 close($spelling);
468 $misspellings = join("|", @spelling_list);
469} else {
470 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700471}
Kees Cook66b47b42014-10-13 15:51:57 -0700472
Andy Whitcroft8905a672007-11-28 16:21:06 -0800473sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700474 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
475 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700476 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700477 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700478 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800479 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700480 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800481 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800482 (?:typeof|__typeof__)\s*\([^\)]*\)|
Joe Perches021158b2015-02-13 14:38:43 -0800483 (?:$typeOtherOSTypedefs\b)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700484 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700485 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800486 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700487 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800488 }x;
Joe Perches18130872014-08-06 16:11:22 -0700489 $NonptrTypeMisordered = qr{
490 (?:$Modifier\s+|const\s+)*
491 (?:
492 (?:${Misordered}\b)
493 )
494 (?:\s+$Modifier|\s+const)*
495 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700496 $NonptrTypeWithAttr = qr{
497 (?:$Modifier\s+|const\s+)*
498 (?:
499 (?:typeof|__typeof__)\s*\([^\)]*\)|
500 (?:$typeTypedefs\b)|
Joe Perches021158b2015-02-13 14:38:43 -0800501 (?:$typeOtherOSTypedefs\b)|
Joe Perches8716de32013-09-11 14:24:05 -0700502 (?:${allWithAttr}\b)
503 )
504 (?:\s+$Modifier|\s+const)*
505 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800506 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700507 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700508 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700509 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800510 }x;
Joe Perches18130872014-08-06 16:11:22 -0700511 $TypeMisordered = qr{
512 $NonptrTypeMisordered
513 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
514 (?:\s+$Inline|\s+$Modifier)*
515 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700516 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700517 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800518}
519build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700520
Joe Perches7d2367a2011-07-25 17:13:22 -0700521our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700522
523# Using $balanced_parens, $LvalOrFunc, or $FuncArg
524# requires at least perl version v5.10.0
525# Any use must be runtime checked with $^V
526
527our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700528our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800529our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700530
Joe Perchesf8422302014-08-06 16:11:31 -0700531our $declaration_macros = qr{(?x:
532 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
533 (?:$Storage\s+)?LIST_HEAD\s*\(|
534 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
535)};
536
Joe Perches7d2367a2011-07-25 17:13:22 -0700537sub deparenthesize {
538 my ($string) = @_;
539 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700540
541 while ($string =~ /^\s*\(.*\)\s*$/) {
542 $string =~ s@^\s*\(\s*@@;
543 $string =~ s@\s*\)\s*$@@;
544 }
545
Joe Perches7d2367a2011-07-25 17:13:22 -0700546 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700547
Joe Perches7d2367a2011-07-25 17:13:22 -0700548 return $string;
549}
550
Joe Perches34456862013-07-03 15:05:34 -0700551sub seed_camelcase_file {
552 my ($file) = @_;
553
554 return if (!(-f $file));
555
556 local $/;
557
558 open(my $include_file, '<', "$file")
559 or warn "$P: Can't read '$file' $!\n";
560 my $text = <$include_file>;
561 close($include_file);
562
563 my @lines = split('\n', $text);
564
565 foreach my $line (@lines) {
566 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
567 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
568 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800569 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
570 $camelcase{$1} = 1;
571 } 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 -0700572 $camelcase{$1} = 1;
573 }
574 }
575}
576
577my $camelcase_seeded = 0;
578sub seed_camelcase_includes {
579 return if ($camelcase_seeded);
580
581 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700582 my $camelcase_cache = "";
583 my @include_files = ();
584
585 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700586
Richard Genoud3645e322014-02-10 14:25:32 -0800587 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700588 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
589 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700590 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700591 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700592 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700593 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700594 @include_files = split('\n', $files);
595 foreach my $file (@include_files) {
596 my $date = POSIX::strftime("%Y%m%d%H%M",
597 localtime((stat $file)[9]));
598 $last_mod_date = $date if ($last_mod_date < $date);
599 }
600 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700601 }
Joe Perchesc707a812013-07-08 16:00:43 -0700602
603 if ($camelcase_cache ne "" && -f $camelcase_cache) {
604 open(my $camelcase_file, '<', "$camelcase_cache")
605 or warn "$P: Can't read '$camelcase_cache' $!\n";
606 while (<$camelcase_file>) {
607 chomp;
608 $camelcase{$_} = 1;
609 }
610 close($camelcase_file);
611
612 return;
613 }
614
Richard Genoud3645e322014-02-10 14:25:32 -0800615 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700616 $files = `git ls-files "include/*.h"`;
617 @include_files = split('\n', $files);
618 }
619
Joe Perches34456862013-07-03 15:05:34 -0700620 foreach my $file (@include_files) {
621 seed_camelcase_file($file);
622 }
Joe Perches351b2a12013-07-03 15:05:36 -0700623
Joe Perchesc707a812013-07-08 16:00:43 -0700624 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700625 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700626 open(my $camelcase_file, '>', "$camelcase_cache")
627 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700628 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
629 print $camelcase_file ("$_\n");
630 }
631 close($camelcase_file);
632 }
Joe Perches34456862013-07-03 15:05:34 -0700633}
634
Joe Perchesd311cd42014-08-06 16:10:57 -0700635sub git_commit_info {
636 my ($commit, $id, $desc) = @_;
637
638 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
639
640 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
641 $output =~ s/^\s*//gm;
642 my @lines = split("\n", $output);
643
Joe Perches0d7835f2015-02-13 14:38:35 -0800644 return ($id, $desc) if ($#lines < 0);
645
Joe Perchesd311cd42014-08-06 16:10:57 -0700646 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
647# Maybe one day convert this block of bash into something that returns
648# all matching commit ids, but it's very slow...
649#
650# echo "checking commits $1..."
651# git rev-list --remotes | grep -i "^$1" |
652# while read line ; do
653# git log --format='%H %s' -1 $line |
654# echo "commit $(cut -c 1-12,41-)"
655# done
656 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
657 } else {
658 $id = substr($lines[0], 0, 12);
659 $desc = substr($lines[0], 41);
660 }
661
662 return ($id, $desc);
663}
664
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700665$chk_signoff = 0 if ($file);
666
Andy Whitcroft00df3442007-06-08 13:47:06 -0700667my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800668my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700669my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700670my @fixed_inserted = ();
671my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700672my $fixlinenr = -1;
673
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800674my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700675for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800676 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700677 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800678 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700679 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800680 } elsif ($filename eq '-') {
681 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700682 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800683 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700684 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700685 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800686 if ($filename eq '-') {
687 $vname = 'Your patch';
688 } else {
689 $vname = $filename;
690 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800691 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700692 chomp;
693 push(@rawlines, $_);
694 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800695 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800696 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700697 $exit = 1;
698 }
699 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800700 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700701 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700702 @fixed_inserted = ();
703 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700704 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700705}
706
707exit($exit);
708
709sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700710 my ($root) = @_;
711
712 my @tree_check = (
713 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
714 "README", "Documentation", "arch", "include", "drivers",
715 "fs", "init", "ipc", "kernel", "lib", "scripts",
716 );
717
718 foreach my $check (@tree_check) {
719 if (! -e $root . '/' . $check) {
720 return 0;
721 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700722 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700723 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700724}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700725
Joe Perches20112472011-07-25 17:13:23 -0700726sub parse_email {
727 my ($formatted_email) = @_;
728
729 my $name = "";
730 my $address = "";
731 my $comment = "";
732
733 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
734 $name = $1;
735 $address = $2;
736 $comment = $3 if defined $3;
737 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
738 $address = $1;
739 $comment = $2 if defined $2;
740 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
741 $address = $1;
742 $comment = $2 if defined $2;
743 $formatted_email =~ s/$address.*$//;
744 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700745 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700746 $name =~ s/^\"|\"$//g;
747 # If there's a name left after stripping spaces and
748 # leading quotes, and the address doesn't have both
749 # leading and trailing angle brackets, the address
750 # is invalid. ie:
751 # "joe smith joe@smith.com" bad
752 # "joe smith <joe@smith.com" bad
753 if ($name ne "" && $address !~ /^<[^>]+>$/) {
754 $name = "";
755 $address = "";
756 $comment = "";
757 }
758 }
759
Joe Perches3705ce52013-07-03 15:05:31 -0700760 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700761 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700762 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700763 $address =~ s/^\<|\>$//g;
764
765 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
766 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
767 $name = "\"$name\"";
768 }
769
770 return ($name, $address, $comment);
771}
772
773sub format_email {
774 my ($name, $address) = @_;
775
776 my $formatted_email;
777
Joe Perches3705ce52013-07-03 15:05:31 -0700778 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700779 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700780 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700781
782 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
783 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
784 $name = "\"$name\"";
785 }
786
787 if ("$name" eq "") {
788 $formatted_email = "$address";
789 } else {
790 $formatted_email = "$name <$address>";
791 }
792
793 return $formatted_email;
794}
795
Joe Perchesd311cd42014-08-06 16:10:57 -0700796sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700797 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700798
Joe Perchesbd474ca2014-08-06 16:11:10 -0700799 foreach my $path (split(/:/, $ENV{PATH})) {
800 if (-e "$path/$bin") {
801 return "$path/$bin";
802 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700803 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700804
Joe Perchesbd474ca2014-08-06 16:11:10 -0700805 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700806}
807
Joe Perches000d1cc12011-07-25 17:13:25 -0700808sub which_conf {
809 my ($conf) = @_;
810
811 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
812 if (-e "$path/$conf") {
813 return "$path/$conf";
814 }
815 }
816
817 return "";
818}
819
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700820sub expand_tabs {
821 my ($str) = @_;
822
823 my $res = '';
824 my $n = 0;
825 for my $c (split(//, $str)) {
826 if ($c eq "\t") {
827 $res .= ' ';
828 $n++;
829 for (; ($n % 8) != 0; $n++) {
830 $res .= ' ';
831 }
832 next;
833 }
834 $res .= $c;
835 $n++;
836 }
837
838 return $res;
839}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700841 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700842 return $res;
843}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700844
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700845sub line_stats {
846 my ($line) = @_;
847
848 # Drop the diff line leader and expand tabs
849 $line =~ s/^.//;
850 $line = expand_tabs($line);
851
852 # Pick the indent from the front of the line.
853 my ($white) = ($line =~ /^(\s*)/);
854
855 return (length($line), length($white));
856}
857
Andy Whitcroft773647a2008-03-28 14:15:58 -0700858my $sanitise_quote = '';
859
860sub sanitise_line_reset {
861 my ($in_comment) = @_;
862
863 if ($in_comment) {
864 $sanitise_quote = '*/';
865 } else {
866 $sanitise_quote = '';
867 }
868}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700869sub sanitise_line {
870 my ($line) = @_;
871
872 my $res = '';
873 my $l = '';
874
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800875 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700876 my $off = 0;
877 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700878
Andy Whitcroft773647a2008-03-28 14:15:58 -0700879 # Always copy over the diff marker.
880 $res = substr($line, 0, 1);
881
882 for ($off = 1; $off < length($line); $off++) {
883 $c = substr($line, $off, 1);
884
885 # Comments we are wacking completly including the begin
886 # and end, all to $;.
887 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
888 $sanitise_quote = '*/';
889
890 substr($res, $off, 2, "$;$;");
891 $off++;
892 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800893 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700894 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700895 $sanitise_quote = '';
896 substr($res, $off, 2, "$;$;");
897 $off++;
898 next;
899 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700900 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
901 $sanitise_quote = '//';
902
903 substr($res, $off, 2, $sanitise_quote);
904 $off++;
905 next;
906 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700907
908 # A \ in a string means ignore the next character.
909 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
910 $c eq "\\") {
911 substr($res, $off, 2, 'XX');
912 $off++;
913 next;
914 }
915 # Regular quotes.
916 if ($c eq "'" || $c eq '"') {
917 if ($sanitise_quote eq '') {
918 $sanitise_quote = $c;
919
920 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700921 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700922 } elsif ($sanitise_quote eq $c) {
923 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700924 }
925 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700926
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800927 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700928 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
929 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700930 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
931 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700932 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
933 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700934 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700935 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700936 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800937 }
938
Daniel Walker113f04a2009-09-21 17:04:35 -0700939 if ($sanitise_quote eq '//') {
940 $sanitise_quote = '';
941 }
942
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800943 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700944 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800945 my $clean = 'X' x length($1);
946 $res =~ s@\<.*\>@<$clean>@;
947
948 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700949 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800950 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700951 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800952 }
953
Andy Whitcroft00df3442007-06-08 13:47:06 -0700954 return $res;
955}
956
Joe Perchesa6962d72013-04-29 16:18:13 -0700957sub get_quoted_string {
958 my ($line, $rawline) = @_;
959
Joe Perches5e4f6ba2014-12-10 15:52:05 -0800960 return "" if ($line !~ m/(\"[X\t]+\")/g);
Joe Perchesa6962d72013-04-29 16:18:13 -0700961 return substr($rawline, $-[0], $+[0] - $-[0]);
962}
963
Andy Whitcroft8905a672007-11-28 16:21:06 -0800964sub ctx_statement_block {
965 my ($linenr, $remain, $off) = @_;
966 my $line = $linenr - 1;
967 my $blk = '';
968 my $soff = $off;
969 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700970 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800971
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800972 my $loff = 0;
973
Andy Whitcroft8905a672007-11-28 16:21:06 -0800974 my $type = '';
975 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800976 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800977 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800978 my $c;
979 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800980
981 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800982 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800983 @stack = (['', 0]) if ($#stack == -1);
984
Andy Whitcroft773647a2008-03-28 14:15:58 -0700985 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800986 # If we are about to drop off the end, pull in more
987 # context.
988 if ($off >= $len) {
989 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700990 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800991 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800992 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800993 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800994 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800995 $len = length($blk);
996 $line++;
997 last;
998 }
999 # Bail if there is no further context.
1000 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001001 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001002 last;
1003 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001004 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1005 $level++;
1006 $type = '#';
1007 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001008 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001009 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001010 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001011 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001012
Andy Whitcroft773647a2008-03-28 14:15:58 -07001013 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001014
1015 # Handle nested #if/#else.
1016 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1017 push(@stack, [ $type, $level ]);
1018 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1019 ($type, $level) = @{$stack[$#stack - 1]};
1020 } elsif ($remainder =~ /^#\s*endif\b/) {
1021 ($type, $level) = @{pop(@stack)};
1022 }
1023
Andy Whitcroft8905a672007-11-28 16:21:06 -08001024 # Statement ends at the ';' or a close '}' at the
1025 # outermost level.
1026 if ($level == 0 && $c eq ';') {
1027 last;
1028 }
1029
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001030 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001031 if ($level == 0 && $coff_set == 0 &&
1032 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1033 $remainder =~ /^(else)(?:\s|{)/ &&
1034 $remainder !~ /^else\s+if\b/) {
1035 $coff = $off + length($1) - 1;
1036 $coff_set = 1;
1037 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1038 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001039 }
1040
Andy Whitcroft8905a672007-11-28 16:21:06 -08001041 if (($type eq '' || $type eq '(') && $c eq '(') {
1042 $level++;
1043 $type = '(';
1044 }
1045 if ($type eq '(' && $c eq ')') {
1046 $level--;
1047 $type = ($level != 0)? '(' : '';
1048
1049 if ($level == 0 && $coff < $soff) {
1050 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001051 $coff_set = 1;
1052 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001053 }
1054 }
1055 if (($type eq '' || $type eq '{') && $c eq '{') {
1056 $level++;
1057 $type = '{';
1058 }
1059 if ($type eq '{' && $c eq '}') {
1060 $level--;
1061 $type = ($level != 0)? '{' : '';
1062
1063 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001064 if (substr($blk, $off + 1, 1) eq ';') {
1065 $off++;
1066 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001067 last;
1068 }
1069 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001070 # Preprocessor commands end at the newline unless escaped.
1071 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1072 $level--;
1073 $type = '';
1074 $off++;
1075 last;
1076 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001077 $off++;
1078 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001079 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001080 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001081 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001082 $line++;
1083 $remain--;
1084 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001085
1086 my $statement = substr($blk, $soff, $off - $soff + 1);
1087 my $condition = substr($blk, $soff, $coff - $soff + 1);
1088
1089 #warn "STATEMENT<$statement>\n";
1090 #warn "CONDITION<$condition>\n";
1091
Andy Whitcroft773647a2008-03-28 14:15:58 -07001092 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001093
1094 return ($statement, $condition,
1095 $line, $remain + 1, $off - $loff + 1, $level);
1096}
1097
Andy Whitcroftcf655042008-03-04 14:28:20 -08001098sub statement_lines {
1099 my ($stmt) = @_;
1100
1101 # Strip the diff line prefixes and rip blank lines at start and end.
1102 $stmt =~ s/(^|\n)./$1/g;
1103 $stmt =~ s/^\s*//;
1104 $stmt =~ s/\s*$//;
1105
1106 my @stmt_lines = ($stmt =~ /\n/g);
1107
1108 return $#stmt_lines + 2;
1109}
1110
1111sub statement_rawlines {
1112 my ($stmt) = @_;
1113
1114 my @stmt_lines = ($stmt =~ /\n/g);
1115
1116 return $#stmt_lines + 2;
1117}
1118
1119sub statement_block_size {
1120 my ($stmt) = @_;
1121
1122 $stmt =~ s/(^|\n)./$1/g;
1123 $stmt =~ s/^\s*{//;
1124 $stmt =~ s/}\s*$//;
1125 $stmt =~ s/^\s*//;
1126 $stmt =~ s/\s*$//;
1127
1128 my @stmt_lines = ($stmt =~ /\n/g);
1129 my @stmt_statements = ($stmt =~ /;/g);
1130
1131 my $stmt_lines = $#stmt_lines + 2;
1132 my $stmt_statements = $#stmt_statements + 1;
1133
1134 if ($stmt_lines > $stmt_statements) {
1135 return $stmt_lines;
1136 } else {
1137 return $stmt_statements;
1138 }
1139}
1140
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001141sub ctx_statement_full {
1142 my ($linenr, $remain, $off) = @_;
1143 my ($statement, $condition, $level);
1144
1145 my (@chunks);
1146
Andy Whitcroftcf655042008-03-04 14:28:20 -08001147 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001148 ($statement, $condition, $linenr, $remain, $off, $level) =
1149 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001150 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001151 push(@chunks, [ $condition, $statement ]);
1152 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1153 return ($level, $linenr, @chunks);
1154 }
1155
1156 # Pull in the following conditional/block pairs and see if they
1157 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001158 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001159 ($statement, $condition, $linenr, $remain, $off, $level) =
1160 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001161 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001162 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001163 #print "C: push\n";
1164 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001165 }
1166
1167 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001168}
1169
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001170sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001171 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001172 my $line;
1173 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001174 my $blk = '';
1175 my @o;
1176 my @c;
1177 my @res = ();
1178
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001179 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001180 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001181 for ($line = $start; $remain > 0; $line++) {
1182 next if ($rawlines[$line] =~ /^-/);
1183 $remain--;
1184
1185 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001186
1187 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001188 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001189 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001190 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001191 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001192 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001193 $level = pop(@stack);
1194 }
1195
Andy Whitcroft01464f32010-10-26 14:23:19 -07001196 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001197 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1198 if ($off > 0) {
1199 $off--;
1200 next;
1201 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001202
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001203 if ($c eq $close && $level > 0) {
1204 $level--;
1205 last if ($level == 0);
1206 } elsif ($c eq $open) {
1207 $level++;
1208 }
1209 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001210
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001211 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001212 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001213 }
1214
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001215 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001216 }
1217
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001218 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001219}
1220sub ctx_block_outer {
1221 my ($linenr, $remain) = @_;
1222
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001223 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1224 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001225}
1226sub ctx_block {
1227 my ($linenr, $remain) = @_;
1228
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001229 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1230 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001231}
1232sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001233 my ($linenr, $remain, $off) = @_;
1234
1235 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1236 return @r;
1237}
1238sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001239 my ($linenr, $remain) = @_;
1240
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001241 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001242}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001243sub ctx_statement_level {
1244 my ($linenr, $remain, $off) = @_;
1245
1246 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1247}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001248
1249sub ctx_locate_comment {
1250 my ($first_line, $end_line) = @_;
1251
1252 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001253 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001254 return $current_comment if (defined $current_comment);
1255
1256 # Look through the context and try and figure out if there is a
1257 # comment.
1258 my $in_comment = 0;
1259 $current_comment = '';
1260 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001261 my $line = $rawlines[$linenr - 1];
1262 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001263 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1264 $in_comment = 1;
1265 }
1266 if ($line =~ m@/\*@) {
1267 $in_comment = 1;
1268 }
1269 if (!$in_comment && $current_comment ne '') {
1270 $current_comment = '';
1271 }
1272 $current_comment .= $line . "\n" if ($in_comment);
1273 if ($line =~ m@\*/@) {
1274 $in_comment = 0;
1275 }
1276 }
1277
1278 chomp($current_comment);
1279 return($current_comment);
1280}
1281sub ctx_has_comment {
1282 my ($first_line, $end_line) = @_;
1283 my $cmt = ctx_locate_comment($first_line, $end_line);
1284
Andy Whitcroft00df3442007-06-08 13:47:06 -07001285 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001286 ##print "CMMT: $cmt\n";
1287
1288 return ($cmt ne '');
1289}
1290
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001291sub raw_line {
1292 my ($linenr, $cnt) = @_;
1293
1294 my $offset = $linenr - 1;
1295 $cnt++;
1296
1297 my $line;
1298 while ($cnt) {
1299 $line = $rawlines[$offset++];
1300 next if (defined($line) && $line =~ /^-/);
1301 $cnt--;
1302 }
1303
1304 return $line;
1305}
1306
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001307sub cat_vet {
1308 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001309 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001310
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001311 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001312 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1313 $res .= $1;
1314 if ($2 ne '') {
1315 $coded = sprintf("^%c", unpack('C', $2) + 64);
1316 $res .= $coded;
1317 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001318 }
1319 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001320
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001321 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001322}
1323
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001324my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001325my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001326my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001327my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001328
1329sub annotate_reset {
1330 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001331 $av_pending = '_';
1332 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001333 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001334}
1335
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001336sub annotate_values {
1337 my ($stream, $type) = @_;
1338
1339 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001340 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001341 my $cur = $stream;
1342
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001343 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001344
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001345 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001346 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001347 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001348 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001349 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001350 print "WS($1)\n" if ($dbg_values > 1);
1351 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001352 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001353 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001354 }
1355
Florian Micklerc023e4732011-01-12 16:59:58 -08001356 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001357 print "CAST($1)\n" if ($dbg_values > 1);
1358 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001359 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001360
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001361 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001362 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001363 $type = 'T';
1364
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001365 } elsif ($cur =~ /^($Modifier)\s*/) {
1366 print "MODIFIER($1)\n" if ($dbg_values > 1);
1367 $type = 'T';
1368
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001369 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001370 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001371 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001372 push(@av_paren_type, $type);
1373 if ($2 ne '') {
1374 $av_pending = 'N';
1375 }
1376 $type = 'E';
1377
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001378 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001379 print "UNDEF($1)\n" if ($dbg_values > 1);
1380 $av_preprocessor = 1;
1381 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001382
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001383 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001384 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001385 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001386
1387 push(@av_paren_type, $type);
1388 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001389 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001390
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001391 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001392 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1393 $av_preprocessor = 1;
1394
1395 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1396
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001397 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001398
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001399 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001400 print "PRE_END($1)\n" if ($dbg_values > 1);
1401
1402 $av_preprocessor = 1;
1403
1404 # Assume all arms of the conditional end as this
1405 # one does, and continue as if the #endif was not here.
1406 pop(@av_paren_type);
1407 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001408 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001409
1410 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001411 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001412
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001413 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1414 print "ATTR($1)\n" if ($dbg_values > 1);
1415 $av_pending = $type;
1416 $type = 'N';
1417
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001418 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001419 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001420 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001421 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001422 }
1423 $type = 'N';
1424
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001425 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001426 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001427 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001428 $type = 'N';
1429
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001430 } elsif ($cur =~/^(case)/o) {
1431 print "CASE($1)\n" if ($dbg_values > 1);
1432 $av_pend_colon = 'C';
1433 $type = 'N';
1434
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001435 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001436 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001437 $type = 'N';
1438
1439 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001440 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001441 push(@av_paren_type, $av_pending);
1442 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001443 $type = 'N';
1444
1445 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001446 my $new_type = pop(@av_paren_type);
1447 if ($new_type ne '_') {
1448 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001449 print "PAREN('$1') -> $type\n"
1450 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001451 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001452 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001453 }
1454
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001455 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001456 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001457 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001458 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001459
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001460 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1461 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001462 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001463 } elsif ($type eq 'E') {
1464 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001465 }
1466 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1467 $type = 'V';
1468
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001469 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001470 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001471 $type = 'V';
1472
1473 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001474 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001475 $type = 'N';
1476
Andy Whitcroftcf655042008-03-04 14:28:20 -08001477 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001478 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001479 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001480 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001481
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001482 } elsif ($cur =~/^(,)/) {
1483 print "COMMA($1)\n" if ($dbg_values > 1);
1484 $type = 'C';
1485
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001486 } elsif ($cur =~ /^(\?)/o) {
1487 print "QUESTION($1)\n" if ($dbg_values > 1);
1488 $type = 'N';
1489
1490 } elsif ($cur =~ /^(:)/o) {
1491 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1492
1493 substr($var, length($res), 1, $av_pend_colon);
1494 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1495 $type = 'E';
1496 } else {
1497 $type = 'N';
1498 }
1499 $av_pend_colon = 'O';
1500
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001501 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001502 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001503 $type = 'N';
1504
Andy Whitcroft0d413862008-10-15 22:02:16 -07001505 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001506 my $variant;
1507
1508 print "OPV($1)\n" if ($dbg_values > 1);
1509 if ($type eq 'V') {
1510 $variant = 'B';
1511 } else {
1512 $variant = 'U';
1513 }
1514
1515 substr($var, length($res), 1, $variant);
1516 $type = 'N';
1517
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001518 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001519 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001520 if ($1 ne '++' && $1 ne '--') {
1521 $type = 'N';
1522 }
1523
1524 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001525 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001526 }
1527 if (defined $1) {
1528 $cur = substr($cur, length($1));
1529 $res .= $type x length($1);
1530 }
1531 }
1532
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001533 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001534}
1535
Andy Whitcroft8905a672007-11-28 16:21:06 -08001536sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001537 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001538 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001539 ^(?:
1540 $Modifier|
1541 $Storage|
1542 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001543 DEFINE_\S+
1544 )$|
1545 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001546 goto|
1547 return|
1548 case|
1549 else|
1550 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001551 do|
1552 \#|
1553 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001554 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001555 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001556 )}x;
1557 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1558 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001559 # Check for modifiers.
1560 $possible =~ s/\s*$Storage\s*//g;
1561 $possible =~ s/\s*$Sparse\s*//g;
1562 if ($possible =~ /^\s*$/) {
1563
1564 } elsif ($possible =~ /\s/) {
1565 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001566 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001567 if ($modifier !~ $notPermitted) {
1568 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1569 push(@modifierList, $modifier);
1570 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001571 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001572
1573 } else {
1574 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1575 push(@typeList, $possible);
1576 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001577 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001578 } else {
1579 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001580 }
1581}
1582
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001583my $prefix = '';
1584
Joe Perches000d1cc12011-07-25 17:13:25 -07001585sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001586 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001587
Joe Perchescbec18a2014-04-03 14:49:19 -07001588 return defined $use_type{$type} if (scalar keys %use_type > 0);
1589
1590 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001591}
1592
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001593sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001594 my ($level, $type, $msg) = @_;
1595
1596 if (!show_type($type) ||
1597 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001598 return 0;
1599 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001600 my $line;
1601 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001602 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001603 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001604 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001605 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001606 $line = (split('\n', $line))[0] . "\n" if ($terse);
1607
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001608 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001609
1610 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001611}
Joe Perchescbec18a2014-04-03 14:49:19 -07001612
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001613sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001614 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001615}
Joe Perches000d1cc12011-07-25 17:13:25 -07001616
Joe Perchesd752fcc2014-08-06 16:11:05 -07001617sub fixup_current_range {
1618 my ($lineRef, $offset, $length) = @_;
1619
1620 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1621 my $o = $1;
1622 my $l = $2;
1623 my $no = $o + $offset;
1624 my $nl = $l + $length;
1625 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1626 }
1627}
1628
1629sub fix_inserted_deleted_lines {
1630 my ($linesRef, $insertedRef, $deletedRef) = @_;
1631
1632 my $range_last_linenr = 0;
1633 my $delta_offset = 0;
1634
1635 my $old_linenr = 0;
1636 my $new_linenr = 0;
1637
1638 my $next_insert = 0;
1639 my $next_delete = 0;
1640
1641 my @lines = ();
1642
1643 my $inserted = @{$insertedRef}[$next_insert++];
1644 my $deleted = @{$deletedRef}[$next_delete++];
1645
1646 foreach my $old_line (@{$linesRef}) {
1647 my $save_line = 1;
1648 my $line = $old_line; #don't modify the array
1649 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1650 $delta_offset = 0;
1651 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1652 $range_last_linenr = $new_linenr;
1653 fixup_current_range(\$line, $delta_offset, 0);
1654 }
1655
1656 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1657 $deleted = @{$deletedRef}[$next_delete++];
1658 $save_line = 0;
1659 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1660 }
1661
1662 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1663 push(@lines, ${$inserted}{'LINE'});
1664 $inserted = @{$insertedRef}[$next_insert++];
1665 $new_linenr++;
1666 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1667 }
1668
1669 if ($save_line) {
1670 push(@lines, $line);
1671 $new_linenr++;
1672 }
1673
1674 $old_linenr++;
1675 }
1676
1677 return @lines;
1678}
1679
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001680sub fix_insert_line {
1681 my ($linenr, $line) = @_;
1682
1683 my $inserted = {
1684 LINENR => $linenr,
1685 LINE => $line,
1686 };
1687 push(@fixed_inserted, $inserted);
1688}
1689
1690sub fix_delete_line {
1691 my ($linenr, $line) = @_;
1692
1693 my $deleted = {
1694 LINENR => $linenr,
1695 LINE => $line,
1696 };
1697
1698 push(@fixed_deleted, $deleted);
1699}
1700
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001701sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001702 my ($type, $msg) = @_;
1703
1704 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001705 our $clean = 0;
1706 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001707 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001708 }
Joe Perches3705ce52013-07-03 15:05:31 -07001709 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001710}
1711sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001712 my ($type, $msg) = @_;
1713
1714 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001715 our $clean = 0;
1716 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001717 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001718 }
Joe Perches3705ce52013-07-03 15:05:31 -07001719 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001720}
1721sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001722 my ($type, $msg) = @_;
1723
1724 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 our $clean = 0;
1726 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001727 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001728 }
Joe Perches3705ce52013-07-03 15:05:31 -07001729 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001730}
1731
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001732sub check_absolute_file {
1733 my ($absolute, $herecurr) = @_;
1734 my $file = $absolute;
1735
1736 ##print "absolute<$absolute>\n";
1737
1738 # See if any suffix of this path is a path within the tree.
1739 while ($file =~ s@^[^/]*/@@) {
1740 if (-f "$root/$file") {
1741 ##print "file<$file>\n";
1742 last;
1743 }
1744 }
1745 if (! -f _) {
1746 return 0;
1747 }
1748
1749 # It is, so see if the prefix is acceptable.
1750 my $prefix = $absolute;
1751 substr($prefix, -length($file)) = '';
1752
1753 ##print "prefix<$prefix>\n";
1754 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001755 WARN("USE_RELATIVE_PATH",
1756 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001757 }
1758}
1759
Joe Perches3705ce52013-07-03 15:05:31 -07001760sub trim {
1761 my ($string) = @_;
1762
Joe Perchesb34c6482013-09-11 14:24:01 -07001763 $string =~ s/^\s+|\s+$//g;
1764
1765 return $string;
1766}
1767
1768sub ltrim {
1769 my ($string) = @_;
1770
1771 $string =~ s/^\s+//;
1772
1773 return $string;
1774}
1775
1776sub rtrim {
1777 my ($string) = @_;
1778
1779 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001780
1781 return $string;
1782}
1783
Joe Perches52ea8502013-11-12 15:10:09 -08001784sub string_find_replace {
1785 my ($string, $find, $replace) = @_;
1786
1787 $string =~ s/$find/$replace/g;
1788
1789 return $string;
1790}
1791
Joe Perches3705ce52013-07-03 15:05:31 -07001792sub tabify {
1793 my ($leading) = @_;
1794
1795 my $source_indent = 8;
1796 my $max_spaces_before_tab = $source_indent - 1;
1797 my $spaces_to_tab = " " x $source_indent;
1798
1799 #convert leading spaces to tabs
1800 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1801 #Remove spaces before a tab
1802 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1803
1804 return "$leading";
1805}
1806
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001807sub pos_last_openparen {
1808 my ($line) = @_;
1809
1810 my $pos = 0;
1811
1812 my $opens = $line =~ tr/\(/\(/;
1813 my $closes = $line =~ tr/\)/\)/;
1814
1815 my $last_openparen = 0;
1816
1817 if (($opens == 0) || ($closes >= $opens)) {
1818 return -1;
1819 }
1820
1821 my $len = length($line);
1822
1823 for ($pos = 0; $pos < $len; $pos++) {
1824 my $string = substr($line, $pos);
1825 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1826 $pos += length($1) - 1;
1827 } elsif (substr($line, $pos, 1) eq '(') {
1828 $last_openparen = $pos;
1829 } elsif (index($string, '(') == -1) {
1830 last;
1831 }
1832 }
1833
Joe Perches91cb5192014-04-03 14:49:32 -07001834 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001835}
1836
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001837sub process {
1838 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001839
1840 my $linenr=0;
1841 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001842 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001843 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001844 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001845
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001846 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001847 my $indent;
1848 my $previndent=0;
1849 my $stashindent=0;
1850
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001851 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001852 my $signoff = 0;
1853 my $is_patch = 0;
1854
Joe Perches29ee1b02014-08-06 16:10:35 -07001855 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001856 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001857 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001858 my $non_utf8_charset = 0;
1859
Joe Perches365dd4e2014-08-06 16:10:42 -07001860 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08001861 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07001862
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001863 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001864 our $cnt_lines = 0;
1865 our $cnt_error = 0;
1866 our $cnt_warn = 0;
1867 our $cnt_chk = 0;
1868
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001869 # Trace the real file/line as we go.
1870 my $realfile = '';
1871 my $realline = 0;
1872 my $realcnt = 0;
1873 my $here = '';
1874 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001875 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001876 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001877 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001878
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001879 my $prev_values = 'E';
1880
1881 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001882 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001883 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001884 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001885 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001886
Joe Perches7e51f192013-09-11 14:23:57 -07001887 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001888
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001889 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001890 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001891 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001892 my @setup_docs = ();
1893 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001894
Joe Perchesd8b07712013-11-12 15:10:06 -08001895 my $camelcase_file_seeded = 0;
1896
Andy Whitcroft773647a2008-03-28 14:15:58 -07001897 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001898 my $line;
1899 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001900 $linenr++;
1901 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001902
Joe Perches3705ce52013-07-03 15:05:31 -07001903 push(@fixed, $rawline) if ($fix);
1904
Andy Whitcroft773647a2008-03-28 14:15:58 -07001905 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001906 $setup_docs = 0;
1907 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1908 $setup_docs = 1;
1909 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001910 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001911 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001912 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1913 $realline=$1-1;
1914 if (defined $2) {
1915 $realcnt=$3+1;
1916 } else {
1917 $realcnt=1+1;
1918 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001919 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001920
1921 # Guestimate if this is a continuing comment. Run
1922 # the context looking for a comment "edge". If this
1923 # edge is a close comment then we must be in a comment
1924 # at context start.
1925 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001926 my $cnt = $realcnt;
1927 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1928 next if (defined $rawlines[$ln - 1] &&
1929 $rawlines[$ln - 1] =~ /^-/);
1930 $cnt--;
1931 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001932 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001933 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1934 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1935 ($edge) = $1;
1936 last;
1937 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001938 }
1939 if (defined $edge && $edge eq '*/') {
1940 $in_comment = 1;
1941 }
1942
1943 # Guestimate if this is a continuing comment. If this
1944 # is the start of a diff block and this line starts
1945 # ' *' then it is very likely a comment.
1946 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001947 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001948 {
1949 $in_comment = 1;
1950 }
1951
1952 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1953 sanitise_line_reset($in_comment);
1954
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001955 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001956 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001957 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001958 $line = sanitise_line($rawline);
1959 }
1960 push(@lines, $line);
1961
1962 if ($realcnt > 1) {
1963 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1964 } else {
1965 $realcnt = 0;
1966 }
1967
1968 #print "==>$rawline\n";
1969 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001970
1971 if ($setup_docs && $line =~ /^\+/) {
1972 push(@setup_docs, $line);
1973 }
1974 }
1975
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001976 $prefix = '';
1977
Andy Whitcroft773647a2008-03-28 14:15:58 -07001978 $realcnt = 0;
1979 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001980 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001981 foreach my $line (@lines) {
1982 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001983 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001984 my $sline = $line; #copy of $line
1985 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001986
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001987 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001988
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001989#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001990 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001991 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001992 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001993 $realline=$1-1;
1994 if (defined $2) {
1995 $realcnt=$3+1;
1996 } else {
1997 $realcnt=1+1;
1998 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001999 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002000 $prev_values = 'E';
2001
Andy Whitcroft773647a2008-03-28 14:15:58 -07002002 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002003 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002004 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002005 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002006 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002007
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002008# track the line number as we move through the hunk, note that
2009# new versions of GNU diff omit the leading space on completely
2010# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002011 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002012 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002013 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002014
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002015 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002016 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002017
2018 # Track the previous line.
2019 ($prevline, $stashline) = ($stashline, $line);
2020 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002021 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2022
Andy Whitcroft773647a2008-03-28 14:15:58 -07002023 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002024
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002025 } elsif ($realcnt == 1) {
2026 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002027 }
2028
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002029 my $hunk_line = ($realcnt != 0);
2030
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002031#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07002032 $prefix = "$filename:$realline: " if ($emacs && $file);
2033 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2034
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002035 $here = "#$linenr: " if (!$file);
2036 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002037
Joe Perches2ac73b42014-06-04 16:12:05 -07002038 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002039 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002040 if ($line =~ /^diff --git.*?(\S+)$/) {
2041 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002042 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002043 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002044 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002045 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002046 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002047 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002048 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002049
2050 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002051 if (!$file && $tree && $p1_prefix ne '' &&
2052 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002053 WARN("PATCH_PREFIX",
2054 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002055 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002056
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002057 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002058 ERROR("MODIFIED_INCLUDE_ASM",
2059 "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 -07002060 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002061 $found_file = 1;
2062 }
2063
2064 if ($found_file) {
2065 if ($realfile =~ m@^(drivers/net/|net/)@) {
2066 $check = 1;
2067 } else {
2068 $check = $check_orig;
2069 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002070 next;
2071 }
2072
Randy Dunlap389834b2007-06-08 13:47:03 -07002073 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002074
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002075 my $hereline = "$here\n$rawline\n";
2076 my $herecurr = "$here\n$rawline\n";
2077 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002078
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002079 $cnt_lines++ if ($realcnt != 0);
2080
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002081# Check for incorrect file permissions
2082 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2083 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002084 if ($realfile !~ m@scripts/@ &&
2085 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002086 ERROR("EXECUTE_PERMISSIONS",
2087 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002088 }
2089 }
2090
Joe Perches20112472011-07-25 17:13:23 -07002091# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002092 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002093 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002094 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002095 }
2096
Joe Perchese0d975b2014-12-10 15:51:49 -08002097# Check if MAINTAINERS is being updated. If so, there's probably no need to
2098# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2099 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2100 $reported_maintainer_file = 1;
2101 }
2102
Joe Perches20112472011-07-25 17:13:23 -07002103# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002104 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002105 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002106 my $space_before = $1;
2107 my $sign_off = $2;
2108 my $space_after = $3;
2109 my $email = $4;
2110 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2111
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002112 if ($sign_off !~ /$signature_tags/) {
2113 WARN("BAD_SIGN_OFF",
2114 "Non-standard signature: $sign_off\n" . $herecurr);
2115 }
Joe Perches20112472011-07-25 17:13:23 -07002116 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002117 if (WARN("BAD_SIGN_OFF",
2118 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2119 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002120 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002121 "$ucfirst_sign_off $email";
2122 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002123 }
Joe Perches20112472011-07-25 17:13:23 -07002124 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002125 if (WARN("BAD_SIGN_OFF",
2126 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2127 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002128 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002129 "$ucfirst_sign_off $email";
2130 }
2131
Joe Perches20112472011-07-25 17:13:23 -07002132 }
2133 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002134 if (WARN("BAD_SIGN_OFF",
2135 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2136 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002137 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002138 "$ucfirst_sign_off $email";
2139 }
Joe Perches20112472011-07-25 17:13:23 -07002140 }
2141
2142 my ($email_name, $email_address, $comment) = parse_email($email);
2143 my $suggested_email = format_email(($email_name, $email_address));
2144 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002145 ERROR("BAD_SIGN_OFF",
2146 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002147 } else {
2148 my $dequoted = $suggested_email;
2149 $dequoted =~ s/^"//;
2150 $dequoted =~ s/" </ </;
2151 # Don't force email to have quotes
2152 # Allow just an angle bracketed address
2153 if ("$dequoted$comment" ne $email &&
2154 "<$email_address>$comment" ne $email &&
2155 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002156 WARN("BAD_SIGN_OFF",
2157 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002158 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002159 }
Joe Perches7e51f192013-09-11 14:23:57 -07002160
2161# Check for duplicate signatures
2162 my $sig_nospace = $line;
2163 $sig_nospace =~ s/\s//g;
2164 $sig_nospace = lc($sig_nospace);
2165 if (defined $signatures{$sig_nospace}) {
2166 WARN("BAD_SIGN_OFF",
2167 "Duplicate signature\n" . $herecurr);
2168 } else {
2169 $signatures{$sig_nospace} = 1;
2170 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002171 }
2172
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002173# Check email subject for common tools that don't need to be mentioned
2174 if ($in_header_lines &&
2175 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2176 WARN("EMAIL_SUBJECT",
2177 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2178 }
2179
Joe Perches9b3189e2014-06-04 16:12:10 -07002180# Check for old stable address
2181 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2182 ERROR("STABLE_ADDRESS",
2183 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2184 }
2185
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002186# Check for unwanted Gerrit info
2187 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2188 ERROR("GERRIT_CHANGE_ID",
2189 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2190 }
2191
Joe Perches0d7835f2015-02-13 14:38:35 -08002192# Check for git id commit length and improperly formed commit descriptions
2193 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002194 my $init_char = $1;
2195 my $orig_commit = lc($2);
Joe Perches0d7835f2015-02-13 14:38:35 -08002196 my $short = 1;
2197 my $long = 0;
2198 my $case = 1;
2199 my $space = 1;
2200 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002201 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002202 my $id = '0123456789ab';
2203 my $orig_desc = "commit description";
2204 my $description = "";
2205
2206 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2207 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2208 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2209 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2210 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2211 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002212 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002213 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2214 defined $rawlines[$linenr] &&
2215 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2216 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002217 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002218 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2219 defined $rawlines[$linenr] &&
2220 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2221 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2222 $orig_desc = $1;
2223 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2224 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002225 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002226 }
2227
2228 ($id, $description) = git_commit_info($orig_commit,
2229 $id, $orig_desc);
2230
Joe Perches19c146a2015-02-13 14:39:00 -08002231 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002232 ERROR("GIT_COMMIT_ID",
2233 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2234 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002235 }
2236
Joe Perches13f19372014-08-06 16:10:59 -07002237# Check for added, moved or deleted files
2238 if (!$reported_maintainer_file && !$in_commit_log &&
2239 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2240 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2241 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2242 (defined($1) || defined($2))))) {
2243 $reported_maintainer_file = 1;
2244 WARN("FILE_PATH_CHANGES",
2245 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2246 }
2247
Andy Whitcroft00df3442007-06-08 13:47:06 -07002248# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002249 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002250 ERROR("CORRUPTED_PATCH",
2251 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002252 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002253 }
2254
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002255# Check for absolute kernel paths.
2256 if ($tree) {
2257 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2258 my $file = $1;
2259
2260 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2261 check_absolute_file($1, $herecurr)) {
2262 #
2263 } else {
2264 check_absolute_file($file, $herecurr);
2265 }
2266 }
2267 }
2268
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002269# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2270 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002271 $rawline !~ m/^$UTF8*$/) {
2272 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2273
2274 my $blank = copy_spacing($rawline);
2275 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2276 my $hereptr = "$hereline$ptr\n";
2277
Joe Perches34d99212011-07-25 17:13:26 -07002278 CHK("INVALID_UTF8",
2279 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002280 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002281
Joe Perches15662b32011-10-31 17:13:12 -07002282# Check if it's the start of a commit log
2283# (not a header line and we haven't seen the patch filename)
2284 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002285 !($rawline =~ /^\s+\S/ ||
2286 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002287 $in_header_lines = 0;
2288 $in_commit_log = 1;
2289 }
2290
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002291# Check if there is UTF-8 in a commit log when a mail header has explicitly
2292# declined it, i.e defined some charset where it is missing.
2293 if ($in_header_lines &&
2294 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2295 $1 !~ /utf-8/i) {
2296 $non_utf8_charset = 1;
2297 }
2298
2299 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002300 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002301 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002302 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2303 }
2304
Kees Cook66b47b42014-10-13 15:51:57 -07002305# Check for various typo / spelling mistakes
Joe Perches36061e32014-12-10 15:51:43 -08002306 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
Kees Cook66b47b42014-10-13 15:51:57 -07002307 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2308 my $typo = $1;
2309 my $typo_fix = $spelling_fix{lc($typo)};
2310 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2311 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2312 my $msg_type = \&WARN;
2313 $msg_type = \&CHK if ($file);
2314 if (&{$msg_type}("TYPO_SPELLING",
2315 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2316 $fix) {
2317 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2318 }
2319 }
2320 }
2321
Andy Whitcroft306708542008-10-15 22:02:28 -07002322# ignore non-hunk lines and lines being removed
2323 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002324
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002325#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002326 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002327 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002328 if (ERROR("DOS_LINE_ENDINGS",
2329 "DOS line endings\n" . $herevet) &&
2330 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002331 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002332 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002333 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2334 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002335 if (ERROR("TRAILING_WHITESPACE",
2336 "trailing whitespace\n" . $herevet) &&
2337 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002338 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002339 }
2340
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002341 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002342 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002343
Josh Triplett4783f892013-11-12 15:10:12 -08002344# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002345 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002346 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2347 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002348 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2349 my $msg_type = \&ERROR;
2350 $msg_type = \&CHK if ($file);
2351 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002352 "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 -08002353 }
2354
Andi Kleen33549572010-05-24 14:33:29 -07002355# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002356# Only applies when adding the entry originally, after that we do not have
2357# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002358 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002359 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002360 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002361 my $cnt = $realcnt;
2362 my $ln = $linenr + 1;
2363 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002364 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002365 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002366 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002367 $f = $lines[$ln - 1];
2368 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2369 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002370
2371 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002372 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002373
Joe Perches8d73e0e2014-08-06 16:10:46 -07002374 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002375 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002376 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002377 $length = -1;
2378 }
2379
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002380 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002381 $f =~ s/#.*//;
2382 $f =~ s/^\s+//;
2383 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002384 if ($f =~ /^\s*config\s/) {
2385 $is_end = 1;
2386 last;
2387 }
Andi Kleen33549572010-05-24 14:33:29 -07002388 $length++;
2389 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002390 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2391 WARN("CONFIG_DESCRIPTION",
2392 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2393 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002394 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002395 }
2396
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002397# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2398 if ($realfile =~ /Kconfig/ &&
2399 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2400 WARN("CONFIG_EXPERIMENTAL",
2401 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2402 }
2403
Christoph Jaeger327953e2015-02-13 14:38:29 -08002404# discourage the use of boolean for type definition attributes of Kconfig options
2405 if ($realfile =~ /Kconfig/ &&
2406 $line =~ /^\+\s*\bboolean\b/) {
2407 WARN("CONFIG_TYPE_BOOLEAN",
2408 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2409 }
2410
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002411 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2412 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2413 my $flag = $1;
2414 my $replacement = {
2415 'EXTRA_AFLAGS' => 'asflags-y',
2416 'EXTRA_CFLAGS' => 'ccflags-y',
2417 'EXTRA_CPPFLAGS' => 'cppflags-y',
2418 'EXTRA_LDFLAGS' => 'ldflags-y',
2419 };
2420
2421 WARN("DEPRECATED_VARIABLE",
2422 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2423 }
2424
Rob Herringbff5da42014-01-23 15:54:51 -08002425# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002426 if (defined $root &&
2427 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2428 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2429
Rob Herringbff5da42014-01-23 15:54:51 -08002430 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2431
Florian Vaussardcc933192014-04-03 14:49:27 -07002432 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2433 my $vp_file = $dt_path . "vendor-prefixes.txt";
2434
Rob Herringbff5da42014-01-23 15:54:51 -08002435 foreach my $compat (@compats) {
2436 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002437 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2438 my $compat3 = $compat;
2439 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2440 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002441 if ( $? >> 8 ) {
2442 WARN("UNDOCUMENTED_DT_STRING",
2443 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2444 }
2445
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002446 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2447 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002448 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002449 if ( $? >> 8 ) {
2450 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002451 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002452 }
2453 }
2454 }
2455
Andy Whitcroft5368df202008-10-15 22:02:27 -07002456# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002457 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002458
Joe Perches6cd7f382012-12-17 16:01:54 -08002459#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002460 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002461 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002462 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002463 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002464 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002465 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002466 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002467 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002468 }
2469
Andy Whitcroft8905a672007-11-28 16:21:06 -08002470# check for adding lines without a newline.
2471 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002472 WARN("MISSING_EOF_NEWLINE",
2473 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002474 }
2475
Mike Frysinger42e41c52009-09-21 17:04:40 -07002476# Blackfin: use hi/lo macros
2477 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2478 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2479 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002480 ERROR("LO_MACRO",
2481 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002482 }
2483 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2484 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002485 ERROR("HI_MACRO",
2486 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002487 }
2488 }
2489
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002490# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002491 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002492
2493# at the beginning of a line any tabs must come first and anything
2494# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002495 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2496 $rawline =~ /^\+\s* \s*/) {
2497 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002498 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002499 if (ERROR("CODE_INDENT",
2500 "code indent should use tabs where possible\n" . $herevet) &&
2501 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002502 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002503 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002504 }
2505
Alberto Panizzo08e44362010-03-05 13:43:54 -08002506# check for space before tabs.
2507 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2508 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002509 if (WARN("SPACE_BEFORE_TAB",
2510 "please, no space before tabs\n" . $herevet) &&
2511 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002512 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002513 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002514 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002515 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002516 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002517 }
2518
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002519# check for && or || at the start of a line
2520 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2521 CHK("LOGICAL_CONTINUATIONS",
2522 "Logical continuations should be on the previous line\n" . $hereprev);
2523 }
2524
2525# check multi-line statement indentation matches previous line
2526 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002527 $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 -07002528 $prevline =~ /^\+(\t*)(.*)$/;
2529 my $oldindent = $1;
2530 my $rest = $2;
2531
2532 my $pos = pos_last_openparen($rest);
2533 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002534 $line =~ /^(\+| )([ \t]*)/;
2535 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002536
2537 my $goodtabindent = $oldindent .
2538 "\t" x ($pos / 8) .
2539 " " x ($pos % 8);
2540 my $goodspaceindent = $oldindent . " " x $pos;
2541
2542 if ($newindent ne $goodtabindent &&
2543 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002544
2545 if (CHK("PARENTHESIS_ALIGNMENT",
2546 "Alignment should match open parenthesis\n" . $hereprev) &&
2547 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002548 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002549 s/^\+[ \t]*/\+$goodtabindent/;
2550 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002551 }
2552 }
2553 }
2554
Joe Perches6ab3a972015-04-16 12:44:05 -07002555# check for space after cast like "(int) foo" or "(struct foo) bar"
2556# avoid checking a few false positives:
2557# "sizeof(<type>)" or "__alignof__(<type>)"
2558# function pointer declarations like "(*foo)(int) = bar;"
2559# structure definitions like "(struct foo) { 0 };"
2560# multiline macros that define functions
2561# known attributes or the __attribute__ keyword
2562 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2563 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002564 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002565 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002566 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002567 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002568 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002569 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002570 }
2571
Joe Perches05880602012-10-04 17:13:35 -07002572 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002573 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002574 $rawline =~ /^\+[ \t]*\*/ &&
2575 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002576 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2577 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2578 }
2579
2580 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002581 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2582 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002583 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002584 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2585 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2586 "networking block comments start with * on subsequent lines\n" . $hereprev);
2587 }
2588
2589 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002590 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2591 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2592 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2593 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002594 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2595 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2596 }
2597
Joe Perches7f619192014-08-06 16:10:39 -07002598# check for missing blank lines after struct/union declarations
2599# with exceptions for various attributes and macros
2600 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2601 $line =~ /^\+/ &&
2602 !($line =~ /^\+\s*$/ ||
2603 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2604 $line =~ /^\+\s*MODULE_/i ||
2605 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2606 $line =~ /^\+[a-z_]*init/ ||
2607 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2608 $line =~ /^\+\s*DECLARE/ ||
2609 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002610 if (CHK("LINE_SPACING",
2611 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2612 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002613 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002614 }
Joe Perches7f619192014-08-06 16:10:39 -07002615 }
2616
Joe Perches365dd4e2014-08-06 16:10:42 -07002617# check for multiple consecutive blank lines
2618 if ($prevline =~ /^[\+ ]\s*$/ &&
2619 $line =~ /^\+\s*$/ &&
2620 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002621 if (CHK("LINE_SPACING",
2622 "Please don't use multiple blank lines\n" . $hereprev) &&
2623 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002624 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002625 }
2626
Joe Perches365dd4e2014-08-06 16:10:42 -07002627 $last_blank_line = $linenr;
2628 }
2629
Joe Perches3b617e32014-04-03 14:49:28 -07002630# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002631 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2632 # actual declarations
2633 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002634 # function pointer declarations
2635 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002636 # foo bar; where foo is some local typedef or #define
2637 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2638 # known declaration macros
2639 $prevline =~ /^\+\s+$declaration_macros/) &&
2640 # for "else if" which can look like "$Ident $Ident"
2641 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2642 # other possible extensions of declaration lines
2643 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2644 # not starting a section or a macro "\" extended line
2645 $prevline =~ /(?:\{\s*|\\)$/) &&
2646 # looks like a declaration
2647 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002648 # function pointer declarations
2649 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002650 # foo bar; where foo is some local typedef or #define
2651 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2652 # known declaration macros
2653 $sline =~ /^\+\s+$declaration_macros/ ||
2654 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002655 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002656 # start or end of block or continuation of declaration
2657 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2658 # bitfield continuation
2659 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2660 # other possible extensions of declaration lines
2661 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2662 # indentation of previous and current line are the same
2663 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002664 if (WARN("LINE_SPACING",
2665 "Missing a blank line after declarations\n" . $hereprev) &&
2666 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002667 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002668 }
Joe Perches3b617e32014-04-03 14:49:28 -07002669 }
2670
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002671# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002672# Exceptions:
2673# 1) within comments
2674# 2) indented preprocessor commands
2675# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002676 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002677 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002678 if (WARN("LEADING_SPACE",
2679 "please, no spaces at the start of a line\n" . $herevet) &&
2680 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002681 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002682 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002683 }
2684
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002685# check we are in a valid C source file if not then ignore this hunk
2686 next if ($realfile !~ /\.(h|c)$/);
2687
Joe Perches032a4c02014-08-06 16:10:29 -07002688# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002689# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002690# if the previous line is a break or return and is indented 1 tab more...
2691 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2692 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002693 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2694 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2695 defined $lines[$linenr] &&
2696 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002697 WARN("UNNECESSARY_ELSE",
2698 "else is not generally useful after a break or return\n" . $hereprev);
2699 }
2700 }
2701
Joe Perchesc00df192014-08-06 16:11:01 -07002702# check indentation of a line with a break;
2703# if the previous line is a goto or return and is indented the same # of tabs
2704 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2705 my $tabs = $1;
2706 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2707 WARN("UNNECESSARY_BREAK",
2708 "break is not useful after a goto or return\n" . $hereprev);
2709 }
2710 }
2711
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002712# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2713 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2714 WARN("CONFIG_EXPERIMENTAL",
2715 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2716 }
2717
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002718# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002719 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002720 WARN("CVS_KEYWORD",
2721 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002722 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002723
Mike Frysinger42e41c52009-09-21 17:04:40 -07002724# Blackfin: don't use __builtin_bfin_[cs]sync
2725 if ($line =~ /__builtin_bfin_csync/) {
2726 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002727 ERROR("CSYNC",
2728 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002729 }
2730 if ($line =~ /__builtin_bfin_ssync/) {
2731 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002732 ERROR("SSYNC",
2733 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002734 }
2735
Joe Perches56e77d72013-02-21 16:44:14 -08002736# check for old HOTPLUG __dev<foo> section markings
2737 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2738 WARN("HOTPLUG_SECTION",
2739 "Using $1 is unnecessary\n" . $herecurr);
2740 }
2741
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002742# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002743 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2744 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002745#print "LINE<$line>\n";
2746 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002747 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002748 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002749 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002750 $stat =~ s/\n./\n /g;
2751 $cond =~ s/\n./\n /g;
2752
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002753#print "linenr<$linenr> <$stat>\n";
2754 # If this statement has no statement boundaries within
2755 # it there is no point in retrying a statement scan
2756 # until we hit end of it.
2757 my $frag = $stat; $frag =~ s/;+\s*$//;
2758 if ($frag !~ /(?:{|;)/) {
2759#print "skip<$line_nr_next>\n";
2760 $suppress_statement = $line_nr_next;
2761 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002762
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002763 # Find the real next line.
2764 $realline_next = $line_nr_next;
2765 if (defined $realline_next &&
2766 (!defined $lines[$realline_next - 1] ||
2767 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2768 $realline_next++;
2769 }
2770
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002771 my $s = $stat;
2772 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002773
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002774 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002775 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002776
2777 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002778 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002779
Andy Whitcroft463f2862009-09-21 17:04:34 -07002780 } elsif ($s =~ /^.\s*else\b/s) {
2781
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002782 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002783 } 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 -07002784 my $type = $1;
2785 $type =~ s/\s+/ /g;
2786 possible($type, "A:" . $s);
2787
Andy Whitcroft8905a672007-11-28 16:21:06 -08002788 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002789 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002790 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002791 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002792
2793 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002794 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002795 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002796 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002797
2798 # Check for any sort of function declaration.
2799 # int foo(something bar, other baz);
2800 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002801 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 -08002802 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002803
Andy Whitcroftcf655042008-03-04 14:28:20 -08002804 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002805 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002806 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002807
Andy Whitcroft8905a672007-11-28 16:21:06 -08002808 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002809 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002810
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002811 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002812 }
2813 }
2814 }
2815
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002816 }
2817
Andy Whitcroft653d4872007-06-23 17:16:34 -07002818#
2819# Checks which may be anchored in the context.
2820#
2821
2822# Check for switch () and associated case and default
2823# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002824 if ($line=~/\bswitch\s*\(.*\)/) {
2825 my $err = '';
2826 my $sep = '';
2827 my @ctx = ctx_block_outer($linenr, $realcnt);
2828 shift(@ctx);
2829 for my $ctx (@ctx) {
2830 my ($clen, $cindent) = line_stats($ctx);
2831 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2832 $indent != $cindent) {
2833 $err .= "$sep$ctx\n";
2834 $sep = '';
2835 } else {
2836 $sep = "[...]\n";
2837 }
2838 }
2839 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002840 ERROR("SWITCH_CASE_INDENT_LEVEL",
2841 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002842 }
2843 }
2844
2845# if/while/etc brace do not go on next line, unless defining a do while loop,
2846# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07002847 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 -07002848 my $pre_ctx = "$1$2";
2849
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002850 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002851
2852 if ($line =~ /^\+\t{6,}/) {
2853 WARN("DEEP_INDENTATION",
2854 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2855 }
2856
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002857 my $ctx_cnt = $realcnt - $#ctx - 1;
2858 my $ctx = join("\n", @ctx);
2859
Andy Whitcroft548596d2008-07-23 21:29:01 -07002860 my $ctx_ln = $linenr;
2861 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002862
Andy Whitcroft548596d2008-07-23 21:29:01 -07002863 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2864 defined $lines[$ctx_ln - 1] &&
2865 $lines[$ctx_ln - 1] =~ /^-/)) {
2866 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2867 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002868 $ctx_ln++;
2869 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002870
Andy Whitcroft53210162008-07-23 21:29:03 -07002871 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2872 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002873
Joe Perchesd752fcc2014-08-06 16:11:05 -07002874 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002875 ERROR("OPEN_BRACE",
2876 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002877 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002878 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002879 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2880 $ctx =~ /\)\s*\;\s*$/ &&
2881 defined $lines[$ctx_ln - 1])
2882 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002883 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2884 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002885 WARN("TRAILING_SEMICOLON",
2886 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002887 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002888 }
2889 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002890 }
2891
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002892# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07002893 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 -08002894 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2895 ctx_statement_block($linenr, $realcnt, 0)
2896 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002897 my ($s, $c) = ($stat, $cond);
2898
2899 substr($s, 0, length($c), '');
2900
2901 # Make sure we remove the line prefixes as we have
2902 # none on the first line, and are going to readd them
2903 # where necessary.
2904 $s =~ s/\n./\n/gs;
2905
2906 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002907 my @newlines = ($c =~ /\n/gs);
2908 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002909
2910 # We want to check the first line inside the block
2911 # starting at the end of the conditional, so remove:
2912 # 1) any blank line termination
2913 # 2) any opening brace { on end of the line
2914 # 3) any do (...) {
2915 my $continuation = 0;
2916 my $check = 0;
2917 $s =~ s/^.*\bdo\b//;
2918 $s =~ s/^\s*{//;
2919 if ($s =~ s/^\s*\\//) {
2920 $continuation = 1;
2921 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002922 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002923 $check = 1;
2924 $cond_lines++;
2925 }
2926
2927 # Also ignore a loop construct at the end of a
2928 # preprocessor statement.
2929 if (($prevline =~ /^.\s*#\s*define\s/ ||
2930 $prevline =~ /\\\s*$/) && $continuation == 0) {
2931 $check = 0;
2932 }
2933
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002934 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002935 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002936 while ($cond_ptr != $cond_lines) {
2937 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002938
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002939 # If we see an #else/#elif then the code
2940 # is not linear.
2941 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2942 $check = 0;
2943 }
2944
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002945 # Ignore:
2946 # 1) blank lines, they should be at 0,
2947 # 2) preprocessor lines, and
2948 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002949 if ($continuation ||
2950 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002951 $s =~ /^\s*#\s*?/ ||
2952 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002953 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002954 if ($s =~ s/^.*?\n//) {
2955 $cond_lines++;
2956 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002957 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002958 }
2959
2960 my (undef, $sindent) = line_stats("+" . $s);
2961 my $stat_real = raw_line($linenr, $cond_lines);
2962
2963 # Check if either of these lines are modified, else
2964 # this is not this patch's fault.
2965 if (!defined($stat_real) ||
2966 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2967 $check = 0;
2968 }
2969 if (defined($stat_real) && $cond_lines > 1) {
2970 $stat_real = "[...]\n$stat_real";
2971 }
2972
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002973 #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 -07002974
2975 if ($check && (($sindent % 8) != 0 ||
2976 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002977 WARN("SUSPECT_CODE_INDENT",
2978 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002979 }
2980 }
2981
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002982 # Track the 'values' across context and added lines.
2983 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002984 my ($curr_values, $curr_vars) =
2985 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002986 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002987 if ($dbg_values) {
2988 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002989 print "$linenr > .$outline\n";
2990 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002991 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002992 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002993 $prev_values = substr($curr_values, -1);
2994
Andy Whitcroft00df3442007-06-08 13:47:06 -07002995#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002996 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002997
Andy Whitcroft653d4872007-06-23 17:16:34 -07002998# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002999 if ($dbg_type) {
3000 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003001 ERROR("TEST_TYPE",
3002 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003003 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003004 ERROR("TEST_NOT_TYPE",
3005 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003006 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003007 next;
3008 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003009# TEST: allow direct testing of the attribute matcher.
3010 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003011 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003012 ERROR("TEST_ATTR",
3013 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003014 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003015 ERROR("TEST_NOT_ATTR",
3016 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003017 }
3018 next;
3019 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003020
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003021# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003022 if ($line =~ /^.\s*{/ &&
3023 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003024 if (ERROR("OPEN_BRACE",
3025 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003026 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3027 fix_delete_line($fixlinenr - 1, $prevrawline);
3028 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003029 my $fixedline = $prevrawline;
3030 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003031 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003032 $fixedline = $line;
3033 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003034 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003035 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003036 }
3037
Andy Whitcroft653d4872007-06-23 17:16:34 -07003038#
3039# Checks which are anchored on the added line.
3040#
3041
3042# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003043 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003044 my $path = $1;
3045 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003046 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003047 "malformed #include filename\n" . $herecurr);
3048 }
3049 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3050 ERROR("UAPI_INCLUDE",
3051 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003052 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003053 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003054
3055# no C99 // comments
3056 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003057 if (ERROR("C99_COMMENTS",
3058 "do not use C99 // comments\n" . $herecurr) &&
3059 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003060 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003061 if ($line =~ /\/\/(.*)$/) {
3062 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003063 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003064 }
3065 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003066 }
3067 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003068 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003069 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003070
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003071# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3072# the whole statement.
3073#print "APW <$lines[$realline_next - 1]>\n";
3074 if (defined $realline_next &&
3075 exists $lines[$realline_next - 1] &&
3076 !defined $suppress_export{$realline_next} &&
3077 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3078 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003079 # Handle definitions which produce identifiers with
3080 # a prefix:
3081 # XXX(foo);
3082 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003083 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003084 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003085 $name =~ /^${Ident}_$2/) {
3086#print "FOO C name<$name>\n";
3087 $suppress_export{$realline_next} = 1;
3088
3089 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003090 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003091 ^.DEFINE_$Ident\(\Q$name\E\)|
3092 ^.DECLARE_$Ident\(\Q$name\E\)|
3093 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003094 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3095 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003096 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003097#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3098 $suppress_export{$realline_next} = 2;
3099 } else {
3100 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003101 }
3102 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003103 if (!defined $suppress_export{$linenr} &&
3104 $prevline =~ /^.\s*$/ &&
3105 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3106 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3107#print "FOO B <$lines[$linenr - 1]>\n";
3108 $suppress_export{$linenr} = 2;
3109 }
3110 if (defined $suppress_export{$linenr} &&
3111 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003112 WARN("EXPORT_SYMBOL",
3113 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003114 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003115
Joe Eloff5150bda2010-08-09 17:21:00 -07003116# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003117 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3118 if (ERROR("GLOBAL_INITIALISERS",
3119 "do not initialise globals to 0 or NULL\n" .
3120 $herecurr) &&
3121 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003122 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003123 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003124 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003125# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003126 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3127 if (ERROR("INITIALISED_STATIC",
3128 "do not initialise statics to 0 or NULL\n" .
3129 $herecurr) &&
3130 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003131 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003132 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003133 }
3134
Joe Perches18130872014-08-06 16:11:22 -07003135# check for misordered declarations of char/short/int/long with signed/unsigned
3136 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3137 my $tmp = trim($1);
3138 WARN("MISORDERED_TYPE",
3139 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3140 }
3141
Joe Perchescb710ec2010-10-26 14:23:20 -07003142# check for static const char * arrays.
3143 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003144 WARN("STATIC_CONST_CHAR_ARRAY",
3145 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003146 $herecurr);
3147 }
3148
3149# check for static char foo[] = "bar" declarations.
3150 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003151 WARN("STATIC_CONST_CHAR_ARRAY",
3152 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003153 $herecurr);
3154 }
3155
Joe Perches9b0fa602014-04-03 14:49:18 -07003156# check for non-global char *foo[] = {"bar", ...} declarations.
3157 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3158 WARN("STATIC_CONST_CHAR_ARRAY",
3159 "char * array declaration might be better as static const\n" .
3160 $herecurr);
3161 }
3162
Joe Perchesb36190c2014-01-27 17:07:18 -08003163# check for function declarations without arguments like "int foo()"
3164 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3165 if (ERROR("FUNCTION_WITHOUT_ARGS",
3166 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3167 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003168 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003169 }
3170 }
3171
Joe Perches92e112f2013-12-13 11:36:22 -07003172# check for uses of DEFINE_PCI_DEVICE_TABLE
3173 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3174 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3175 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3176 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003177 $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 -07003178 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003179 }
3180
Andy Whitcroft653d4872007-06-23 17:16:34 -07003181# check for new typedefs, only function parameters and sparse annotations
3182# make sense.
3183 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003184 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003185 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003186 $line !~ /\b$typeTypedefs\b/ &&
Joe Perches021158b2015-02-13 14:38:43 -08003187 $line !~ /\b$typeOtherOSTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003188 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003189 WARN("NEW_TYPEDEFS",
3190 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003191 }
3192
3193# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003194 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003195 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3196 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003197 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003198
Andy Whitcroft65863862009-01-06 14:41:21 -08003199 # Should start with a space.
3200 $to =~ s/^(\S)/ $1/;
3201 # Should not end with a space.
3202 $to =~ s/\s+$//;
3203 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003204 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003205 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003206
Joe Perches3705ce52013-07-03 15:05:31 -07003207## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003208 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003209 if (ERROR("POINTER_LOCATION",
3210 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3211 $fix) {
3212 my $sub_from = $ident;
3213 my $sub_to = $ident;
3214 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003215 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003216 s@\Q$sub_from\E@$sub_to@;
3217 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003218 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003219 }
3220 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3221 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003222 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003223
Andy Whitcroft65863862009-01-06 14:41:21 -08003224 # Should start with a space.
3225 $to =~ s/^(\S)/ $1/;
3226 # Should not end with a space.
3227 $to =~ s/\s+$//;
3228 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003229 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003230 }
3231 # Modifiers should have spaces.
3232 $to =~ s/(\b$Modifier$)/$1 /;
3233
Joe Perches3705ce52013-07-03 15:05:31 -07003234## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003235 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003236 if (ERROR("POINTER_LOCATION",
3237 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3238 $fix) {
3239
3240 my $sub_from = $match;
3241 my $sub_to = $match;
3242 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003243 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003244 s@\Q$sub_from\E@$sub_to@;
3245 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003246 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003247 }
3248
3249# # no BUG() or BUG_ON()
3250# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3251# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3252# print "$herecurr";
3253# $clean = 0;
3254# }
3255
Andy Whitcroft8905a672007-11-28 16:21:06 -08003256 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003257 WARN("LINUX_VERSION_CODE",
3258 "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 -08003259 }
3260
Joe Perches17441222011-06-15 15:08:17 -07003261# check for uses of printk_ratelimit
3262 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003263 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003264 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003265 }
3266
Andy Whitcroft00df3442007-06-08 13:47:06 -07003267# printk should use KERN_* levels. Note that follow on printk's on the
3268# same line do not need a level, so we use the current block context
3269# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003270# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003271# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003272 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003273 my $ok = 0;
3274 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3275 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003276 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003277 # with "\n" ignore it, else it is to blame
3278 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3279 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3280 $ok = 1;
3281 }
3282 last;
3283 }
3284 }
3285 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003286 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3287 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003288 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003289 }
3290
Joe Perches243f3802012-05-31 16:26:09 -07003291 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3292 my $orig = $1;
3293 my $level = lc($orig);
3294 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003295 my $level2 = $level;
3296 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003297 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003298 "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 -07003299 }
3300
3301 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003302 if (WARN("PREFER_PR_LEVEL",
3303 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3304 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003305 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003306 s/\bpr_warning\b/pr_warn/;
3307 }
Joe Perches243f3802012-05-31 16:26:09 -07003308 }
3309
Joe Perchesdc139312013-02-21 16:44:13 -08003310 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3311 my $orig = $1;
3312 my $level = lc($orig);
3313 $level = "warn" if ($level eq "warning");
3314 $level = "dbg" if ($level eq "debug");
3315 WARN("PREFER_DEV_LEVEL",
3316 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3317 }
3318
Andy Whitcroft653d4872007-06-23 17:16:34 -07003319# function brace can't be on same line, except for #defines of do while,
3320# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003321 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003322 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003323 if (ERROR("OPEN_BRACE",
3324 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3325 $fix) {
3326 fix_delete_line($fixlinenr, $rawline);
3327 my $fixed_line = $rawline;
3328 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3329 my $line1 = $1;
3330 my $line2 = $2;
3331 fix_insert_line($fixlinenr, ltrim($line1));
3332 fix_insert_line($fixlinenr, "\+{");
3333 if ($line2 !~ /^\s*$/) {
3334 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3335 }
3336 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003337 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003338
Andy Whitcroft8905a672007-11-28 16:21:06 -08003339# open braces for enum, union and struct go on the same line.
3340 if ($line =~ /^.\s*{/ &&
3341 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003342 if (ERROR("OPEN_BRACE",
3343 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3344 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3345 fix_delete_line($fixlinenr - 1, $prevrawline);
3346 fix_delete_line($fixlinenr, $rawline);
3347 my $fixedline = rtrim($prevrawline) . " {";
3348 fix_insert_line($fixlinenr, $fixedline);
3349 $fixedline = $rawline;
3350 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3351 if ($fixedline !~ /^\+\s*$/) {
3352 fix_insert_line($fixlinenr, $fixedline);
3353 }
3354 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003355 }
3356
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003357# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003358 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3359 if (WARN("SPACING",
3360 "missing space after $1 definition\n" . $herecurr) &&
3361 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003362 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003363 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3364 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003365 }
3366
Joe Perches31070b52014-01-23 15:54:49 -08003367# Function pointer declarations
3368# check spacing between type, funcptr, and args
3369# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003370 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003371 my $declare = $1;
3372 my $pre_pointer_space = $2;
3373 my $post_pointer_space = $3;
3374 my $funcname = $4;
3375 my $post_funcname_space = $5;
3376 my $pre_args_space = $6;
3377
Joe Perches91f72e92014-04-03 14:49:12 -07003378# the $Declare variable will capture all spaces after the type
3379# so check it for a missing trailing missing space but pointer return types
3380# don't need a space so don't warn for those.
3381 my $post_declare_space = "";
3382 if ($declare =~ /(\s+)$/) {
3383 $post_declare_space = $1;
3384 $declare = rtrim($declare);
3385 }
3386 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003387 WARN("SPACING",
3388 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003389 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003390 }
3391
3392# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003393# This test is not currently implemented because these declarations are
3394# equivalent to
3395# int foo(int bar, ...)
3396# and this is form shouldn't/doesn't generate a checkpatch warning.
3397#
3398# elsif ($declare =~ /\s{2,}$/) {
3399# WARN("SPACING",
3400# "Multiple spaces after return type\n" . $herecurr);
3401# }
Joe Perches31070b52014-01-23 15:54:49 -08003402
3403# unnecessary space "type ( *funcptr)(args...)"
3404 if (defined $pre_pointer_space &&
3405 $pre_pointer_space =~ /^\s/) {
3406 WARN("SPACING",
3407 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3408 }
3409
3410# unnecessary space "type (* funcptr)(args...)"
3411 if (defined $post_pointer_space &&
3412 $post_pointer_space =~ /^\s/) {
3413 WARN("SPACING",
3414 "Unnecessary space before function pointer name\n" . $herecurr);
3415 }
3416
3417# unnecessary space "type (*funcptr )(args...)"
3418 if (defined $post_funcname_space &&
3419 $post_funcname_space =~ /^\s/) {
3420 WARN("SPACING",
3421 "Unnecessary space after function pointer name\n" . $herecurr);
3422 }
3423
3424# unnecessary space "type (*funcptr) (args...)"
3425 if (defined $pre_args_space &&
3426 $pre_args_space =~ /^\s/) {
3427 WARN("SPACING",
3428 "Unnecessary space before function pointer arguments\n" . $herecurr);
3429 }
3430
3431 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003432 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003433 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003434 }
3435 }
3436
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003437# check for spacing round square brackets; allowed:
3438# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003439# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3440# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003441 while ($line =~ /(.*?\s)\[/g) {
3442 my ($where, $prefix) = ($-[1], $1);
3443 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003444 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003445 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003446 if (ERROR("BRACKET_SPACE",
3447 "space prohibited before open square bracket '['\n" . $herecurr) &&
3448 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003449 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003450 s/^(\+.*?)\s+\[/$1\[/;
3451 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003452 }
3453 }
3454
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003455# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003456 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003457 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003458 my $ctx_before = substr($line, 0, $-[1]);
3459 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003460
3461 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003462 if ($name =~ /^(?:
3463 if|for|while|switch|return|case|
3464 volatile|__volatile__|
3465 __attribute__|format|__extension__|
3466 asm|__asm__)$/x)
3467 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003468 # cpp #define statements have non-optional spaces, ie
3469 # if there is a space between the name and the open
3470 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003471 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003472
3473 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003474 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003475
3476 # If this whole things ends with a type its most
3477 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003478 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003479
3480 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003481 if (WARN("SPACING",
3482 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3483 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003484 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003485 s/\b$name\s+\(/$name\(/;
3486 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003487 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003488 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003489
Andy Whitcroft653d4872007-06-23 17:16:34 -07003490# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003491 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003492 my $fixed_line = "";
3493 my $line_fixed = 0;
3494
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003495 my $ops = qr{
3496 <<=|>>=|<=|>=|==|!=|
3497 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3498 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003499 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003500 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003501 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003502 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003503
3504## print("element count: <" . $#elements . ">\n");
3505## foreach my $el (@elements) {
3506## print("el: <$el>\n");
3507## }
3508
3509 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003510 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003511
Joe Perches3705ce52013-07-03 15:05:31 -07003512 foreach my $el (@elements) {
3513 push(@fix_elements, substr($rawline, $off, length($el)));
3514 $off += length($el);
3515 }
3516
3517 $off = 0;
3518
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003519 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003520 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003521
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003522 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003523
3524 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3525
3526## print("n: <$n> good: <$good>\n");
3527
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003528 $off += length($elements[$n]);
3529
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003530 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003531 my $ca = substr($opline, 0, $off);
3532 my $cc = '';
3533 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3534 $cc = substr($opline, $off + length($elements[$n + 1]));
3535 }
3536 my $cb = "$ca$;$cc";
3537
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003538 my $a = '';
3539 $a = 'V' if ($elements[$n] ne '');
3540 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003541 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003542 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3543 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003544 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003545
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003546 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003547
3548 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003549 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003550 $c = 'V' if ($elements[$n + 2] ne '');
3551 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003552 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003553 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3554 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003555 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003556 } else {
3557 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003558 }
3559
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003560 my $ctx = "${a}x${c}";
3561
3562 my $at = "(ctx:$ctx)";
3563
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003564 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003565 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003566
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003567 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003568 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003569
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003570 # Get the full operator variant.
3571 my $opv = $op . substr($curr_vars, $off, 1);
3572
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003573 # Ignore operators passed as parameters.
3574 if ($op_type ne 'V' &&
3575 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3576
Andy Whitcroftcf655042008-03-04 14:28:20 -08003577# # Ignore comments
3578# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003579
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003580 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003581 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003582 if ($ctx !~ /.x[WEBC]/ &&
3583 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003584 if (ERROR("SPACING",
3585 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003586 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003587 $line_fixed = 1;
3588 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003589 }
3590
3591 # // is a comment
3592 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003593
Joe Perchesb00e4812014-04-03 14:49:33 -07003594 # : when part of a bitfield
3595 } elsif ($opv eq ':B') {
3596 # skip the bitfield test for now
3597
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003598 # No spaces for:
3599 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003600 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003601 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003602 if (ERROR("SPACING",
3603 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003604 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003605 if (defined $fix_elements[$n + 2]) {
3606 $fix_elements[$n + 2] =~ s/^\s+//;
3607 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003608 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003609 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003610 }
3611
Joe Perches23810972014-12-10 15:51:32 -08003612 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003613 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003614 my $rtrim_before = 0;
3615 my $space_after = 0;
3616 if ($ctx =~ /Wx./) {
3617 if (ERROR("SPACING",
3618 "space prohibited before that '$op' $at\n" . $hereptr)) {
3619 $line_fixed = 1;
3620 $rtrim_before = 1;
3621 }
3622 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003623 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003624 if (ERROR("SPACING",
3625 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003626 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003627 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003628 $space_after = 1;
3629 }
3630 }
3631 if ($rtrim_before || $space_after) {
3632 if ($rtrim_before) {
3633 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3634 } else {
3635 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3636 }
3637 if ($space_after) {
3638 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003639 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003640 }
3641
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003642 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003643 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003644 #warn "'*' is part of type\n";
3645
3646 # unary operators should have a space before and
3647 # none after. May be left adjacent to another
3648 # unary operator, or a cast
3649 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003650 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003651 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003652 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003653 if (ERROR("SPACING",
3654 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003655 if ($n != $last_after + 2) {
3656 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3657 $line_fixed = 1;
3658 }
Joe Perches3705ce52013-07-03 15:05:31 -07003659 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003660 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003661 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003662 # A unary '*' may be const
3663
3664 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003665 if (ERROR("SPACING",
3666 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003667 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003668 if (defined $fix_elements[$n + 2]) {
3669 $fix_elements[$n + 2] =~ s/^\s+//;
3670 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003671 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003672 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003673 }
3674
3675 # unary ++ and unary -- are allowed no space on one side.
3676 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003677 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003678 if (ERROR("SPACING",
3679 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003680 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003681 $line_fixed = 1;
3682 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003683 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003684 if ($ctx =~ /Wx[BE]/ ||
3685 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003686 if (ERROR("SPACING",
3687 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003688 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003689 $line_fixed = 1;
3690 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003691 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003692 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003693 if (ERROR("SPACING",
3694 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003695 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003696 if (defined $fix_elements[$n + 2]) {
3697 $fix_elements[$n + 2] =~ s/^\s+//;
3698 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003699 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003700 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003701 }
3702
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003703 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003704 } elsif ($op eq '<<' or $op eq '>>' or
3705 $op eq '&' or $op eq '^' or $op eq '|' or
3706 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003707 $op eq '*' or $op eq '/' or
3708 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003709 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08003710 if ($check) {
3711 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
3712 if (CHK("SPACING",
3713 "spaces preferred around that '$op' $at\n" . $hereptr)) {
3714 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3715 $fix_elements[$n + 2] =~ s/^\s+//;
3716 $line_fixed = 1;
3717 }
3718 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
3719 if (CHK("SPACING",
3720 "space preferred before that '$op' $at\n" . $hereptr)) {
3721 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
3722 $line_fixed = 1;
3723 }
3724 }
3725 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003726 if (ERROR("SPACING",
3727 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003728 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3729 if (defined $fix_elements[$n + 2]) {
3730 $fix_elements[$n + 2] =~ s/^\s+//;
3731 }
Joe Perches3705ce52013-07-03 15:05:31 -07003732 $line_fixed = 1;
3733 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003734 }
3735
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003736 # A colon needs no spaces before when it is
3737 # terminating a case value or a label.
3738 } elsif ($opv eq ':C' || $opv eq ':L') {
3739 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003740 if (ERROR("SPACING",
3741 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003742 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003743 $line_fixed = 1;
3744 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003745 }
3746
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003747 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003748 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003749 my $ok = 0;
3750
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003751 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003752 if (($op eq '<' &&
3753 $cc =~ /^\S+\@\S+>/) ||
3754 ($op eq '>' &&
3755 $ca =~ /<\S+\@\S+$/))
3756 {
3757 $ok = 1;
3758 }
3759
Joe Perches84731622013-11-12 15:10:05 -08003760 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003761 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003762 my $msg_type = \&ERROR;
3763 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3764
3765 if (&{$msg_type}("SPACING",
3766 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003767 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3768 if (defined $fix_elements[$n + 2]) {
3769 $fix_elements[$n + 2] =~ s/^\s+//;
3770 }
Joe Perches3705ce52013-07-03 15:05:31 -07003771 $line_fixed = 1;
3772 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003773 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003774 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003775 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003776
3777## print("n: <$n> GOOD: <$good>\n");
3778
3779 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003780 }
Joe Perches3705ce52013-07-03 15:05:31 -07003781
3782 if (($#elements % 2) == 0) {
3783 $fixed_line = $fixed_line . $fix_elements[$#elements];
3784 }
3785
Joe Perches194f66f2014-08-06 16:11:03 -07003786 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3787 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003788 }
3789
3790
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003791 }
3792
Joe Perches786b6322013-07-03 15:05:32 -07003793# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003794 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003795 if (WARN("SPACING",
3796 "space prohibited before semicolon\n" . $herecurr) &&
3797 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003798 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003799 s/^(\+.*\S)\s+;/$1;/;
3800 }
3801 }
3802
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003803# check for multiple assignments
3804 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003805 CHK("MULTIPLE_ASSIGNMENTS",
3806 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003807 }
3808
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003809## # check for multiple declarations, allowing for a function declaration
3810## # continuation.
3811## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3812## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3813##
3814## # Remove any bracketed sections to ensure we do not
3815## # falsly report the parameters of functions.
3816## my $ln = $line;
3817## while ($ln =~ s/\([^\(\)]*\)//g) {
3818## }
3819## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003820## WARN("MULTIPLE_DECLARATION",
3821## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003822## }
3823## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003824
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003825#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003826 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3827 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003828 if (ERROR("SPACING",
3829 "space required before the open brace '{'\n" . $herecurr) &&
3830 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003831 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003832 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003833 }
3834
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003835## # check for blank lines before declarations
3836## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3837## $prevrawline =~ /^.\s*$/) {
3838## WARN("SPACING",
3839## "No blank lines before declarations\n" . $hereprev);
3840## }
3841##
3842
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003843# closing brace should have a space following it when it has anything
3844# on the line
3845 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003846 if (ERROR("SPACING",
3847 "space required after that close brace '}'\n" . $herecurr) &&
3848 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003849 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003850 s/}((?!(?:,|;|\)))\S)/} $1/;
3851 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003852 }
3853
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003854# check spacing on square brackets
3855 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003856 if (ERROR("SPACING",
3857 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3858 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003859 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003860 s/\[\s+/\[/;
3861 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003862 }
3863 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003864 if (ERROR("SPACING",
3865 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3866 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003867 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003868 s/\s+\]/\]/;
3869 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003870 }
3871
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003872# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003873 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3874 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003875 if (ERROR("SPACING",
3876 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3877 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003878 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003879 s/\(\s+/\(/;
3880 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003881 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003882 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003883 $line !~ /for\s*\(.*;\s+\)/ &&
3884 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003885 if (ERROR("SPACING",
3886 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3887 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003888 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003889 s/\s+\)/\)/;
3890 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003891 }
3892
Joe Perchese2826fd2014-08-06 16:10:48 -07003893# check unnecessary parentheses around addressof/dereference single $Lvals
3894# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3895
3896 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08003897 my $var = $1;
3898 if (CHK("UNNECESSARY_PARENTHESES",
3899 "Unnecessary parentheses around $var\n" . $herecurr) &&
3900 $fix) {
3901 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3902 }
3903 }
3904
3905# check for unnecessary parentheses around function pointer uses
3906# ie: (foo->bar)(); should be foo->bar();
3907# but not "if (foo->bar) (" to avoid some false positives
3908 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3909 my $var = $2;
3910 if (CHK("UNNECESSARY_PARENTHESES",
3911 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3912 $fix) {
3913 my $var2 = deparenthesize($var);
3914 $var2 =~ s/\s//g;
3915 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3916 }
3917 }
Joe Perchese2826fd2014-08-06 16:10:48 -07003918
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003919#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003920 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003921 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003922 if (WARN("INDENTED_LABEL",
3923 "labels should not be indented\n" . $herecurr) &&
3924 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003925 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003926 s/^(.)\s+/$1/;
3927 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003928 }
3929
Joe Perches5b9553a2014-04-03 14:49:21 -07003930# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003931 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003932 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003933 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003934 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3935 my $value = $1;
3936 $value = deparenthesize($value);
3937 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3938 ERROR("RETURN_PARENTHESES",
3939 "return is not a function, parentheses are not required\n" . $herecurr);
3940 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003941 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003942 ERROR("SPACING",
3943 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003944 }
3945 }
Joe Perches507e5142013-11-12 15:10:13 -08003946
Joe Perchesb43ae212014-06-23 13:22:07 -07003947# unnecessary return in a void function
3948# at end-of-function, with the previous line a single leading tab, then return;
3949# and the line before that not a goto label target like "out:"
3950 if ($sline =~ /^[ \+]}\s*$/ &&
3951 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3952 $linenr >= 3 &&
3953 $lines[$linenr - 3] =~ /^[ +]/ &&
3954 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003955 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003956 "void function return statements are not generally useful\n" . $hereprev);
3957 }
Joe Perches9819cf22014-06-04 16:12:09 -07003958
Joe Perches189248d2014-01-23 15:54:47 -08003959# if statements using unnecessary parentheses - ie: if ((foo == bar))
3960 if ($^V && $^V ge 5.10.0 &&
3961 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3962 my $openparens = $1;
3963 my $count = $openparens =~ tr@\(@\(@;
3964 my $msg = "";
3965 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3966 my $comp = $4; #Not $1 because of $LvalOrFunc
3967 $msg = " - maybe == should be = ?" if ($comp eq "==");
3968 WARN("UNNECESSARY_PARENTHESES",
3969 "Unnecessary parentheses$msg\n" . $herecurr);
3970 }
3971 }
3972
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003973# Return of what appears to be an errno should normally be -'ve
3974 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3975 my $name = $1;
3976 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003977 WARN("USE_NEGATIVE_ERRNO",
3978 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003979 }
3980 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003981
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003982# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003983 if ($line =~ /\b(if|while|for|switch)\(/) {
3984 if (ERROR("SPACING",
3985 "space required before the open parenthesis '('\n" . $herecurr) &&
3986 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003987 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003988 s/\b(if|while|for|switch)\(/$1 \(/;
3989 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003990 }
3991
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003992# Check for illegal assignment in if conditional -- and check for trailing
3993# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003994 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003995 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3996 ctx_statement_block($linenr, $realcnt, 0)
3997 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003998 my ($stat_next) = ctx_statement_block($line_nr_next,
3999 $remain_next, $off_next);
4000 $stat_next =~ s/\n./\n /g;
4001 ##print "stat<$stat> stat_next<$stat_next>\n";
4002
4003 if ($stat_next =~ /^\s*while\b/) {
4004 # If the statement carries leading newlines,
4005 # then count those as offsets.
4006 my ($whitespace) =
4007 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4008 my $offset =
4009 statement_rawlines($whitespace) - 1;
4010
4011 $suppress_whiletrailers{$line_nr_next +
4012 $offset} = 1;
4013 }
4014 }
4015 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004016 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004017 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004018 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004019
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004020 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004021 ERROR("ASSIGN_IN_IF",
4022 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004023 }
4024
4025 # Find out what is on the end of the line after the
4026 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004027 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004028 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004029 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004030 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4031 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004032 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004033 # Find out how long the conditional actually is.
4034 my @newlines = ($c =~ /\n/gs);
4035 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004036 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004037
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004038 $stat_real = raw_line($linenr, $cond_lines)
4039 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004040 if (defined($stat_real) && $cond_lines > 1) {
4041 $stat_real = "[...]\n$stat_real";
4042 }
4043
Joe Perches000d1cc12011-07-25 17:13:25 -07004044 ERROR("TRAILING_STATEMENTS",
4045 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004046 }
4047 }
4048
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004049# Check for bitwise tests written as boolean
4050 if ($line =~ /
4051 (?:
4052 (?:\[|\(|\&\&|\|\|)
4053 \s*0[xX][0-9]+\s*
4054 (?:\&\&|\|\|)
4055 |
4056 (?:\&\&|\|\|)
4057 \s*0[xX][0-9]+\s*
4058 (?:\&\&|\|\||\)|\])
4059 )/x)
4060 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004061 WARN("HEXADECIMAL_BOOLEAN_TEST",
4062 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004063 }
4064
Andy Whitcroft8905a672007-11-28 16:21:06 -08004065# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004066 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4067 my $s = $1;
4068 $s =~ s/$;//g; # Remove any comments
4069 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004070 ERROR("TRAILING_STATEMENTS",
4071 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004072 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004073 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004074# if should not continue a brace
4075 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004076 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004077 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004078 $herecurr);
4079 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004080# case and default should not have general statements after them
4081 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4082 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004083 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004084 \s*return\s+
4085 )/xg)
4086 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004087 ERROR("TRAILING_STATEMENTS",
4088 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004089 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004090
4091 # Check for }<nl>else {, these must be at the same
4092 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004093 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4094 $previndent == $indent) {
4095 if (ERROR("ELSE_AFTER_BRACE",
4096 "else should follow close brace '}'\n" . $hereprev) &&
4097 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4098 fix_delete_line($fixlinenr - 1, $prevrawline);
4099 fix_delete_line($fixlinenr, $rawline);
4100 my $fixedline = $prevrawline;
4101 $fixedline =~ s/}\s*$//;
4102 if ($fixedline !~ /^\+\s*$/) {
4103 fix_insert_line($fixlinenr, $fixedline);
4104 }
4105 $fixedline = $rawline;
4106 $fixedline =~ s/^(.\s*)else/$1} else/;
4107 fix_insert_line($fixlinenr, $fixedline);
4108 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004109 }
4110
Joe Perches8b8856f2014-08-06 16:11:14 -07004111 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4112 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004113 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4114
4115 # Find out what is on the end of the line after the
4116 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004117 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004118 $s =~ s/\n.*//g;
4119
4120 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004121 if (ERROR("WHILE_AFTER_BRACE",
4122 "while should follow close brace '}'\n" . $hereprev) &&
4123 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4124 fix_delete_line($fixlinenr - 1, $prevrawline);
4125 fix_delete_line($fixlinenr, $rawline);
4126 my $fixedline = $prevrawline;
4127 my $trailing = $rawline;
4128 $trailing =~ s/^\+//;
4129 $trailing = trim($trailing);
4130 $fixedline =~ s/}\s*$/} $trailing/;
4131 fix_insert_line($fixlinenr, $fixedline);
4132 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004133 }
4134 }
4135
Joe Perches95e2c602013-07-03 15:05:20 -07004136#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004137 while ($line =~ m{($Constant|$Lval)}g) {
4138 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004139
4140#gcc binary extension
4141 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004142 if (WARN("GCC_BINARY_CONSTANT",
4143 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4144 $fix) {
4145 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004146 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004147 s/\b$var\b/$hexval/;
4148 }
Joe Perches95e2c602013-07-03 15:05:20 -07004149 }
4150
4151#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004152 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004153 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004154#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004155 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004156#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004157 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4158#Ignore some three character SI units explicitly, like MiB and KHz
4159 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004160 while ($var =~ m{($Ident)}g) {
4161 my $word = $1;
4162 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004163 if ($check) {
4164 seed_camelcase_includes();
4165 if (!$file && !$camelcase_file_seeded) {
4166 seed_camelcase_file($realfile);
4167 $camelcase_file_seeded = 1;
4168 }
4169 }
Joe Perches7e781f62013-09-11 14:23:55 -07004170 if (!defined $camelcase{$word}) {
4171 $camelcase{$word} = 1;
4172 CHK("CAMELCASE",
4173 "Avoid CamelCase: <$word>\n" . $herecurr);
4174 }
Joe Perches34456862013-07-03 15:05:34 -07004175 }
Joe Perches323c1262012-12-17 16:02:07 -08004176 }
4177 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004178
4179#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004180 if ($line =~ /\#\s*define.*\\\s+$/) {
4181 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4182 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4183 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004184 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004185 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004186 }
4187
Andy Whitcroft653d4872007-06-23 17:16:34 -07004188#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004189 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004190 my $file = "$1.h";
4191 my $checkfile = "include/linux/$file";
4192 if (-f "$root/$checkfile" &&
4193 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004194 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004195 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004196 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004197 CHK("ARCH_INCLUDE_LINUX",
4198 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004199 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004200 WARN("INCLUDE_LINUX",
4201 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004202 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004203 }
4204 }
4205
Andy Whitcroft653d4872007-06-23 17:16:34 -07004206# multi-statement macros should be enclosed in a do while loop, grab the
4207# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004208# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004209 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4210 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004211 my $ln = $linenr;
4212 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004213 my ($off, $dstat, $dcond, $rest);
4214 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004215 my $has_flow_statement = 0;
4216 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004217 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004218 ctx_statement_block($linenr, $realcnt, 0);
4219 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004220 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004221 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004222
Joe Perches08a28432014-10-13 15:51:55 -07004223 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4224 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4225
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004226 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004227 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004228 $dstat =~ s/\\\n.//g;
4229 $dstat =~ s/^\s*//s;
4230 $dstat =~ s/\s*$//s;
4231
4232 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004233 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4234 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004235 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004236 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004237 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004238
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004239 # Flatten any obvious string concatentation.
4240 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4241 $dstat =~ s/$Ident\s*("X*")/$1/)
4242 {
4243 }
4244
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004245 my $exceptions = qr{
4246 $Declare|
4247 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004248 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004249 DECLARE_PER_CPU|
4250 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004251 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004252 union|
4253 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004254 \.$Ident\s*=\s*|
4255 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004256 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004257 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004258 if ($dstat ne '' &&
4259 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4260 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004261 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004262 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004263 $dstat !~ /$exceptions/ &&
4264 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004265 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004266 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004267 $dstat !~ /^for\s*$Constant$/ && # for (...)
4268 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4269 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004270 $dstat !~ /^\({/ && # ({...
4271 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004272 {
4273 $ctx =~ s/\n*$//;
4274 my $herectx = $here . "\n";
4275 my $cnt = statement_rawlines($ctx);
4276
4277 for (my $n = 0; $n < $cnt; $n++) {
4278 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004279 }
4280
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004281 if ($dstat =~ /;/) {
4282 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4283 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4284 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004285 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004286 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004287 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004288 }
Joe Perches5023d342012-12-17 16:01:47 -08004289
Joe Perches08a28432014-10-13 15:51:55 -07004290# check for macros with flow control, but without ## concatenation
4291# ## concatenation is commonly a macro that defines a function so ignore those
4292 if ($has_flow_statement && !$has_arg_concat) {
4293 my $herectx = $here . "\n";
4294 my $cnt = statement_rawlines($ctx);
4295
4296 for (my $n = 0; $n < $cnt; $n++) {
4297 $herectx .= raw_line($linenr, $n) . "\n";
4298 }
4299 WARN("MACRO_WITH_FLOW_CONTROL",
4300 "Macros with flow control statements should be avoided\n" . "$herectx");
4301 }
4302
Joe Perches481eb482012-12-17 16:01:56 -08004303# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004304
4305 } else {
4306 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004307 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4308 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004309 $line =~ /^\+.*\\$/) {
4310 WARN("LINE_CONTINUATIONS",
4311 "Avoid unnecessary line continuations\n" . $herecurr);
4312 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004313 }
4314
Joe Perchesb13edf72012-07-30 14:41:24 -07004315# do {} while (0) macro tests:
4316# single-statement macros do not need to be enclosed in do while (0) loop,
4317# macro should not end with a semicolon
4318 if ($^V && $^V ge 5.10.0 &&
4319 $realfile !~ m@/vmlinux.lds.h$@ &&
4320 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4321 my $ln = $linenr;
4322 my $cnt = $realcnt;
4323 my ($off, $dstat, $dcond, $rest);
4324 my $ctx = '';
4325 ($dstat, $dcond, $ln, $cnt, $off) =
4326 ctx_statement_block($linenr, $realcnt, 0);
4327 $ctx = $dstat;
4328
4329 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004330 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004331
4332 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4333 my $stmts = $2;
4334 my $semis = $3;
4335
4336 $ctx =~ s/\n*$//;
4337 my $cnt = statement_rawlines($ctx);
4338 my $herectx = $here . "\n";
4339
4340 for (my $n = 0; $n < $cnt; $n++) {
4341 $herectx .= raw_line($linenr, $n) . "\n";
4342 }
4343
Joe Perchesac8e97f2012-08-21 16:15:53 -07004344 if (($stmts =~ tr/;/;/) == 1 &&
4345 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004346 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4347 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4348 }
4349 if (defined $semis && $semis ne "") {
4350 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4351 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4352 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004353 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4354 $ctx =~ s/\n*$//;
4355 my $cnt = statement_rawlines($ctx);
4356 my $herectx = $here . "\n";
4357
4358 for (my $n = 0; $n < $cnt; $n++) {
4359 $herectx .= raw_line($linenr, $n) . "\n";
4360 }
4361
4362 WARN("TRAILING_SEMICOLON",
4363 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004364 }
4365 }
4366
Mike Frysinger080ba922009-01-06 14:41:25 -08004367# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4368# all assignments may have only one of the following with an assignment:
4369# .
4370# ALIGN(...)
4371# VMLINUX_SYMBOL(...)
4372 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004373 WARN("MISSING_VMLINUX_SYMBOL",
4374 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004375 }
4376
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004377# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004378 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4379 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004380 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004381 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004382 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4383 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004384 my @allowed = ();
4385 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004386 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004387 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004388 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004389 for my $chunk (@chunks) {
4390 my ($cond, $block) = @{$chunk};
4391
Andy Whitcroft773647a2008-03-28 14:15:58 -07004392 # If the condition carries leading newlines, then count those as offsets.
4393 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4394 my $offset = statement_rawlines($whitespace) - 1;
4395
Joe Perchesaad4f612012-03-23 15:02:19 -07004396 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004397 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4398
4399 # We have looked at and allowed this specific line.
4400 $suppress_ifbraces{$ln + $offset} = 1;
4401
4402 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004403 $ln += statement_rawlines($block) - 1;
4404
Andy Whitcroft773647a2008-03-28 14:15:58 -07004405 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004406
4407 $seen++ if ($block =~ /^\s*{/);
4408
Joe Perchesaad4f612012-03-23 15:02:19 -07004409 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004410 if (statement_lines($cond) > 1) {
4411 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004412 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004413 }
4414 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004415 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004416 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004417 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004418 if (statement_block_size($block) > 1) {
4419 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004420 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004421 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004422 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004423 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004424 if ($seen) {
4425 my $sum_allowed = 0;
4426 foreach (@allowed) {
4427 $sum_allowed += $_;
4428 }
4429 if ($sum_allowed == 0) {
4430 WARN("BRACES",
4431 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4432 } elsif ($sum_allowed != $allow &&
4433 $seen != $allow) {
4434 CHK("BRACES",
4435 "braces {} should be used on all arms of this statement\n" . $herectx);
4436 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004437 }
4438 }
4439 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004440 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004441 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004442 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004443
Andy Whitcroftcf655042008-03-04 14:28:20 -08004444 # Check the pre-context.
4445 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4446 #print "APW: ALLOWED: pre<$1>\n";
4447 $allowed = 1;
4448 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004449
4450 my ($level, $endln, @chunks) =
4451 ctx_statement_full($linenr, $realcnt, $-[0]);
4452
Andy Whitcroftcf655042008-03-04 14:28:20 -08004453 # Check the condition.
4454 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004455 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004456 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004457 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004458 }
4459 if (statement_lines($cond) > 1) {
4460 #print "APW: ALLOWED: cond<$cond>\n";
4461 $allowed = 1;
4462 }
4463 if ($block =~/\b(?:if|for|while)\b/) {
4464 #print "APW: ALLOWED: block<$block>\n";
4465 $allowed = 1;
4466 }
4467 if (statement_block_size($block) > 1) {
4468 #print "APW: ALLOWED: lines block<$block>\n";
4469 $allowed = 1;
4470 }
4471 # Check the post-context.
4472 if (defined $chunks[1]) {
4473 my ($cond, $block) = @{$chunks[1]};
4474 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004475 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004476 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004477 if ($block =~ /^\s*\{/) {
4478 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4479 $allowed = 1;
4480 }
4481 }
4482 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004483 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004484 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004485
Andy Whitcroftf0556632008-10-15 22:02:23 -07004486 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004487 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004488 }
4489
Joe Perches000d1cc12011-07-25 17:13:25 -07004490 WARN("BRACES",
4491 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004492 }
4493 }
4494
Joe Perches0979ae62012-12-17 16:01:59 -08004495# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004496 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004497 if (CHK("BRACES",
4498 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4499 $fix && $prevrawline =~ /^\+/) {
4500 fix_delete_line($fixlinenr - 1, $prevrawline);
4501 }
Joe Perches0979ae62012-12-17 16:01:59 -08004502 }
Joe Perches77b9a532013-07-03 15:05:29 -07004503 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004504 if (CHK("BRACES",
4505 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4506 $fix) {
4507 fix_delete_line($fixlinenr, $rawline);
4508 }
Joe Perches0979ae62012-12-17 16:01:59 -08004509 }
4510
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004511# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004512 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4513 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004514 WARN("VOLATILE",
4515 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004516 }
4517
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004518# Check for user-visible strings broken across lines, which breaks the ability
4519# to grep for the string. Make exceptions when the previous string ends in a
4520# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4521# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4522 if ($line =~ /^\+\s*"[X\t]*"/ &&
4523 $prevline =~ /"\s*$/ &&
4524 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4525 if (WARN("SPLIT_STRING",
4526 "quoted string split across lines\n" . $hereprev) &&
4527 $fix &&
4528 $prevrawline =~ /^\+.*"\s*$/ &&
4529 $last_coalesced_string_linenr != $linenr - 1) {
4530 my $extracted_string = get_quoted_string($line, $rawline);
4531 my $comma_close = "";
4532 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4533 $comma_close = $1;
4534 }
4535
4536 fix_delete_line($fixlinenr - 1, $prevrawline);
4537 fix_delete_line($fixlinenr, $rawline);
4538 my $fixedline = $prevrawline;
4539 $fixedline =~ s/"\s*$//;
4540 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4541 fix_insert_line($fixlinenr - 1, $fixedline);
4542 $fixedline = $rawline;
4543 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4544 if ($fixedline !~ /\+\s*$/) {
4545 fix_insert_line($fixlinenr, $fixedline);
4546 }
4547 $last_coalesced_string_linenr = $linenr;
4548 }
4549 }
4550
4551# check for missing a space in a string concatenation
4552 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4553 WARN('MISSING_SPACE',
4554 "break quoted strings at a space character\n" . $hereprev);
4555 }
4556
4557# check for spaces before a quoted newline
4558 if ($rawline =~ /^.*\".*\s\\n/) {
4559 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4560 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4561 $fix) {
4562 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4563 }
4564
4565 }
4566
Joe Perchesf17dba42014-10-13 15:51:51 -07004567# concatenated string without spaces between elements
4568 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4569 CHK("CONCATENATED_STRING",
4570 "Concatenated strings should use spaces between elements\n" . $herecurr);
4571 }
4572
Joe Perches90ad30e2014-12-10 15:51:59 -08004573# uncoalesced string fragments
4574 if ($line =~ /"X*"\s*"/) {
4575 WARN("STRING_FRAGMENTS",
4576 "Consecutive strings are generally better as a single string\n" . $herecurr);
4577 }
4578
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004579# check for %L{u,d,i} in strings
4580 my $string;
4581 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4582 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4583 $string =~ s/%%/__/g;
4584 if ($string =~ /(?<!%)%L[udi]/) {
4585 WARN("PRINTF_L",
4586 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4587 last;
4588 }
4589 }
4590
4591# check for line continuations in quoted strings with odd counts of "
4592 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4593 WARN("LINE_CONTINUATIONS",
4594 "Avoid line continuations in quoted strings\n" . $herecurr);
4595 }
4596
Andy Whitcroft00df3442007-06-08 13:47:06 -07004597# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004598 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004599 CHK("REDUNDANT_CODE",
4600 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004601 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004602 }
4603
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004604# check for needless "if (<foo>) fn(<foo>)" uses
4605 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4606 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4607 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4608 WARN('NEEDLESS_IF',
Fabio Estevam15160f92014-12-10 15:51:40 -08004609 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004610 }
4611 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004612
Joe Perchesebfdc402014-08-06 16:10:27 -07004613# check for unnecessary "Out of Memory" messages
4614 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4615 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4616 (defined $1 || defined $3) &&
4617 $linenr > 3) {
4618 my $testval = $2;
4619 my $testline = $lines[$linenr - 3];
4620
4621 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4622# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4623
4624 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4625 WARN("OOM_MESSAGE",
4626 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4627 }
4628 }
4629
Joe Perchesf78d98f2014-10-13 15:52:01 -07004630# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08004631 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07004632 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4633 my $level = $1;
4634 if (WARN("UNNECESSARY_KERN_LEVEL",
4635 "Possible unnecessary $level\n" . $herecurr) &&
4636 $fix) {
4637 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4638 }
4639 }
4640
Joe Perchesabb08a52014-12-10 15:51:46 -08004641# check for mask then right shift without a parentheses
4642 if ($^V && $^V ge 5.10.0 &&
4643 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4644 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4645 WARN("MASK_THEN_SHIFT",
4646 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4647 }
4648
Joe Perchesb75ac612014-12-10 15:52:02 -08004649# check for pointer comparisons to NULL
4650 if ($^V && $^V ge 5.10.0) {
4651 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4652 my $val = $1;
4653 my $equal = "!";
4654 $equal = "" if ($4 eq "!=");
4655 if (CHK("COMPARISON_TO_NULL",
4656 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4657 $fix) {
4658 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4659 }
4660 }
4661 }
4662
Joe Perches8716de32013-09-11 14:24:05 -07004663# check for bad placement of section $InitAttribute (e.g.: __initdata)
4664 if ($line =~ /(\b$InitAttribute\b)/) {
4665 my $attr = $1;
4666 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4667 my $ptr = $1;
4668 my $var = $2;
4669 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4670 ERROR("MISPLACED_INIT",
4671 "$attr should be placed after $var\n" . $herecurr)) ||
4672 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4673 WARN("MISPLACED_INIT",
4674 "$attr should be placed after $var\n" . $herecurr))) &&
4675 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004676 $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 -07004677 }
4678 }
4679 }
4680
Joe Perchese970b8842013-11-12 15:10:10 -08004681# check for $InitAttributeData (ie: __initdata) with const
4682 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4683 my $attr = $1;
4684 $attr =~ /($InitAttributePrefix)(.*)/;
4685 my $attr_prefix = $1;
4686 my $attr_type = $2;
4687 if (ERROR("INIT_ATTRIBUTE",
4688 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4689 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004690 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004691 s/$InitAttributeData/${attr_prefix}initconst/;
4692 }
4693 }
4694
4695# check for $InitAttributeConst (ie: __initconst) without const
4696 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4697 my $attr = $1;
4698 if (ERROR("INIT_ATTRIBUTE",
4699 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4700 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004701 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004702 /(^\+\s*(?:static\s+))/;
4703 $lead = rtrim($1);
4704 $lead = "$lead " if ($lead !~ /^\+$/);
4705 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004706 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08004707 }
4708 }
4709
Joe Perchesfbdb8132014-04-03 14:49:14 -07004710# don't use __constant_<foo> functions outside of include/uapi/
4711 if ($realfile !~ m@^include/uapi/@ &&
4712 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4713 my $constant_func = $1;
4714 my $func = $constant_func;
4715 $func =~ s/^__constant_//;
4716 if (WARN("CONSTANT_CONVERSION",
4717 "$constant_func should be $func\n" . $herecurr) &&
4718 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004719 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004720 }
4721 }
4722
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004723# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004724 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004725 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004726 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004727 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004728 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004729 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4730 }
4731 if ($delay > 2000) {
4732 WARN("LONG_UDELAY",
4733 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004734 }
4735 }
4736
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004737# warn about unexpectedly long msleep's
4738 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4739 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004740 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004741 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004742 }
4743 }
4744
Joe Perches36ec1932013-07-03 15:05:25 -07004745# check for comparisons of jiffies
4746 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4747 WARN("JIFFIES_COMPARISON",
4748 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4749 }
4750
Joe Perches9d7a34a2013-07-03 15:05:26 -07004751# check for comparisons of get_jiffies_64()
4752 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4753 WARN("JIFFIES_COMPARISON",
4754 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4755 }
4756
Andy Whitcroft00df3442007-06-08 13:47:06 -07004757# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004758# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004759# print "#ifdef in C files should be avoided\n";
4760# print "$herecurr";
4761# $clean = 0;
4762# }
4763
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004764# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004765 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004766 if (ERROR("SPACING",
4767 "exactly one space required after that #$1\n" . $herecurr) &&
4768 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004769 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004770 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4771 }
4772
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004773 }
4774
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004775# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004776 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4777 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004778 my $which = $1;
4779 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004780 CHK("UNCOMMENTED_DEFINITION",
4781 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004782 }
4783 }
4784# check for memory barriers without a comment.
4785 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4786 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004787 WARN("MEMORY_BARRIER",
4788 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004789 }
4790 }
4791# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004792 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004793 CHK("ARCH_DEFINES",
4794 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004795 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004796
Tobias Klauserd4977c72010-05-24 14:33:30 -07004797# Check that the storage class is at the beginning of a declaration
4798 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004799 WARN("STORAGE_CLASS",
4800 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004801 }
4802
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004803# check the location of the inline attribute, that it is between
4804# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004805 if ($line =~ /\b$Type\s+$Inline\b/ ||
4806 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004807 ERROR("INLINE_LOCATION",
4808 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004809 }
4810
Andy Whitcroft8905a672007-11-28 16:21:06 -08004811# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004812 if ($realfile !~ m@\binclude/uapi/@ &&
4813 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004814 if (WARN("INLINE",
4815 "plain inline is preferred over $1\n" . $herecurr) &&
4816 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004817 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004818
4819 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004820 }
4821
Joe Perches3d130fd2011-01-12 17:00:00 -08004822# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004823 if ($realfile !~ m@\binclude/uapi/@ &&
4824 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004825 WARN("PREFER_PACKED",
4826 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004827 }
4828
Joe Perches39b7e282011-07-25 17:13:24 -07004829# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004830 if ($realfile !~ m@\binclude/uapi/@ &&
4831 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004832 WARN("PREFER_ALIGNED",
4833 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004834 }
4835
Joe Perches5f14d3b2012-01-10 15:09:52 -08004836# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004837 if ($realfile !~ m@\binclude/uapi/@ &&
4838 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004839 if (WARN("PREFER_PRINTF",
4840 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4841 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004842 $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 -07004843
4844 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004845 }
4846
Joe Perches6061d942012-03-23 15:02:16 -07004847# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004848 if ($realfile !~ m@\binclude/uapi/@ &&
4849 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004850 if (WARN("PREFER_SCANF",
4851 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4852 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004853 $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 -07004854 }
Joe Perches6061d942012-03-23 15:02:16 -07004855 }
4856
Joe Perches619a9082014-12-10 15:51:35 -08004857# Check for __attribute__ weak, or __weak declarations (may have link issues)
4858 if ($^V && $^V ge 5.10.0 &&
4859 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4860 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4861 $line =~ /\b__weak\b/)) {
4862 ERROR("WEAK_DECLARATION",
4863 "Using weak declarations can have unintended link defects\n" . $herecurr);
4864 }
4865
Joe Perches8f53a9b2010-03-05 13:43:48 -08004866# check for sizeof(&)
4867 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004868 WARN("SIZEOF_ADDRESS",
4869 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004870 }
4871
Joe Perches66c80b62012-07-30 14:41:22 -07004872# check for sizeof without parenthesis
4873 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004874 if (WARN("SIZEOF_PARENTHESIS",
4875 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4876 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004877 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004878 }
Joe Perches66c80b62012-07-30 14:41:22 -07004879 }
4880
Joe Perches88982fe2012-12-17 16:02:00 -08004881# check for struct spinlock declarations
4882 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4883 WARN("USE_SPINLOCK_T",
4884 "struct spinlock should be spinlock_t\n" . $herecurr);
4885 }
4886
Joe Perchesa6962d72013-04-29 16:18:13 -07004887# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004888 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004889 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08004890 $fmt =~ s/%%//g;
4891 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004892 if (WARN("PREFER_SEQ_PUTS",
4893 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4894 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004895 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004896 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004897 }
4898 }
4899
Andy Whitcroft554e1652012-01-10 15:09:57 -08004900# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004901 if ($^V && $^V ge 5.10.0 &&
4902 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004903 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004904
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004905 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004906 my $ms_val = $7;
4907 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004908
Andy Whitcroft554e1652012-01-10 15:09:57 -08004909 if ($ms_size =~ /^(0x|)0$/i) {
4910 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004911 "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 -08004912 } elsif ($ms_size =~ /^(0x|)1$/i) {
4913 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004914 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4915 }
4916 }
4917
Joe Perches98a9bba2014-01-23 15:54:52 -08004918# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4919 if ($^V && $^V ge 5.10.0 &&
4920 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4921 if (WARN("PREFER_ETHER_ADDR_COPY",
4922 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4923 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004924 $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 -08004925 }
4926 }
4927
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004928# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004929 if ($^V && $^V ge 5.10.0 &&
4930 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004931 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004932 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004933 my $call = $1;
4934 my $cast1 = deparenthesize($2);
4935 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004936 my $cast2 = deparenthesize($7);
4937 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004938 my $cast;
4939
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004940 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004941 $cast = "$cast1 or $cast2";
4942 } elsif ($cast1 ne "") {
4943 $cast = $cast1;
4944 } else {
4945 $cast = $cast2;
4946 }
4947 WARN("MINMAX",
4948 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004949 }
4950 }
4951
Joe Perches4a273192012-07-30 14:41:20 -07004952# check usleep_range arguments
4953 if ($^V && $^V ge 5.10.0 &&
4954 defined $stat &&
4955 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4956 my $min = $1;
4957 my $max = $7;
4958 if ($min eq $max) {
4959 WARN("USLEEP_RANGE",
4960 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4961 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4962 $min > $max) {
4963 WARN("USLEEP_RANGE",
4964 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4965 }
4966 }
4967
Joe Perches823b7942013-11-12 15:10:15 -08004968# check for naked sscanf
4969 if ($^V && $^V ge 5.10.0 &&
4970 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004971 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004972 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4973 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4974 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4975 my $lc = $stat =~ tr@\n@@;
4976 $lc = $lc + $linenr;
4977 my $stat_real = raw_line($linenr, 0);
4978 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4979 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4980 }
4981 WARN("NAKED_SSCANF",
4982 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4983 }
4984
Joe Perchesafc819a2014-06-04 16:12:08 -07004985# check for simple sscanf that should be kstrto<foo>
4986 if ($^V && $^V ge 5.10.0 &&
4987 defined $stat &&
4988 $line =~ /\bsscanf\b/) {
4989 my $lc = $stat =~ tr@\n@@;
4990 $lc = $lc + $linenr;
4991 my $stat_real = raw_line($linenr, 0);
4992 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4993 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4994 }
4995 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4996 my $format = $6;
4997 my $count = $format =~ tr@%@%@;
4998 if ($count == 1 &&
4999 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5000 WARN("SSCANF_TO_KSTRTO",
5001 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5002 }
5003 }
5004 }
5005
Joe Perches70dc8a42013-09-11 14:23:58 -07005006# check for new externs in .h files.
5007 if ($realfile =~ /\.h$/ &&
5008 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005009 if (CHK("AVOID_EXTERNS",
5010 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005011 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005012 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005013 }
5014 }
5015
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005016# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005017 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005018 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005019 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005020 my $function_name = $1;
5021 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005022
5023 my $s = $stat;
5024 if (defined $cond) {
5025 substr($s, 0, length($cond), '');
5026 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005027 if ($s =~ /^\s*;/ &&
5028 $function_name ne 'uninitialized_var')
5029 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005030 WARN("AVOID_EXTERNS",
5031 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005032 }
5033
5034 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005035 WARN("FUNCTION_ARGUMENTS",
5036 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005037 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005038
5039 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5040 $stat =~ /^.\s*extern\s+/)
5041 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005042 WARN("AVOID_EXTERNS",
5043 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005044 }
5045
5046# checks for new __setup's
5047 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5048 my $name = $1;
5049
5050 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005051 CHK("UNDOCUMENTED_SETUP",
5052 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005053 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005054 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005055
5056# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005057 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005058 WARN("UNNECESSARY_CASTS",
5059 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005060 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005061
Joe Perchesa640d252013-07-03 15:05:21 -07005062# alloc style
5063# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5064 if ($^V && $^V ge 5.10.0 &&
5065 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5066 CHK("ALLOC_SIZEOF_STRUCT",
5067 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5068 }
5069
Joe Perches60a55362014-06-04 16:12:07 -07005070# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5071 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005072 $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 -07005073 my $oldfunc = $3;
5074 my $a1 = $4;
5075 my $a2 = $10;
5076 my $newfunc = "kmalloc_array";
5077 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005078 my $r1 = $a1;
5079 my $r2 = $a2;
5080 if ($a1 =~ /^sizeof\s*\S/) {
5081 $r1 = $a2;
5082 $r2 = $a1;
5083 }
5084 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5085 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005086 if (WARN("ALLOC_WITH_MULTIPLY",
5087 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5088 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005089 $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 -07005090
5091 }
5092 }
5093 }
5094
Joe Perches972fdea2013-04-29 16:18:12 -07005095# check for krealloc arg reuse
5096 if ($^V && $^V ge 5.10.0 &&
5097 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5098 WARN("KREALLOC_ARG_REUSE",
5099 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5100 }
5101
Joe Perches5ce59ae2013-02-21 16:44:18 -08005102# check for alloc argument mismatch
5103 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5104 WARN("ALLOC_ARRAY_ARGS",
5105 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5106 }
5107
Joe Perchescaf2a542011-01-12 16:59:56 -08005108# check for multiple semicolons
5109 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005110 if (WARN("ONE_SEMICOLON",
5111 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5112 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005113 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005114 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005115 }
5116
Joe Perches0ab90192014-12-10 15:51:57 -08005117# check for #defines like: 1 << <digit> that could be BIT(digit)
5118 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5119 my $ull = "";
5120 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5121 if (CHK("BIT_MACRO",
5122 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5123 $fix) {
5124 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5125 }
5126 }
5127
Joe Perchese81f2392014-08-06 16:11:25 -07005128# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005129 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5130 my $has_break = 0;
5131 my $has_statement = 0;
5132 my $count = 0;
5133 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005134 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005135 $prevline--;
5136 my $rline = $rawlines[$prevline - 1];
5137 my $fline = $lines[$prevline - 1];
5138 last if ($fline =~ /^\@\@/);
5139 next if ($fline =~ /^\-/);
5140 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5141 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5142 next if ($fline =~ /^.[\s$;]*$/);
5143 $has_statement = 1;
5144 $count++;
5145 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5146 }
5147 if (!$has_break && $has_statement) {
5148 WARN("MISSING_BREAK",
5149 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5150 }
5151 }
5152
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005153# check for switch/default statements without a break;
5154 if ($^V && $^V ge 5.10.0 &&
5155 defined $stat &&
5156 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5157 my $ctx = '';
5158 my $herectx = $here . "\n";
5159 my $cnt = statement_rawlines($stat);
5160 for (my $n = 0; $n < $cnt; $n++) {
5161 $herectx .= raw_line($linenr, $n) . "\n";
5162 }
5163 WARN("DEFAULT_NO_BREAK",
5164 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005165 }
5166
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005167# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005168 if ($line =~ /\b__FUNCTION__\b/) {
5169 if (WARN("USE_FUNC",
5170 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5171 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005172 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005173 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005174 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005175
Joe Perches62ec8182015-02-13 14:38:18 -08005176# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5177 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5178 ERROR("DATE_TIME",
5179 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5180 }
5181
Joe Perches2c924882012-03-23 15:02:20 -07005182# check for use of yield()
5183 if ($line =~ /\byield\s*\(\s*\)/) {
5184 WARN("YIELD",
5185 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5186 }
5187
Joe Perches179f8f42013-07-03 15:05:30 -07005188# check for comparisons against true and false
5189 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5190 my $lead = $1;
5191 my $arg = $2;
5192 my $test = $3;
5193 my $otype = $4;
5194 my $trail = $5;
5195 my $op = "!";
5196
5197 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5198
5199 my $type = lc($otype);
5200 if ($type =~ /^(?:true|false)$/) {
5201 if (("$test" eq "==" && "$type" eq "true") ||
5202 ("$test" eq "!=" && "$type" eq "false")) {
5203 $op = "";
5204 }
5205
5206 CHK("BOOL_COMPARISON",
5207 "Using comparison to $otype is error prone\n" . $herecurr);
5208
5209## maybe suggesting a correct construct would better
5210## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5211
5212 }
5213 }
5214
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005215# check for semaphores initialized locked
5216 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005217 WARN("CONSIDER_COMPLETION",
5218 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005219 }
Joe Perches6712d852012-03-23 15:02:20 -07005220
Joe Perches67d0a072011-10-31 17:13:10 -07005221# recommend kstrto* over simple_strto* and strict_strto*
5222 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005223 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005224 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005225 }
Joe Perches6712d852012-03-23 15:02:20 -07005226
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005227# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005228 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005229 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005230 "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 -07005231 }
Joe Perches6712d852012-03-23 15:02:20 -07005232
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005233# check for various structs that are normally const (ops, kgdb, device_tree)
5234 my $const_structs = qr{
5235 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005236 address_space_operations|
5237 backlight_ops|
5238 block_device_operations|
5239 dentry_operations|
5240 dev_pm_ops|
5241 dma_map_ops|
5242 extent_io_ops|
5243 file_lock_operations|
5244 file_operations|
5245 hv_ops|
5246 ide_dma_ops|
5247 intel_dvo_dev_ops|
5248 item_operations|
5249 iwl_ops|
5250 kgdb_arch|
5251 kgdb_io|
5252 kset_uevent_ops|
5253 lock_manager_operations|
5254 microcode_ops|
5255 mtrr_ops|
5256 neigh_ops|
5257 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005258 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005259 pci_raw_ops|
5260 pipe_buf_operations|
5261 platform_hibernation_ops|
5262 platform_suspend_ops|
5263 proto_ops|
5264 rpc_pipe_ops|
5265 seq_operations|
5266 snd_ac97_build_ops|
5267 soc_pcmcia_socket_ops|
5268 stacktrace_ops|
5269 sysfs_ops|
5270 tty_operations|
5271 usb_mon_operations|
5272 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005273 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005274 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005275 WARN("CONST_STRUCT",
5276 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005277 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005278 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005279
5280# use of NR_CPUS is usually wrong
5281# ignore definitions of NR_CPUS and usage to define arrays as likely right
5282 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005283 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5284 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005285 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5286 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5287 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005288 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005289 WARN("NR_CPUS",
5290 "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 -07005291 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005292
Joe Perches52ea8502013-11-12 15:10:09 -08005293# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5294 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5295 ERROR("DEFINE_ARCH_HAS",
5296 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5297 }
5298
Joe Perchesacd93622015-02-13 14:38:38 -08005299# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5300 if ($^V && $^V ge 5.10.0 &&
5301 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5302 WARN("LIKELY_MISUSE",
5303 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5304 }
5305
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005306# whine mightly about in_atomic
5307 if ($line =~ /\bin_atomic\s*\(/) {
5308 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005309 ERROR("IN_ATOMIC",
5310 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005311 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005312 WARN("IN_ATOMIC",
5313 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005314 }
5315 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005316
5317# check for lockdep_set_novalidate_class
5318 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5319 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5320 if ($realfile !~ m@^kernel/lockdep@ &&
5321 $realfile !~ m@^include/linux/lockdep@ &&
5322 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005323 ERROR("LOCKDEP",
5324 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005325 }
5326 }
Dave Jones88f88312011-01-12 16:59:59 -08005327
5328 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5329 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005330 WARN("EXPORTED_WORLD_WRITABLE",
5331 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005332 }
Joe Perches24358802014-04-03 14:49:13 -07005333
Joe Perches515a2352014-04-03 14:49:24 -07005334# Mode permission misuses where it seems decimal should be octal
5335# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5336 if ($^V && $^V ge 5.10.0 &&
5337 $line =~ /$mode_perms_search/) {
5338 foreach my $entry (@mode_permission_funcs) {
5339 my $func = $entry->[0];
5340 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005341
Joe Perches515a2352014-04-03 14:49:24 -07005342 my $skip_args = "";
5343 if ($arg_pos > 1) {
5344 $arg_pos--;
5345 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5346 }
5347 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5348 if ($line =~ /$test/) {
5349 my $val = $1;
5350 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005351
Joe Perches515a2352014-04-03 14:49:24 -07005352 if ($val !~ /^0$/ &&
5353 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5354 length($val) ne 4)) {
5355 ERROR("NON_OCTAL_PERMISSIONS",
5356 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005357 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5358 ERROR("EXPORTED_WORLD_WRITABLE",
5359 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07005360 }
Joe Perches24358802014-04-03 14:49:13 -07005361 }
5362 }
5363 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005364 }
5365
5366 # If we have no input at all, then there is nothing to report on
5367 # so just keep quiet.
5368 if ($#rawlines == -1) {
5369 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005370 }
5371
Andy Whitcroft8905a672007-11-28 16:21:06 -08005372 # In mailback mode only produce a report in the negative, for
5373 # things that appear to be patches.
5374 if ($mailback && ($clean == 1 || !$is_patch)) {
5375 exit(0);
5376 }
5377
5378 # This is not a patch, and we are are in 'no-patch' mode so
5379 # just keep quiet.
5380 if (!$chk_patch && !$is_patch) {
5381 exit(0);
5382 }
5383
5384 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005385 ERROR("NOT_UNIFIED_DIFF",
5386 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005387 }
5388 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005389 ERROR("MISSING_SIGN_OFF",
5390 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005391 }
5392
Andy Whitcroft8905a672007-11-28 16:21:06 -08005393 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005394 if ($summary && !($clean == 1 && $quiet == 1)) {
5395 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005396 print "total: $cnt_error errors, $cnt_warn warnings, " .
5397 (($check)? "$cnt_chk checks, " : "") .
5398 "$cnt_lines lines checked\n";
5399 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005400 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005401
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005402 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005403
5404 if ($^V lt 5.10.0) {
5405 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5406 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5407 }
5408
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005409 # If there were whitespace errors which cleanpatch can fix
5410 # then suggest that.
5411 if ($rpt_cleaners) {
5412 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5413 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005414 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005415 }
5416 }
5417
Joe Perches91bfe482013-09-11 14:23:59 -07005418 hash_show_words(\%use_type, "Used");
5419 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005420
Joe Perchesd752fcc2014-08-06 16:11:05 -07005421 if ($clean == 0 && $fix &&
5422 ("@rawlines" ne "@fixed" ||
5423 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005424 my $newfile = $filename;
5425 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005426 my $linecount = 0;
5427 my $f;
5428
Joe Perchesd752fcc2014-08-06 16:11:05 -07005429 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5430
Joe Perches3705ce52013-07-03 15:05:31 -07005431 open($f, '>', $newfile)
5432 or die "$P: Can't open $newfile for write\n";
5433 foreach my $fixed_line (@fixed) {
5434 $linecount++;
5435 if ($file) {
5436 if ($linecount > 3) {
5437 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005438 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005439 }
5440 } else {
5441 print $f $fixed_line . "\n";
5442 }
5443 }
5444 close($f);
5445
5446 if (!$quiet) {
5447 print << "EOM";
5448Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5449
5450Do _NOT_ trust the results written to this file.
5451Do _NOT_ submit these changes without inspecting them for correctness.
5452
5453This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5454No warranties, expressed or implied...
5455
5456EOM
5457 }
5458 }
5459
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005460 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005461 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005462 }
5463 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005464 print << "EOM";
5465$vname has style problems, please review.
5466
5467If any of these errors are false positives, please report
5468them to the maintainer, see CHECKPATCH in MAINTAINERS.
5469EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005470 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005471
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005472 return $clean;
5473}