blob: 6a3baa0bdde8705fd42e8c98fbf1b6fe4838c022 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
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 Perches2ac73b4f2014-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 Perches2ac73b4f2014-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
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700342our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700343 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700344 atomic_t
345)};
346
Joe Perches691e6692010-03-05 13:43:51 -0800347our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700348 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700349 (?:[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 -0700350 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700351 panic|
Joe Perches06668722013-11-12 15:10:07 -0800352 MODULE_[A-Z_]+|
353 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800354)};
355
Joe Perches20112472011-07-25 17:13:23 -0700356our $signature_tags = qr{(?xi:
357 Signed-off-by:|
358 Acked-by:|
359 Tested-by:|
360 Reviewed-by:|
361 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700362 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700363 To:|
364 Cc:
365)};
366
Joe Perches18130872014-08-06 16:11:22 -0700367our @typeListMisordered = (
368 qr{char\s+(?:un)?signed},
369 qr{int\s+(?:(?:un)?signed\s+)?short\s},
370 qr{int\s+short(?:\s+(?:un)?signed)},
371 qr{short\s+int(?:\s+(?:un)?signed)},
372 qr{(?:un)?signed\s+int\s+short},
373 qr{short\s+(?:un)?signed},
374 qr{long\s+int\s+(?:un)?signed},
375 qr{int\s+long\s+(?:un)?signed},
376 qr{long\s+(?:un)?signed\s+int},
377 qr{int\s+(?:un)?signed\s+long},
378 qr{int\s+(?:un)?signed},
379 qr{int\s+long\s+long\s+(?:un)?signed},
380 qr{long\s+long\s+int\s+(?:un)?signed},
381 qr{long\s+long\s+(?:un)?signed\s+int},
382 qr{long\s+long\s+(?:un)?signed},
383 qr{long\s+(?:un)?signed},
384);
385
Andy Whitcroft8905a672007-11-28 16:21:06 -0800386our @typeList = (
387 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700388 qr{(?:(?:un)?signed\s+)?char},
389 qr{(?:(?:un)?signed\s+)?short\s+int},
390 qr{(?:(?:un)?signed\s+)?short},
391 qr{(?:(?:un)?signed\s+)?int},
392 qr{(?:(?:un)?signed\s+)?long\s+int},
393 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
394 qr{(?:(?:un)?signed\s+)?long\s+long},
395 qr{(?:(?:un)?signed\s+)?long},
396 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800397 qr{float},
398 qr{double},
399 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800400 qr{struct\s+$Ident},
401 qr{union\s+$Ident},
402 qr{enum\s+$Ident},
403 qr{${Ident}_t},
404 qr{${Ident}_handler},
405 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700406 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407);
Joe Perches8716de32013-09-11 14:24:05 -0700408our @typeListWithAttr = (
409 @typeList,
410 qr{struct\s+$InitAttribute\s+$Ident},
411 qr{union\s+$InitAttribute\s+$Ident},
412);
413
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700414our @modifierList = (
415 qr{fastcall},
416);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800417
Joe Perches24358802014-04-03 14:49:13 -0700418our @mode_permission_funcs = (
419 ["module_param", 3],
420 ["module_param_(?:array|named|string)", 4],
421 ["module_param_array_named", 5],
422 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
423 ["proc_create(?:_data|)", 2],
424 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
425);
426
Joe Perches515a2352014-04-03 14:49:24 -0700427#Create a search pattern for all these functions to speed up a loop below
428our $mode_perms_search = "";
429foreach my $entry (@mode_permission_funcs) {
430 $mode_perms_search .= '|' if ($mode_perms_search ne "");
431 $mode_perms_search .= $entry->[0];
432}
433
Wolfram Sang7840a942010-08-09 17:20:57 -0700434our $allowed_asm_includes = qr{(?x:
435 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700436 memory|
437 time|
438 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700439)};
440# memory.h: ARM has a custom one
441
Kees Cook66b47b42014-10-13 15:51:57 -0700442# Load common spelling mistakes and build regular expression list.
443my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700444my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700445
Joe Perches36061e32014-12-10 15:51:43 -0800446if (open(my $spelling, '<', $spelling_file)) {
447 my @spelling_list;
448 while (<$spelling>) {
449 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700450
Joe Perches36061e32014-12-10 15:51:43 -0800451 $line =~ s/\s*\n?$//g;
452 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700453
Joe Perches36061e32014-12-10 15:51:43 -0800454 next if ($line =~ m/^\s*#/);
455 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700456
Joe Perches36061e32014-12-10 15:51:43 -0800457 my ($suspect, $fix) = split(/\|\|/, $line);
458
459 push(@spelling_list, $suspect);
460 $spelling_fix{$suspect} = $fix;
461 }
462 close($spelling);
463 $misspellings = join("|", @spelling_list);
464} else {
465 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700466}
Kees Cook66b47b42014-10-13 15:51:57 -0700467
Andy Whitcroft8905a672007-11-28 16:21:06 -0800468sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700469 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
470 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700471 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700472 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700473 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800474 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700475 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800476 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800477 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700478 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700479 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800480 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700481 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800482 }x;
Joe Perches18130872014-08-06 16:11:22 -0700483 $NonptrTypeMisordered = qr{
484 (?:$Modifier\s+|const\s+)*
485 (?:
486 (?:${Misordered}\b)
487 )
488 (?:\s+$Modifier|\s+const)*
489 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700490 $NonptrTypeWithAttr = qr{
491 (?:$Modifier\s+|const\s+)*
492 (?:
493 (?:typeof|__typeof__)\s*\([^\)]*\)|
494 (?:$typeTypedefs\b)|
495 (?:${allWithAttr}\b)
496 )
497 (?:\s+$Modifier|\s+const)*
498 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800499 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700500 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700501 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700502 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800503 }x;
Joe Perches18130872014-08-06 16:11:22 -0700504 $TypeMisordered = qr{
505 $NonptrTypeMisordered
506 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
507 (?:\s+$Inline|\s+$Modifier)*
508 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700509 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700510 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800511}
512build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700513
Joe Perches7d2367a2011-07-25 17:13:22 -0700514our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700515
516# Using $balanced_parens, $LvalOrFunc, or $FuncArg
517# requires at least perl version v5.10.0
518# Any use must be runtime checked with $^V
519
520our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700521our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800522our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700523
Joe Perchesf8422302014-08-06 16:11:31 -0700524our $declaration_macros = qr{(?x:
525 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
526 (?:$Storage\s+)?LIST_HEAD\s*\(|
527 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
528)};
529
Joe Perches7d2367a2011-07-25 17:13:22 -0700530sub deparenthesize {
531 my ($string) = @_;
532 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700533
534 while ($string =~ /^\s*\(.*\)\s*$/) {
535 $string =~ s@^\s*\(\s*@@;
536 $string =~ s@\s*\)\s*$@@;
537 }
538
Joe Perches7d2367a2011-07-25 17:13:22 -0700539 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700540
Joe Perches7d2367a2011-07-25 17:13:22 -0700541 return $string;
542}
543
Joe Perches34456862013-07-03 15:05:34 -0700544sub seed_camelcase_file {
545 my ($file) = @_;
546
547 return if (!(-f $file));
548
549 local $/;
550
551 open(my $include_file, '<', "$file")
552 or warn "$P: Can't read '$file' $!\n";
553 my $text = <$include_file>;
554 close($include_file);
555
556 my @lines = split('\n', $text);
557
558 foreach my $line (@lines) {
559 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
560 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
561 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800562 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
563 $camelcase{$1} = 1;
564 } 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 -0700565 $camelcase{$1} = 1;
566 }
567 }
568}
569
570my $camelcase_seeded = 0;
571sub seed_camelcase_includes {
572 return if ($camelcase_seeded);
573
574 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700575 my $camelcase_cache = "";
576 my @include_files = ();
577
578 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700579
Richard Genoud3645e322014-02-10 14:25:32 -0800580 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700581 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
582 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700583 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700584 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700585 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700586 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700587 @include_files = split('\n', $files);
588 foreach my $file (@include_files) {
589 my $date = POSIX::strftime("%Y%m%d%H%M",
590 localtime((stat $file)[9]));
591 $last_mod_date = $date if ($last_mod_date < $date);
592 }
593 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700594 }
Joe Perchesc707a812013-07-08 16:00:43 -0700595
596 if ($camelcase_cache ne "" && -f $camelcase_cache) {
597 open(my $camelcase_file, '<', "$camelcase_cache")
598 or warn "$P: Can't read '$camelcase_cache' $!\n";
599 while (<$camelcase_file>) {
600 chomp;
601 $camelcase{$_} = 1;
602 }
603 close($camelcase_file);
604
605 return;
606 }
607
Richard Genoud3645e322014-02-10 14:25:32 -0800608 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700609 $files = `git ls-files "include/*.h"`;
610 @include_files = split('\n', $files);
611 }
612
Joe Perches34456862013-07-03 15:05:34 -0700613 foreach my $file (@include_files) {
614 seed_camelcase_file($file);
615 }
Joe Perches351b2a12013-07-03 15:05:36 -0700616
Joe Perchesc707a812013-07-08 16:00:43 -0700617 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700618 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700619 open(my $camelcase_file, '>', "$camelcase_cache")
620 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700621 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
622 print $camelcase_file ("$_\n");
623 }
624 close($camelcase_file);
625 }
Joe Perches34456862013-07-03 15:05:34 -0700626}
627
Joe Perchesd311cd42014-08-06 16:10:57 -0700628sub git_commit_info {
629 my ($commit, $id, $desc) = @_;
630
631 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
632
633 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
634 $output =~ s/^\s*//gm;
635 my @lines = split("\n", $output);
636
Joe Perches0d7835f2015-02-13 14:38:35 -0800637 return ($id, $desc) if ($#lines < 0);
638
Joe Perchesd311cd42014-08-06 16:10:57 -0700639 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
640# Maybe one day convert this block of bash into something that returns
641# all matching commit ids, but it's very slow...
642#
643# echo "checking commits $1..."
644# git rev-list --remotes | grep -i "^$1" |
645# while read line ; do
646# git log --format='%H %s' -1 $line |
647# echo "commit $(cut -c 1-12,41-)"
648# done
649 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
650 } else {
651 $id = substr($lines[0], 0, 12);
652 $desc = substr($lines[0], 41);
653 }
654
655 return ($id, $desc);
656}
657
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700658$chk_signoff = 0 if ($file);
659
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700660my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800661my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700662my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700663my @fixed_inserted = ();
664my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700665my $fixlinenr = -1;
666
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800667my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700668for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800669 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700670 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800671 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700672 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800673 } elsif ($filename eq '-') {
674 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700675 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800676 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700677 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700678 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800679 if ($filename eq '-') {
680 $vname = 'Your patch';
681 } else {
682 $vname = $filename;
683 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800684 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700685 chomp;
686 push(@rawlines, $_);
687 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800688 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800689 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700690 $exit = 1;
691 }
692 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800693 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700694 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700695 @fixed_inserted = ();
696 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700697 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700698}
699
700exit($exit);
701
702sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700703 my ($root) = @_;
704
705 my @tree_check = (
706 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
707 "README", "Documentation", "arch", "include", "drivers",
708 "fs", "init", "ipc", "kernel", "lib", "scripts",
709 );
710
711 foreach my $check (@tree_check) {
712 if (! -e $root . '/' . $check) {
713 return 0;
714 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700715 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700716 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700717}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700718
Joe Perches20112472011-07-25 17:13:23 -0700719sub parse_email {
720 my ($formatted_email) = @_;
721
722 my $name = "";
723 my $address = "";
724 my $comment = "";
725
726 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
727 $name = $1;
728 $address = $2;
729 $comment = $3 if defined $3;
730 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
731 $address = $1;
732 $comment = $2 if defined $2;
733 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
734 $address = $1;
735 $comment = $2 if defined $2;
736 $formatted_email =~ s/$address.*$//;
737 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700738 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700739 $name =~ s/^\"|\"$//g;
740 # If there's a name left after stripping spaces and
741 # leading quotes, and the address doesn't have both
742 # leading and trailing angle brackets, the address
743 # is invalid. ie:
744 # "joe smith joe@smith.com" bad
745 # "joe smith <joe@smith.com" bad
746 if ($name ne "" && $address !~ /^<[^>]+>$/) {
747 $name = "";
748 $address = "";
749 $comment = "";
750 }
751 }
752
Joe Perches3705ce52013-07-03 15:05:31 -0700753 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700754 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700755 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700756 $address =~ s/^\<|\>$//g;
757
758 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
759 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
760 $name = "\"$name\"";
761 }
762
763 return ($name, $address, $comment);
764}
765
766sub format_email {
767 my ($name, $address) = @_;
768
769 my $formatted_email;
770
Joe Perches3705ce52013-07-03 15:05:31 -0700771 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700772 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700773 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700774
775 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
776 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
777 $name = "\"$name\"";
778 }
779
780 if ("$name" eq "") {
781 $formatted_email = "$address";
782 } else {
783 $formatted_email = "$name <$address>";
784 }
785
786 return $formatted_email;
787}
788
Joe Perchesd311cd42014-08-06 16:10:57 -0700789sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700790 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700791
Joe Perchesbd474ca2014-08-06 16:11:10 -0700792 foreach my $path (split(/:/, $ENV{PATH})) {
793 if (-e "$path/$bin") {
794 return "$path/$bin";
795 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700796 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700797
Joe Perchesbd474ca2014-08-06 16:11:10 -0700798 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700799}
800
Joe Perches000d1cc12011-07-25 17:13:25 -0700801sub which_conf {
802 my ($conf) = @_;
803
804 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
805 if (-e "$path/$conf") {
806 return "$path/$conf";
807 }
808 }
809
810 return "";
811}
812
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700813sub expand_tabs {
814 my ($str) = @_;
815
816 my $res = '';
817 my $n = 0;
818 for my $c (split(//, $str)) {
819 if ($c eq "\t") {
820 $res .= ' ';
821 $n++;
822 for (; ($n % 8) != 0; $n++) {
823 $res .= ' ';
824 }
825 next;
826 }
827 $res .= $c;
828 $n++;
829 }
830
831 return $res;
832}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700834 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700835 return $res;
836}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700837
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700838sub line_stats {
839 my ($line) = @_;
840
841 # Drop the diff line leader and expand tabs
842 $line =~ s/^.//;
843 $line = expand_tabs($line);
844
845 # Pick the indent from the front of the line.
846 my ($white) = ($line =~ /^(\s*)/);
847
848 return (length($line), length($white));
849}
850
Andy Whitcroft773647a2008-03-28 14:15:58 -0700851my $sanitise_quote = '';
852
853sub sanitise_line_reset {
854 my ($in_comment) = @_;
855
856 if ($in_comment) {
857 $sanitise_quote = '*/';
858 } else {
859 $sanitise_quote = '';
860 }
861}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700862sub sanitise_line {
863 my ($line) = @_;
864
865 my $res = '';
866 my $l = '';
867
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800868 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700869 my $off = 0;
870 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700871
Andy Whitcroft773647a2008-03-28 14:15:58 -0700872 # Always copy over the diff marker.
873 $res = substr($line, 0, 1);
874
875 for ($off = 1; $off < length($line); $off++) {
876 $c = substr($line, $off, 1);
877
878 # Comments we are wacking completly including the begin
879 # and end, all to $;.
880 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
881 $sanitise_quote = '*/';
882
883 substr($res, $off, 2, "$;$;");
884 $off++;
885 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800886 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700887 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700888 $sanitise_quote = '';
889 substr($res, $off, 2, "$;$;");
890 $off++;
891 next;
892 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700893 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
894 $sanitise_quote = '//';
895
896 substr($res, $off, 2, $sanitise_quote);
897 $off++;
898 next;
899 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700900
901 # A \ in a string means ignore the next character.
902 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
903 $c eq "\\") {
904 substr($res, $off, 2, 'XX');
905 $off++;
906 next;
907 }
908 # Regular quotes.
909 if ($c eq "'" || $c eq '"') {
910 if ($sanitise_quote eq '') {
911 $sanitise_quote = $c;
912
913 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700914 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700915 } elsif ($sanitise_quote eq $c) {
916 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700917 }
918 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700919
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800920 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700921 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
922 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700923 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
924 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700925 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
926 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700927 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700928 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700929 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800930 }
931
Daniel Walker113f04a2009-09-21 17:04:35 -0700932 if ($sanitise_quote eq '//') {
933 $sanitise_quote = '';
934 }
935
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800936 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700937 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800938 my $clean = 'X' x length($1);
939 $res =~ s@\<.*\>@<$clean>@;
940
941 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700942 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800943 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700944 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800945 }
946
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700947 return $res;
948}
949
Joe Perchesa6962d72013-04-29 16:18:13 -0700950sub get_quoted_string {
951 my ($line, $rawline) = @_;
952
Joe Perches5e4f6ba2014-12-10 15:52:05 -0800953 return "" if ($line !~ m/(\"[X\t]+\")/g);
Joe Perchesa6962d72013-04-29 16:18:13 -0700954 return substr($rawline, $-[0], $+[0] - $-[0]);
955}
956
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957sub ctx_statement_block {
958 my ($linenr, $remain, $off) = @_;
959 my $line = $linenr - 1;
960 my $blk = '';
961 my $soff = $off;
962 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700963 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800964
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800965 my $loff = 0;
966
Andy Whitcroft8905a672007-11-28 16:21:06 -0800967 my $type = '';
968 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800969 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800970 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800971 my $c;
972 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800973
974 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800975 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800976 @stack = (['', 0]) if ($#stack == -1);
977
Andy Whitcroft773647a2008-03-28 14:15:58 -0700978 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800979 # If we are about to drop off the end, pull in more
980 # context.
981 if ($off >= $len) {
982 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700983 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800984 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800985 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800986 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800987 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800988 $len = length($blk);
989 $line++;
990 last;
991 }
992 # Bail if there is no further context.
993 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800994 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800995 last;
996 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800997 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
998 $level++;
999 $type = '#';
1000 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001001 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001002 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001003 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001004 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001005
Andy Whitcroft773647a2008-03-28 14:15:58 -07001006 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001007
1008 # Handle nested #if/#else.
1009 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1010 push(@stack, [ $type, $level ]);
1011 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1012 ($type, $level) = @{$stack[$#stack - 1]};
1013 } elsif ($remainder =~ /^#\s*endif\b/) {
1014 ($type, $level) = @{pop(@stack)};
1015 }
1016
Andy Whitcroft8905a672007-11-28 16:21:06 -08001017 # Statement ends at the ';' or a close '}' at the
1018 # outermost level.
1019 if ($level == 0 && $c eq ';') {
1020 last;
1021 }
1022
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001023 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001024 if ($level == 0 && $coff_set == 0 &&
1025 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1026 $remainder =~ /^(else)(?:\s|{)/ &&
1027 $remainder !~ /^else\s+if\b/) {
1028 $coff = $off + length($1) - 1;
1029 $coff_set = 1;
1030 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1031 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001032 }
1033
Andy Whitcroft8905a672007-11-28 16:21:06 -08001034 if (($type eq '' || $type eq '(') && $c eq '(') {
1035 $level++;
1036 $type = '(';
1037 }
1038 if ($type eq '(' && $c eq ')') {
1039 $level--;
1040 $type = ($level != 0)? '(' : '';
1041
1042 if ($level == 0 && $coff < $soff) {
1043 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001044 $coff_set = 1;
1045 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001046 }
1047 }
1048 if (($type eq '' || $type eq '{') && $c eq '{') {
1049 $level++;
1050 $type = '{';
1051 }
1052 if ($type eq '{' && $c eq '}') {
1053 $level--;
1054 $type = ($level != 0)? '{' : '';
1055
1056 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001057 if (substr($blk, $off + 1, 1) eq ';') {
1058 $off++;
1059 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001060 last;
1061 }
1062 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001063 # Preprocessor commands end at the newline unless escaped.
1064 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1065 $level--;
1066 $type = '';
1067 $off++;
1068 last;
1069 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001070 $off++;
1071 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001072 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001073 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001074 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001075 $line++;
1076 $remain--;
1077 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001078
1079 my $statement = substr($blk, $soff, $off - $soff + 1);
1080 my $condition = substr($blk, $soff, $coff - $soff + 1);
1081
1082 #warn "STATEMENT<$statement>\n";
1083 #warn "CONDITION<$condition>\n";
1084
Andy Whitcroft773647a2008-03-28 14:15:58 -07001085 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001086
1087 return ($statement, $condition,
1088 $line, $remain + 1, $off - $loff + 1, $level);
1089}
1090
Andy Whitcroftcf655042008-03-04 14:28:20 -08001091sub statement_lines {
1092 my ($stmt) = @_;
1093
1094 # Strip the diff line prefixes and rip blank lines at start and end.
1095 $stmt =~ s/(^|\n)./$1/g;
1096 $stmt =~ s/^\s*//;
1097 $stmt =~ s/\s*$//;
1098
1099 my @stmt_lines = ($stmt =~ /\n/g);
1100
1101 return $#stmt_lines + 2;
1102}
1103
1104sub statement_rawlines {
1105 my ($stmt) = @_;
1106
1107 my @stmt_lines = ($stmt =~ /\n/g);
1108
1109 return $#stmt_lines + 2;
1110}
1111
1112sub statement_block_size {
1113 my ($stmt) = @_;
1114
1115 $stmt =~ s/(^|\n)./$1/g;
1116 $stmt =~ s/^\s*{//;
1117 $stmt =~ s/}\s*$//;
1118 $stmt =~ s/^\s*//;
1119 $stmt =~ s/\s*$//;
1120
1121 my @stmt_lines = ($stmt =~ /\n/g);
1122 my @stmt_statements = ($stmt =~ /;/g);
1123
1124 my $stmt_lines = $#stmt_lines + 2;
1125 my $stmt_statements = $#stmt_statements + 1;
1126
1127 if ($stmt_lines > $stmt_statements) {
1128 return $stmt_lines;
1129 } else {
1130 return $stmt_statements;
1131 }
1132}
1133
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001134sub ctx_statement_full {
1135 my ($linenr, $remain, $off) = @_;
1136 my ($statement, $condition, $level);
1137
1138 my (@chunks);
1139
Andy Whitcroftcf655042008-03-04 14:28:20 -08001140 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001141 ($statement, $condition, $linenr, $remain, $off, $level) =
1142 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001143 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001144 push(@chunks, [ $condition, $statement ]);
1145 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1146 return ($level, $linenr, @chunks);
1147 }
1148
1149 # Pull in the following conditional/block pairs and see if they
1150 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001151 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001152 ($statement, $condition, $linenr, $remain, $off, $level) =
1153 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001154 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001155 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001156 #print "C: push\n";
1157 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001158 }
1159
1160 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001161}
1162
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001163sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001164 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001165 my $line;
1166 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001167 my $blk = '';
1168 my @o;
1169 my @c;
1170 my @res = ();
1171
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001172 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001173 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001174 for ($line = $start; $remain > 0; $line++) {
1175 next if ($rawlines[$line] =~ /^-/);
1176 $remain--;
1177
1178 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001179
1180 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001181 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001182 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001183 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001184 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001185 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001186 $level = pop(@stack);
1187 }
1188
Andy Whitcroft01464f32010-10-26 14:23:19 -07001189 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001190 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1191 if ($off > 0) {
1192 $off--;
1193 next;
1194 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001195
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001196 if ($c eq $close && $level > 0) {
1197 $level--;
1198 last if ($level == 0);
1199 } elsif ($c eq $open) {
1200 $level++;
1201 }
1202 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001203
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001204 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001205 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001206 }
1207
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001208 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001209 }
1210
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001211 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001212}
1213sub ctx_block_outer {
1214 my ($linenr, $remain) = @_;
1215
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001216 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1217 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001218}
1219sub ctx_block {
1220 my ($linenr, $remain) = @_;
1221
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001222 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1223 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001224}
1225sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001226 my ($linenr, $remain, $off) = @_;
1227
1228 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1229 return @r;
1230}
1231sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001232 my ($linenr, $remain) = @_;
1233
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001234 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001235}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001236sub ctx_statement_level {
1237 my ($linenr, $remain, $off) = @_;
1238
1239 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1240}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001241
1242sub ctx_locate_comment {
1243 my ($first_line, $end_line) = @_;
1244
1245 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001246 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001247 return $current_comment if (defined $current_comment);
1248
1249 # Look through the context and try and figure out if there is a
1250 # comment.
1251 my $in_comment = 0;
1252 $current_comment = '';
1253 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001254 my $line = $rawlines[$linenr - 1];
1255 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001256 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1257 $in_comment = 1;
1258 }
1259 if ($line =~ m@/\*@) {
1260 $in_comment = 1;
1261 }
1262 if (!$in_comment && $current_comment ne '') {
1263 $current_comment = '';
1264 }
1265 $current_comment .= $line . "\n" if ($in_comment);
1266 if ($line =~ m@\*/@) {
1267 $in_comment = 0;
1268 }
1269 }
1270
1271 chomp($current_comment);
1272 return($current_comment);
1273}
1274sub ctx_has_comment {
1275 my ($first_line, $end_line) = @_;
1276 my $cmt = ctx_locate_comment($first_line, $end_line);
1277
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001278 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001279 ##print "CMMT: $cmt\n";
1280
1281 return ($cmt ne '');
1282}
1283
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001284sub raw_line {
1285 my ($linenr, $cnt) = @_;
1286
1287 my $offset = $linenr - 1;
1288 $cnt++;
1289
1290 my $line;
1291 while ($cnt) {
1292 $line = $rawlines[$offset++];
1293 next if (defined($line) && $line =~ /^-/);
1294 $cnt--;
1295 }
1296
1297 return $line;
1298}
1299
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001300sub cat_vet {
1301 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001302 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001303
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001304 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001305 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1306 $res .= $1;
1307 if ($2 ne '') {
1308 $coded = sprintf("^%c", unpack('C', $2) + 64);
1309 $res .= $coded;
1310 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001311 }
1312 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001313
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001314 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001315}
1316
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001317my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001318my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001319my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001320my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001321
1322sub annotate_reset {
1323 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001324 $av_pending = '_';
1325 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001326 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001327}
1328
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001329sub annotate_values {
1330 my ($stream, $type) = @_;
1331
1332 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001333 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001334 my $cur = $stream;
1335
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001336 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001337
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001338 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001339 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001340 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001341 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001342 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001343 print "WS($1)\n" if ($dbg_values > 1);
1344 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001345 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001346 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001347 }
1348
Florian Micklerc023e4732011-01-12 16:59:58 -08001349 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001350 print "CAST($1)\n" if ($dbg_values > 1);
1351 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001352 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001353
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001354 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001355 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001356 $type = 'T';
1357
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001358 } elsif ($cur =~ /^($Modifier)\s*/) {
1359 print "MODIFIER($1)\n" if ($dbg_values > 1);
1360 $type = 'T';
1361
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001362 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001363 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001364 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001365 push(@av_paren_type, $type);
1366 if ($2 ne '') {
1367 $av_pending = 'N';
1368 }
1369 $type = 'E';
1370
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001371 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001372 print "UNDEF($1)\n" if ($dbg_values > 1);
1373 $av_preprocessor = 1;
1374 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001375
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001376 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001377 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001378 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001379
1380 push(@av_paren_type, $type);
1381 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001382 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001383
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001384 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001385 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1386 $av_preprocessor = 1;
1387
1388 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1389
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001390 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001391
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001392 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001393 print "PRE_END($1)\n" if ($dbg_values > 1);
1394
1395 $av_preprocessor = 1;
1396
1397 # Assume all arms of the conditional end as this
1398 # one does, and continue as if the #endif was not here.
1399 pop(@av_paren_type);
1400 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001401 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001402
1403 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001404 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001405
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001406 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1407 print "ATTR($1)\n" if ($dbg_values > 1);
1408 $av_pending = $type;
1409 $type = 'N';
1410
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001411 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001412 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001413 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001414 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001415 }
1416 $type = 'N';
1417
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001418 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001419 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001420 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001421 $type = 'N';
1422
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001423 } elsif ($cur =~/^(case)/o) {
1424 print "CASE($1)\n" if ($dbg_values > 1);
1425 $av_pend_colon = 'C';
1426 $type = 'N';
1427
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001428 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001429 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001430 $type = 'N';
1431
1432 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001433 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001434 push(@av_paren_type, $av_pending);
1435 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001436 $type = 'N';
1437
1438 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001439 my $new_type = pop(@av_paren_type);
1440 if ($new_type ne '_') {
1441 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001442 print "PAREN('$1') -> $type\n"
1443 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001444 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001445 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001446 }
1447
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001448 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001449 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001450 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001451 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001452
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001453 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1454 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001455 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001456 } elsif ($type eq 'E') {
1457 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001458 }
1459 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1460 $type = 'V';
1461
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001462 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001463 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001464 $type = 'V';
1465
1466 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001467 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001468 $type = 'N';
1469
Andy Whitcroftcf655042008-03-04 14:28:20 -08001470 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001471 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001472 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001473 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001474
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001475 } elsif ($cur =~/^(,)/) {
1476 print "COMMA($1)\n" if ($dbg_values > 1);
1477 $type = 'C';
1478
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001479 } elsif ($cur =~ /^(\?)/o) {
1480 print "QUESTION($1)\n" if ($dbg_values > 1);
1481 $type = 'N';
1482
1483 } elsif ($cur =~ /^(:)/o) {
1484 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1485
1486 substr($var, length($res), 1, $av_pend_colon);
1487 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1488 $type = 'E';
1489 } else {
1490 $type = 'N';
1491 }
1492 $av_pend_colon = 'O';
1493
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001494 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001495 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001496 $type = 'N';
1497
Andy Whitcroft0d413862008-10-15 22:02:16 -07001498 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001499 my $variant;
1500
1501 print "OPV($1)\n" if ($dbg_values > 1);
1502 if ($type eq 'V') {
1503 $variant = 'B';
1504 } else {
1505 $variant = 'U';
1506 }
1507
1508 substr($var, length($res), 1, $variant);
1509 $type = 'N';
1510
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001511 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001512 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001513 if ($1 ne '++' && $1 ne '--') {
1514 $type = 'N';
1515 }
1516
1517 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001518 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001519 }
1520 if (defined $1) {
1521 $cur = substr($cur, length($1));
1522 $res .= $type x length($1);
1523 }
1524 }
1525
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001526 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001527}
1528
Andy Whitcroft8905a672007-11-28 16:21:06 -08001529sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001530 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001531 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001532 ^(?:
1533 $Modifier|
1534 $Storage|
1535 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001536 DEFINE_\S+
1537 )$|
1538 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001539 goto|
1540 return|
1541 case|
1542 else|
1543 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001544 do|
1545 \#|
1546 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001547 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001548 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001549 )}x;
1550 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1551 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001552 # Check for modifiers.
1553 $possible =~ s/\s*$Storage\s*//g;
1554 $possible =~ s/\s*$Sparse\s*//g;
1555 if ($possible =~ /^\s*$/) {
1556
1557 } elsif ($possible =~ /\s/) {
1558 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001559 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001560 if ($modifier !~ $notPermitted) {
1561 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1562 push(@modifierList, $modifier);
1563 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001564 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001565
1566 } else {
1567 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1568 push(@typeList, $possible);
1569 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001570 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001571 } else {
1572 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001573 }
1574}
1575
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001576my $prefix = '';
1577
Joe Perches000d1cc12011-07-25 17:13:25 -07001578sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001579 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001580
Joe Perchescbec18a2014-04-03 14:49:19 -07001581 return defined $use_type{$type} if (scalar keys %use_type > 0);
1582
1583 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001584}
1585
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001586sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001587 my ($level, $type, $msg) = @_;
1588
1589 if (!show_type($type) ||
1590 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001591 return 0;
1592 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001593 my $line;
1594 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001595 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001596 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001597 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001598 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001599 $line = (split('\n', $line))[0] . "\n" if ($terse);
1600
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001601 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001602
1603 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001604}
Joe Perchescbec18a2014-04-03 14:49:19 -07001605
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001606sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001607 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001608}
Joe Perches000d1cc12011-07-25 17:13:25 -07001609
Joe Perchesd752fcc2014-08-06 16:11:05 -07001610sub fixup_current_range {
1611 my ($lineRef, $offset, $length) = @_;
1612
1613 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1614 my $o = $1;
1615 my $l = $2;
1616 my $no = $o + $offset;
1617 my $nl = $l + $length;
1618 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1619 }
1620}
1621
1622sub fix_inserted_deleted_lines {
1623 my ($linesRef, $insertedRef, $deletedRef) = @_;
1624
1625 my $range_last_linenr = 0;
1626 my $delta_offset = 0;
1627
1628 my $old_linenr = 0;
1629 my $new_linenr = 0;
1630
1631 my $next_insert = 0;
1632 my $next_delete = 0;
1633
1634 my @lines = ();
1635
1636 my $inserted = @{$insertedRef}[$next_insert++];
1637 my $deleted = @{$deletedRef}[$next_delete++];
1638
1639 foreach my $old_line (@{$linesRef}) {
1640 my $save_line = 1;
1641 my $line = $old_line; #don't modify the array
1642 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1643 $delta_offset = 0;
1644 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1645 $range_last_linenr = $new_linenr;
1646 fixup_current_range(\$line, $delta_offset, 0);
1647 }
1648
1649 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1650 $deleted = @{$deletedRef}[$next_delete++];
1651 $save_line = 0;
1652 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1653 }
1654
1655 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1656 push(@lines, ${$inserted}{'LINE'});
1657 $inserted = @{$insertedRef}[$next_insert++];
1658 $new_linenr++;
1659 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1660 }
1661
1662 if ($save_line) {
1663 push(@lines, $line);
1664 $new_linenr++;
1665 }
1666
1667 $old_linenr++;
1668 }
1669
1670 return @lines;
1671}
1672
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001673sub fix_insert_line {
1674 my ($linenr, $line) = @_;
1675
1676 my $inserted = {
1677 LINENR => $linenr,
1678 LINE => $line,
1679 };
1680 push(@fixed_inserted, $inserted);
1681}
1682
1683sub fix_delete_line {
1684 my ($linenr, $line) = @_;
1685
1686 my $deleted = {
1687 LINENR => $linenr,
1688 LINE => $line,
1689 };
1690
1691 push(@fixed_deleted, $deleted);
1692}
1693
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001694sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001695 my ($type, $msg) = @_;
1696
1697 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001698 our $clean = 0;
1699 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001700 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001701 }
Joe Perches3705ce52013-07-03 15:05:31 -07001702 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001703}
1704sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001705 my ($type, $msg) = @_;
1706
1707 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001708 our $clean = 0;
1709 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001710 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001711 }
Joe Perches3705ce52013-07-03 15:05:31 -07001712 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001713}
1714sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001715 my ($type, $msg) = @_;
1716
1717 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001718 our $clean = 0;
1719 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001720 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001721 }
Joe Perches3705ce52013-07-03 15:05:31 -07001722 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001723}
1724
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001725sub check_absolute_file {
1726 my ($absolute, $herecurr) = @_;
1727 my $file = $absolute;
1728
1729 ##print "absolute<$absolute>\n";
1730
1731 # See if any suffix of this path is a path within the tree.
1732 while ($file =~ s@^[^/]*/@@) {
1733 if (-f "$root/$file") {
1734 ##print "file<$file>\n";
1735 last;
1736 }
1737 }
1738 if (! -f _) {
1739 return 0;
1740 }
1741
1742 # It is, so see if the prefix is acceptable.
1743 my $prefix = $absolute;
1744 substr($prefix, -length($file)) = '';
1745
1746 ##print "prefix<$prefix>\n";
1747 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001748 WARN("USE_RELATIVE_PATH",
1749 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001750 }
1751}
1752
Joe Perches3705ce52013-07-03 15:05:31 -07001753sub trim {
1754 my ($string) = @_;
1755
Joe Perchesb34c6482013-09-11 14:24:01 -07001756 $string =~ s/^\s+|\s+$//g;
1757
1758 return $string;
1759}
1760
1761sub ltrim {
1762 my ($string) = @_;
1763
1764 $string =~ s/^\s+//;
1765
1766 return $string;
1767}
1768
1769sub rtrim {
1770 my ($string) = @_;
1771
1772 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001773
1774 return $string;
1775}
1776
Joe Perches52ea8502013-11-12 15:10:09 -08001777sub string_find_replace {
1778 my ($string, $find, $replace) = @_;
1779
1780 $string =~ s/$find/$replace/g;
1781
1782 return $string;
1783}
1784
Joe Perches3705ce52013-07-03 15:05:31 -07001785sub tabify {
1786 my ($leading) = @_;
1787
1788 my $source_indent = 8;
1789 my $max_spaces_before_tab = $source_indent - 1;
1790 my $spaces_to_tab = " " x $source_indent;
1791
1792 #convert leading spaces to tabs
1793 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1794 #Remove spaces before a tab
1795 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1796
1797 return "$leading";
1798}
1799
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001800sub pos_last_openparen {
1801 my ($line) = @_;
1802
1803 my $pos = 0;
1804
1805 my $opens = $line =~ tr/\(/\(/;
1806 my $closes = $line =~ tr/\)/\)/;
1807
1808 my $last_openparen = 0;
1809
1810 if (($opens == 0) || ($closes >= $opens)) {
1811 return -1;
1812 }
1813
1814 my $len = length($line);
1815
1816 for ($pos = 0; $pos < $len; $pos++) {
1817 my $string = substr($line, $pos);
1818 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1819 $pos += length($1) - 1;
1820 } elsif (substr($line, $pos, 1) eq '(') {
1821 $last_openparen = $pos;
1822 } elsif (index($string, '(') == -1) {
1823 last;
1824 }
1825 }
1826
Joe Perches91cb5192014-04-03 14:49:32 -07001827 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001828}
1829
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001830sub process {
1831 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001832
1833 my $linenr=0;
1834 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001835 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001836 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001837 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001838
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001839 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001840 my $indent;
1841 my $previndent=0;
1842 my $stashindent=0;
1843
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001844 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001845 my $signoff = 0;
1846 my $is_patch = 0;
1847
Joe Perches29ee1b02014-08-06 16:10:35 -07001848 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001849 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001850 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001851 my $non_utf8_charset = 0;
1852
Joe Perches365dd4e2014-08-06 16:10:42 -07001853 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08001854 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07001855
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001856 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001857 our $cnt_lines = 0;
1858 our $cnt_error = 0;
1859 our $cnt_warn = 0;
1860 our $cnt_chk = 0;
1861
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001862 # Trace the real file/line as we go.
1863 my $realfile = '';
1864 my $realline = 0;
1865 my $realcnt = 0;
1866 my $here = '';
1867 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001868 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001869 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001870 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001871
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001872 my $prev_values = 'E';
1873
1874 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001875 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001876 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001877 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001878 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001879
Joe Perches7e51f192013-09-11 14:23:57 -07001880 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001881
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001882 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001883 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001884 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001885 my @setup_docs = ();
1886 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001887
Joe Perchesd8b07712013-11-12 15:10:06 -08001888 my $camelcase_file_seeded = 0;
1889
Andy Whitcroft773647a2008-03-28 14:15:58 -07001890 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001891 my $line;
1892 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001893 $linenr++;
1894 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001895
Joe Perches3705ce52013-07-03 15:05:31 -07001896 push(@fixed, $rawline) if ($fix);
1897
Andy Whitcroft773647a2008-03-28 14:15:58 -07001898 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001899 $setup_docs = 0;
1900 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1901 $setup_docs = 1;
1902 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001903 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001904 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001905 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1906 $realline=$1-1;
1907 if (defined $2) {
1908 $realcnt=$3+1;
1909 } else {
1910 $realcnt=1+1;
1911 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001912 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001913
1914 # Guestimate if this is a continuing comment. Run
1915 # the context looking for a comment "edge". If this
1916 # edge is a close comment then we must be in a comment
1917 # at context start.
1918 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001919 my $cnt = $realcnt;
1920 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1921 next if (defined $rawlines[$ln - 1] &&
1922 $rawlines[$ln - 1] =~ /^-/);
1923 $cnt--;
1924 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001925 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001926 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1927 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1928 ($edge) = $1;
1929 last;
1930 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931 }
1932 if (defined $edge && $edge eq '*/') {
1933 $in_comment = 1;
1934 }
1935
1936 # Guestimate if this is a continuing comment. If this
1937 # is the start of a diff block and this line starts
1938 # ' *' then it is very likely a comment.
1939 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001940 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001941 {
1942 $in_comment = 1;
1943 }
1944
1945 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1946 sanitise_line_reset($in_comment);
1947
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001948 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001949 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001950 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001951 $line = sanitise_line($rawline);
1952 }
1953 push(@lines, $line);
1954
1955 if ($realcnt > 1) {
1956 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1957 } else {
1958 $realcnt = 0;
1959 }
1960
1961 #print "==>$rawline\n";
1962 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001963
1964 if ($setup_docs && $line =~ /^\+/) {
1965 push(@setup_docs, $line);
1966 }
1967 }
1968
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001969 $prefix = '';
1970
Andy Whitcroft773647a2008-03-28 14:15:58 -07001971 $realcnt = 0;
1972 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001973 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001974 foreach my $line (@lines) {
1975 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001976 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001977 my $sline = $line; #copy of $line
1978 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001979
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001980 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001981
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001982#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001983 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001984 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001985 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001986 $realline=$1-1;
1987 if (defined $2) {
1988 $realcnt=$3+1;
1989 } else {
1990 $realcnt=1+1;
1991 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001992 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001993 $prev_values = 'E';
1994
Andy Whitcroft773647a2008-03-28 14:15:58 -07001995 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001996 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001997 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001998 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001999 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002000
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002001# track the line number as we move through the hunk, note that
2002# new versions of GNU diff omit the leading space on completely
2003# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002004 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002005 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002006 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002007
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002008 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002009 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002010
2011 # Track the previous line.
2012 ($prevline, $stashline) = ($stashline, $line);
2013 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002014 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2015
Andy Whitcroft773647a2008-03-28 14:15:58 -07002016 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002017
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002018 } elsif ($realcnt == 1) {
2019 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002020 }
2021
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002022 my $hunk_line = ($realcnt != 0);
2023
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002024#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07002025 $prefix = "$filename:$realline: " if ($emacs && $file);
2026 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2027
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002028 $here = "#$linenr: " if (!$file);
2029 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002030
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002031 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002032 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002033 if ($line =~ /^diff --git.*?(\S+)$/) {
2034 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002035 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002036 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002037 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002038 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002039 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002040 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002041 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002042
2043 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002044 if (!$file && $tree && $p1_prefix ne '' &&
2045 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002046 WARN("PATCH_PREFIX",
2047 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002048 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002049
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002050 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002051 ERROR("MODIFIED_INCLUDE_ASM",
2052 "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 -07002053 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002054 $found_file = 1;
2055 }
2056
2057 if ($found_file) {
2058 if ($realfile =~ m@^(drivers/net/|net/)@) {
2059 $check = 1;
2060 } else {
2061 $check = $check_orig;
2062 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002063 next;
2064 }
2065
Randy Dunlap389834b2007-06-08 13:47:03 -07002066 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002067
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002068 my $hereline = "$here\n$rawline\n";
2069 my $herecurr = "$here\n$rawline\n";
2070 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002071
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002072 $cnt_lines++ if ($realcnt != 0);
2073
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002074# Check for incorrect file permissions
2075 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2076 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002077 if ($realfile !~ m@scripts/@ &&
2078 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002079 ERROR("EXECUTE_PERMISSIONS",
2080 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002081 }
2082 }
2083
Joe Perches20112472011-07-25 17:13:23 -07002084# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002085 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002086 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002087 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002088 }
2089
Joe Perchese0d975b2014-12-10 15:51:49 -08002090# Check if MAINTAINERS is being updated. If so, there's probably no need to
2091# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2092 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2093 $reported_maintainer_file = 1;
2094 }
2095
Joe Perches20112472011-07-25 17:13:23 -07002096# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002097 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002098 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002099 my $space_before = $1;
2100 my $sign_off = $2;
2101 my $space_after = $3;
2102 my $email = $4;
2103 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2104
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002105 if ($sign_off !~ /$signature_tags/) {
2106 WARN("BAD_SIGN_OFF",
2107 "Non-standard signature: $sign_off\n" . $herecurr);
2108 }
Joe Perches20112472011-07-25 17:13:23 -07002109 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002110 if (WARN("BAD_SIGN_OFF",
2111 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2112 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002113 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002114 "$ucfirst_sign_off $email";
2115 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002116 }
Joe Perches20112472011-07-25 17:13:23 -07002117 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002118 if (WARN("BAD_SIGN_OFF",
2119 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2120 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002121 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002122 "$ucfirst_sign_off $email";
2123 }
2124
Joe Perches20112472011-07-25 17:13:23 -07002125 }
2126 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002127 if (WARN("BAD_SIGN_OFF",
2128 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2129 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002130 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002131 "$ucfirst_sign_off $email";
2132 }
Joe Perches20112472011-07-25 17:13:23 -07002133 }
2134
2135 my ($email_name, $email_address, $comment) = parse_email($email);
2136 my $suggested_email = format_email(($email_name, $email_address));
2137 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002138 ERROR("BAD_SIGN_OFF",
2139 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002140 } else {
2141 my $dequoted = $suggested_email;
2142 $dequoted =~ s/^"//;
2143 $dequoted =~ s/" </ </;
2144 # Don't force email to have quotes
2145 # Allow just an angle bracketed address
2146 if ("$dequoted$comment" ne $email &&
2147 "<$email_address>$comment" ne $email &&
2148 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002149 WARN("BAD_SIGN_OFF",
2150 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002151 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002152 }
Joe Perches7e51f192013-09-11 14:23:57 -07002153
2154# Check for duplicate signatures
2155 my $sig_nospace = $line;
2156 $sig_nospace =~ s/\s//g;
2157 $sig_nospace = lc($sig_nospace);
2158 if (defined $signatures{$sig_nospace}) {
2159 WARN("BAD_SIGN_OFF",
2160 "Duplicate signature\n" . $herecurr);
2161 } else {
2162 $signatures{$sig_nospace} = 1;
2163 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002164 }
2165
Joe Perches9b3189eb2014-06-04 16:12:10 -07002166# Check for old stable address
2167 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2168 ERROR("STABLE_ADDRESS",
2169 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2170 }
2171
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002172# Check for unwanted Gerrit info
2173 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2174 ERROR("GERRIT_CHANGE_ID",
2175 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2176 }
2177
Joe Perches0d7835f2015-02-13 14:38:35 -08002178# Check for git id commit length and improperly formed commit descriptions
2179 if ($in_commit_log && $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002180 my $init_char = $1;
2181 my $orig_commit = lc($2);
Joe Perches0d7835f2015-02-13 14:38:35 -08002182 my $short = 1;
2183 my $long = 0;
2184 my $case = 1;
2185 my $space = 1;
2186 my $hasdesc = 0;
2187 my $id = '0123456789ab';
2188 my $orig_desc = "commit description";
2189 my $description = "";
2190
2191 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2192 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2193 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2194 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2195 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2196 $orig_desc = $1;
2197 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2198 defined $rawlines[$linenr] &&
2199 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2200 $orig_desc = $1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002201 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2202 defined $rawlines[$linenr] &&
2203 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2204 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2205 $orig_desc = $1;
2206 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2207 $orig_desc .= " " . $1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002208 }
2209
2210 ($id, $description) = git_commit_info($orig_commit,
2211 $id, $orig_desc);
2212
2213 if ($short || $long || $space || $case || ($orig_desc ne $description)) {
2214 ERROR("GIT_COMMIT_ID",
2215 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2216 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002217 }
2218
Joe Perches13f19372014-08-06 16:10:59 -07002219# Check for added, moved or deleted files
2220 if (!$reported_maintainer_file && !$in_commit_log &&
2221 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2222 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2223 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2224 (defined($1) || defined($2))))) {
2225 $reported_maintainer_file = 1;
2226 WARN("FILE_PATH_CHANGES",
2227 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2228 }
2229
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002230# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002231 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002232 ERROR("CORRUPTED_PATCH",
2233 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002234 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002235 }
2236
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002237# Check for absolute kernel paths.
2238 if ($tree) {
2239 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2240 my $file = $1;
2241
2242 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2243 check_absolute_file($1, $herecurr)) {
2244 #
2245 } else {
2246 check_absolute_file($file, $herecurr);
2247 }
2248 }
2249 }
2250
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002251# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2252 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002253 $rawline !~ m/^$UTF8*$/) {
2254 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2255
2256 my $blank = copy_spacing($rawline);
2257 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2258 my $hereptr = "$hereline$ptr\n";
2259
Joe Perches34d99212011-07-25 17:13:26 -07002260 CHK("INVALID_UTF8",
2261 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002262 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002263
Joe Perches15662b32011-10-31 17:13:12 -07002264# Check if it's the start of a commit log
2265# (not a header line and we haven't seen the patch filename)
2266 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002267 !($rawline =~ /^\s+\S/ ||
2268 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002269 $in_header_lines = 0;
2270 $in_commit_log = 1;
2271 }
2272
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002273# Check if there is UTF-8 in a commit log when a mail header has explicitly
2274# declined it, i.e defined some charset where it is missing.
2275 if ($in_header_lines &&
2276 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2277 $1 !~ /utf-8/i) {
2278 $non_utf8_charset = 1;
2279 }
2280
2281 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002282 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002283 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002284 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2285 }
2286
Kees Cook66b47b42014-10-13 15:51:57 -07002287# Check for various typo / spelling mistakes
Joe Perches36061e32014-12-10 15:51:43 -08002288 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
Kees Cook66b47b42014-10-13 15:51:57 -07002289 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2290 my $typo = $1;
2291 my $typo_fix = $spelling_fix{lc($typo)};
2292 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2293 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2294 my $msg_type = \&WARN;
2295 $msg_type = \&CHK if ($file);
2296 if (&{$msg_type}("TYPO_SPELLING",
2297 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2298 $fix) {
2299 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2300 }
2301 }
2302 }
2303
Andy Whitcroft306708542008-10-15 22:02:28 -07002304# ignore non-hunk lines and lines being removed
2305 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002306
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002307#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002308 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002309 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002310 if (ERROR("DOS_LINE_ENDINGS",
2311 "DOS line endings\n" . $herevet) &&
2312 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002313 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002314 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002315 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2316 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002317 if (ERROR("TRAILING_WHITESPACE",
2318 "trailing whitespace\n" . $herevet) &&
2319 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002320 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002321 }
2322
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002323 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002324 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002325
Josh Triplett4783f892013-11-12 15:10:12 -08002326# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002327 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002328 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2329 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002330 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2331 my $msg_type = \&ERROR;
2332 $msg_type = \&CHK if ($file);
2333 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002334 "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 -08002335 }
2336
Andi Kleen33549572010-05-24 14:33:29 -07002337# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002338# Only applies when adding the entry originally, after that we do not have
2339# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002340 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002341 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002342 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002343 my $cnt = $realcnt;
2344 my $ln = $linenr + 1;
2345 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002346 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002347 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002348 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002349 $f = $lines[$ln - 1];
2350 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2351 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002352
2353 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002354 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002355
Joe Perches8d73e0e2014-08-06 16:10:46 -07002356 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002357 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002358 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002359 $length = -1;
2360 }
2361
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002362 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002363 $f =~ s/#.*//;
2364 $f =~ s/^\s+//;
2365 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002366 if ($f =~ /^\s*config\s/) {
2367 $is_end = 1;
2368 last;
2369 }
Andi Kleen33549572010-05-24 14:33:29 -07002370 $length++;
2371 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002372 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2373 WARN("CONFIG_DESCRIPTION",
2374 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2375 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002376 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002377 }
2378
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002379# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2380 if ($realfile =~ /Kconfig/ &&
2381 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2382 WARN("CONFIG_EXPERIMENTAL",
2383 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2384 }
2385
Christoph Jaeger327953e2015-02-13 14:38:29 -08002386# discourage the use of boolean for type definition attributes of Kconfig options
2387 if ($realfile =~ /Kconfig/ &&
2388 $line =~ /^\+\s*\bboolean\b/) {
2389 WARN("CONFIG_TYPE_BOOLEAN",
2390 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2391 }
2392
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002393 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2394 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2395 my $flag = $1;
2396 my $replacement = {
2397 'EXTRA_AFLAGS' => 'asflags-y',
2398 'EXTRA_CFLAGS' => 'ccflags-y',
2399 'EXTRA_CPPFLAGS' => 'cppflags-y',
2400 'EXTRA_LDFLAGS' => 'ldflags-y',
2401 };
2402
2403 WARN("DEPRECATED_VARIABLE",
2404 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2405 }
2406
Rob Herringbff5da42014-01-23 15:54:51 -08002407# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002408 if (defined $root &&
2409 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2410 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2411
Rob Herringbff5da42014-01-23 15:54:51 -08002412 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2413
Florian Vaussardcc933192014-04-03 14:49:27 -07002414 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2415 my $vp_file = $dt_path . "vendor-prefixes.txt";
2416
Rob Herringbff5da42014-01-23 15:54:51 -08002417 foreach my $compat (@compats) {
2418 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002419 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2420 my $compat3 = $compat;
2421 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2422 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002423 if ( $? >> 8 ) {
2424 WARN("UNDOCUMENTED_DT_STRING",
2425 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2426 }
2427
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002428 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2429 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002430 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002431 if ( $? >> 8 ) {
2432 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002433 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002434 }
2435 }
2436 }
2437
Andy Whitcroft5368df202008-10-15 22:02:27 -07002438# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002439 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002440
Joe Perches6cd7f382012-12-17 16:01:54 -08002441#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002442 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002443 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002444 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002445 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002446 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002447 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002448 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002449 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002450 }
2451
Andy Whitcroft8905a672007-11-28 16:21:06 -08002452# check for adding lines without a newline.
2453 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002454 WARN("MISSING_EOF_NEWLINE",
2455 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002456 }
2457
Mike Frysinger42e41c52009-09-21 17:04:40 -07002458# Blackfin: use hi/lo macros
2459 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2460 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2461 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002462 ERROR("LO_MACRO",
2463 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002464 }
2465 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2466 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002467 ERROR("HI_MACRO",
2468 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002469 }
2470 }
2471
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002472# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002473 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002474
2475# at the beginning of a line any tabs must come first and anything
2476# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002477 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2478 $rawline =~ /^\+\s* \s*/) {
2479 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002480 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002481 if (ERROR("CODE_INDENT",
2482 "code indent should use tabs where possible\n" . $herevet) &&
2483 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002484 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002485 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002486 }
2487
Alberto Panizzo08e44362010-03-05 13:43:54 -08002488# check for space before tabs.
2489 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2490 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002491 if (WARN("SPACE_BEFORE_TAB",
2492 "please, no space before tabs\n" . $herevet) &&
2493 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002494 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002495 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002496 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002497 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002498 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002499 }
2500
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002501# check for && or || at the start of a line
2502 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2503 CHK("LOGICAL_CONTINUATIONS",
2504 "Logical continuations should be on the previous line\n" . $hereprev);
2505 }
2506
2507# check multi-line statement indentation matches previous line
2508 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002509 $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 -07002510 $prevline =~ /^\+(\t*)(.*)$/;
2511 my $oldindent = $1;
2512 my $rest = $2;
2513
2514 my $pos = pos_last_openparen($rest);
2515 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002516 $line =~ /^(\+| )([ \t]*)/;
2517 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002518
2519 my $goodtabindent = $oldindent .
2520 "\t" x ($pos / 8) .
2521 " " x ($pos % 8);
2522 my $goodspaceindent = $oldindent . " " x $pos;
2523
2524 if ($newindent ne $goodtabindent &&
2525 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002526
2527 if (CHK("PARENTHESIS_ALIGNMENT",
2528 "Alignment should match open parenthesis\n" . $hereprev) &&
2529 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002530 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002531 s/^\+[ \t]*/\+$goodtabindent/;
2532 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002533 }
2534 }
2535 }
2536
Joe Perches04941aa2014-12-10 15:51:37 -08002537 if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ &&
2538 (!defined($1) || $1 !~ /sizeof\s*/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002539 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002540 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002541 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002542 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002543 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002544 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002545 }
2546
Joe Perches05880602012-10-04 17:13:35 -07002547 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002548 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002549 $rawline =~ /^\+[ \t]*\*/ &&
2550 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002551 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2552 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2553 }
2554
2555 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002556 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2557 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002558 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002559 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2560 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2561 "networking block comments start with * on subsequent lines\n" . $hereprev);
2562 }
2563
2564 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002565 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2566 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2567 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2568 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002569 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2570 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2571 }
2572
Joe Perches7f619192014-08-06 16:10:39 -07002573# check for missing blank lines after struct/union declarations
2574# with exceptions for various attributes and macros
2575 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2576 $line =~ /^\+/ &&
2577 !($line =~ /^\+\s*$/ ||
2578 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2579 $line =~ /^\+\s*MODULE_/i ||
2580 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2581 $line =~ /^\+[a-z_]*init/ ||
2582 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2583 $line =~ /^\+\s*DECLARE/ ||
2584 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002585 if (CHK("LINE_SPACING",
2586 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2587 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002588 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002589 }
Joe Perches7f619192014-08-06 16:10:39 -07002590 }
2591
Joe Perches365dd4e2014-08-06 16:10:42 -07002592# check for multiple consecutive blank lines
2593 if ($prevline =~ /^[\+ ]\s*$/ &&
2594 $line =~ /^\+\s*$/ &&
2595 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002596 if (CHK("LINE_SPACING",
2597 "Please don't use multiple blank lines\n" . $hereprev) &&
2598 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002599 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002600 }
2601
Joe Perches365dd4e2014-08-06 16:10:42 -07002602 $last_blank_line = $linenr;
2603 }
2604
Joe Perches3b617e32014-04-03 14:49:28 -07002605# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002606 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2607 # actual declarations
2608 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002609 # function pointer declarations
2610 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002611 # foo bar; where foo is some local typedef or #define
2612 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2613 # known declaration macros
2614 $prevline =~ /^\+\s+$declaration_macros/) &&
2615 # for "else if" which can look like "$Ident $Ident"
2616 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2617 # other possible extensions of declaration lines
2618 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2619 # not starting a section or a macro "\" extended line
2620 $prevline =~ /(?:\{\s*|\\)$/) &&
2621 # looks like a declaration
2622 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002623 # function pointer declarations
2624 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002625 # foo bar; where foo is some local typedef or #define
2626 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2627 # known declaration macros
2628 $sline =~ /^\+\s+$declaration_macros/ ||
2629 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002630 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002631 # start or end of block or continuation of declaration
2632 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2633 # bitfield continuation
2634 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2635 # other possible extensions of declaration lines
2636 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2637 # indentation of previous and current line are the same
2638 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002639 if (WARN("LINE_SPACING",
2640 "Missing a blank line after declarations\n" . $hereprev) &&
2641 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002642 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002643 }
Joe Perches3b617e32014-04-03 14:49:28 -07002644 }
2645
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002646# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002647# Exceptions:
2648# 1) within comments
2649# 2) indented preprocessor commands
2650# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002651 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002652 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002653 if (WARN("LEADING_SPACE",
2654 "please, no spaces at the start of a line\n" . $herevet) &&
2655 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002656 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002657 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002658 }
2659
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002660# check we are in a valid C source file if not then ignore this hunk
2661 next if ($realfile !~ /\.(h|c)$/);
2662
Joe Perches032a4c02014-08-06 16:10:29 -07002663# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002664# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002665# if the previous line is a break or return and is indented 1 tab more...
2666 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2667 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002668 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2669 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2670 defined $lines[$linenr] &&
2671 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002672 WARN("UNNECESSARY_ELSE",
2673 "else is not generally useful after a break or return\n" . $hereprev);
2674 }
2675 }
2676
Joe Perchesc00df192014-08-06 16:11:01 -07002677# check indentation of a line with a break;
2678# if the previous line is a goto or return and is indented the same # of tabs
2679 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2680 my $tabs = $1;
2681 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2682 WARN("UNNECESSARY_BREAK",
2683 "break is not useful after a goto or return\n" . $hereprev);
2684 }
2685 }
2686
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002687# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2688 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2689 WARN("CONFIG_EXPERIMENTAL",
2690 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2691 }
2692
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002693# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002694 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002695 WARN("CVS_KEYWORD",
2696 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002697 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002698
Mike Frysinger42e41c52009-09-21 17:04:40 -07002699# Blackfin: don't use __builtin_bfin_[cs]sync
2700 if ($line =~ /__builtin_bfin_csync/) {
2701 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002702 ERROR("CSYNC",
2703 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002704 }
2705 if ($line =~ /__builtin_bfin_ssync/) {
2706 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002707 ERROR("SSYNC",
2708 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002709 }
2710
Joe Perches56e77d72013-02-21 16:44:14 -08002711# check for old HOTPLUG __dev<foo> section markings
2712 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2713 WARN("HOTPLUG_SECTION",
2714 "Using $1 is unnecessary\n" . $herecurr);
2715 }
2716
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002717# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002718 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2719 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002720#print "LINE<$line>\n";
2721 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002722 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002723 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002724 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002725 $stat =~ s/\n./\n /g;
2726 $cond =~ s/\n./\n /g;
2727
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002728#print "linenr<$linenr> <$stat>\n";
2729 # If this statement has no statement boundaries within
2730 # it there is no point in retrying a statement scan
2731 # until we hit end of it.
2732 my $frag = $stat; $frag =~ s/;+\s*$//;
2733 if ($frag !~ /(?:{|;)/) {
2734#print "skip<$line_nr_next>\n";
2735 $suppress_statement = $line_nr_next;
2736 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002737
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002738 # Find the real next line.
2739 $realline_next = $line_nr_next;
2740 if (defined $realline_next &&
2741 (!defined $lines[$realline_next - 1] ||
2742 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2743 $realline_next++;
2744 }
2745
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002746 my $s = $stat;
2747 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002748
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002749 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002750 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002751
2752 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002753 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002754
Andy Whitcroft463f2862009-09-21 17:04:34 -07002755 } elsif ($s =~ /^.\s*else\b/s) {
2756
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002757 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002758 } 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 -07002759 my $type = $1;
2760 $type =~ s/\s+/ /g;
2761 possible($type, "A:" . $s);
2762
Andy Whitcroft8905a672007-11-28 16:21:06 -08002763 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002764 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002765 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002766 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002767
2768 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002769 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002770 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002771 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002772
2773 # Check for any sort of function declaration.
2774 # int foo(something bar, other baz);
2775 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002776 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 -08002777 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002778
Andy Whitcroftcf655042008-03-04 14:28:20 -08002779 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002780 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002781 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002782
Andy Whitcroft8905a672007-11-28 16:21:06 -08002783 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002784 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002785
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002786 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002787 }
2788 }
2789 }
2790
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002791 }
2792
Andy Whitcroft653d4872007-06-23 17:16:34 -07002793#
2794# Checks which may be anchored in the context.
2795#
2796
2797# Check for switch () and associated case and default
2798# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002799 if ($line=~/\bswitch\s*\(.*\)/) {
2800 my $err = '';
2801 my $sep = '';
2802 my @ctx = ctx_block_outer($linenr, $realcnt);
2803 shift(@ctx);
2804 for my $ctx (@ctx) {
2805 my ($clen, $cindent) = line_stats($ctx);
2806 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2807 $indent != $cindent) {
2808 $err .= "$sep$ctx\n";
2809 $sep = '';
2810 } else {
2811 $sep = "[...]\n";
2812 }
2813 }
2814 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002815 ERROR("SWITCH_CASE_INDENT_LEVEL",
2816 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002817 }
2818 }
2819
2820# if/while/etc brace do not go on next line, unless defining a do while loop,
2821# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07002822 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 -07002823 my $pre_ctx = "$1$2";
2824
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002825 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002826
2827 if ($line =~ /^\+\t{6,}/) {
2828 WARN("DEEP_INDENTATION",
2829 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2830 }
2831
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002832 my $ctx_cnt = $realcnt - $#ctx - 1;
2833 my $ctx = join("\n", @ctx);
2834
Andy Whitcroft548596d2008-07-23 21:29:01 -07002835 my $ctx_ln = $linenr;
2836 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002837
Andy Whitcroft548596d2008-07-23 21:29:01 -07002838 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2839 defined $lines[$ctx_ln - 1] &&
2840 $lines[$ctx_ln - 1] =~ /^-/)) {
2841 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2842 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002843 $ctx_ln++;
2844 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002845
Andy Whitcroft53210162008-07-23 21:29:03 -07002846 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2847 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002848
Joe Perchesd752fcc2014-08-06 16:11:05 -07002849 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002850 ERROR("OPEN_BRACE",
2851 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002852 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002853 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002854 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2855 $ctx =~ /\)\s*\;\s*$/ &&
2856 defined $lines[$ctx_ln - 1])
2857 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002858 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2859 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002860 WARN("TRAILING_SEMICOLON",
2861 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002862 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002863 }
2864 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002865 }
2866
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002867# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07002868 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 -08002869 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2870 ctx_statement_block($linenr, $realcnt, 0)
2871 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002872 my ($s, $c) = ($stat, $cond);
2873
2874 substr($s, 0, length($c), '');
2875
2876 # Make sure we remove the line prefixes as we have
2877 # none on the first line, and are going to readd them
2878 # where necessary.
2879 $s =~ s/\n./\n/gs;
2880
2881 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002882 my @newlines = ($c =~ /\n/gs);
2883 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002884
2885 # We want to check the first line inside the block
2886 # starting at the end of the conditional, so remove:
2887 # 1) any blank line termination
2888 # 2) any opening brace { on end of the line
2889 # 3) any do (...) {
2890 my $continuation = 0;
2891 my $check = 0;
2892 $s =~ s/^.*\bdo\b//;
2893 $s =~ s/^\s*{//;
2894 if ($s =~ s/^\s*\\//) {
2895 $continuation = 1;
2896 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002897 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002898 $check = 1;
2899 $cond_lines++;
2900 }
2901
2902 # Also ignore a loop construct at the end of a
2903 # preprocessor statement.
2904 if (($prevline =~ /^.\s*#\s*define\s/ ||
2905 $prevline =~ /\\\s*$/) && $continuation == 0) {
2906 $check = 0;
2907 }
2908
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002909 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002910 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002911 while ($cond_ptr != $cond_lines) {
2912 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002913
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002914 # If we see an #else/#elif then the code
2915 # is not linear.
2916 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2917 $check = 0;
2918 }
2919
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002920 # Ignore:
2921 # 1) blank lines, they should be at 0,
2922 # 2) preprocessor lines, and
2923 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002924 if ($continuation ||
2925 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002926 $s =~ /^\s*#\s*?/ ||
2927 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002928 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002929 if ($s =~ s/^.*?\n//) {
2930 $cond_lines++;
2931 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002932 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002933 }
2934
2935 my (undef, $sindent) = line_stats("+" . $s);
2936 my $stat_real = raw_line($linenr, $cond_lines);
2937
2938 # Check if either of these lines are modified, else
2939 # this is not this patch's fault.
2940 if (!defined($stat_real) ||
2941 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2942 $check = 0;
2943 }
2944 if (defined($stat_real) && $cond_lines > 1) {
2945 $stat_real = "[...]\n$stat_real";
2946 }
2947
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002948 #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 -07002949
2950 if ($check && (($sindent % 8) != 0 ||
2951 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002952 WARN("SUSPECT_CODE_INDENT",
2953 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002954 }
2955 }
2956
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002957 # Track the 'values' across context and added lines.
2958 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002959 my ($curr_values, $curr_vars) =
2960 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002961 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002962 if ($dbg_values) {
2963 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002964 print "$linenr > .$outline\n";
2965 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002966 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002967 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002968 $prev_values = substr($curr_values, -1);
2969
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002970#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002971 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002972
Andy Whitcroft653d4872007-06-23 17:16:34 -07002973# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002974 if ($dbg_type) {
2975 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002976 ERROR("TEST_TYPE",
2977 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002978 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002979 ERROR("TEST_NOT_TYPE",
2980 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002981 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002982 next;
2983 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002984# TEST: allow direct testing of the attribute matcher.
2985 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002986 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002987 ERROR("TEST_ATTR",
2988 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002989 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002990 ERROR("TEST_NOT_ATTR",
2991 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002992 }
2993 next;
2994 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002995
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002996# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002997 if ($line =~ /^.\s*{/ &&
2998 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002999 if (ERROR("OPEN_BRACE",
3000 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003001 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3002 fix_delete_line($fixlinenr - 1, $prevrawline);
3003 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003004 my $fixedline = $prevrawline;
3005 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003006 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003007 $fixedline = $line;
3008 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003009 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003010 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003011 }
3012
Andy Whitcroft653d4872007-06-23 17:16:34 -07003013#
3014# Checks which are anchored on the added line.
3015#
3016
3017# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003018 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003019 my $path = $1;
3020 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003021 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003022 "malformed #include filename\n" . $herecurr);
3023 }
3024 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3025 ERROR("UAPI_INCLUDE",
3026 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003027 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003028 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003029
3030# no C99 // comments
3031 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003032 if (ERROR("C99_COMMENTS",
3033 "do not use C99 // comments\n" . $herecurr) &&
3034 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003035 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003036 if ($line =~ /\/\/(.*)$/) {
3037 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003038 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003039 }
3040 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003041 }
3042 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003043 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003044 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003045
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003046# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3047# the whole statement.
3048#print "APW <$lines[$realline_next - 1]>\n";
3049 if (defined $realline_next &&
3050 exists $lines[$realline_next - 1] &&
3051 !defined $suppress_export{$realline_next} &&
3052 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3053 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003054 # Handle definitions which produce identifiers with
3055 # a prefix:
3056 # XXX(foo);
3057 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003058 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003059 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003060 $name =~ /^${Ident}_$2/) {
3061#print "FOO C name<$name>\n";
3062 $suppress_export{$realline_next} = 1;
3063
3064 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003065 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003066 ^.DEFINE_$Ident\(\Q$name\E\)|
3067 ^.DECLARE_$Ident\(\Q$name\E\)|
3068 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003069 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3070 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003071 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003072#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3073 $suppress_export{$realline_next} = 2;
3074 } else {
3075 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003076 }
3077 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003078 if (!defined $suppress_export{$linenr} &&
3079 $prevline =~ /^.\s*$/ &&
3080 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3081 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3082#print "FOO B <$lines[$linenr - 1]>\n";
3083 $suppress_export{$linenr} = 2;
3084 }
3085 if (defined $suppress_export{$linenr} &&
3086 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003087 WARN("EXPORT_SYMBOL",
3088 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003089 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003090
Joe Eloff5150bda2010-08-09 17:21:00 -07003091# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003092 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3093 if (ERROR("GLOBAL_INITIALISERS",
3094 "do not initialise globals to 0 or NULL\n" .
3095 $herecurr) &&
3096 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003097 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003098 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003099 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003100# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003101 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3102 if (ERROR("INITIALISED_STATIC",
3103 "do not initialise statics to 0 or NULL\n" .
3104 $herecurr) &&
3105 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003106 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003107 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003108 }
3109
Joe Perches18130872014-08-06 16:11:22 -07003110# check for misordered declarations of char/short/int/long with signed/unsigned
3111 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3112 my $tmp = trim($1);
3113 WARN("MISORDERED_TYPE",
3114 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3115 }
3116
Joe Perchescb710ec2010-10-26 14:23:20 -07003117# check for static const char * arrays.
3118 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003119 WARN("STATIC_CONST_CHAR_ARRAY",
3120 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003121 $herecurr);
3122 }
3123
3124# check for static char foo[] = "bar" declarations.
3125 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003126 WARN("STATIC_CONST_CHAR_ARRAY",
3127 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003128 $herecurr);
3129 }
3130
Joe Perches9b0fa602014-04-03 14:49:18 -07003131# check for non-global char *foo[] = {"bar", ...} declarations.
3132 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3133 WARN("STATIC_CONST_CHAR_ARRAY",
3134 "char * array declaration might be better as static const\n" .
3135 $herecurr);
3136 }
3137
Joe Perchesb36190c2014-01-27 17:07:18 -08003138# check for function declarations without arguments like "int foo()"
3139 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3140 if (ERROR("FUNCTION_WITHOUT_ARGS",
3141 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3142 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003143 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003144 }
3145 }
3146
Joe Perches92e112f2013-12-13 11:36:22 -07003147# check for uses of DEFINE_PCI_DEVICE_TABLE
3148 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3149 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3150 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3151 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003152 $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 -07003153 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003154 }
3155
Andy Whitcroft653d4872007-06-23 17:16:34 -07003156# check for new typedefs, only function parameters and sparse annotations
3157# make sense.
3158 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003159 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003160 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003161 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003162 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003163 WARN("NEW_TYPEDEFS",
3164 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003165 }
3166
3167# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003168 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003169 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3170 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003171 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003172
Andy Whitcroft65863862009-01-06 14:41:21 -08003173 # Should start with a space.
3174 $to =~ s/^(\S)/ $1/;
3175 # Should not end with a space.
3176 $to =~ s/\s+$//;
3177 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003178 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003179 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003180
Joe Perches3705ce52013-07-03 15:05:31 -07003181## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003182 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003183 if (ERROR("POINTER_LOCATION",
3184 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3185 $fix) {
3186 my $sub_from = $ident;
3187 my $sub_to = $ident;
3188 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003189 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003190 s@\Q$sub_from\E@$sub_to@;
3191 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003192 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003193 }
3194 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3195 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003196 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003197
Andy Whitcroft65863862009-01-06 14:41:21 -08003198 # Should start with a space.
3199 $to =~ s/^(\S)/ $1/;
3200 # Should not end with a space.
3201 $to =~ s/\s+$//;
3202 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003203 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003204 }
3205 # Modifiers should have spaces.
3206 $to =~ s/(\b$Modifier$)/$1 /;
3207
Joe Perches3705ce52013-07-03 15:05:31 -07003208## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003209 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003210 if (ERROR("POINTER_LOCATION",
3211 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3212 $fix) {
3213
3214 my $sub_from = $match;
3215 my $sub_to = $match;
3216 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003217 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003218 s@\Q$sub_from\E@$sub_to@;
3219 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003220 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003221 }
3222
3223# # no BUG() or BUG_ON()
3224# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3225# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3226# print "$herecurr";
3227# $clean = 0;
3228# }
3229
Andy Whitcroft8905a672007-11-28 16:21:06 -08003230 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003231 WARN("LINUX_VERSION_CODE",
3232 "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 -08003233 }
3234
Joe Perches17441222011-06-15 15:08:17 -07003235# check for uses of printk_ratelimit
3236 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003237 WARN("PRINTK_RATELIMITED",
3238"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003239 }
3240
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003241# printk should use KERN_* levels. Note that follow on printk's on the
3242# same line do not need a level, so we use the current block context
3243# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003244# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003245# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003246 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003247 my $ok = 0;
3248 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3249 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003250 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003251 # with "\n" ignore it, else it is to blame
3252 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3253 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3254 $ok = 1;
3255 }
3256 last;
3257 }
3258 }
3259 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003260 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3261 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003262 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003263 }
3264
Joe Perches243f3802012-05-31 16:26:09 -07003265 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3266 my $orig = $1;
3267 my $level = lc($orig);
3268 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003269 my $level2 = $level;
3270 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003271 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003272 "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 -07003273 }
3274
3275 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003276 if (WARN("PREFER_PR_LEVEL",
3277 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3278 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003279 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003280 s/\bpr_warning\b/pr_warn/;
3281 }
Joe Perches243f3802012-05-31 16:26:09 -07003282 }
3283
Joe Perchesdc139312013-02-21 16:44:13 -08003284 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3285 my $orig = $1;
3286 my $level = lc($orig);
3287 $level = "warn" if ($level eq "warning");
3288 $level = "dbg" if ($level eq "debug");
3289 WARN("PREFER_DEV_LEVEL",
3290 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3291 }
3292
Andy Whitcroft653d4872007-06-23 17:16:34 -07003293# function brace can't be on same line, except for #defines of do while,
3294# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003295 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003296 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003297 if (ERROR("OPEN_BRACE",
3298 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3299 $fix) {
3300 fix_delete_line($fixlinenr, $rawline);
3301 my $fixed_line = $rawline;
3302 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3303 my $line1 = $1;
3304 my $line2 = $2;
3305 fix_insert_line($fixlinenr, ltrim($line1));
3306 fix_insert_line($fixlinenr, "\+{");
3307 if ($line2 !~ /^\s*$/) {
3308 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3309 }
3310 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003311 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003312
Andy Whitcroft8905a672007-11-28 16:21:06 -08003313# open braces for enum, union and struct go on the same line.
3314 if ($line =~ /^.\s*{/ &&
3315 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003316 if (ERROR("OPEN_BRACE",
3317 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3318 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3319 fix_delete_line($fixlinenr - 1, $prevrawline);
3320 fix_delete_line($fixlinenr, $rawline);
3321 my $fixedline = rtrim($prevrawline) . " {";
3322 fix_insert_line($fixlinenr, $fixedline);
3323 $fixedline = $rawline;
3324 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3325 if ($fixedline !~ /^\+\s*$/) {
3326 fix_insert_line($fixlinenr, $fixedline);
3327 }
3328 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003329 }
3330
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003331# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003332 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3333 if (WARN("SPACING",
3334 "missing space after $1 definition\n" . $herecurr) &&
3335 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003336 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003337 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3338 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003339 }
3340
Joe Perches31070b52014-01-23 15:54:49 -08003341# Function pointer declarations
3342# check spacing between type, funcptr, and args
3343# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003344 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003345 my $declare = $1;
3346 my $pre_pointer_space = $2;
3347 my $post_pointer_space = $3;
3348 my $funcname = $4;
3349 my $post_funcname_space = $5;
3350 my $pre_args_space = $6;
3351
Joe Perches91f72e92014-04-03 14:49:12 -07003352# the $Declare variable will capture all spaces after the type
3353# so check it for a missing trailing missing space but pointer return types
3354# don't need a space so don't warn for those.
3355 my $post_declare_space = "";
3356 if ($declare =~ /(\s+)$/) {
3357 $post_declare_space = $1;
3358 $declare = rtrim($declare);
3359 }
3360 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003361 WARN("SPACING",
3362 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003363 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003364 }
3365
3366# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003367# This test is not currently implemented because these declarations are
3368# equivalent to
3369# int foo(int bar, ...)
3370# and this is form shouldn't/doesn't generate a checkpatch warning.
3371#
3372# elsif ($declare =~ /\s{2,}$/) {
3373# WARN("SPACING",
3374# "Multiple spaces after return type\n" . $herecurr);
3375# }
Joe Perches31070b52014-01-23 15:54:49 -08003376
3377# unnecessary space "type ( *funcptr)(args...)"
3378 if (defined $pre_pointer_space &&
3379 $pre_pointer_space =~ /^\s/) {
3380 WARN("SPACING",
3381 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3382 }
3383
3384# unnecessary space "type (* funcptr)(args...)"
3385 if (defined $post_pointer_space &&
3386 $post_pointer_space =~ /^\s/) {
3387 WARN("SPACING",
3388 "Unnecessary space before function pointer name\n" . $herecurr);
3389 }
3390
3391# unnecessary space "type (*funcptr )(args...)"
3392 if (defined $post_funcname_space &&
3393 $post_funcname_space =~ /^\s/) {
3394 WARN("SPACING",
3395 "Unnecessary space after function pointer name\n" . $herecurr);
3396 }
3397
3398# unnecessary space "type (*funcptr) (args...)"
3399 if (defined $pre_args_space &&
3400 $pre_args_space =~ /^\s/) {
3401 WARN("SPACING",
3402 "Unnecessary space before function pointer arguments\n" . $herecurr);
3403 }
3404
3405 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003406 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003407 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003408 }
3409 }
3410
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003411# check for spacing round square brackets; allowed:
3412# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003413# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3414# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003415 while ($line =~ /(.*?\s)\[/g) {
3416 my ($where, $prefix) = ($-[1], $1);
3417 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003418 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003419 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003420 if (ERROR("BRACKET_SPACE",
3421 "space prohibited before open square bracket '['\n" . $herecurr) &&
3422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003423 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003424 s/^(\+.*?)\s+\[/$1\[/;
3425 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003426 }
3427 }
3428
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003429# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003430 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003431 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003432 my $ctx_before = substr($line, 0, $-[1]);
3433 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003434
3435 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003436 if ($name =~ /^(?:
3437 if|for|while|switch|return|case|
3438 volatile|__volatile__|
3439 __attribute__|format|__extension__|
3440 asm|__asm__)$/x)
3441 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003442 # cpp #define statements have non-optional spaces, ie
3443 # if there is a space between the name and the open
3444 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003445 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003446
3447 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003448 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003449
3450 # If this whole things ends with a type its most
3451 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003452 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003453
3454 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003455 if (WARN("SPACING",
3456 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3457 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003458 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003459 s/\b$name\s+\(/$name\(/;
3460 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003461 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003462 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003463
Andy Whitcroft653d4872007-06-23 17:16:34 -07003464# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003465 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003466 my $fixed_line = "";
3467 my $line_fixed = 0;
3468
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003469 my $ops = qr{
3470 <<=|>>=|<=|>=|==|!=|
3471 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3472 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003473 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003474 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003475 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003476 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003477
3478## print("element count: <" . $#elements . ">\n");
3479## foreach my $el (@elements) {
3480## print("el: <$el>\n");
3481## }
3482
3483 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003484 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003485
Joe Perches3705ce52013-07-03 15:05:31 -07003486 foreach my $el (@elements) {
3487 push(@fix_elements, substr($rawline, $off, length($el)));
3488 $off += length($el);
3489 }
3490
3491 $off = 0;
3492
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003493 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003494 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003495
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003496 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003497
3498 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3499
3500## print("n: <$n> good: <$good>\n");
3501
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003502 $off += length($elements[$n]);
3503
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003504 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003505 my $ca = substr($opline, 0, $off);
3506 my $cc = '';
3507 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3508 $cc = substr($opline, $off + length($elements[$n + 1]));
3509 }
3510 my $cb = "$ca$;$cc";
3511
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003512 my $a = '';
3513 $a = 'V' if ($elements[$n] ne '');
3514 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003515 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003516 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3517 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003518 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003519
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003520 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003521
3522 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003523 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003524 $c = 'V' if ($elements[$n + 2] ne '');
3525 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003526 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003527 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3528 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003529 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003530 } else {
3531 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003532 }
3533
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003534 my $ctx = "${a}x${c}";
3535
3536 my $at = "(ctx:$ctx)";
3537
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003538 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003539 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003540
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003541 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003542 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003543
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003544 # Get the full operator variant.
3545 my $opv = $op . substr($curr_vars, $off, 1);
3546
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003547 # Ignore operators passed as parameters.
3548 if ($op_type ne 'V' &&
3549 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3550
Andy Whitcroftcf655042008-03-04 14:28:20 -08003551# # Ignore comments
3552# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003553
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003554 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003555 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003556 if ($ctx !~ /.x[WEBC]/ &&
3557 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003558 if (ERROR("SPACING",
3559 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003560 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003561 $line_fixed = 1;
3562 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003563 }
3564
3565 # // is a comment
3566 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003567
Joe Perchesb00e4812014-04-03 14:49:33 -07003568 # : when part of a bitfield
3569 } elsif ($opv eq ':B') {
3570 # skip the bitfield test for now
3571
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003572 # No spaces for:
3573 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003574 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003575 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003576 if (ERROR("SPACING",
3577 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003578 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003579 if (defined $fix_elements[$n + 2]) {
3580 $fix_elements[$n + 2] =~ s/^\s+//;
3581 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003582 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003583 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003584 }
3585
Joe Perches23810972014-12-10 15:51:32 -08003586 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003587 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003588 my $rtrim_before = 0;
3589 my $space_after = 0;
3590 if ($ctx =~ /Wx./) {
3591 if (ERROR("SPACING",
3592 "space prohibited before that '$op' $at\n" . $hereptr)) {
3593 $line_fixed = 1;
3594 $rtrim_before = 1;
3595 }
3596 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003597 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003598 if (ERROR("SPACING",
3599 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003600 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003601 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003602 $space_after = 1;
3603 }
3604 }
3605 if ($rtrim_before || $space_after) {
3606 if ($rtrim_before) {
3607 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3608 } else {
3609 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3610 }
3611 if ($space_after) {
3612 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003613 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003614 }
3615
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003616 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003617 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003618 #warn "'*' is part of type\n";
3619
3620 # unary operators should have a space before and
3621 # none after. May be left adjacent to another
3622 # unary operator, or a cast
3623 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003624 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003625 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003626 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003627 if (ERROR("SPACING",
3628 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003629 if ($n != $last_after + 2) {
3630 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3631 $line_fixed = 1;
3632 }
Joe Perches3705ce52013-07-03 15:05:31 -07003633 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003634 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003635 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003636 # A unary '*' may be const
3637
3638 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003639 if (ERROR("SPACING",
3640 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003641 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003642 if (defined $fix_elements[$n + 2]) {
3643 $fix_elements[$n + 2] =~ s/^\s+//;
3644 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003645 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003646 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003647 }
3648
3649 # unary ++ and unary -- are allowed no space on one side.
3650 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003651 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003652 if (ERROR("SPACING",
3653 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003654 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003655 $line_fixed = 1;
3656 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003657 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003658 if ($ctx =~ /Wx[BE]/ ||
3659 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003660 if (ERROR("SPACING",
3661 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003662 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003663 $line_fixed = 1;
3664 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003665 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003666 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003667 if (ERROR("SPACING",
3668 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003669 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003670 if (defined $fix_elements[$n + 2]) {
3671 $fix_elements[$n + 2] =~ s/^\s+//;
3672 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003673 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003674 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003675 }
3676
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003677 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003678 } elsif ($op eq '<<' or $op eq '>>' or
3679 $op eq '&' or $op eq '^' or $op eq '|' or
3680 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003681 $op eq '*' or $op eq '/' or
3682 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003683 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003684 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003685 if (ERROR("SPACING",
3686 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003687 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3688 if (defined $fix_elements[$n + 2]) {
3689 $fix_elements[$n + 2] =~ s/^\s+//;
3690 }
Joe Perches3705ce52013-07-03 15:05:31 -07003691 $line_fixed = 1;
3692 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003693 }
3694
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003695 # A colon needs no spaces before when it is
3696 # terminating a case value or a label.
3697 } elsif ($opv eq ':C' || $opv eq ':L') {
3698 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003699 if (ERROR("SPACING",
3700 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003701 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003702 $line_fixed = 1;
3703 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003704 }
3705
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003706 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003707 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003708 my $ok = 0;
3709
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003710 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003711 if (($op eq '<' &&
3712 $cc =~ /^\S+\@\S+>/) ||
3713 ($op eq '>' &&
3714 $ca =~ /<\S+\@\S+$/))
3715 {
3716 $ok = 1;
3717 }
3718
Joe Perches84731622013-11-12 15:10:05 -08003719 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003720 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003721 my $msg_type = \&ERROR;
3722 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3723
3724 if (&{$msg_type}("SPACING",
3725 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003726 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3727 if (defined $fix_elements[$n + 2]) {
3728 $fix_elements[$n + 2] =~ s/^\s+//;
3729 }
Joe Perches3705ce52013-07-03 15:05:31 -07003730 $line_fixed = 1;
3731 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003732 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003733 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003734 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003735
3736## print("n: <$n> GOOD: <$good>\n");
3737
3738 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003739 }
Joe Perches3705ce52013-07-03 15:05:31 -07003740
3741 if (($#elements % 2) == 0) {
3742 $fixed_line = $fixed_line . $fix_elements[$#elements];
3743 }
3744
Joe Perches194f66f2014-08-06 16:11:03 -07003745 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3746 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003747 }
3748
3749
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003750 }
3751
Joe Perches786b6322013-07-03 15:05:32 -07003752# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003753 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003754 if (WARN("SPACING",
3755 "space prohibited before semicolon\n" . $herecurr) &&
3756 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003757 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003758 s/^(\+.*\S)\s+;/$1;/;
3759 }
3760 }
3761
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003762# check for multiple assignments
3763 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003764 CHK("MULTIPLE_ASSIGNMENTS",
3765 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003766 }
3767
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003768## # check for multiple declarations, allowing for a function declaration
3769## # continuation.
3770## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3771## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3772##
3773## # Remove any bracketed sections to ensure we do not
3774## # falsly report the parameters of functions.
3775## my $ln = $line;
3776## while ($ln =~ s/\([^\(\)]*\)//g) {
3777## }
3778## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003779## WARN("MULTIPLE_DECLARATION",
3780## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003781## }
3782## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003783
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003784#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003785 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3786 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003787 if (ERROR("SPACING",
3788 "space required before the open brace '{'\n" . $herecurr) &&
3789 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003790 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003791 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003792 }
3793
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003794## # check for blank lines before declarations
3795## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3796## $prevrawline =~ /^.\s*$/) {
3797## WARN("SPACING",
3798## "No blank lines before declarations\n" . $hereprev);
3799## }
3800##
3801
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003802# closing brace should have a space following it when it has anything
3803# on the line
3804 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003805 if (ERROR("SPACING",
3806 "space required after that close brace '}'\n" . $herecurr) &&
3807 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003808 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003809 s/}((?!(?:,|;|\)))\S)/} $1/;
3810 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003811 }
3812
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003813# check spacing on square brackets
3814 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003815 if (ERROR("SPACING",
3816 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3817 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003818 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003819 s/\[\s+/\[/;
3820 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003821 }
3822 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003823 if (ERROR("SPACING",
3824 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3825 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003826 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003827 s/\s+\]/\]/;
3828 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003829 }
3830
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003831# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003832 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3833 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003834 if (ERROR("SPACING",
3835 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3836 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003837 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003838 s/\(\s+/\(/;
3839 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003840 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003841 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003842 $line !~ /for\s*\(.*;\s+\)/ &&
3843 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003844 if (ERROR("SPACING",
3845 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3846 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003847 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003848 s/\s+\)/\)/;
3849 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003850 }
3851
Joe Perchese2826fd2014-08-06 16:10:48 -07003852# check unnecessary parentheses around addressof/dereference single $Lvals
3853# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3854
3855 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08003856 my $var = $1;
3857 if (CHK("UNNECESSARY_PARENTHESES",
3858 "Unnecessary parentheses around $var\n" . $herecurr) &&
3859 $fix) {
3860 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3861 }
3862 }
3863
3864# check for unnecessary parentheses around function pointer uses
3865# ie: (foo->bar)(); should be foo->bar();
3866# but not "if (foo->bar) (" to avoid some false positives
3867 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3868 my $var = $2;
3869 if (CHK("UNNECESSARY_PARENTHESES",
3870 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3871 $fix) {
3872 my $var2 = deparenthesize($var);
3873 $var2 =~ s/\s//g;
3874 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3875 }
3876 }
Joe Perchese2826fd2014-08-06 16:10:48 -07003877
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003878#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003879 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003880 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003881 if (WARN("INDENTED_LABEL",
3882 "labels should not be indented\n" . $herecurr) &&
3883 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003884 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003885 s/^(.)\s+/$1/;
3886 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003887 }
3888
Joe Perches5b9553a2014-04-03 14:49:21 -07003889# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003890 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003891 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003892 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003893 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3894 my $value = $1;
3895 $value = deparenthesize($value);
3896 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3897 ERROR("RETURN_PARENTHESES",
3898 "return is not a function, parentheses are not required\n" . $herecurr);
3899 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003900 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003901 ERROR("SPACING",
3902 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003903 }
3904 }
Joe Perches507e5142013-11-12 15:10:13 -08003905
Joe Perchesb43ae212014-06-23 13:22:07 -07003906# unnecessary return in a void function
3907# at end-of-function, with the previous line a single leading tab, then return;
3908# and the line before that not a goto label target like "out:"
3909 if ($sline =~ /^[ \+]}\s*$/ &&
3910 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3911 $linenr >= 3 &&
3912 $lines[$linenr - 3] =~ /^[ +]/ &&
3913 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003914 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003915 "void function return statements are not generally useful\n" . $hereprev);
3916 }
Joe Perches9819cf22014-06-04 16:12:09 -07003917
Joe Perches189248d2014-01-23 15:54:47 -08003918# if statements using unnecessary parentheses - ie: if ((foo == bar))
3919 if ($^V && $^V ge 5.10.0 &&
3920 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3921 my $openparens = $1;
3922 my $count = $openparens =~ tr@\(@\(@;
3923 my $msg = "";
3924 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3925 my $comp = $4; #Not $1 because of $LvalOrFunc
3926 $msg = " - maybe == should be = ?" if ($comp eq "==");
3927 WARN("UNNECESSARY_PARENTHESES",
3928 "Unnecessary parentheses$msg\n" . $herecurr);
3929 }
3930 }
3931
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003932# Return of what appears to be an errno should normally be -'ve
3933 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3934 my $name = $1;
3935 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003936 WARN("USE_NEGATIVE_ERRNO",
3937 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003938 }
3939 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003940
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003941# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003942 if ($line =~ /\b(if|while|for|switch)\(/) {
3943 if (ERROR("SPACING",
3944 "space required before the open parenthesis '('\n" . $herecurr) &&
3945 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003946 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003947 s/\b(if|while|for|switch)\(/$1 \(/;
3948 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003949 }
3950
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003951# Check for illegal assignment in if conditional -- and check for trailing
3952# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003953 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003954 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3955 ctx_statement_block($linenr, $realcnt, 0)
3956 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003957 my ($stat_next) = ctx_statement_block($line_nr_next,
3958 $remain_next, $off_next);
3959 $stat_next =~ s/\n./\n /g;
3960 ##print "stat<$stat> stat_next<$stat_next>\n";
3961
3962 if ($stat_next =~ /^\s*while\b/) {
3963 # If the statement carries leading newlines,
3964 # then count those as offsets.
3965 my ($whitespace) =
3966 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3967 my $offset =
3968 statement_rawlines($whitespace) - 1;
3969
3970 $suppress_whiletrailers{$line_nr_next +
3971 $offset} = 1;
3972 }
3973 }
3974 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003975 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003976 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003977 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003978
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003979 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003980 ERROR("ASSIGN_IN_IF",
3981 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003982 }
3983
3984 # Find out what is on the end of the line after the
3985 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003986 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003987 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003988 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003989 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3990 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003991 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003992 # Find out how long the conditional actually is.
3993 my @newlines = ($c =~ /\n/gs);
3994 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003995 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003996
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003997 $stat_real = raw_line($linenr, $cond_lines)
3998 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003999 if (defined($stat_real) && $cond_lines > 1) {
4000 $stat_real = "[...]\n$stat_real";
4001 }
4002
Joe Perches000d1cc12011-07-25 17:13:25 -07004003 ERROR("TRAILING_STATEMENTS",
4004 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004005 }
4006 }
4007
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004008# Check for bitwise tests written as boolean
4009 if ($line =~ /
4010 (?:
4011 (?:\[|\(|\&\&|\|\|)
4012 \s*0[xX][0-9]+\s*
4013 (?:\&\&|\|\|)
4014 |
4015 (?:\&\&|\|\|)
4016 \s*0[xX][0-9]+\s*
4017 (?:\&\&|\|\||\)|\])
4018 )/x)
4019 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004020 WARN("HEXADECIMAL_BOOLEAN_TEST",
4021 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004022 }
4023
Andy Whitcroft8905a672007-11-28 16:21:06 -08004024# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004025 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4026 my $s = $1;
4027 $s =~ s/$;//g; # Remove any comments
4028 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004029 ERROR("TRAILING_STATEMENTS",
4030 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004031 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004032 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004033# if should not continue a brace
4034 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004035 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004036 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004037 $herecurr);
4038 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004039# case and default should not have general statements after them
4040 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4041 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004042 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004043 \s*return\s+
4044 )/xg)
4045 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004046 ERROR("TRAILING_STATEMENTS",
4047 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004048 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004049
4050 # Check for }<nl>else {, these must be at the same
4051 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004052 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4053 $previndent == $indent) {
4054 if (ERROR("ELSE_AFTER_BRACE",
4055 "else should follow close brace '}'\n" . $hereprev) &&
4056 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4057 fix_delete_line($fixlinenr - 1, $prevrawline);
4058 fix_delete_line($fixlinenr, $rawline);
4059 my $fixedline = $prevrawline;
4060 $fixedline =~ s/}\s*$//;
4061 if ($fixedline !~ /^\+\s*$/) {
4062 fix_insert_line($fixlinenr, $fixedline);
4063 }
4064 $fixedline = $rawline;
4065 $fixedline =~ s/^(.\s*)else/$1} else/;
4066 fix_insert_line($fixlinenr, $fixedline);
4067 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004068 }
4069
Joe Perches8b8856f2014-08-06 16:11:14 -07004070 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4071 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004072 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4073
4074 # Find out what is on the end of the line after the
4075 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004076 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004077 $s =~ s/\n.*//g;
4078
4079 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004080 if (ERROR("WHILE_AFTER_BRACE",
4081 "while should follow close brace '}'\n" . $hereprev) &&
4082 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4083 fix_delete_line($fixlinenr - 1, $prevrawline);
4084 fix_delete_line($fixlinenr, $rawline);
4085 my $fixedline = $prevrawline;
4086 my $trailing = $rawline;
4087 $trailing =~ s/^\+//;
4088 $trailing = trim($trailing);
4089 $fixedline =~ s/}\s*$/} $trailing/;
4090 fix_insert_line($fixlinenr, $fixedline);
4091 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004092 }
4093 }
4094
Joe Perches95e2c602013-07-03 15:05:20 -07004095#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004096 while ($line =~ m{($Constant|$Lval)}g) {
4097 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004098
4099#gcc binary extension
4100 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004101 if (WARN("GCC_BINARY_CONSTANT",
4102 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4103 $fix) {
4104 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004105 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004106 s/\b$var\b/$hexval/;
4107 }
Joe Perches95e2c602013-07-03 15:05:20 -07004108 }
4109
4110#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004111 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004112 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004113#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004114 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004115#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004116 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4117#Ignore some three character SI units explicitly, like MiB and KHz
4118 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004119 while ($var =~ m{($Ident)}g) {
4120 my $word = $1;
4121 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004122 if ($check) {
4123 seed_camelcase_includes();
4124 if (!$file && !$camelcase_file_seeded) {
4125 seed_camelcase_file($realfile);
4126 $camelcase_file_seeded = 1;
4127 }
4128 }
Joe Perches7e781f62013-09-11 14:23:55 -07004129 if (!defined $camelcase{$word}) {
4130 $camelcase{$word} = 1;
4131 CHK("CAMELCASE",
4132 "Avoid CamelCase: <$word>\n" . $herecurr);
4133 }
Joe Perches34456862013-07-03 15:05:34 -07004134 }
Joe Perches323c1262012-12-17 16:02:07 -08004135 }
4136 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004137
4138#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004139 if ($line =~ /\#\s*define.*\\\s+$/) {
4140 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4141 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4142 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004143 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004144 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004145 }
4146
Andy Whitcroft653d4872007-06-23 17:16:34 -07004147#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004148 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004149 my $file = "$1.h";
4150 my $checkfile = "include/linux/$file";
4151 if (-f "$root/$checkfile" &&
4152 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004153 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004154 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004155 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004156 CHK("ARCH_INCLUDE_LINUX",
4157 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004158 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004159 WARN("INCLUDE_LINUX",
4160 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004161 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004162 }
4163 }
4164
Andy Whitcroft653d4872007-06-23 17:16:34 -07004165# multi-statement macros should be enclosed in a do while loop, grab the
4166# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004167# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004168 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4169 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004170 my $ln = $linenr;
4171 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004172 my ($off, $dstat, $dcond, $rest);
4173 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004174 my $has_flow_statement = 0;
4175 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004176 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004177 ctx_statement_block($linenr, $realcnt, 0);
4178 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004179 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004180 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004181
Joe Perches08a28432014-10-13 15:51:55 -07004182 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4183 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4184
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004185 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004186 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004187 $dstat =~ s/\\\n.//g;
4188 $dstat =~ s/^\s*//s;
4189 $dstat =~ s/\s*$//s;
4190
4191 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004192 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4193 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004194 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004195 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004196 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004197
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004198 # Flatten any obvious string concatentation.
4199 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4200 $dstat =~ s/$Ident\s*("X*")/$1/)
4201 {
4202 }
4203
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004204 my $exceptions = qr{
4205 $Declare|
4206 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004207 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004208 DECLARE_PER_CPU|
4209 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004210 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004211 union|
4212 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004213 \.$Ident\s*=\s*|
4214 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004215 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004216 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004217 if ($dstat ne '' &&
4218 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4219 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004220 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004221 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004222 $dstat !~ /$exceptions/ &&
4223 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004224 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004225 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004226 $dstat !~ /^for\s*$Constant$/ && # for (...)
4227 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4228 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004229 $dstat !~ /^\({/ && # ({...
4230 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004231 {
4232 $ctx =~ s/\n*$//;
4233 my $herectx = $here . "\n";
4234 my $cnt = statement_rawlines($ctx);
4235
4236 for (my $n = 0; $n < $cnt; $n++) {
4237 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004238 }
4239
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004240 if ($dstat =~ /;/) {
4241 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4242 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4243 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004244 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004245 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004246 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004247 }
Joe Perches5023d342012-12-17 16:01:47 -08004248
Joe Perches08a28432014-10-13 15:51:55 -07004249# check for macros with flow control, but without ## concatenation
4250# ## concatenation is commonly a macro that defines a function so ignore those
4251 if ($has_flow_statement && !$has_arg_concat) {
4252 my $herectx = $here . "\n";
4253 my $cnt = statement_rawlines($ctx);
4254
4255 for (my $n = 0; $n < $cnt; $n++) {
4256 $herectx .= raw_line($linenr, $n) . "\n";
4257 }
4258 WARN("MACRO_WITH_FLOW_CONTROL",
4259 "Macros with flow control statements should be avoided\n" . "$herectx");
4260 }
4261
Joe Perches481eb482012-12-17 16:01:56 -08004262# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004263
4264 } else {
4265 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004266 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4267 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004268 $line =~ /^\+.*\\$/) {
4269 WARN("LINE_CONTINUATIONS",
4270 "Avoid unnecessary line continuations\n" . $herecurr);
4271 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004272 }
4273
Joe Perchesb13edf72012-07-30 14:41:24 -07004274# do {} while (0) macro tests:
4275# single-statement macros do not need to be enclosed in do while (0) loop,
4276# macro should not end with a semicolon
4277 if ($^V && $^V ge 5.10.0 &&
4278 $realfile !~ m@/vmlinux.lds.h$@ &&
4279 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4280 my $ln = $linenr;
4281 my $cnt = $realcnt;
4282 my ($off, $dstat, $dcond, $rest);
4283 my $ctx = '';
4284 ($dstat, $dcond, $ln, $cnt, $off) =
4285 ctx_statement_block($linenr, $realcnt, 0);
4286 $ctx = $dstat;
4287
4288 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004289 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004290
4291 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4292 my $stmts = $2;
4293 my $semis = $3;
4294
4295 $ctx =~ s/\n*$//;
4296 my $cnt = statement_rawlines($ctx);
4297 my $herectx = $here . "\n";
4298
4299 for (my $n = 0; $n < $cnt; $n++) {
4300 $herectx .= raw_line($linenr, $n) . "\n";
4301 }
4302
Joe Perchesac8e97f2012-08-21 16:15:53 -07004303 if (($stmts =~ tr/;/;/) == 1 &&
4304 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004305 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4306 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4307 }
4308 if (defined $semis && $semis ne "") {
4309 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4310 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4311 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004312 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4313 $ctx =~ s/\n*$//;
4314 my $cnt = statement_rawlines($ctx);
4315 my $herectx = $here . "\n";
4316
4317 for (my $n = 0; $n < $cnt; $n++) {
4318 $herectx .= raw_line($linenr, $n) . "\n";
4319 }
4320
4321 WARN("TRAILING_SEMICOLON",
4322 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004323 }
4324 }
4325
Mike Frysinger080ba922009-01-06 14:41:25 -08004326# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4327# all assignments may have only one of the following with an assignment:
4328# .
4329# ALIGN(...)
4330# VMLINUX_SYMBOL(...)
4331 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004332 WARN("MISSING_VMLINUX_SYMBOL",
4333 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004334 }
4335
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004336# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004337 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4338 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004339 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004340 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004341 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4342 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004343 my @allowed = ();
4344 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004345 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004346 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004347 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004348 for my $chunk (@chunks) {
4349 my ($cond, $block) = @{$chunk};
4350
Andy Whitcroft773647a2008-03-28 14:15:58 -07004351 # If the condition carries leading newlines, then count those as offsets.
4352 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4353 my $offset = statement_rawlines($whitespace) - 1;
4354
Joe Perchesaad4f612012-03-23 15:02:19 -07004355 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004356 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4357
4358 # We have looked at and allowed this specific line.
4359 $suppress_ifbraces{$ln + $offset} = 1;
4360
4361 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004362 $ln += statement_rawlines($block) - 1;
4363
Andy Whitcroft773647a2008-03-28 14:15:58 -07004364 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004365
4366 $seen++ if ($block =~ /^\s*{/);
4367
Joe Perchesaad4f612012-03-23 15:02:19 -07004368 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004369 if (statement_lines($cond) > 1) {
4370 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004371 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004372 }
4373 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004374 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004375 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004376 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004377 if (statement_block_size($block) > 1) {
4378 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004379 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004380 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004381 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004382 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004383 if ($seen) {
4384 my $sum_allowed = 0;
4385 foreach (@allowed) {
4386 $sum_allowed += $_;
4387 }
4388 if ($sum_allowed == 0) {
4389 WARN("BRACES",
4390 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4391 } elsif ($sum_allowed != $allow &&
4392 $seen != $allow) {
4393 CHK("BRACES",
4394 "braces {} should be used on all arms of this statement\n" . $herectx);
4395 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004396 }
4397 }
4398 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004399 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004400 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004401 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004402
Andy Whitcroftcf655042008-03-04 14:28:20 -08004403 # Check the pre-context.
4404 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4405 #print "APW: ALLOWED: pre<$1>\n";
4406 $allowed = 1;
4407 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004408
4409 my ($level, $endln, @chunks) =
4410 ctx_statement_full($linenr, $realcnt, $-[0]);
4411
Andy Whitcroftcf655042008-03-04 14:28:20 -08004412 # Check the condition.
4413 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004414 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004415 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004416 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004417 }
4418 if (statement_lines($cond) > 1) {
4419 #print "APW: ALLOWED: cond<$cond>\n";
4420 $allowed = 1;
4421 }
4422 if ($block =~/\b(?:if|for|while)\b/) {
4423 #print "APW: ALLOWED: block<$block>\n";
4424 $allowed = 1;
4425 }
4426 if (statement_block_size($block) > 1) {
4427 #print "APW: ALLOWED: lines block<$block>\n";
4428 $allowed = 1;
4429 }
4430 # Check the post-context.
4431 if (defined $chunks[1]) {
4432 my ($cond, $block) = @{$chunks[1]};
4433 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004434 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004435 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004436 if ($block =~ /^\s*\{/) {
4437 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4438 $allowed = 1;
4439 }
4440 }
4441 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004442 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004443 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004444
Andy Whitcroftf0556632008-10-15 22:02:23 -07004445 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004446 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004447 }
4448
Joe Perches000d1cc12011-07-25 17:13:25 -07004449 WARN("BRACES",
4450 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004451 }
4452 }
4453
Joe Perches0979ae62012-12-17 16:01:59 -08004454# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004455 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004456 CHK("BRACES",
4457 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4458 }
Joe Perches77b9a532013-07-03 15:05:29 -07004459 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004460 CHK("BRACES",
4461 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4462 }
4463
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004464# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004465 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4466 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004467 WARN("VOLATILE",
4468 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004469 }
4470
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004471# Check for user-visible strings broken across lines, which breaks the ability
4472# to grep for the string. Make exceptions when the previous string ends in a
4473# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4474# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4475 if ($line =~ /^\+\s*"[X\t]*"/ &&
4476 $prevline =~ /"\s*$/ &&
4477 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4478 if (WARN("SPLIT_STRING",
4479 "quoted string split across lines\n" . $hereprev) &&
4480 $fix &&
4481 $prevrawline =~ /^\+.*"\s*$/ &&
4482 $last_coalesced_string_linenr != $linenr - 1) {
4483 my $extracted_string = get_quoted_string($line, $rawline);
4484 my $comma_close = "";
4485 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4486 $comma_close = $1;
4487 }
4488
4489 fix_delete_line($fixlinenr - 1, $prevrawline);
4490 fix_delete_line($fixlinenr, $rawline);
4491 my $fixedline = $prevrawline;
4492 $fixedline =~ s/"\s*$//;
4493 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4494 fix_insert_line($fixlinenr - 1, $fixedline);
4495 $fixedline = $rawline;
4496 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4497 if ($fixedline !~ /\+\s*$/) {
4498 fix_insert_line($fixlinenr, $fixedline);
4499 }
4500 $last_coalesced_string_linenr = $linenr;
4501 }
4502 }
4503
4504# check for missing a space in a string concatenation
4505 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4506 WARN('MISSING_SPACE',
4507 "break quoted strings at a space character\n" . $hereprev);
4508 }
4509
4510# check for spaces before a quoted newline
4511 if ($rawline =~ /^.*\".*\s\\n/) {
4512 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4513 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4514 $fix) {
4515 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4516 }
4517
4518 }
4519
Joe Perchesf17dba42014-10-13 15:51:51 -07004520# concatenated string without spaces between elements
4521 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4522 CHK("CONCATENATED_STRING",
4523 "Concatenated strings should use spaces between elements\n" . $herecurr);
4524 }
4525
Joe Perches90ad30e2014-12-10 15:51:59 -08004526# uncoalesced string fragments
4527 if ($line =~ /"X*"\s*"/) {
4528 WARN("STRING_FRAGMENTS",
4529 "Consecutive strings are generally better as a single string\n" . $herecurr);
4530 }
4531
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004532# check for %L{u,d,i} in strings
4533 my $string;
4534 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4535 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4536 $string =~ s/%%/__/g;
4537 if ($string =~ /(?<!%)%L[udi]/) {
4538 WARN("PRINTF_L",
4539 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4540 last;
4541 }
4542 }
4543
4544# check for line continuations in quoted strings with odd counts of "
4545 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4546 WARN("LINE_CONTINUATIONS",
4547 "Avoid line continuations in quoted strings\n" . $herecurr);
4548 }
4549
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004550# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004551 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004552 CHK("REDUNDANT_CODE",
4553 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004554 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004555 }
4556
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004557# check for needless "if (<foo>) fn(<foo>)" uses
4558 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4559 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4560 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4561 WARN('NEEDLESS_IF',
Fabio Estevam15160f92014-12-10 15:51:40 -08004562 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004563 }
4564 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004565
Joe Perchesebfdc402014-08-06 16:10:27 -07004566# check for unnecessary "Out of Memory" messages
4567 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4568 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4569 (defined $1 || defined $3) &&
4570 $linenr > 3) {
4571 my $testval = $2;
4572 my $testline = $lines[$linenr - 3];
4573
4574 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4575# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4576
4577 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4578 WARN("OOM_MESSAGE",
4579 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4580 }
4581 }
4582
Joe Perchesf78d98f2014-10-13 15:52:01 -07004583# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08004584 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07004585 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4586 my $level = $1;
4587 if (WARN("UNNECESSARY_KERN_LEVEL",
4588 "Possible unnecessary $level\n" . $herecurr) &&
4589 $fix) {
4590 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4591 }
4592 }
4593
Joe Perchesabb08a52014-12-10 15:51:46 -08004594# check for mask then right shift without a parentheses
4595 if ($^V && $^V ge 5.10.0 &&
4596 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4597 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4598 WARN("MASK_THEN_SHIFT",
4599 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4600 }
4601
Joe Perchesb75ac612014-12-10 15:52:02 -08004602# check for pointer comparisons to NULL
4603 if ($^V && $^V ge 5.10.0) {
4604 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4605 my $val = $1;
4606 my $equal = "!";
4607 $equal = "" if ($4 eq "!=");
4608 if (CHK("COMPARISON_TO_NULL",
4609 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4610 $fix) {
4611 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4612 }
4613 }
4614 }
4615
Joe Perches8716de32013-09-11 14:24:05 -07004616# check for bad placement of section $InitAttribute (e.g.: __initdata)
4617 if ($line =~ /(\b$InitAttribute\b)/) {
4618 my $attr = $1;
4619 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4620 my $ptr = $1;
4621 my $var = $2;
4622 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4623 ERROR("MISPLACED_INIT",
4624 "$attr should be placed after $var\n" . $herecurr)) ||
4625 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4626 WARN("MISPLACED_INIT",
4627 "$attr should be placed after $var\n" . $herecurr))) &&
4628 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004629 $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 -07004630 }
4631 }
4632 }
4633
Joe Perchese970b8842013-11-12 15:10:10 -08004634# check for $InitAttributeData (ie: __initdata) with const
4635 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4636 my $attr = $1;
4637 $attr =~ /($InitAttributePrefix)(.*)/;
4638 my $attr_prefix = $1;
4639 my $attr_type = $2;
4640 if (ERROR("INIT_ATTRIBUTE",
4641 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4642 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004643 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004644 s/$InitAttributeData/${attr_prefix}initconst/;
4645 }
4646 }
4647
4648# check for $InitAttributeConst (ie: __initconst) without const
4649 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4650 my $attr = $1;
4651 if (ERROR("INIT_ATTRIBUTE",
4652 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4653 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004654 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004655 /(^\+\s*(?:static\s+))/;
4656 $lead = rtrim($1);
4657 $lead = "$lead " if ($lead !~ /^\+$/);
4658 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004659 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08004660 }
4661 }
4662
Joe Perchesfbdb8132014-04-03 14:49:14 -07004663# don't use __constant_<foo> functions outside of include/uapi/
4664 if ($realfile !~ m@^include/uapi/@ &&
4665 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4666 my $constant_func = $1;
4667 my $func = $constant_func;
4668 $func =~ s/^__constant_//;
4669 if (WARN("CONSTANT_CONVERSION",
4670 "$constant_func should be $func\n" . $herecurr) &&
4671 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004672 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004673 }
4674 }
4675
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004676# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004677 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004678 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004679 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004680 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004681 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004682 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4683 }
4684 if ($delay > 2000) {
4685 WARN("LONG_UDELAY",
4686 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004687 }
4688 }
4689
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004690# warn about unexpectedly long msleep's
4691 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4692 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004693 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004694 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004695 }
4696 }
4697
Joe Perches36ec1932013-07-03 15:05:25 -07004698# check for comparisons of jiffies
4699 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4700 WARN("JIFFIES_COMPARISON",
4701 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4702 }
4703
Joe Perches9d7a34a2013-07-03 15:05:26 -07004704# check for comparisons of get_jiffies_64()
4705 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4706 WARN("JIFFIES_COMPARISON",
4707 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4708 }
4709
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004710# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004711# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004712# print "#ifdef in C files should be avoided\n";
4713# print "$herecurr";
4714# $clean = 0;
4715# }
4716
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004717# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004718 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004719 if (ERROR("SPACING",
4720 "exactly one space required after that #$1\n" . $herecurr) &&
4721 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004722 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004723 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4724 }
4725
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004726 }
4727
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004728# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004729 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4730 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004731 my $which = $1;
4732 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004733 CHK("UNCOMMENTED_DEFINITION",
4734 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004735 }
4736 }
4737# check for memory barriers without a comment.
4738 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4739 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004740 WARN("MEMORY_BARRIER",
4741 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004742 }
4743 }
4744# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004745 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004746 CHK("ARCH_DEFINES",
4747 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004748 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004749
Tobias Klauserd4977c72010-05-24 14:33:30 -07004750# Check that the storage class is at the beginning of a declaration
4751 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004752 WARN("STORAGE_CLASS",
4753 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004754 }
4755
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004756# check the location of the inline attribute, that it is between
4757# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004758 if ($line =~ /\b$Type\s+$Inline\b/ ||
4759 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004760 ERROR("INLINE_LOCATION",
4761 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004762 }
4763
Andy Whitcroft8905a672007-11-28 16:21:06 -08004764# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004765 if ($realfile !~ m@\binclude/uapi/@ &&
4766 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004767 if (WARN("INLINE",
4768 "plain inline is preferred over $1\n" . $herecurr) &&
4769 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004770 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004771
4772 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004773 }
4774
Joe Perches3d130fd2011-01-12 17:00:00 -08004775# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004776 if ($realfile !~ m@\binclude/uapi/@ &&
4777 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004778 WARN("PREFER_PACKED",
4779 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004780 }
4781
Joe Perches39b7e282011-07-25 17:13:24 -07004782# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004783 if ($realfile !~ m@\binclude/uapi/@ &&
4784 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004785 WARN("PREFER_ALIGNED",
4786 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004787 }
4788
Joe Perches5f14d3b2012-01-10 15:09:52 -08004789# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004790 if ($realfile !~ m@\binclude/uapi/@ &&
4791 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004792 if (WARN("PREFER_PRINTF",
4793 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4794 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004795 $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 -07004796
4797 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004798 }
4799
Joe Perches6061d942012-03-23 15:02:16 -07004800# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004801 if ($realfile !~ m@\binclude/uapi/@ &&
4802 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004803 if (WARN("PREFER_SCANF",
4804 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4805 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004806 $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 -07004807 }
Joe Perches6061d942012-03-23 15:02:16 -07004808 }
4809
Joe Perches619a9082014-12-10 15:51:35 -08004810# Check for __attribute__ weak, or __weak declarations (may have link issues)
4811 if ($^V && $^V ge 5.10.0 &&
4812 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4813 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4814 $line =~ /\b__weak\b/)) {
4815 ERROR("WEAK_DECLARATION",
4816 "Using weak declarations can have unintended link defects\n" . $herecurr);
4817 }
4818
Joe Perches8f53a9b2010-03-05 13:43:48 -08004819# check for sizeof(&)
4820 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004821 WARN("SIZEOF_ADDRESS",
4822 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004823 }
4824
Joe Perches66c80b62012-07-30 14:41:22 -07004825# check for sizeof without parenthesis
4826 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004827 if (WARN("SIZEOF_PARENTHESIS",
4828 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4829 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004830 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004831 }
Joe Perches66c80b62012-07-30 14:41:22 -07004832 }
4833
Joe Perches88982fe2012-12-17 16:02:00 -08004834# check for struct spinlock declarations
4835 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4836 WARN("USE_SPINLOCK_T",
4837 "struct spinlock should be spinlock_t\n" . $herecurr);
4838 }
4839
Joe Perchesa6962d72013-04-29 16:18:13 -07004840# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004841 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004842 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004843 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004844 if (WARN("PREFER_SEQ_PUTS",
4845 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4846 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004847 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004848 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004849 }
4850 }
4851
Andy Whitcroft554e1652012-01-10 15:09:57 -08004852# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004853 if ($^V && $^V ge 5.10.0 &&
4854 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004855 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004856
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004857 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004858 my $ms_val = $7;
4859 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004860
Andy Whitcroft554e1652012-01-10 15:09:57 -08004861 if ($ms_size =~ /^(0x|)0$/i) {
4862 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004863 "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 -08004864 } elsif ($ms_size =~ /^(0x|)1$/i) {
4865 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004866 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4867 }
4868 }
4869
Joe Perches98a9bba2014-01-23 15:54:52 -08004870# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4871 if ($^V && $^V ge 5.10.0 &&
4872 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4873 if (WARN("PREFER_ETHER_ADDR_COPY",
4874 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4875 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004876 $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 -08004877 }
4878 }
4879
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004880# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004881 if ($^V && $^V ge 5.10.0 &&
4882 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004883 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004884 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004885 my $call = $1;
4886 my $cast1 = deparenthesize($2);
4887 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004888 my $cast2 = deparenthesize($7);
4889 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004890 my $cast;
4891
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004892 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004893 $cast = "$cast1 or $cast2";
4894 } elsif ($cast1 ne "") {
4895 $cast = $cast1;
4896 } else {
4897 $cast = $cast2;
4898 }
4899 WARN("MINMAX",
4900 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004901 }
4902 }
4903
Joe Perches4a273192012-07-30 14:41:20 -07004904# check usleep_range arguments
4905 if ($^V && $^V ge 5.10.0 &&
4906 defined $stat &&
4907 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4908 my $min = $1;
4909 my $max = $7;
4910 if ($min eq $max) {
4911 WARN("USLEEP_RANGE",
4912 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4913 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4914 $min > $max) {
4915 WARN("USLEEP_RANGE",
4916 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4917 }
4918 }
4919
Joe Perches823b7942013-11-12 15:10:15 -08004920# check for naked sscanf
4921 if ($^V && $^V ge 5.10.0 &&
4922 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004923 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004924 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4925 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4926 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4927 my $lc = $stat =~ tr@\n@@;
4928 $lc = $lc + $linenr;
4929 my $stat_real = raw_line($linenr, 0);
4930 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4931 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4932 }
4933 WARN("NAKED_SSCANF",
4934 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4935 }
4936
Joe Perchesafc819a2014-06-04 16:12:08 -07004937# check for simple sscanf that should be kstrto<foo>
4938 if ($^V && $^V ge 5.10.0 &&
4939 defined $stat &&
4940 $line =~ /\bsscanf\b/) {
4941 my $lc = $stat =~ tr@\n@@;
4942 $lc = $lc + $linenr;
4943 my $stat_real = raw_line($linenr, 0);
4944 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4945 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4946 }
4947 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4948 my $format = $6;
4949 my $count = $format =~ tr@%@%@;
4950 if ($count == 1 &&
4951 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4952 WARN("SSCANF_TO_KSTRTO",
4953 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4954 }
4955 }
4956 }
4957
Joe Perches70dc8a42013-09-11 14:23:58 -07004958# check for new externs in .h files.
4959 if ($realfile =~ /\.h$/ &&
4960 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004961 if (CHK("AVOID_EXTERNS",
4962 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004963 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004964 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004965 }
4966 }
4967
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004968# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004969 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004970 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004971 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004972 my $function_name = $1;
4973 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004974
4975 my $s = $stat;
4976 if (defined $cond) {
4977 substr($s, 0, length($cond), '');
4978 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004979 if ($s =~ /^\s*;/ &&
4980 $function_name ne 'uninitialized_var')
4981 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004982 WARN("AVOID_EXTERNS",
4983 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004984 }
4985
4986 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004987 WARN("FUNCTION_ARGUMENTS",
4988 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004989 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004990
4991 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4992 $stat =~ /^.\s*extern\s+/)
4993 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004994 WARN("AVOID_EXTERNS",
4995 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004996 }
4997
4998# checks for new __setup's
4999 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5000 my $name = $1;
5001
5002 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005003 CHK("UNDOCUMENTED_SETUP",
5004 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005005 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005006 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005007
5008# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005009 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005010 WARN("UNNECESSARY_CASTS",
5011 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005012 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005013
Joe Perchesa640d252013-07-03 15:05:21 -07005014# alloc style
5015# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5016 if ($^V && $^V ge 5.10.0 &&
5017 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5018 CHK("ALLOC_SIZEOF_STRUCT",
5019 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5020 }
5021
Joe Perches60a55362014-06-04 16:12:07 -07005022# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5023 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005024 $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 -07005025 my $oldfunc = $3;
5026 my $a1 = $4;
5027 my $a2 = $10;
5028 my $newfunc = "kmalloc_array";
5029 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005030 my $r1 = $a1;
5031 my $r2 = $a2;
5032 if ($a1 =~ /^sizeof\s*\S/) {
5033 $r1 = $a2;
5034 $r2 = $a1;
5035 }
5036 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5037 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005038 if (WARN("ALLOC_WITH_MULTIPLY",
5039 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5040 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005041 $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 -07005042
5043 }
5044 }
5045 }
5046
Joe Perches972fdea2013-04-29 16:18:12 -07005047# check for krealloc arg reuse
5048 if ($^V && $^V ge 5.10.0 &&
5049 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5050 WARN("KREALLOC_ARG_REUSE",
5051 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5052 }
5053
Joe Perches5ce59ae2013-02-21 16:44:18 -08005054# check for alloc argument mismatch
5055 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5056 WARN("ALLOC_ARRAY_ARGS",
5057 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5058 }
5059
Joe Perchescaf2a542011-01-12 16:59:56 -08005060# check for multiple semicolons
5061 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005062 if (WARN("ONE_SEMICOLON",
5063 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5064 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005065 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005066 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005067 }
5068
Joe Perches0ab90192014-12-10 15:51:57 -08005069# check for #defines like: 1 << <digit> that could be BIT(digit)
5070 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5071 my $ull = "";
5072 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5073 if (CHK("BIT_MACRO",
5074 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5075 $fix) {
5076 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5077 }
5078 }
5079
Joe Perchese81f2392014-08-06 16:11:25 -07005080# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005081 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5082 my $has_break = 0;
5083 my $has_statement = 0;
5084 my $count = 0;
5085 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005086 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005087 $prevline--;
5088 my $rline = $rawlines[$prevline - 1];
5089 my $fline = $lines[$prevline - 1];
5090 last if ($fline =~ /^\@\@/);
5091 next if ($fline =~ /^\-/);
5092 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5093 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5094 next if ($fline =~ /^.[\s$;]*$/);
5095 $has_statement = 1;
5096 $count++;
5097 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5098 }
5099 if (!$has_break && $has_statement) {
5100 WARN("MISSING_BREAK",
5101 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5102 }
5103 }
5104
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005105# check for switch/default statements without a break;
5106 if ($^V && $^V ge 5.10.0 &&
5107 defined $stat &&
5108 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5109 my $ctx = '';
5110 my $herectx = $here . "\n";
5111 my $cnt = statement_rawlines($stat);
5112 for (my $n = 0; $n < $cnt; $n++) {
5113 $herectx .= raw_line($linenr, $n) . "\n";
5114 }
5115 WARN("DEFAULT_NO_BREAK",
5116 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005117 }
5118
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005119# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005120 if ($line =~ /\b__FUNCTION__\b/) {
5121 if (WARN("USE_FUNC",
5122 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5123 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005124 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005125 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005126 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005127
Joe Perches62ec8182015-02-13 14:38:18 -08005128# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5129 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5130 ERROR("DATE_TIME",
5131 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5132 }
5133
Joe Perches2c924882012-03-23 15:02:20 -07005134# check for use of yield()
5135 if ($line =~ /\byield\s*\(\s*\)/) {
5136 WARN("YIELD",
5137 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5138 }
5139
Joe Perches179f8f42013-07-03 15:05:30 -07005140# check for comparisons against true and false
5141 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5142 my $lead = $1;
5143 my $arg = $2;
5144 my $test = $3;
5145 my $otype = $4;
5146 my $trail = $5;
5147 my $op = "!";
5148
5149 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5150
5151 my $type = lc($otype);
5152 if ($type =~ /^(?:true|false)$/) {
5153 if (("$test" eq "==" && "$type" eq "true") ||
5154 ("$test" eq "!=" && "$type" eq "false")) {
5155 $op = "";
5156 }
5157
5158 CHK("BOOL_COMPARISON",
5159 "Using comparison to $otype is error prone\n" . $herecurr);
5160
5161## maybe suggesting a correct construct would better
5162## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5163
5164 }
5165 }
5166
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005167# check for semaphores initialized locked
5168 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005169 WARN("CONSIDER_COMPLETION",
5170 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005171 }
Joe Perches6712d852012-03-23 15:02:20 -07005172
Joe Perches67d0a072011-10-31 17:13:10 -07005173# recommend kstrto* over simple_strto* and strict_strto*
5174 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005175 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005176 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005177 }
Joe Perches6712d852012-03-23 15:02:20 -07005178
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005179# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005180 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005181 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005182 "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 -07005183 }
Joe Perches6712d852012-03-23 15:02:20 -07005184
Emese Revfy79404842010-03-05 13:43:53 -08005185# check for various ops structs, ensure they are const.
5186 my $struct_ops = qr{acpi_dock_ops|
5187 address_space_operations|
5188 backlight_ops|
5189 block_device_operations|
5190 dentry_operations|
5191 dev_pm_ops|
5192 dma_map_ops|
5193 extent_io_ops|
5194 file_lock_operations|
5195 file_operations|
5196 hv_ops|
5197 ide_dma_ops|
5198 intel_dvo_dev_ops|
5199 item_operations|
5200 iwl_ops|
5201 kgdb_arch|
5202 kgdb_io|
5203 kset_uevent_ops|
5204 lock_manager_operations|
5205 microcode_ops|
5206 mtrr_ops|
5207 neigh_ops|
5208 nlmsvc_binding|
5209 pci_raw_ops|
5210 pipe_buf_operations|
5211 platform_hibernation_ops|
5212 platform_suspend_ops|
5213 proto_ops|
5214 rpc_pipe_ops|
5215 seq_operations|
5216 snd_ac97_build_ops|
5217 soc_pcmcia_socket_ops|
5218 stacktrace_ops|
5219 sysfs_ops|
5220 tty_operations|
5221 usb_mon_operations|
5222 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005223 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08005224 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005225 WARN("CONST_STRUCT",
5226 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005227 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005228 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005229
5230# use of NR_CPUS is usually wrong
5231# ignore definitions of NR_CPUS and usage to define arrays as likely right
5232 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005233 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5234 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005235 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5236 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5237 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005238 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005239 WARN("NR_CPUS",
5240 "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 -07005241 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005242
Joe Perches52ea8502013-11-12 15:10:09 -08005243# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5244 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5245 ERROR("DEFINE_ARCH_HAS",
5246 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5247 }
5248
Joe Perchesacd93622015-02-13 14:38:38 -08005249# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5250 if ($^V && $^V ge 5.10.0 &&
5251 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5252 WARN("LIKELY_MISUSE",
5253 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5254 }
5255
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005256# whine mightly about in_atomic
5257 if ($line =~ /\bin_atomic\s*\(/) {
5258 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005259 ERROR("IN_ATOMIC",
5260 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005261 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005262 WARN("IN_ATOMIC",
5263 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005264 }
5265 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005266
5267# check for lockdep_set_novalidate_class
5268 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5269 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5270 if ($realfile !~ m@^kernel/lockdep@ &&
5271 $realfile !~ m@^include/linux/lockdep@ &&
5272 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005273 ERROR("LOCKDEP",
5274 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005275 }
5276 }
Dave Jones88f88312011-01-12 16:59:59 -08005277
5278 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5279 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005280 WARN("EXPORTED_WORLD_WRITABLE",
5281 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005282 }
Joe Perches24358802014-04-03 14:49:13 -07005283
Joe Perches515a2352014-04-03 14:49:24 -07005284# Mode permission misuses where it seems decimal should be octal
5285# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5286 if ($^V && $^V ge 5.10.0 &&
5287 $line =~ /$mode_perms_search/) {
5288 foreach my $entry (@mode_permission_funcs) {
5289 my $func = $entry->[0];
5290 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005291
Joe Perches515a2352014-04-03 14:49:24 -07005292 my $skip_args = "";
5293 if ($arg_pos > 1) {
5294 $arg_pos--;
5295 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5296 }
5297 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5298 if ($line =~ /$test/) {
5299 my $val = $1;
5300 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005301
Joe Perches515a2352014-04-03 14:49:24 -07005302 if ($val !~ /^0$/ &&
5303 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5304 length($val) ne 4)) {
5305 ERROR("NON_OCTAL_PERMISSIONS",
5306 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005307 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5308 ERROR("EXPORTED_WORLD_WRITABLE",
5309 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07005310 }
Joe Perches24358802014-04-03 14:49:13 -07005311 }
5312 }
5313 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005314 }
5315
5316 # If we have no input at all, then there is nothing to report on
5317 # so just keep quiet.
5318 if ($#rawlines == -1) {
5319 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005320 }
5321
Andy Whitcroft8905a672007-11-28 16:21:06 -08005322 # In mailback mode only produce a report in the negative, for
5323 # things that appear to be patches.
5324 if ($mailback && ($clean == 1 || !$is_patch)) {
5325 exit(0);
5326 }
5327
5328 # This is not a patch, and we are are in 'no-patch' mode so
5329 # just keep quiet.
5330 if (!$chk_patch && !$is_patch) {
5331 exit(0);
5332 }
5333
5334 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005335 ERROR("NOT_UNIFIED_DIFF",
5336 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005337 }
5338 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005339 ERROR("MISSING_SIGN_OFF",
5340 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005341 }
5342
Andy Whitcroft8905a672007-11-28 16:21:06 -08005343 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005344 if ($summary && !($clean == 1 && $quiet == 1)) {
5345 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005346 print "total: $cnt_error errors, $cnt_warn warnings, " .
5347 (($check)? "$cnt_chk checks, " : "") .
5348 "$cnt_lines lines checked\n";
5349 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005350 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005351
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005352 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005353
5354 if ($^V lt 5.10.0) {
5355 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5356 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5357 }
5358
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005359 # If there were whitespace errors which cleanpatch can fix
5360 # then suggest that.
5361 if ($rpt_cleaners) {
5362 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5363 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005364 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005365 }
5366 }
5367
Joe Perches91bfe482013-09-11 14:23:59 -07005368 hash_show_words(\%use_type, "Used");
5369 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005370
Joe Perchesd752fcc2014-08-06 16:11:05 -07005371 if ($clean == 0 && $fix &&
5372 ("@rawlines" ne "@fixed" ||
5373 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005374 my $newfile = $filename;
5375 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005376 my $linecount = 0;
5377 my $f;
5378
Joe Perchesd752fcc2014-08-06 16:11:05 -07005379 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5380
Joe Perches3705ce52013-07-03 15:05:31 -07005381 open($f, '>', $newfile)
5382 or die "$P: Can't open $newfile for write\n";
5383 foreach my $fixed_line (@fixed) {
5384 $linecount++;
5385 if ($file) {
5386 if ($linecount > 3) {
5387 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005388 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005389 }
5390 } else {
5391 print $f $fixed_line . "\n";
5392 }
5393 }
5394 close($f);
5395
5396 if (!$quiet) {
5397 print << "EOM";
5398Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5399
5400Do _NOT_ trust the results written to this file.
5401Do _NOT_ submit these changes without inspecting them for correctness.
5402
5403This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5404No warranties, expressed or implied...
5405
5406EOM
5407 }
5408 }
5409
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005410 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005411 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005412 }
5413 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005414 print << "EOM";
5415$vname has style problems, please review.
5416
5417If any of these errors are false positives, please report
5418them to the maintainer, see CHECKPATCH in MAINTAINERS.
5419EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005420 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005421
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005422 return $clean;
5423}