blob: f0bb6d60c07b182686ff203ca3c4fee90e954ab8 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070012
13my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080014my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
Joe Perches000d1cc12011-07-25 17:13:25 -070016my $V = '0.32';
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -0700125GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700126 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -0700167if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700168 print "$P: no input files\n";
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Perchese970b882013-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|
281 __noclone|
282 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283 __read_mostly|
284 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700285 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700286 ____cacheline_aligned|
287 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800288 ____cacheline_internodealigned_in_smp|
289 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700290 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700291our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700292our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700293our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
294our $Lval = qr{$Ident(?:$Member)*};
295
Joe Perches95e2c602013-07-03 15:05:20 -0700296our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
297our $Binary = qr{(?i)0b[01]+$Int_type?};
298our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
299our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700300our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800301our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
302our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
303our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800304our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700305our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800306our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700307our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700308our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700309our $Operators = qr{
310 <=|>=|==|!=|
311 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700312 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700313 }x;
314
Joe Perches91cb5192014-04-03 14:49:32 -0700315our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
316
Andy Whitcroft8905a672007-11-28 16:21:06 -0800317our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700318our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700319our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800320our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700321our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800322our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700323our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800324
Joe Perches15662b32011-10-31 17:13:12 -0700325our $NON_ASCII_UTF8 = qr{
326 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700327 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
328 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
329 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
330 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
331 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
332 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
333}x;
334
Joe Perches15662b32011-10-31 17:13:12 -0700335our $UTF8 = qr{
336 [\x09\x0A\x0D\x20-\x7E] # ASCII
337 | $NON_ASCII_UTF8
338}x;
339
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700340our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700341 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700342 atomic_t
343)};
344
Joe Perches691e6692010-03-05 13:43:51 -0800345our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700346 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700347 (?:[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 -0700348 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700349 panic|
Joe Perches06668722013-11-12 15:10:07 -0800350 MODULE_[A-Z_]+|
351 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800352)};
353
Joe Perches20112472011-07-25 17:13:23 -0700354our $signature_tags = qr{(?xi:
355 Signed-off-by:|
356 Acked-by:|
357 Tested-by:|
358 Reviewed-by:|
359 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700360 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700361 To:|
362 Cc:
363)};
364
Joe Perches18130872014-08-06 16:11:22 -0700365our @typeListMisordered = (
366 qr{char\s+(?:un)?signed},
367 qr{int\s+(?:(?:un)?signed\s+)?short\s},
368 qr{int\s+short(?:\s+(?:un)?signed)},
369 qr{short\s+int(?:\s+(?:un)?signed)},
370 qr{(?:un)?signed\s+int\s+short},
371 qr{short\s+(?:un)?signed},
372 qr{long\s+int\s+(?:un)?signed},
373 qr{int\s+long\s+(?:un)?signed},
374 qr{long\s+(?:un)?signed\s+int},
375 qr{int\s+(?:un)?signed\s+long},
376 qr{int\s+(?:un)?signed},
377 qr{int\s+long\s+long\s+(?:un)?signed},
378 qr{long\s+long\s+int\s+(?:un)?signed},
379 qr{long\s+long\s+(?:un)?signed\s+int},
380 qr{long\s+long\s+(?:un)?signed},
381 qr{long\s+(?:un)?signed},
382);
383
Andy Whitcroft8905a672007-11-28 16:21:06 -0800384our @typeList = (
385 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700386 qr{(?:(?:un)?signed\s+)?char},
387 qr{(?:(?:un)?signed\s+)?short\s+int},
388 qr{(?:(?:un)?signed\s+)?short},
389 qr{(?:(?:un)?signed\s+)?int},
390 qr{(?:(?:un)?signed\s+)?long\s+int},
391 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
392 qr{(?:(?:un)?signed\s+)?long\s+long},
393 qr{(?:(?:un)?signed\s+)?long},
394 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395 qr{float},
396 qr{double},
397 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398 qr{struct\s+$Ident},
399 qr{union\s+$Ident},
400 qr{enum\s+$Ident},
401 qr{${Ident}_t},
402 qr{${Ident}_handler},
403 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700404 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800405);
Joe Perches8716de32013-09-11 14:24:05 -0700406our @typeListWithAttr = (
407 @typeList,
408 qr{struct\s+$InitAttribute\s+$Ident},
409 qr{union\s+$InitAttribute\s+$Ident},
410);
411
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700412our @modifierList = (
413 qr{fastcall},
414);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800415
Joe Perches24358802014-04-03 14:49:13 -0700416our @mode_permission_funcs = (
417 ["module_param", 3],
418 ["module_param_(?:array|named|string)", 4],
419 ["module_param_array_named", 5],
420 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
421 ["proc_create(?:_data|)", 2],
422 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
423);
424
Joe Perches515a2352014-04-03 14:49:24 -0700425#Create a search pattern for all these functions to speed up a loop below
426our $mode_perms_search = "";
427foreach my $entry (@mode_permission_funcs) {
428 $mode_perms_search .= '|' if ($mode_perms_search ne "");
429 $mode_perms_search .= $entry->[0];
430}
431
Wolfram Sang7840a942010-08-09 17:20:57 -0700432our $allowed_asm_includes = qr{(?x:
433 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700434 memory|
435 time|
436 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700437)};
438# memory.h: ARM has a custom one
439
Kees Cook66b47b42014-10-13 15:51:57 -0700440# Load common spelling mistakes and build regular expression list.
441my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700442my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700443
Joe Perches36061e32014-12-10 15:51:43 -0800444if (open(my $spelling, '<', $spelling_file)) {
445 my @spelling_list;
446 while (<$spelling>) {
447 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700448
Joe Perches36061e32014-12-10 15:51:43 -0800449 $line =~ s/\s*\n?$//g;
450 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700451
Joe Perches36061e32014-12-10 15:51:43 -0800452 next if ($line =~ m/^\s*#/);
453 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700454
Joe Perches36061e32014-12-10 15:51:43 -0800455 my ($suspect, $fix) = split(/\|\|/, $line);
456
457 push(@spelling_list, $suspect);
458 $spelling_fix{$suspect} = $fix;
459 }
460 close($spelling);
461 $misspellings = join("|", @spelling_list);
462} else {
463 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700464}
Kees Cook66b47b42014-10-13 15:51:57 -0700465
Andy Whitcroft8905a672007-11-28 16:21:06 -0800466sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700467 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
468 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700469 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700470 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700471 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800472 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700473 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800474 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800475 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700476 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700477 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800478 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700479 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800480 }x;
Joe Perches18130872014-08-06 16:11:22 -0700481 $NonptrTypeMisordered = qr{
482 (?:$Modifier\s+|const\s+)*
483 (?:
484 (?:${Misordered}\b)
485 )
486 (?:\s+$Modifier|\s+const)*
487 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700488 $NonptrTypeWithAttr = qr{
489 (?:$Modifier\s+|const\s+)*
490 (?:
491 (?:typeof|__typeof__)\s*\([^\)]*\)|
492 (?:$typeTypedefs\b)|
493 (?:${allWithAttr}\b)
494 )
495 (?:\s+$Modifier|\s+const)*
496 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800497 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700498 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700499 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700500 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800501 }x;
Joe Perches18130872014-08-06 16:11:22 -0700502 $TypeMisordered = qr{
503 $NonptrTypeMisordered
504 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
505 (?:\s+$Inline|\s+$Modifier)*
506 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700507 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700508 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800509}
510build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700511
Joe Perches7d2367a2011-07-25 17:13:22 -0700512our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700513
514# Using $balanced_parens, $LvalOrFunc, or $FuncArg
515# requires at least perl version v5.10.0
516# Any use must be runtime checked with $^V
517
518our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700519our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800520our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700521
Joe Perchesf8422302014-08-06 16:11:31 -0700522our $declaration_macros = qr{(?x:
523 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
524 (?:$Storage\s+)?LIST_HEAD\s*\(|
525 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
526)};
527
Joe Perches7d2367a2011-07-25 17:13:22 -0700528sub deparenthesize {
529 my ($string) = @_;
530 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700531
532 while ($string =~ /^\s*\(.*\)\s*$/) {
533 $string =~ s@^\s*\(\s*@@;
534 $string =~ s@\s*\)\s*$@@;
535 }
536
Joe Perches7d2367a2011-07-25 17:13:22 -0700537 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700538
Joe Perches7d2367a2011-07-25 17:13:22 -0700539 return $string;
540}
541
Joe Perches34456862013-07-03 15:05:34 -0700542sub seed_camelcase_file {
543 my ($file) = @_;
544
545 return if (!(-f $file));
546
547 local $/;
548
549 open(my $include_file, '<', "$file")
550 or warn "$P: Can't read '$file' $!\n";
551 my $text = <$include_file>;
552 close($include_file);
553
554 my @lines = split('\n', $text);
555
556 foreach my $line (@lines) {
557 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
558 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
559 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800560 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
561 $camelcase{$1} = 1;
562 } 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 -0700563 $camelcase{$1} = 1;
564 }
565 }
566}
567
568my $camelcase_seeded = 0;
569sub seed_camelcase_includes {
570 return if ($camelcase_seeded);
571
572 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700573 my $camelcase_cache = "";
574 my @include_files = ();
575
576 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700577
Richard Genoud3645e322014-02-10 14:25:32 -0800578 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700579 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
580 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700581 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700582 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700583 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700584 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700585 @include_files = split('\n', $files);
586 foreach my $file (@include_files) {
587 my $date = POSIX::strftime("%Y%m%d%H%M",
588 localtime((stat $file)[9]));
589 $last_mod_date = $date if ($last_mod_date < $date);
590 }
591 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700592 }
Joe Perchesc707a812013-07-08 16:00:43 -0700593
594 if ($camelcase_cache ne "" && -f $camelcase_cache) {
595 open(my $camelcase_file, '<', "$camelcase_cache")
596 or warn "$P: Can't read '$camelcase_cache' $!\n";
597 while (<$camelcase_file>) {
598 chomp;
599 $camelcase{$_} = 1;
600 }
601 close($camelcase_file);
602
603 return;
604 }
605
Richard Genoud3645e322014-02-10 14:25:32 -0800606 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700607 $files = `git ls-files "include/*.h"`;
608 @include_files = split('\n', $files);
609 }
610
Joe Perches34456862013-07-03 15:05:34 -0700611 foreach my $file (@include_files) {
612 seed_camelcase_file($file);
613 }
Joe Perches351b2a12013-07-03 15:05:36 -0700614
Joe Perchesc707a812013-07-08 16:00:43 -0700615 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700616 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700617 open(my $camelcase_file, '>', "$camelcase_cache")
618 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700619 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
620 print $camelcase_file ("$_\n");
621 }
622 close($camelcase_file);
623 }
Joe Perches34456862013-07-03 15:05:34 -0700624}
625
Joe Perchesd311cd42014-08-06 16:10:57 -0700626sub git_commit_info {
627 my ($commit, $id, $desc) = @_;
628
629 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
630
631 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
632 $output =~ s/^\s*//gm;
633 my @lines = split("\n", $output);
634
635 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
636# Maybe one day convert this block of bash into something that returns
637# all matching commit ids, but it's very slow...
638#
639# echo "checking commits $1..."
640# git rev-list --remotes | grep -i "^$1" |
641# while read line ; do
642# git log --format='%H %s' -1 $line |
643# echo "commit $(cut -c 1-12,41-)"
644# done
645 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
646 } else {
647 $id = substr($lines[0], 0, 12);
648 $desc = substr($lines[0], 41);
649 }
650
651 return ($id, $desc);
652}
653
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700654$chk_signoff = 0 if ($file);
655
Andy Whitcroft00df3442007-06-08 13:47:06 -0700656my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800657my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700658my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700659my @fixed_inserted = ();
660my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700661my $fixlinenr = -1;
662
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800663my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700664for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800665 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700666 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800667 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700668 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800669 } elsif ($filename eq '-') {
670 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700671 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800672 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700673 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700674 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800675 if ($filename eq '-') {
676 $vname = 'Your patch';
677 } else {
678 $vname = $filename;
679 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800680 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700681 chomp;
682 push(@rawlines, $_);
683 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800684 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800685 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700686 $exit = 1;
687 }
688 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800689 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700690 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700691 @fixed_inserted = ();
692 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700693 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700694}
695
696exit($exit);
697
698sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700699 my ($root) = @_;
700
701 my @tree_check = (
702 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
703 "README", "Documentation", "arch", "include", "drivers",
704 "fs", "init", "ipc", "kernel", "lib", "scripts",
705 );
706
707 foreach my $check (@tree_check) {
708 if (! -e $root . '/' . $check) {
709 return 0;
710 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700711 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700712 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700713}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700714
Joe Perches20112472011-07-25 17:13:23 -0700715sub parse_email {
716 my ($formatted_email) = @_;
717
718 my $name = "";
719 my $address = "";
720 my $comment = "";
721
722 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
723 $name = $1;
724 $address = $2;
725 $comment = $3 if defined $3;
726 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
727 $address = $1;
728 $comment = $2 if defined $2;
729 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
730 $address = $1;
731 $comment = $2 if defined $2;
732 $formatted_email =~ s/$address.*$//;
733 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700734 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700735 $name =~ s/^\"|\"$//g;
736 # If there's a name left after stripping spaces and
737 # leading quotes, and the address doesn't have both
738 # leading and trailing angle brackets, the address
739 # is invalid. ie:
740 # "joe smith joe@smith.com" bad
741 # "joe smith <joe@smith.com" bad
742 if ($name ne "" && $address !~ /^<[^>]+>$/) {
743 $name = "";
744 $address = "";
745 $comment = "";
746 }
747 }
748
Joe Perches3705ce52013-07-03 15:05:31 -0700749 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700750 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700751 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700752 $address =~ s/^\<|\>$//g;
753
754 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
755 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
756 $name = "\"$name\"";
757 }
758
759 return ($name, $address, $comment);
760}
761
762sub format_email {
763 my ($name, $address) = @_;
764
765 my $formatted_email;
766
Joe Perches3705ce52013-07-03 15:05:31 -0700767 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700768 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700769 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700770
771 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
772 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
773 $name = "\"$name\"";
774 }
775
776 if ("$name" eq "") {
777 $formatted_email = "$address";
778 } else {
779 $formatted_email = "$name <$address>";
780 }
781
782 return $formatted_email;
783}
784
Joe Perchesd311cd42014-08-06 16:10:57 -0700785sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700786 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700787
Joe Perchesbd474ca2014-08-06 16:11:10 -0700788 foreach my $path (split(/:/, $ENV{PATH})) {
789 if (-e "$path/$bin") {
790 return "$path/$bin";
791 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700792 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700793
Joe Perchesbd474ca2014-08-06 16:11:10 -0700794 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700795}
796
Joe Perches000d1cc12011-07-25 17:13:25 -0700797sub which_conf {
798 my ($conf) = @_;
799
800 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
801 if (-e "$path/$conf") {
802 return "$path/$conf";
803 }
804 }
805
806 return "";
807}
808
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700809sub expand_tabs {
810 my ($str) = @_;
811
812 my $res = '';
813 my $n = 0;
814 for my $c (split(//, $str)) {
815 if ($c eq "\t") {
816 $res .= ' ';
817 $n++;
818 for (; ($n % 8) != 0; $n++) {
819 $res .= ' ';
820 }
821 next;
822 }
823 $res .= $c;
824 $n++;
825 }
826
827 return $res;
828}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700829sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700830 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700831 return $res;
832}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700833
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700834sub line_stats {
835 my ($line) = @_;
836
837 # Drop the diff line leader and expand tabs
838 $line =~ s/^.//;
839 $line = expand_tabs($line);
840
841 # Pick the indent from the front of the line.
842 my ($white) = ($line =~ /^(\s*)/);
843
844 return (length($line), length($white));
845}
846
Andy Whitcroft773647a2008-03-28 14:15:58 -0700847my $sanitise_quote = '';
848
849sub sanitise_line_reset {
850 my ($in_comment) = @_;
851
852 if ($in_comment) {
853 $sanitise_quote = '*/';
854 } else {
855 $sanitise_quote = '';
856 }
857}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700858sub sanitise_line {
859 my ($line) = @_;
860
861 my $res = '';
862 my $l = '';
863
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800864 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700865 my $off = 0;
866 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700867
Andy Whitcroft773647a2008-03-28 14:15:58 -0700868 # Always copy over the diff marker.
869 $res = substr($line, 0, 1);
870
871 for ($off = 1; $off < length($line); $off++) {
872 $c = substr($line, $off, 1);
873
874 # Comments we are wacking completly including the begin
875 # and end, all to $;.
876 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
877 $sanitise_quote = '*/';
878
879 substr($res, $off, 2, "$;$;");
880 $off++;
881 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800882 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700883 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700884 $sanitise_quote = '';
885 substr($res, $off, 2, "$;$;");
886 $off++;
887 next;
888 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700889 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
890 $sanitise_quote = '//';
891
892 substr($res, $off, 2, $sanitise_quote);
893 $off++;
894 next;
895 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700896
897 # A \ in a string means ignore the next character.
898 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
899 $c eq "\\") {
900 substr($res, $off, 2, 'XX');
901 $off++;
902 next;
903 }
904 # Regular quotes.
905 if ($c eq "'" || $c eq '"') {
906 if ($sanitise_quote eq '') {
907 $sanitise_quote = $c;
908
909 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700910 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700911 } elsif ($sanitise_quote eq $c) {
912 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700913 }
914 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700915
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800916 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700917 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
918 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700919 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
920 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700921 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
922 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700923 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700924 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700925 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800926 }
927
Daniel Walker113f04a2009-09-21 17:04:35 -0700928 if ($sanitise_quote eq '//') {
929 $sanitise_quote = '';
930 }
931
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800932 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700933 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800934 my $clean = 'X' x length($1);
935 $res =~ s@\<.*\>@<$clean>@;
936
937 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700938 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800939 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700940 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800941 }
942
Andy Whitcroft00df3442007-06-08 13:47:06 -0700943 return $res;
944}
945
Joe Perchesa6962d72013-04-29 16:18:13 -0700946sub get_quoted_string {
947 my ($line, $rawline) = @_;
948
Joe Perches5e4f6ba2014-12-10 15:52:05 -0800949 return "" if ($line !~ m/(\"[X\t]+\")/g);
Joe Perchesa6962d72013-04-29 16:18:13 -0700950 return substr($rawline, $-[0], $+[0] - $-[0]);
951}
952
Andy Whitcroft8905a672007-11-28 16:21:06 -0800953sub ctx_statement_block {
954 my ($linenr, $remain, $off) = @_;
955 my $line = $linenr - 1;
956 my $blk = '';
957 my $soff = $off;
958 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700959 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800960
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800961 my $loff = 0;
962
Andy Whitcroft8905a672007-11-28 16:21:06 -0800963 my $type = '';
964 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800965 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800966 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800967 my $c;
968 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800969
970 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800971 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800972 @stack = (['', 0]) if ($#stack == -1);
973
Andy Whitcroft773647a2008-03-28 14:15:58 -0700974 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800975 # If we are about to drop off the end, pull in more
976 # context.
977 if ($off >= $len) {
978 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700979 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800980 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800981 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800982 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800983 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800984 $len = length($blk);
985 $line++;
986 last;
987 }
988 # Bail if there is no further context.
989 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800990 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800991 last;
992 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800993 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
994 $level++;
995 $type = '#';
996 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800997 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800998 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800999 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001000 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001001
Andy Whitcroft773647a2008-03-28 14:15:58 -07001002 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001003
1004 # Handle nested #if/#else.
1005 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1006 push(@stack, [ $type, $level ]);
1007 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1008 ($type, $level) = @{$stack[$#stack - 1]};
1009 } elsif ($remainder =~ /^#\s*endif\b/) {
1010 ($type, $level) = @{pop(@stack)};
1011 }
1012
Andy Whitcroft8905a672007-11-28 16:21:06 -08001013 # Statement ends at the ';' or a close '}' at the
1014 # outermost level.
1015 if ($level == 0 && $c eq ';') {
1016 last;
1017 }
1018
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001019 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001020 if ($level == 0 && $coff_set == 0 &&
1021 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1022 $remainder =~ /^(else)(?:\s|{)/ &&
1023 $remainder !~ /^else\s+if\b/) {
1024 $coff = $off + length($1) - 1;
1025 $coff_set = 1;
1026 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1027 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001028 }
1029
Andy Whitcroft8905a672007-11-28 16:21:06 -08001030 if (($type eq '' || $type eq '(') && $c eq '(') {
1031 $level++;
1032 $type = '(';
1033 }
1034 if ($type eq '(' && $c eq ')') {
1035 $level--;
1036 $type = ($level != 0)? '(' : '';
1037
1038 if ($level == 0 && $coff < $soff) {
1039 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001040 $coff_set = 1;
1041 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001042 }
1043 }
1044 if (($type eq '' || $type eq '{') && $c eq '{') {
1045 $level++;
1046 $type = '{';
1047 }
1048 if ($type eq '{' && $c eq '}') {
1049 $level--;
1050 $type = ($level != 0)? '{' : '';
1051
1052 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001053 if (substr($blk, $off + 1, 1) eq ';') {
1054 $off++;
1055 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001056 last;
1057 }
1058 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001059 # Preprocessor commands end at the newline unless escaped.
1060 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1061 $level--;
1062 $type = '';
1063 $off++;
1064 last;
1065 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001066 $off++;
1067 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001068 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001069 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001070 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001071 $line++;
1072 $remain--;
1073 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001074
1075 my $statement = substr($blk, $soff, $off - $soff + 1);
1076 my $condition = substr($blk, $soff, $coff - $soff + 1);
1077
1078 #warn "STATEMENT<$statement>\n";
1079 #warn "CONDITION<$condition>\n";
1080
Andy Whitcroft773647a2008-03-28 14:15:58 -07001081 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001082
1083 return ($statement, $condition,
1084 $line, $remain + 1, $off - $loff + 1, $level);
1085}
1086
Andy Whitcroftcf655042008-03-04 14:28:20 -08001087sub statement_lines {
1088 my ($stmt) = @_;
1089
1090 # Strip the diff line prefixes and rip blank lines at start and end.
1091 $stmt =~ s/(^|\n)./$1/g;
1092 $stmt =~ s/^\s*//;
1093 $stmt =~ s/\s*$//;
1094
1095 my @stmt_lines = ($stmt =~ /\n/g);
1096
1097 return $#stmt_lines + 2;
1098}
1099
1100sub statement_rawlines {
1101 my ($stmt) = @_;
1102
1103 my @stmt_lines = ($stmt =~ /\n/g);
1104
1105 return $#stmt_lines + 2;
1106}
1107
1108sub statement_block_size {
1109 my ($stmt) = @_;
1110
1111 $stmt =~ s/(^|\n)./$1/g;
1112 $stmt =~ s/^\s*{//;
1113 $stmt =~ s/}\s*$//;
1114 $stmt =~ s/^\s*//;
1115 $stmt =~ s/\s*$//;
1116
1117 my @stmt_lines = ($stmt =~ /\n/g);
1118 my @stmt_statements = ($stmt =~ /;/g);
1119
1120 my $stmt_lines = $#stmt_lines + 2;
1121 my $stmt_statements = $#stmt_statements + 1;
1122
1123 if ($stmt_lines > $stmt_statements) {
1124 return $stmt_lines;
1125 } else {
1126 return $stmt_statements;
1127 }
1128}
1129
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001130sub ctx_statement_full {
1131 my ($linenr, $remain, $off) = @_;
1132 my ($statement, $condition, $level);
1133
1134 my (@chunks);
1135
Andy Whitcroftcf655042008-03-04 14:28:20 -08001136 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001137 ($statement, $condition, $linenr, $remain, $off, $level) =
1138 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001139 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001140 push(@chunks, [ $condition, $statement ]);
1141 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1142 return ($level, $linenr, @chunks);
1143 }
1144
1145 # Pull in the following conditional/block pairs and see if they
1146 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001147 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001148 ($statement, $condition, $linenr, $remain, $off, $level) =
1149 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001150 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001151 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001152 #print "C: push\n";
1153 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001154 }
1155
1156 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001157}
1158
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001159sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001160 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001161 my $line;
1162 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001163 my $blk = '';
1164 my @o;
1165 my @c;
1166 my @res = ();
1167
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001168 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001169 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001170 for ($line = $start; $remain > 0; $line++) {
1171 next if ($rawlines[$line] =~ /^-/);
1172 $remain--;
1173
1174 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001175
1176 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001177 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001178 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001179 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001180 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001181 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001182 $level = pop(@stack);
1183 }
1184
Andy Whitcroft01464f32010-10-26 14:23:19 -07001185 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001186 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1187 if ($off > 0) {
1188 $off--;
1189 next;
1190 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001191
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001192 if ($c eq $close && $level > 0) {
1193 $level--;
1194 last if ($level == 0);
1195 } elsif ($c eq $open) {
1196 $level++;
1197 }
1198 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001199
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001200 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001201 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001202 }
1203
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001204 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001205 }
1206
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001207 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001208}
1209sub ctx_block_outer {
1210 my ($linenr, $remain) = @_;
1211
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001212 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1213 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001214}
1215sub ctx_block {
1216 my ($linenr, $remain) = @_;
1217
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001218 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1219 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001220}
1221sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001222 my ($linenr, $remain, $off) = @_;
1223
1224 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1225 return @r;
1226}
1227sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001228 my ($linenr, $remain) = @_;
1229
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001230 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001231}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001232sub ctx_statement_level {
1233 my ($linenr, $remain, $off) = @_;
1234
1235 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1236}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001237
1238sub ctx_locate_comment {
1239 my ($first_line, $end_line) = @_;
1240
1241 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001242 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001243 return $current_comment if (defined $current_comment);
1244
1245 # Look through the context and try and figure out if there is a
1246 # comment.
1247 my $in_comment = 0;
1248 $current_comment = '';
1249 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001250 my $line = $rawlines[$linenr - 1];
1251 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001252 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1253 $in_comment = 1;
1254 }
1255 if ($line =~ m@/\*@) {
1256 $in_comment = 1;
1257 }
1258 if (!$in_comment && $current_comment ne '') {
1259 $current_comment = '';
1260 }
1261 $current_comment .= $line . "\n" if ($in_comment);
1262 if ($line =~ m@\*/@) {
1263 $in_comment = 0;
1264 }
1265 }
1266
1267 chomp($current_comment);
1268 return($current_comment);
1269}
1270sub ctx_has_comment {
1271 my ($first_line, $end_line) = @_;
1272 my $cmt = ctx_locate_comment($first_line, $end_line);
1273
Andy Whitcroft00df3442007-06-08 13:47:06 -07001274 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001275 ##print "CMMT: $cmt\n";
1276
1277 return ($cmt ne '');
1278}
1279
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001280sub raw_line {
1281 my ($linenr, $cnt) = @_;
1282
1283 my $offset = $linenr - 1;
1284 $cnt++;
1285
1286 my $line;
1287 while ($cnt) {
1288 $line = $rawlines[$offset++];
1289 next if (defined($line) && $line =~ /^-/);
1290 $cnt--;
1291 }
1292
1293 return $line;
1294}
1295
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001296sub cat_vet {
1297 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001298 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001299
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001300 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001301 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1302 $res .= $1;
1303 if ($2 ne '') {
1304 $coded = sprintf("^%c", unpack('C', $2) + 64);
1305 $res .= $coded;
1306 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001307 }
1308 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001309
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001310 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001311}
1312
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001313my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001314my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001315my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001316my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001317
1318sub annotate_reset {
1319 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001320 $av_pending = '_';
1321 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001322 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001323}
1324
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001325sub annotate_values {
1326 my ($stream, $type) = @_;
1327
1328 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001329 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001330 my $cur = $stream;
1331
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001332 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001333
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001334 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001335 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001336 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001337 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001338 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001339 print "WS($1)\n" if ($dbg_values > 1);
1340 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001341 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001342 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001343 }
1344
Florian Micklerc023e4732011-01-12 16:59:58 -08001345 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001346 print "CAST($1)\n" if ($dbg_values > 1);
1347 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001348 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001349
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001350 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001351 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001352 $type = 'T';
1353
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001354 } elsif ($cur =~ /^($Modifier)\s*/) {
1355 print "MODIFIER($1)\n" if ($dbg_values > 1);
1356 $type = 'T';
1357
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001358 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001359 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001360 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001361 push(@av_paren_type, $type);
1362 if ($2 ne '') {
1363 $av_pending = 'N';
1364 }
1365 $type = 'E';
1366
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001367 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001368 print "UNDEF($1)\n" if ($dbg_values > 1);
1369 $av_preprocessor = 1;
1370 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001371
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001372 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001373 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001375
1376 push(@av_paren_type, $type);
1377 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001378 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001379
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001380 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001381 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1382 $av_preprocessor = 1;
1383
1384 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1385
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001386 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001387
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001388 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001389 print "PRE_END($1)\n" if ($dbg_values > 1);
1390
1391 $av_preprocessor = 1;
1392
1393 # Assume all arms of the conditional end as this
1394 # one does, and continue as if the #endif was not here.
1395 pop(@av_paren_type);
1396 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001397 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001398
1399 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001400 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001401
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001402 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1403 print "ATTR($1)\n" if ($dbg_values > 1);
1404 $av_pending = $type;
1405 $type = 'N';
1406
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001407 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001408 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001409 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001410 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001411 }
1412 $type = 'N';
1413
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001414 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001415 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001416 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001417 $type = 'N';
1418
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001419 } elsif ($cur =~/^(case)/o) {
1420 print "CASE($1)\n" if ($dbg_values > 1);
1421 $av_pend_colon = 'C';
1422 $type = 'N';
1423
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001424 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001425 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001426 $type = 'N';
1427
1428 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001429 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001430 push(@av_paren_type, $av_pending);
1431 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001432 $type = 'N';
1433
1434 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001435 my $new_type = pop(@av_paren_type);
1436 if ($new_type ne '_') {
1437 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001438 print "PAREN('$1') -> $type\n"
1439 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001440 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001441 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001442 }
1443
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001444 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001445 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001446 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001447 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001448
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001449 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1450 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001451 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001452 } elsif ($type eq 'E') {
1453 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001454 }
1455 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1456 $type = 'V';
1457
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001458 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001459 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001460 $type = 'V';
1461
1462 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001463 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001464 $type = 'N';
1465
Andy Whitcroftcf655042008-03-04 14:28:20 -08001466 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001467 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001468 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001469 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001470
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001471 } elsif ($cur =~/^(,)/) {
1472 print "COMMA($1)\n" if ($dbg_values > 1);
1473 $type = 'C';
1474
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001475 } elsif ($cur =~ /^(\?)/o) {
1476 print "QUESTION($1)\n" if ($dbg_values > 1);
1477 $type = 'N';
1478
1479 } elsif ($cur =~ /^(:)/o) {
1480 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1481
1482 substr($var, length($res), 1, $av_pend_colon);
1483 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1484 $type = 'E';
1485 } else {
1486 $type = 'N';
1487 }
1488 $av_pend_colon = 'O';
1489
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001490 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001491 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001492 $type = 'N';
1493
Andy Whitcroft0d413862008-10-15 22:02:16 -07001494 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001495 my $variant;
1496
1497 print "OPV($1)\n" if ($dbg_values > 1);
1498 if ($type eq 'V') {
1499 $variant = 'B';
1500 } else {
1501 $variant = 'U';
1502 }
1503
1504 substr($var, length($res), 1, $variant);
1505 $type = 'N';
1506
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001507 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001508 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001509 if ($1 ne '++' && $1 ne '--') {
1510 $type = 'N';
1511 }
1512
1513 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001514 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001515 }
1516 if (defined $1) {
1517 $cur = substr($cur, length($1));
1518 $res .= $type x length($1);
1519 }
1520 }
1521
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001522 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001523}
1524
Andy Whitcroft8905a672007-11-28 16:21:06 -08001525sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001526 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001527 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001528 ^(?:
1529 $Modifier|
1530 $Storage|
1531 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001532 DEFINE_\S+
1533 )$|
1534 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001535 goto|
1536 return|
1537 case|
1538 else|
1539 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001540 do|
1541 \#|
1542 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001543 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001544 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001545 )}x;
1546 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1547 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001548 # Check for modifiers.
1549 $possible =~ s/\s*$Storage\s*//g;
1550 $possible =~ s/\s*$Sparse\s*//g;
1551 if ($possible =~ /^\s*$/) {
1552
1553 } elsif ($possible =~ /\s/) {
1554 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001555 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001556 if ($modifier !~ $notPermitted) {
1557 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1558 push(@modifierList, $modifier);
1559 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001560 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001561
1562 } else {
1563 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1564 push(@typeList, $possible);
1565 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001566 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001567 } else {
1568 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001569 }
1570}
1571
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001572my $prefix = '';
1573
Joe Perches000d1cc12011-07-25 17:13:25 -07001574sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001575 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001576
Joe Perchescbec18a2014-04-03 14:49:19 -07001577 return defined $use_type{$type} if (scalar keys %use_type > 0);
1578
1579 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001580}
1581
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001582sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001583 my ($level, $type, $msg) = @_;
1584
1585 if (!show_type($type) ||
1586 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001587 return 0;
1588 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001589 my $line;
1590 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001591 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001592 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001593 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001594 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001595 $line = (split('\n', $line))[0] . "\n" if ($terse);
1596
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001597 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001598
1599 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001600}
Joe Perchescbec18a2014-04-03 14:49:19 -07001601
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001602sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001603 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001604}
Joe Perches000d1cc12011-07-25 17:13:25 -07001605
Joe Perchesd752fcc2014-08-06 16:11:05 -07001606sub fixup_current_range {
1607 my ($lineRef, $offset, $length) = @_;
1608
1609 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1610 my $o = $1;
1611 my $l = $2;
1612 my $no = $o + $offset;
1613 my $nl = $l + $length;
1614 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1615 }
1616}
1617
1618sub fix_inserted_deleted_lines {
1619 my ($linesRef, $insertedRef, $deletedRef) = @_;
1620
1621 my $range_last_linenr = 0;
1622 my $delta_offset = 0;
1623
1624 my $old_linenr = 0;
1625 my $new_linenr = 0;
1626
1627 my $next_insert = 0;
1628 my $next_delete = 0;
1629
1630 my @lines = ();
1631
1632 my $inserted = @{$insertedRef}[$next_insert++];
1633 my $deleted = @{$deletedRef}[$next_delete++];
1634
1635 foreach my $old_line (@{$linesRef}) {
1636 my $save_line = 1;
1637 my $line = $old_line; #don't modify the array
1638 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1639 $delta_offset = 0;
1640 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1641 $range_last_linenr = $new_linenr;
1642 fixup_current_range(\$line, $delta_offset, 0);
1643 }
1644
1645 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1646 $deleted = @{$deletedRef}[$next_delete++];
1647 $save_line = 0;
1648 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1649 }
1650
1651 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1652 push(@lines, ${$inserted}{'LINE'});
1653 $inserted = @{$insertedRef}[$next_insert++];
1654 $new_linenr++;
1655 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1656 }
1657
1658 if ($save_line) {
1659 push(@lines, $line);
1660 $new_linenr++;
1661 }
1662
1663 $old_linenr++;
1664 }
1665
1666 return @lines;
1667}
1668
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001669sub fix_insert_line {
1670 my ($linenr, $line) = @_;
1671
1672 my $inserted = {
1673 LINENR => $linenr,
1674 LINE => $line,
1675 };
1676 push(@fixed_inserted, $inserted);
1677}
1678
1679sub fix_delete_line {
1680 my ($linenr, $line) = @_;
1681
1682 my $deleted = {
1683 LINENR => $linenr,
1684 LINE => $line,
1685 };
1686
1687 push(@fixed_deleted, $deleted);
1688}
1689
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001690sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001691 my ($type, $msg) = @_;
1692
1693 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001694 our $clean = 0;
1695 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001696 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001697 }
Joe Perches3705ce52013-07-03 15:05:31 -07001698 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001699}
1700sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001701 my ($type, $msg) = @_;
1702
1703 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001704 our $clean = 0;
1705 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001706 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001707 }
Joe Perches3705ce52013-07-03 15:05:31 -07001708 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001709}
1710sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001711 my ($type, $msg) = @_;
1712
1713 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001714 our $clean = 0;
1715 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001716 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717 }
Joe Perches3705ce52013-07-03 15:05:31 -07001718 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001719}
1720
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001721sub check_absolute_file {
1722 my ($absolute, $herecurr) = @_;
1723 my $file = $absolute;
1724
1725 ##print "absolute<$absolute>\n";
1726
1727 # See if any suffix of this path is a path within the tree.
1728 while ($file =~ s@^[^/]*/@@) {
1729 if (-f "$root/$file") {
1730 ##print "file<$file>\n";
1731 last;
1732 }
1733 }
1734 if (! -f _) {
1735 return 0;
1736 }
1737
1738 # It is, so see if the prefix is acceptable.
1739 my $prefix = $absolute;
1740 substr($prefix, -length($file)) = '';
1741
1742 ##print "prefix<$prefix>\n";
1743 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001744 WARN("USE_RELATIVE_PATH",
1745 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001746 }
1747}
1748
Joe Perches3705ce52013-07-03 15:05:31 -07001749sub trim {
1750 my ($string) = @_;
1751
Joe Perchesb34c6482013-09-11 14:24:01 -07001752 $string =~ s/^\s+|\s+$//g;
1753
1754 return $string;
1755}
1756
1757sub ltrim {
1758 my ($string) = @_;
1759
1760 $string =~ s/^\s+//;
1761
1762 return $string;
1763}
1764
1765sub rtrim {
1766 my ($string) = @_;
1767
1768 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001769
1770 return $string;
1771}
1772
Joe Perches52ea8502013-11-12 15:10:09 -08001773sub string_find_replace {
1774 my ($string, $find, $replace) = @_;
1775
1776 $string =~ s/$find/$replace/g;
1777
1778 return $string;
1779}
1780
Joe Perches3705ce52013-07-03 15:05:31 -07001781sub tabify {
1782 my ($leading) = @_;
1783
1784 my $source_indent = 8;
1785 my $max_spaces_before_tab = $source_indent - 1;
1786 my $spaces_to_tab = " " x $source_indent;
1787
1788 #convert leading spaces to tabs
1789 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1790 #Remove spaces before a tab
1791 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1792
1793 return "$leading";
1794}
1795
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001796sub pos_last_openparen {
1797 my ($line) = @_;
1798
1799 my $pos = 0;
1800
1801 my $opens = $line =~ tr/\(/\(/;
1802 my $closes = $line =~ tr/\)/\)/;
1803
1804 my $last_openparen = 0;
1805
1806 if (($opens == 0) || ($closes >= $opens)) {
1807 return -1;
1808 }
1809
1810 my $len = length($line);
1811
1812 for ($pos = 0; $pos < $len; $pos++) {
1813 my $string = substr($line, $pos);
1814 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1815 $pos += length($1) - 1;
1816 } elsif (substr($line, $pos, 1) eq '(') {
1817 $last_openparen = $pos;
1818 } elsif (index($string, '(') == -1) {
1819 last;
1820 }
1821 }
1822
Joe Perches91cb5192014-04-03 14:49:32 -07001823 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001824}
1825
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001826sub process {
1827 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001828
1829 my $linenr=0;
1830 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001831 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001832 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001833 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001834
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001835 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001836 my $indent;
1837 my $previndent=0;
1838 my $stashindent=0;
1839
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001840 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001841 my $signoff = 0;
1842 my $is_patch = 0;
1843
Joe Perches29ee1b02014-08-06 16:10:35 -07001844 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001845 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001846 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001847 my $non_utf8_charset = 0;
1848
Joe Perches365dd4e2014-08-06 16:10:42 -07001849 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08001850 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07001851
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001852 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001853 our $cnt_lines = 0;
1854 our $cnt_error = 0;
1855 our $cnt_warn = 0;
1856 our $cnt_chk = 0;
1857
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001858 # Trace the real file/line as we go.
1859 my $realfile = '';
1860 my $realline = 0;
1861 my $realcnt = 0;
1862 my $here = '';
1863 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001864 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001865 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001866 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001867
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001868 my $prev_values = 'E';
1869
1870 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001871 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001872 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001873 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001874 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001875
Joe Perches7e51f192013-09-11 14:23:57 -07001876 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001877
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001878 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001879 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001880 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001881 my @setup_docs = ();
1882 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001883
Joe Perchesd8b07712013-11-12 15:10:06 -08001884 my $camelcase_file_seeded = 0;
1885
Andy Whitcroft773647a2008-03-28 14:15:58 -07001886 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001887 my $line;
1888 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001889 $linenr++;
1890 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001891
Joe Perches3705ce52013-07-03 15:05:31 -07001892 push(@fixed, $rawline) if ($fix);
1893
Andy Whitcroft773647a2008-03-28 14:15:58 -07001894 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001895 $setup_docs = 0;
1896 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1897 $setup_docs = 1;
1898 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001899 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001900 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001901 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1902 $realline=$1-1;
1903 if (defined $2) {
1904 $realcnt=$3+1;
1905 } else {
1906 $realcnt=1+1;
1907 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001908 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001909
1910 # Guestimate if this is a continuing comment. Run
1911 # the context looking for a comment "edge". If this
1912 # edge is a close comment then we must be in a comment
1913 # at context start.
1914 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001915 my $cnt = $realcnt;
1916 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1917 next if (defined $rawlines[$ln - 1] &&
1918 $rawlines[$ln - 1] =~ /^-/);
1919 $cnt--;
1920 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001921 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001922 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1923 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1924 ($edge) = $1;
1925 last;
1926 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001927 }
1928 if (defined $edge && $edge eq '*/') {
1929 $in_comment = 1;
1930 }
1931
1932 # Guestimate if this is a continuing comment. If this
1933 # is the start of a diff block and this line starts
1934 # ' *' then it is very likely a comment.
1935 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001936 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001937 {
1938 $in_comment = 1;
1939 }
1940
1941 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1942 sanitise_line_reset($in_comment);
1943
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001944 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001945 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001946 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001947 $line = sanitise_line($rawline);
1948 }
1949 push(@lines, $line);
1950
1951 if ($realcnt > 1) {
1952 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1953 } else {
1954 $realcnt = 0;
1955 }
1956
1957 #print "==>$rawline\n";
1958 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001959
1960 if ($setup_docs && $line =~ /^\+/) {
1961 push(@setup_docs, $line);
1962 }
1963 }
1964
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001965 $prefix = '';
1966
Andy Whitcroft773647a2008-03-28 14:15:58 -07001967 $realcnt = 0;
1968 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001969 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001970 foreach my $line (@lines) {
1971 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001972 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001973 my $sline = $line; #copy of $line
1974 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001975
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001976 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001977
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001978#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001979 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001980 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001981 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001982 $realline=$1-1;
1983 if (defined $2) {
1984 $realcnt=$3+1;
1985 } else {
1986 $realcnt=1+1;
1987 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001988 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001989 $prev_values = 'E';
1990
Andy Whitcroft773647a2008-03-28 14:15:58 -07001991 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001992 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001993 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001994 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001995 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001996
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001997# track the line number as we move through the hunk, note that
1998# new versions of GNU diff omit the leading space on completely
1999# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002000 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002001 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002002 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002003
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002004 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002005 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002006
2007 # Track the previous line.
2008 ($prevline, $stashline) = ($stashline, $line);
2009 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002010 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2011
Andy Whitcroft773647a2008-03-28 14:15:58 -07002012 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002013
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002014 } elsif ($realcnt == 1) {
2015 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002016 }
2017
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002018 my $hunk_line = ($realcnt != 0);
2019
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002020#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07002021 $prefix = "$filename:$realline: " if ($emacs && $file);
2022 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2023
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002024 $here = "#$linenr: " if (!$file);
2025 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002026
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002027 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002028 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002029 if ($line =~ /^diff --git.*?(\S+)$/) {
2030 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002031 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002032 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002033 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002034 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002035 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002036 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002037 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002038
2039 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002040 if (!$file && $tree && $p1_prefix ne '' &&
2041 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002042 WARN("PATCH_PREFIX",
2043 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002044 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002045
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002046 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002047 ERROR("MODIFIED_INCLUDE_ASM",
2048 "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 -07002049 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002050 $found_file = 1;
2051 }
2052
2053 if ($found_file) {
2054 if ($realfile =~ m@^(drivers/net/|net/)@) {
2055 $check = 1;
2056 } else {
2057 $check = $check_orig;
2058 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002059 next;
2060 }
2061
Randy Dunlap389834b2007-06-08 13:47:03 -07002062 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002063
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002064 my $hereline = "$here\n$rawline\n";
2065 my $herecurr = "$here\n$rawline\n";
2066 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002067
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002068 $cnt_lines++ if ($realcnt != 0);
2069
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002070# Check for incorrect file permissions
2071 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2072 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002073 if ($realfile !~ m@scripts/@ &&
2074 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002075 ERROR("EXECUTE_PERMISSIONS",
2076 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002077 }
2078 }
2079
Joe Perches20112472011-07-25 17:13:23 -07002080# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002081 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002082 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002083 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002084 }
2085
Joe Perchese0d975b2014-12-10 15:51:49 -08002086# Check if MAINTAINERS is being updated. If so, there's probably no need to
2087# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2088 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2089 $reported_maintainer_file = 1;
2090 }
2091
Joe Perches20112472011-07-25 17:13:23 -07002092# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002093 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002094 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002095 my $space_before = $1;
2096 my $sign_off = $2;
2097 my $space_after = $3;
2098 my $email = $4;
2099 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2100
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002101 if ($sign_off !~ /$signature_tags/) {
2102 WARN("BAD_SIGN_OFF",
2103 "Non-standard signature: $sign_off\n" . $herecurr);
2104 }
Joe Perches20112472011-07-25 17:13:23 -07002105 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002106 if (WARN("BAD_SIGN_OFF",
2107 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2108 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002109 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002110 "$ucfirst_sign_off $email";
2111 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002112 }
Joe Perches20112472011-07-25 17:13:23 -07002113 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002114 if (WARN("BAD_SIGN_OFF",
2115 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2116 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002117 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002118 "$ucfirst_sign_off $email";
2119 }
2120
Joe Perches20112472011-07-25 17:13:23 -07002121 }
2122 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002123 if (WARN("BAD_SIGN_OFF",
2124 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2125 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002126 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002127 "$ucfirst_sign_off $email";
2128 }
Joe Perches20112472011-07-25 17:13:23 -07002129 }
2130
2131 my ($email_name, $email_address, $comment) = parse_email($email);
2132 my $suggested_email = format_email(($email_name, $email_address));
2133 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002134 ERROR("BAD_SIGN_OFF",
2135 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002136 } else {
2137 my $dequoted = $suggested_email;
2138 $dequoted =~ s/^"//;
2139 $dequoted =~ s/" </ </;
2140 # Don't force email to have quotes
2141 # Allow just an angle bracketed address
2142 if ("$dequoted$comment" ne $email &&
2143 "<$email_address>$comment" ne $email &&
2144 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002145 WARN("BAD_SIGN_OFF",
2146 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002147 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002148 }
Joe Perches7e51f192013-09-11 14:23:57 -07002149
2150# Check for duplicate signatures
2151 my $sig_nospace = $line;
2152 $sig_nospace =~ s/\s//g;
2153 $sig_nospace = lc($sig_nospace);
2154 if (defined $signatures{$sig_nospace}) {
2155 WARN("BAD_SIGN_OFF",
2156 "Duplicate signature\n" . $herecurr);
2157 } else {
2158 $signatures{$sig_nospace} = 1;
2159 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002160 }
2161
Joe Perches9b3189e2014-06-04 16:12:10 -07002162# Check for old stable address
2163 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2164 ERROR("STABLE_ADDRESS",
2165 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2166 }
2167
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002168# Check for unwanted Gerrit info
2169 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2170 ERROR("GERRIT_CHANGE_ID",
2171 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2172 }
2173
Joe Perchesd311cd42014-08-06 16:10:57 -07002174# Check for improperly formed commit descriptions
2175 if ($in_commit_log &&
2176 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
Joe Perches66881732014-09-09 14:50:55 -07002177 !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ ||
2178 ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ &&
2179 defined $rawlines[$linenr] &&
2180 $rawlines[$linenr] =~ /^\s*\("/))) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002181 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2182 my $init_char = $1;
2183 my $orig_commit = lc($2);
2184 my $id = '01234567890ab';
2185 my $desc = 'commit description';
2186 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2187 ERROR("GIT_COMMIT_ID",
Joe Perches3f6316b2014-08-29 15:18:26 -07002188 "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
Joe Perchesd311cd42014-08-06 16:10:57 -07002189 }
2190
Joe Perches13f19372014-08-06 16:10:59 -07002191# Check for added, moved or deleted files
2192 if (!$reported_maintainer_file && !$in_commit_log &&
2193 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2194 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2195 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2196 (defined($1) || defined($2))))) {
2197 $reported_maintainer_file = 1;
2198 WARN("FILE_PATH_CHANGES",
2199 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2200 }
2201
Andy Whitcroft00df3442007-06-08 13:47:06 -07002202# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002203 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002204 ERROR("CORRUPTED_PATCH",
2205 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002206 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002207 }
2208
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002209# Check for absolute kernel paths.
2210 if ($tree) {
2211 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2212 my $file = $1;
2213
2214 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2215 check_absolute_file($1, $herecurr)) {
2216 #
2217 } else {
2218 check_absolute_file($file, $herecurr);
2219 }
2220 }
2221 }
2222
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002223# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2224 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002225 $rawline !~ m/^$UTF8*$/) {
2226 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2227
2228 my $blank = copy_spacing($rawline);
2229 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2230 my $hereptr = "$hereline$ptr\n";
2231
Joe Perches34d99212011-07-25 17:13:26 -07002232 CHK("INVALID_UTF8",
2233 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002234 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002235
Joe Perches15662b32011-10-31 17:13:12 -07002236# Check if it's the start of a commit log
2237# (not a header line and we haven't seen the patch filename)
2238 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002239 !($rawline =~ /^\s+\S/ ||
2240 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002241 $in_header_lines = 0;
2242 $in_commit_log = 1;
2243 }
2244
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002245# Check if there is UTF-8 in a commit log when a mail header has explicitly
2246# declined it, i.e defined some charset where it is missing.
2247 if ($in_header_lines &&
2248 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2249 $1 !~ /utf-8/i) {
2250 $non_utf8_charset = 1;
2251 }
2252
2253 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002254 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002255 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002256 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2257 }
2258
Kees Cook66b47b42014-10-13 15:51:57 -07002259# Check for various typo / spelling mistakes
Joe Perches36061e32014-12-10 15:51:43 -08002260 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
Kees Cook66b47b42014-10-13 15:51:57 -07002261 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2262 my $typo = $1;
2263 my $typo_fix = $spelling_fix{lc($typo)};
2264 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2265 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2266 my $msg_type = \&WARN;
2267 $msg_type = \&CHK if ($file);
2268 if (&{$msg_type}("TYPO_SPELLING",
2269 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2270 $fix) {
2271 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2272 }
2273 }
2274 }
2275
Andy Whitcroft306708542008-10-15 22:02:28 -07002276# ignore non-hunk lines and lines being removed
2277 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002278
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002279#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002280 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002281 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002282 if (ERROR("DOS_LINE_ENDINGS",
2283 "DOS line endings\n" . $herevet) &&
2284 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002285 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002286 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002287 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2288 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002289 if (ERROR("TRAILING_WHITESPACE",
2290 "trailing whitespace\n" . $herevet) &&
2291 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002292 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002293 }
2294
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002295 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002296 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002297
Josh Triplett4783f892013-11-12 15:10:12 -08002298# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002299 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002300 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2301 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002302 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2303 my $msg_type = \&ERROR;
2304 $msg_type = \&CHK if ($file);
2305 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002306 "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 -08002307 }
2308
Andi Kleen33549572010-05-24 14:33:29 -07002309# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002310# Only applies when adding the entry originally, after that we do not have
2311# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002312 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002313 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002314 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002315 my $cnt = $realcnt;
2316 my $ln = $linenr + 1;
2317 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002318 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002319 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002320 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002321 $f = $lines[$ln - 1];
2322 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2323 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002324
2325 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002326 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002327
Joe Perches8d73e0e2014-08-06 16:10:46 -07002328 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002329 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002330 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002331 $length = -1;
2332 }
2333
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002334 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002335 $f =~ s/#.*//;
2336 $f =~ s/^\s+//;
2337 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002338 if ($f =~ /^\s*config\s/) {
2339 $is_end = 1;
2340 last;
2341 }
Andi Kleen33549572010-05-24 14:33:29 -07002342 $length++;
2343 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002344 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2345 WARN("CONFIG_DESCRIPTION",
2346 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2347 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002348 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002349 }
2350
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002351# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2352 if ($realfile =~ /Kconfig/ &&
2353 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2354 WARN("CONFIG_EXPERIMENTAL",
2355 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2356 }
2357
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002358 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2359 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2360 my $flag = $1;
2361 my $replacement = {
2362 'EXTRA_AFLAGS' => 'asflags-y',
2363 'EXTRA_CFLAGS' => 'ccflags-y',
2364 'EXTRA_CPPFLAGS' => 'cppflags-y',
2365 'EXTRA_LDFLAGS' => 'ldflags-y',
2366 };
2367
2368 WARN("DEPRECATED_VARIABLE",
2369 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2370 }
2371
Rob Herringbff5da42014-01-23 15:54:51 -08002372# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002373 if (defined $root &&
2374 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2375 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2376
Rob Herringbff5da42014-01-23 15:54:51 -08002377 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2378
Florian Vaussardcc933192014-04-03 14:49:27 -07002379 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2380 my $vp_file = $dt_path . "vendor-prefixes.txt";
2381
Rob Herringbff5da42014-01-23 15:54:51 -08002382 foreach my $compat (@compats) {
2383 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002384 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2385 my $compat3 = $compat;
2386 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2387 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002388 if ( $? >> 8 ) {
2389 WARN("UNDOCUMENTED_DT_STRING",
2390 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2391 }
2392
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002393 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2394 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002395 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002396 if ( $? >> 8 ) {
2397 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002398 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002399 }
2400 }
2401 }
2402
Andy Whitcroft5368df22008-10-15 22:02:27 -07002403# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002404 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002405
Joe Perches6cd7f382012-12-17 16:01:54 -08002406#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002407 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002408 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002409 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002410 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002411 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002412 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002413 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002414 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002415 }
2416
Andy Whitcroft8905a672007-11-28 16:21:06 -08002417# check for adding lines without a newline.
2418 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002419 WARN("MISSING_EOF_NEWLINE",
2420 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002421 }
2422
Mike Frysinger42e41c52009-09-21 17:04:40 -07002423# Blackfin: use hi/lo macros
2424 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2425 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2426 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002427 ERROR("LO_MACRO",
2428 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002429 }
2430 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2431 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002432 ERROR("HI_MACRO",
2433 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002434 }
2435 }
2436
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002437# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002438 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002439
2440# at the beginning of a line any tabs must come first and anything
2441# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002442 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2443 $rawline =~ /^\+\s* \s*/) {
2444 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002445 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002446 if (ERROR("CODE_INDENT",
2447 "code indent should use tabs where possible\n" . $herevet) &&
2448 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002449 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002450 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002451 }
2452
Alberto Panizzo08e44362010-03-05 13:43:54 -08002453# check for space before tabs.
2454 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2455 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002456 if (WARN("SPACE_BEFORE_TAB",
2457 "please, no space before tabs\n" . $herevet) &&
2458 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002459 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002460 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002461 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002462 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002463 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002464 }
2465
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002466# check for && or || at the start of a line
2467 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2468 CHK("LOGICAL_CONTINUATIONS",
2469 "Logical continuations should be on the previous line\n" . $hereprev);
2470 }
2471
2472# check multi-line statement indentation matches previous line
2473 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002474 $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 -07002475 $prevline =~ /^\+(\t*)(.*)$/;
2476 my $oldindent = $1;
2477 my $rest = $2;
2478
2479 my $pos = pos_last_openparen($rest);
2480 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002481 $line =~ /^(\+| )([ \t]*)/;
2482 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002483
2484 my $goodtabindent = $oldindent .
2485 "\t" x ($pos / 8) .
2486 " " x ($pos % 8);
2487 my $goodspaceindent = $oldindent . " " x $pos;
2488
2489 if ($newindent ne $goodtabindent &&
2490 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002491
2492 if (CHK("PARENTHESIS_ALIGNMENT",
2493 "Alignment should match open parenthesis\n" . $hereprev) &&
2494 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002495 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002496 s/^\+[ \t]*/\+$goodtabindent/;
2497 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002498 }
2499 }
2500 }
2501
Joe Perches04941aa2014-12-10 15:51:37 -08002502 if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ &&
2503 (!defined($1) || $1 !~ /sizeof\s*/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002504 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002505 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002506 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002507 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002508 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002509 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002510 }
2511
Joe Perches05880602012-10-04 17:13:35 -07002512 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002513 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002514 $rawline =~ /^\+[ \t]*\*/ &&
2515 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002516 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2517 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2518 }
2519
2520 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002521 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2522 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002523 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002524 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2525 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2526 "networking block comments start with * on subsequent lines\n" . $hereprev);
2527 }
2528
2529 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002530 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2531 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2532 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2533 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002534 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2535 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2536 }
2537
Joe Perches7f619192014-08-06 16:10:39 -07002538# check for missing blank lines after struct/union declarations
2539# with exceptions for various attributes and macros
2540 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2541 $line =~ /^\+/ &&
2542 !($line =~ /^\+\s*$/ ||
2543 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2544 $line =~ /^\+\s*MODULE_/i ||
2545 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2546 $line =~ /^\+[a-z_]*init/ ||
2547 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2548 $line =~ /^\+\s*DECLARE/ ||
2549 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002550 if (CHK("LINE_SPACING",
2551 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2552 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002553 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002554 }
Joe Perches7f619192014-08-06 16:10:39 -07002555 }
2556
Joe Perches365dd4e2014-08-06 16:10:42 -07002557# check for multiple consecutive blank lines
2558 if ($prevline =~ /^[\+ ]\s*$/ &&
2559 $line =~ /^\+\s*$/ &&
2560 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002561 if (CHK("LINE_SPACING",
2562 "Please don't use multiple blank lines\n" . $hereprev) &&
2563 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002564 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002565 }
2566
Joe Perches365dd4e2014-08-06 16:10:42 -07002567 $last_blank_line = $linenr;
2568 }
2569
Joe Perches3b617e32014-04-03 14:49:28 -07002570# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002571 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2572 # actual declarations
2573 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002574 # function pointer declarations
2575 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002576 # foo bar; where foo is some local typedef or #define
2577 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2578 # known declaration macros
2579 $prevline =~ /^\+\s+$declaration_macros/) &&
2580 # for "else if" which can look like "$Ident $Ident"
2581 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2582 # other possible extensions of declaration lines
2583 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2584 # not starting a section or a macro "\" extended line
2585 $prevline =~ /(?:\{\s*|\\)$/) &&
2586 # looks like a declaration
2587 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002588 # function pointer declarations
2589 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002590 # foo bar; where foo is some local typedef or #define
2591 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2592 # known declaration macros
2593 $sline =~ /^\+\s+$declaration_macros/ ||
2594 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002595 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002596 # start or end of block or continuation of declaration
2597 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2598 # bitfield continuation
2599 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2600 # other possible extensions of declaration lines
2601 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2602 # indentation of previous and current line are the same
2603 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002604 if (WARN("LINE_SPACING",
2605 "Missing a blank line after declarations\n" . $hereprev) &&
2606 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002607 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002608 }
Joe Perches3b617e32014-04-03 14:49:28 -07002609 }
2610
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002611# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002612# Exceptions:
2613# 1) within comments
2614# 2) indented preprocessor commands
2615# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002616 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002617 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002618 if (WARN("LEADING_SPACE",
2619 "please, no spaces at the start of a line\n" . $herevet) &&
2620 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002621 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002622 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002623 }
2624
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002625# check we are in a valid C source file if not then ignore this hunk
2626 next if ($realfile !~ /\.(h|c)$/);
2627
Joe Perches032a4c02014-08-06 16:10:29 -07002628# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002629# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002630# if the previous line is a break or return and is indented 1 tab more...
2631 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2632 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002633 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2634 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2635 defined $lines[$linenr] &&
2636 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002637 WARN("UNNECESSARY_ELSE",
2638 "else is not generally useful after a break or return\n" . $hereprev);
2639 }
2640 }
2641
Joe Perchesc00df192014-08-06 16:11:01 -07002642# check indentation of a line with a break;
2643# if the previous line is a goto or return and is indented the same # of tabs
2644 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2645 my $tabs = $1;
2646 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2647 WARN("UNNECESSARY_BREAK",
2648 "break is not useful after a goto or return\n" . $hereprev);
2649 }
2650 }
2651
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002652# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2653 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2654 WARN("CONFIG_EXPERIMENTAL",
2655 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2656 }
2657
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002658# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002659 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002660 WARN("CVS_KEYWORD",
2661 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002662 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002663
Mike Frysinger42e41c52009-09-21 17:04:40 -07002664# Blackfin: don't use __builtin_bfin_[cs]sync
2665 if ($line =~ /__builtin_bfin_csync/) {
2666 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002667 ERROR("CSYNC",
2668 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002669 }
2670 if ($line =~ /__builtin_bfin_ssync/) {
2671 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002672 ERROR("SSYNC",
2673 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002674 }
2675
Joe Perches56e77d72013-02-21 16:44:14 -08002676# check for old HOTPLUG __dev<foo> section markings
2677 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2678 WARN("HOTPLUG_SECTION",
2679 "Using $1 is unnecessary\n" . $herecurr);
2680 }
2681
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002682# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002683 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2684 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002685#print "LINE<$line>\n";
2686 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002687 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002688 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002689 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002690 $stat =~ s/\n./\n /g;
2691 $cond =~ s/\n./\n /g;
2692
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002693#print "linenr<$linenr> <$stat>\n";
2694 # If this statement has no statement boundaries within
2695 # it there is no point in retrying a statement scan
2696 # until we hit end of it.
2697 my $frag = $stat; $frag =~ s/;+\s*$//;
2698 if ($frag !~ /(?:{|;)/) {
2699#print "skip<$line_nr_next>\n";
2700 $suppress_statement = $line_nr_next;
2701 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002702
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002703 # Find the real next line.
2704 $realline_next = $line_nr_next;
2705 if (defined $realline_next &&
2706 (!defined $lines[$realline_next - 1] ||
2707 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2708 $realline_next++;
2709 }
2710
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002711 my $s = $stat;
2712 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002713
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002714 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002715 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002716
2717 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002718 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002719
Andy Whitcroft463f2862009-09-21 17:04:34 -07002720 } elsif ($s =~ /^.\s*else\b/s) {
2721
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002722 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002723 } 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 -07002724 my $type = $1;
2725 $type =~ s/\s+/ /g;
2726 possible($type, "A:" . $s);
2727
Andy Whitcroft8905a672007-11-28 16:21:06 -08002728 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002729 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002730 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002731 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002732
2733 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002734 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002735 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002736 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002737
2738 # Check for any sort of function declaration.
2739 # int foo(something bar, other baz);
2740 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002741 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 -08002742 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002743
Andy Whitcroftcf655042008-03-04 14:28:20 -08002744 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002745 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002746 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002747
Andy Whitcroft8905a672007-11-28 16:21:06 -08002748 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002749 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002750
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002751 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002752 }
2753 }
2754 }
2755
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002756 }
2757
Andy Whitcroft653d4872007-06-23 17:16:34 -07002758#
2759# Checks which may be anchored in the context.
2760#
2761
2762# Check for switch () and associated case and default
2763# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002764 if ($line=~/\bswitch\s*\(.*\)/) {
2765 my $err = '';
2766 my $sep = '';
2767 my @ctx = ctx_block_outer($linenr, $realcnt);
2768 shift(@ctx);
2769 for my $ctx (@ctx) {
2770 my ($clen, $cindent) = line_stats($ctx);
2771 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2772 $indent != $cindent) {
2773 $err .= "$sep$ctx\n";
2774 $sep = '';
2775 } else {
2776 $sep = "[...]\n";
2777 }
2778 }
2779 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002780 ERROR("SWITCH_CASE_INDENT_LEVEL",
2781 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002782 }
2783 }
2784
2785# if/while/etc brace do not go on next line, unless defining a do while loop,
2786# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07002787 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 -07002788 my $pre_ctx = "$1$2";
2789
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002790 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002791
2792 if ($line =~ /^\+\t{6,}/) {
2793 WARN("DEEP_INDENTATION",
2794 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2795 }
2796
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002797 my $ctx_cnt = $realcnt - $#ctx - 1;
2798 my $ctx = join("\n", @ctx);
2799
Andy Whitcroft548596d2008-07-23 21:29:01 -07002800 my $ctx_ln = $linenr;
2801 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002802
Andy Whitcroft548596d2008-07-23 21:29:01 -07002803 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2804 defined $lines[$ctx_ln - 1] &&
2805 $lines[$ctx_ln - 1] =~ /^-/)) {
2806 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2807 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002808 $ctx_ln++;
2809 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002810
Andy Whitcroft53210162008-07-23 21:29:03 -07002811 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2812 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002813
Joe Perchesd752fcc2014-08-06 16:11:05 -07002814 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002815 ERROR("OPEN_BRACE",
2816 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002817 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002818 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002819 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2820 $ctx =~ /\)\s*\;\s*$/ &&
2821 defined $lines[$ctx_ln - 1])
2822 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002823 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2824 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002825 WARN("TRAILING_SEMICOLON",
2826 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002827 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002828 }
2829 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002830 }
2831
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002832# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07002833 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 -08002834 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2835 ctx_statement_block($linenr, $realcnt, 0)
2836 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002837 my ($s, $c) = ($stat, $cond);
2838
2839 substr($s, 0, length($c), '');
2840
2841 # Make sure we remove the line prefixes as we have
2842 # none on the first line, and are going to readd them
2843 # where necessary.
2844 $s =~ s/\n./\n/gs;
2845
2846 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002847 my @newlines = ($c =~ /\n/gs);
2848 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002849
2850 # We want to check the first line inside the block
2851 # starting at the end of the conditional, so remove:
2852 # 1) any blank line termination
2853 # 2) any opening brace { on end of the line
2854 # 3) any do (...) {
2855 my $continuation = 0;
2856 my $check = 0;
2857 $s =~ s/^.*\bdo\b//;
2858 $s =~ s/^\s*{//;
2859 if ($s =~ s/^\s*\\//) {
2860 $continuation = 1;
2861 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002862 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002863 $check = 1;
2864 $cond_lines++;
2865 }
2866
2867 # Also ignore a loop construct at the end of a
2868 # preprocessor statement.
2869 if (($prevline =~ /^.\s*#\s*define\s/ ||
2870 $prevline =~ /\\\s*$/) && $continuation == 0) {
2871 $check = 0;
2872 }
2873
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002874 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002875 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002876 while ($cond_ptr != $cond_lines) {
2877 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002878
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002879 # If we see an #else/#elif then the code
2880 # is not linear.
2881 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2882 $check = 0;
2883 }
2884
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002885 # Ignore:
2886 # 1) blank lines, they should be at 0,
2887 # 2) preprocessor lines, and
2888 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002889 if ($continuation ||
2890 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002891 $s =~ /^\s*#\s*?/ ||
2892 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002893 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002894 if ($s =~ s/^.*?\n//) {
2895 $cond_lines++;
2896 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002897 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002898 }
2899
2900 my (undef, $sindent) = line_stats("+" . $s);
2901 my $stat_real = raw_line($linenr, $cond_lines);
2902
2903 # Check if either of these lines are modified, else
2904 # this is not this patch's fault.
2905 if (!defined($stat_real) ||
2906 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2907 $check = 0;
2908 }
2909 if (defined($stat_real) && $cond_lines > 1) {
2910 $stat_real = "[...]\n$stat_real";
2911 }
2912
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002913 #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 -07002914
2915 if ($check && (($sindent % 8) != 0 ||
2916 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002917 WARN("SUSPECT_CODE_INDENT",
2918 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002919 }
2920 }
2921
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002922 # Track the 'values' across context and added lines.
2923 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002924 my ($curr_values, $curr_vars) =
2925 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002926 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002927 if ($dbg_values) {
2928 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002929 print "$linenr > .$outline\n";
2930 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002931 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002932 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002933 $prev_values = substr($curr_values, -1);
2934
Andy Whitcroft00df3442007-06-08 13:47:06 -07002935#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002936 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002937
Andy Whitcroft653d4872007-06-23 17:16:34 -07002938# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002939 if ($dbg_type) {
2940 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002941 ERROR("TEST_TYPE",
2942 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002943 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002944 ERROR("TEST_NOT_TYPE",
2945 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002946 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002947 next;
2948 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002949# TEST: allow direct testing of the attribute matcher.
2950 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002951 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002952 ERROR("TEST_ATTR",
2953 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002954 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002955 ERROR("TEST_NOT_ATTR",
2956 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002957 }
2958 next;
2959 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002960
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002961# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002962 if ($line =~ /^.\s*{/ &&
2963 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002964 if (ERROR("OPEN_BRACE",
2965 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002966 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2967 fix_delete_line($fixlinenr - 1, $prevrawline);
2968 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002969 my $fixedline = $prevrawline;
2970 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002971 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002972 $fixedline = $line;
2973 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002974 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002975 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002976 }
2977
Andy Whitcroft653d4872007-06-23 17:16:34 -07002978#
2979# Checks which are anchored on the added line.
2980#
2981
2982# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002983 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002984 my $path = $1;
2985 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002986 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002987 "malformed #include filename\n" . $herecurr);
2988 }
2989 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2990 ERROR("UAPI_INCLUDE",
2991 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002992 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002993 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002994
2995# no C99 // comments
2996 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002997 if (ERROR("C99_COMMENTS",
2998 "do not use C99 // comments\n" . $herecurr) &&
2999 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003000 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003001 if ($line =~ /\/\/(.*)$/) {
3002 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003003 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003004 }
3005 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003006 }
3007 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003008 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003009 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003010
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003011# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3012# the whole statement.
3013#print "APW <$lines[$realline_next - 1]>\n";
3014 if (defined $realline_next &&
3015 exists $lines[$realline_next - 1] &&
3016 !defined $suppress_export{$realline_next} &&
3017 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3018 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003019 # Handle definitions which produce identifiers with
3020 # a prefix:
3021 # XXX(foo);
3022 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003023 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003024 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003025 $name =~ /^${Ident}_$2/) {
3026#print "FOO C name<$name>\n";
3027 $suppress_export{$realline_next} = 1;
3028
3029 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003030 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003031 ^.DEFINE_$Ident\(\Q$name\E\)|
3032 ^.DECLARE_$Ident\(\Q$name\E\)|
3033 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003034 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3035 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003036 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003037#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3038 $suppress_export{$realline_next} = 2;
3039 } else {
3040 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003041 }
3042 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003043 if (!defined $suppress_export{$linenr} &&
3044 $prevline =~ /^.\s*$/ &&
3045 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3046 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3047#print "FOO B <$lines[$linenr - 1]>\n";
3048 $suppress_export{$linenr} = 2;
3049 }
3050 if (defined $suppress_export{$linenr} &&
3051 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003052 WARN("EXPORT_SYMBOL",
3053 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003054 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003055
Joe Eloff5150bda2010-08-09 17:21:00 -07003056# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003057 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3058 if (ERROR("GLOBAL_INITIALISERS",
3059 "do not initialise globals to 0 or NULL\n" .
3060 $herecurr) &&
3061 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003062 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003063 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003064 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003065# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003066 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3067 if (ERROR("INITIALISED_STATIC",
3068 "do not initialise statics to 0 or NULL\n" .
3069 $herecurr) &&
3070 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003071 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003072 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003073 }
3074
Joe Perches18130872014-08-06 16:11:22 -07003075# check for misordered declarations of char/short/int/long with signed/unsigned
3076 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3077 my $tmp = trim($1);
3078 WARN("MISORDERED_TYPE",
3079 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3080 }
3081
Joe Perchescb710ec2010-10-26 14:23:20 -07003082# check for static const char * arrays.
3083 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003084 WARN("STATIC_CONST_CHAR_ARRAY",
3085 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003086 $herecurr);
3087 }
3088
3089# check for static char foo[] = "bar" declarations.
3090 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003091 WARN("STATIC_CONST_CHAR_ARRAY",
3092 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003093 $herecurr);
3094 }
3095
Joe Perches9b0fa602014-04-03 14:49:18 -07003096# check for non-global char *foo[] = {"bar", ...} declarations.
3097 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3098 WARN("STATIC_CONST_CHAR_ARRAY",
3099 "char * array declaration might be better as static const\n" .
3100 $herecurr);
3101 }
3102
Joe Perchesb36190c2014-01-27 17:07:18 -08003103# check for function declarations without arguments like "int foo()"
3104 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3105 if (ERROR("FUNCTION_WITHOUT_ARGS",
3106 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3107 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003108 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003109 }
3110 }
3111
Joe Perches92e112f2013-12-13 11:36:22 -07003112# check for uses of DEFINE_PCI_DEVICE_TABLE
3113 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3114 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3115 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3116 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003117 $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 -07003118 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003119 }
3120
Andy Whitcroft653d4872007-06-23 17:16:34 -07003121# check for new typedefs, only function parameters and sparse annotations
3122# make sense.
3123 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003124 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003125 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003126 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003127 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003128 WARN("NEW_TYPEDEFS",
3129 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003130 }
3131
3132# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003133 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003134 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3135 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003136 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003137
Andy Whitcroft65863862009-01-06 14:41:21 -08003138 # Should start with a space.
3139 $to =~ s/^(\S)/ $1/;
3140 # Should not end with a space.
3141 $to =~ s/\s+$//;
3142 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003143 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003144 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003145
Joe Perches3705ce52013-07-03 15:05:31 -07003146## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003147 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003148 if (ERROR("POINTER_LOCATION",
3149 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3150 $fix) {
3151 my $sub_from = $ident;
3152 my $sub_to = $ident;
3153 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003154 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003155 s@\Q$sub_from\E@$sub_to@;
3156 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003157 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003158 }
3159 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3160 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003161 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003162
Andy Whitcroft65863862009-01-06 14:41:21 -08003163 # Should start with a space.
3164 $to =~ s/^(\S)/ $1/;
3165 # Should not end with a space.
3166 $to =~ s/\s+$//;
3167 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003168 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003169 }
3170 # Modifiers should have spaces.
3171 $to =~ s/(\b$Modifier$)/$1 /;
3172
Joe Perches3705ce52013-07-03 15:05:31 -07003173## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003174 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003175 if (ERROR("POINTER_LOCATION",
3176 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3177 $fix) {
3178
3179 my $sub_from = $match;
3180 my $sub_to = $match;
3181 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003182 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003183 s@\Q$sub_from\E@$sub_to@;
3184 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003185 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003186 }
3187
3188# # no BUG() or BUG_ON()
3189# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3190# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3191# print "$herecurr";
3192# $clean = 0;
3193# }
3194
Andy Whitcroft8905a672007-11-28 16:21:06 -08003195 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003196 WARN("LINUX_VERSION_CODE",
3197 "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 -08003198 }
3199
Joe Perches17441222011-06-15 15:08:17 -07003200# check for uses of printk_ratelimit
3201 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003202 WARN("PRINTK_RATELIMITED",
3203"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003204 }
3205
Andy Whitcroft00df3442007-06-08 13:47:06 -07003206# printk should use KERN_* levels. Note that follow on printk's on the
3207# same line do not need a level, so we use the current block context
3208# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003209# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003210# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003211 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003212 my $ok = 0;
3213 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3214 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003215 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003216 # with "\n" ignore it, else it is to blame
3217 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3218 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3219 $ok = 1;
3220 }
3221 last;
3222 }
3223 }
3224 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003225 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3226 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003227 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003228 }
3229
Joe Perches243f3802012-05-31 16:26:09 -07003230 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3231 my $orig = $1;
3232 my $level = lc($orig);
3233 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003234 my $level2 = $level;
3235 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003236 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003237 "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 -07003238 }
3239
3240 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003241 if (WARN("PREFER_PR_LEVEL",
3242 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3243 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003244 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003245 s/\bpr_warning\b/pr_warn/;
3246 }
Joe Perches243f3802012-05-31 16:26:09 -07003247 }
3248
Joe Perchesdc139312013-02-21 16:44:13 -08003249 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3250 my $orig = $1;
3251 my $level = lc($orig);
3252 $level = "warn" if ($level eq "warning");
3253 $level = "dbg" if ($level eq "debug");
3254 WARN("PREFER_DEV_LEVEL",
3255 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3256 }
3257
Andy Whitcroft653d4872007-06-23 17:16:34 -07003258# function brace can't be on same line, except for #defines of do while,
3259# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003260 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003261 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003262 if (ERROR("OPEN_BRACE",
3263 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3264 $fix) {
3265 fix_delete_line($fixlinenr, $rawline);
3266 my $fixed_line = $rawline;
3267 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3268 my $line1 = $1;
3269 my $line2 = $2;
3270 fix_insert_line($fixlinenr, ltrim($line1));
3271 fix_insert_line($fixlinenr, "\+{");
3272 if ($line2 !~ /^\s*$/) {
3273 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3274 }
3275 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003276 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003277
Andy Whitcroft8905a672007-11-28 16:21:06 -08003278# open braces for enum, union and struct go on the same line.
3279 if ($line =~ /^.\s*{/ &&
3280 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003281 if (ERROR("OPEN_BRACE",
3282 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3283 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3284 fix_delete_line($fixlinenr - 1, $prevrawline);
3285 fix_delete_line($fixlinenr, $rawline);
3286 my $fixedline = rtrim($prevrawline) . " {";
3287 fix_insert_line($fixlinenr, $fixedline);
3288 $fixedline = $rawline;
3289 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3290 if ($fixedline !~ /^\+\s*$/) {
3291 fix_insert_line($fixlinenr, $fixedline);
3292 }
3293 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003294 }
3295
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003296# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003297 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3298 if (WARN("SPACING",
3299 "missing space after $1 definition\n" . $herecurr) &&
3300 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003301 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003302 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3303 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003304 }
3305
Joe Perches31070b52014-01-23 15:54:49 -08003306# Function pointer declarations
3307# check spacing between type, funcptr, and args
3308# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003309 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003310 my $declare = $1;
3311 my $pre_pointer_space = $2;
3312 my $post_pointer_space = $3;
3313 my $funcname = $4;
3314 my $post_funcname_space = $5;
3315 my $pre_args_space = $6;
3316
Joe Perches91f72e92014-04-03 14:49:12 -07003317# the $Declare variable will capture all spaces after the type
3318# so check it for a missing trailing missing space but pointer return types
3319# don't need a space so don't warn for those.
3320 my $post_declare_space = "";
3321 if ($declare =~ /(\s+)$/) {
3322 $post_declare_space = $1;
3323 $declare = rtrim($declare);
3324 }
3325 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003326 WARN("SPACING",
3327 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003328 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003329 }
3330
3331# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003332# This test is not currently implemented because these declarations are
3333# equivalent to
3334# int foo(int bar, ...)
3335# and this is form shouldn't/doesn't generate a checkpatch warning.
3336#
3337# elsif ($declare =~ /\s{2,}$/) {
3338# WARN("SPACING",
3339# "Multiple spaces after return type\n" . $herecurr);
3340# }
Joe Perches31070b52014-01-23 15:54:49 -08003341
3342# unnecessary space "type ( *funcptr)(args...)"
3343 if (defined $pre_pointer_space &&
3344 $pre_pointer_space =~ /^\s/) {
3345 WARN("SPACING",
3346 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3347 }
3348
3349# unnecessary space "type (* funcptr)(args...)"
3350 if (defined $post_pointer_space &&
3351 $post_pointer_space =~ /^\s/) {
3352 WARN("SPACING",
3353 "Unnecessary space before function pointer name\n" . $herecurr);
3354 }
3355
3356# unnecessary space "type (*funcptr )(args...)"
3357 if (defined $post_funcname_space &&
3358 $post_funcname_space =~ /^\s/) {
3359 WARN("SPACING",
3360 "Unnecessary space after function pointer name\n" . $herecurr);
3361 }
3362
3363# unnecessary space "type (*funcptr) (args...)"
3364 if (defined $pre_args_space &&
3365 $pre_args_space =~ /^\s/) {
3366 WARN("SPACING",
3367 "Unnecessary space before function pointer arguments\n" . $herecurr);
3368 }
3369
3370 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003371 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003372 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003373 }
3374 }
3375
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003376# check for spacing round square brackets; allowed:
3377# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003378# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3379# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003380 while ($line =~ /(.*?\s)\[/g) {
3381 my ($where, $prefix) = ($-[1], $1);
3382 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003383 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003384 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003385 if (ERROR("BRACKET_SPACE",
3386 "space prohibited before open square bracket '['\n" . $herecurr) &&
3387 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003388 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003389 s/^(\+.*?)\s+\[/$1\[/;
3390 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003391 }
3392 }
3393
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003394# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003395 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003396 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003397 my $ctx_before = substr($line, 0, $-[1]);
3398 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003399
3400 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003401 if ($name =~ /^(?:
3402 if|for|while|switch|return|case|
3403 volatile|__volatile__|
3404 __attribute__|format|__extension__|
3405 asm|__asm__)$/x)
3406 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003407 # cpp #define statements have non-optional spaces, ie
3408 # if there is a space between the name and the open
3409 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003410 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003411
3412 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003413 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003414
3415 # If this whole things ends with a type its most
3416 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003417 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003418
3419 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003420 if (WARN("SPACING",
3421 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003423 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003424 s/\b$name\s+\(/$name\(/;
3425 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003426 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003427 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003428
Andy Whitcroft653d4872007-06-23 17:16:34 -07003429# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003430 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003431 my $fixed_line = "";
3432 my $line_fixed = 0;
3433
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003434 my $ops = qr{
3435 <<=|>>=|<=|>=|==|!=|
3436 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3437 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003438 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003439 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003440 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003441 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003442
3443## print("element count: <" . $#elements . ">\n");
3444## foreach my $el (@elements) {
3445## print("el: <$el>\n");
3446## }
3447
3448 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003449 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003450
Joe Perches3705ce52013-07-03 15:05:31 -07003451 foreach my $el (@elements) {
3452 push(@fix_elements, substr($rawline, $off, length($el)));
3453 $off += length($el);
3454 }
3455
3456 $off = 0;
3457
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003458 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003459 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003460
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003461 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003462
3463 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3464
3465## print("n: <$n> good: <$good>\n");
3466
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003467 $off += length($elements[$n]);
3468
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003469 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003470 my $ca = substr($opline, 0, $off);
3471 my $cc = '';
3472 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3473 $cc = substr($opline, $off + length($elements[$n + 1]));
3474 }
3475 my $cb = "$ca$;$cc";
3476
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003477 my $a = '';
3478 $a = 'V' if ($elements[$n] ne '');
3479 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003480 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003481 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3482 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003483 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003484
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003485 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003486
3487 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003488 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003489 $c = 'V' if ($elements[$n + 2] ne '');
3490 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003491 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003492 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3493 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003494 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003495 } else {
3496 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003497 }
3498
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003499 my $ctx = "${a}x${c}";
3500
3501 my $at = "(ctx:$ctx)";
3502
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003503 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003504 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003505
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003506 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003507 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003508
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003509 # Get the full operator variant.
3510 my $opv = $op . substr($curr_vars, $off, 1);
3511
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003512 # Ignore operators passed as parameters.
3513 if ($op_type ne 'V' &&
3514 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3515
Andy Whitcroftcf655042008-03-04 14:28:20 -08003516# # Ignore comments
3517# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003518
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003519 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003520 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003521 if ($ctx !~ /.x[WEBC]/ &&
3522 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003523 if (ERROR("SPACING",
3524 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003525 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003526 $line_fixed = 1;
3527 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003528 }
3529
3530 # // is a comment
3531 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003532
Joe Perchesb00e4812014-04-03 14:49:33 -07003533 # : when part of a bitfield
3534 } elsif ($opv eq ':B') {
3535 # skip the bitfield test for now
3536
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003537 # No spaces for:
3538 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003539 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003540 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003541 if (ERROR("SPACING",
3542 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003543 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003544 if (defined $fix_elements[$n + 2]) {
3545 $fix_elements[$n + 2] =~ s/^\s+//;
3546 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003547 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003548 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003549 }
3550
Joe Perches23810972014-12-10 15:51:32 -08003551 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003552 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003553 my $rtrim_before = 0;
3554 my $space_after = 0;
3555 if ($ctx =~ /Wx./) {
3556 if (ERROR("SPACING",
3557 "space prohibited before that '$op' $at\n" . $hereptr)) {
3558 $line_fixed = 1;
3559 $rtrim_before = 1;
3560 }
3561 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003562 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003563 if (ERROR("SPACING",
3564 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003565 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003566 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003567 $space_after = 1;
3568 }
3569 }
3570 if ($rtrim_before || $space_after) {
3571 if ($rtrim_before) {
3572 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3573 } else {
3574 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3575 }
3576 if ($space_after) {
3577 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003578 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003579 }
3580
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003581 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003582 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003583 #warn "'*' is part of type\n";
3584
3585 # unary operators should have a space before and
3586 # none after. May be left adjacent to another
3587 # unary operator, or a cast
3588 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003589 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003590 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003591 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003592 if (ERROR("SPACING",
3593 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003594 if ($n != $last_after + 2) {
3595 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3596 $line_fixed = 1;
3597 }
Joe Perches3705ce52013-07-03 15:05:31 -07003598 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003599 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003600 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003601 # A unary '*' may be const
3602
3603 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003604 if (ERROR("SPACING",
3605 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003606 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003607 if (defined $fix_elements[$n + 2]) {
3608 $fix_elements[$n + 2] =~ s/^\s+//;
3609 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003610 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003611 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003612 }
3613
3614 # unary ++ and unary -- are allowed no space on one side.
3615 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003616 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003617 if (ERROR("SPACING",
3618 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003619 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003620 $line_fixed = 1;
3621 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003622 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003623 if ($ctx =~ /Wx[BE]/ ||
3624 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003625 if (ERROR("SPACING",
3626 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003627 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003628 $line_fixed = 1;
3629 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003630 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003631 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003632 if (ERROR("SPACING",
3633 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003634 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003635 if (defined $fix_elements[$n + 2]) {
3636 $fix_elements[$n + 2] =~ s/^\s+//;
3637 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003638 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003639 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003640 }
3641
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003642 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003643 } elsif ($op eq '<<' or $op eq '>>' or
3644 $op eq '&' or $op eq '^' or $op eq '|' or
3645 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003646 $op eq '*' or $op eq '/' or
3647 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003648 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003649 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003650 if (ERROR("SPACING",
3651 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003652 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3653 if (defined $fix_elements[$n + 2]) {
3654 $fix_elements[$n + 2] =~ s/^\s+//;
3655 }
Joe Perches3705ce52013-07-03 15:05:31 -07003656 $line_fixed = 1;
3657 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003658 }
3659
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003660 # A colon needs no spaces before when it is
3661 # terminating a case value or a label.
3662 } elsif ($opv eq ':C' || $opv eq ':L') {
3663 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003664 if (ERROR("SPACING",
3665 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003666 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003667 $line_fixed = 1;
3668 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003669 }
3670
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003671 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003672 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003673 my $ok = 0;
3674
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003675 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003676 if (($op eq '<' &&
3677 $cc =~ /^\S+\@\S+>/) ||
3678 ($op eq '>' &&
3679 $ca =~ /<\S+\@\S+$/))
3680 {
3681 $ok = 1;
3682 }
3683
Joe Perches84731622013-11-12 15:10:05 -08003684 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003685 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003686 my $msg_type = \&ERROR;
3687 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3688
3689 if (&{$msg_type}("SPACING",
3690 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003691 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3692 if (defined $fix_elements[$n + 2]) {
3693 $fix_elements[$n + 2] =~ s/^\s+//;
3694 }
Joe Perches3705ce52013-07-03 15:05:31 -07003695 $line_fixed = 1;
3696 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003697 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003698 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003699 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003700
3701## print("n: <$n> GOOD: <$good>\n");
3702
3703 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003704 }
Joe Perches3705ce52013-07-03 15:05:31 -07003705
3706 if (($#elements % 2) == 0) {
3707 $fixed_line = $fixed_line . $fix_elements[$#elements];
3708 }
3709
Joe Perches194f66f2014-08-06 16:11:03 -07003710 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3711 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003712 }
3713
3714
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003715 }
3716
Joe Perches786b6322013-07-03 15:05:32 -07003717# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003718 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003719 if (WARN("SPACING",
3720 "space prohibited before semicolon\n" . $herecurr) &&
3721 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003722 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003723 s/^(\+.*\S)\s+;/$1;/;
3724 }
3725 }
3726
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003727# check for multiple assignments
3728 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003729 CHK("MULTIPLE_ASSIGNMENTS",
3730 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003731 }
3732
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003733## # check for multiple declarations, allowing for a function declaration
3734## # continuation.
3735## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3736## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3737##
3738## # Remove any bracketed sections to ensure we do not
3739## # falsly report the parameters of functions.
3740## my $ln = $line;
3741## while ($ln =~ s/\([^\(\)]*\)//g) {
3742## }
3743## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003744## WARN("MULTIPLE_DECLARATION",
3745## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003746## }
3747## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003748
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003749#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003750 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3751 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003752 if (ERROR("SPACING",
3753 "space required before the open brace '{'\n" . $herecurr) &&
3754 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003755 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003756 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003757 }
3758
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003759## # check for blank lines before declarations
3760## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3761## $prevrawline =~ /^.\s*$/) {
3762## WARN("SPACING",
3763## "No blank lines before declarations\n" . $hereprev);
3764## }
3765##
3766
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003767# closing brace should have a space following it when it has anything
3768# on the line
3769 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003770 if (ERROR("SPACING",
3771 "space required after that close brace '}'\n" . $herecurr) &&
3772 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003773 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003774 s/}((?!(?:,|;|\)))\S)/} $1/;
3775 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003776 }
3777
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003778# check spacing on square brackets
3779 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003780 if (ERROR("SPACING",
3781 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3782 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003783 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003784 s/\[\s+/\[/;
3785 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003786 }
3787 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003788 if (ERROR("SPACING",
3789 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3790 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003791 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003792 s/\s+\]/\]/;
3793 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003794 }
3795
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003796# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003797 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3798 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003799 if (ERROR("SPACING",
3800 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3801 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003802 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003803 s/\(\s+/\(/;
3804 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003805 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003806 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003807 $line !~ /for\s*\(.*;\s+\)/ &&
3808 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003809 if (ERROR("SPACING",
3810 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3811 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003812 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003813 s/\s+\)/\)/;
3814 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003815 }
3816
Joe Perchese2826fd2014-08-06 16:10:48 -07003817# check unnecessary parentheses around addressof/dereference single $Lvals
3818# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3819
3820 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08003821 my $var = $1;
3822 if (CHK("UNNECESSARY_PARENTHESES",
3823 "Unnecessary parentheses around $var\n" . $herecurr) &&
3824 $fix) {
3825 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
3826 }
3827 }
3828
3829# check for unnecessary parentheses around function pointer uses
3830# ie: (foo->bar)(); should be foo->bar();
3831# but not "if (foo->bar) (" to avoid some false positives
3832 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
3833 my $var = $2;
3834 if (CHK("UNNECESSARY_PARENTHESES",
3835 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
3836 $fix) {
3837 my $var2 = deparenthesize($var);
3838 $var2 =~ s/\s//g;
3839 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
3840 }
3841 }
Joe Perchese2826fd2014-08-06 16:10:48 -07003842
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003843#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003844 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003845 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003846 if (WARN("INDENTED_LABEL",
3847 "labels should not be indented\n" . $herecurr) &&
3848 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003849 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003850 s/^(.)\s+/$1/;
3851 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003852 }
3853
Joe Perches5b9553a2014-04-03 14:49:21 -07003854# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003855 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003856 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003857 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003858 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3859 my $value = $1;
3860 $value = deparenthesize($value);
3861 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3862 ERROR("RETURN_PARENTHESES",
3863 "return is not a function, parentheses are not required\n" . $herecurr);
3864 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003865 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003866 ERROR("SPACING",
3867 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003868 }
3869 }
Joe Perches507e5142013-11-12 15:10:13 -08003870
Joe Perchesb43ae212014-06-23 13:22:07 -07003871# unnecessary return in a void function
3872# at end-of-function, with the previous line a single leading tab, then return;
3873# and the line before that not a goto label target like "out:"
3874 if ($sline =~ /^[ \+]}\s*$/ &&
3875 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3876 $linenr >= 3 &&
3877 $lines[$linenr - 3] =~ /^[ +]/ &&
3878 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003879 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003880 "void function return statements are not generally useful\n" . $hereprev);
3881 }
Joe Perches9819cf22014-06-04 16:12:09 -07003882
Joe Perches189248d2014-01-23 15:54:47 -08003883# if statements using unnecessary parentheses - ie: if ((foo == bar))
3884 if ($^V && $^V ge 5.10.0 &&
3885 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3886 my $openparens = $1;
3887 my $count = $openparens =~ tr@\(@\(@;
3888 my $msg = "";
3889 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3890 my $comp = $4; #Not $1 because of $LvalOrFunc
3891 $msg = " - maybe == should be = ?" if ($comp eq "==");
3892 WARN("UNNECESSARY_PARENTHESES",
3893 "Unnecessary parentheses$msg\n" . $herecurr);
3894 }
3895 }
3896
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003897# Return of what appears to be an errno should normally be -'ve
3898 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3899 my $name = $1;
3900 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003901 WARN("USE_NEGATIVE_ERRNO",
3902 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003903 }
3904 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003905
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003906# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003907 if ($line =~ /\b(if|while|for|switch)\(/) {
3908 if (ERROR("SPACING",
3909 "space required before the open parenthesis '('\n" . $herecurr) &&
3910 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003911 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003912 s/\b(if|while|for|switch)\(/$1 \(/;
3913 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003914 }
3915
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003916# Check for illegal assignment in if conditional -- and check for trailing
3917# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003918 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003919 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3920 ctx_statement_block($linenr, $realcnt, 0)
3921 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003922 my ($stat_next) = ctx_statement_block($line_nr_next,
3923 $remain_next, $off_next);
3924 $stat_next =~ s/\n./\n /g;
3925 ##print "stat<$stat> stat_next<$stat_next>\n";
3926
3927 if ($stat_next =~ /^\s*while\b/) {
3928 # If the statement carries leading newlines,
3929 # then count those as offsets.
3930 my ($whitespace) =
3931 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3932 my $offset =
3933 statement_rawlines($whitespace) - 1;
3934
3935 $suppress_whiletrailers{$line_nr_next +
3936 $offset} = 1;
3937 }
3938 }
3939 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003940 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003941 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003942 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003943
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003944 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003945 ERROR("ASSIGN_IN_IF",
3946 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003947 }
3948
3949 # Find out what is on the end of the line after the
3950 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003951 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003952 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003953 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003954 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3955 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003956 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003957 # Find out how long the conditional actually is.
3958 my @newlines = ($c =~ /\n/gs);
3959 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003960 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003961
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003962 $stat_real = raw_line($linenr, $cond_lines)
3963 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003964 if (defined($stat_real) && $cond_lines > 1) {
3965 $stat_real = "[...]\n$stat_real";
3966 }
3967
Joe Perches000d1cc12011-07-25 17:13:25 -07003968 ERROR("TRAILING_STATEMENTS",
3969 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003970 }
3971 }
3972
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003973# Check for bitwise tests written as boolean
3974 if ($line =~ /
3975 (?:
3976 (?:\[|\(|\&\&|\|\|)
3977 \s*0[xX][0-9]+\s*
3978 (?:\&\&|\|\|)
3979 |
3980 (?:\&\&|\|\|)
3981 \s*0[xX][0-9]+\s*
3982 (?:\&\&|\|\||\)|\])
3983 )/x)
3984 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003985 WARN("HEXADECIMAL_BOOLEAN_TEST",
3986 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003987 }
3988
Andy Whitcroft8905a672007-11-28 16:21:06 -08003989# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003990 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3991 my $s = $1;
3992 $s =~ s/$;//g; # Remove any comments
3993 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003994 ERROR("TRAILING_STATEMENTS",
3995 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003996 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003997 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003998# if should not continue a brace
3999 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004000 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004001 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004002 $herecurr);
4003 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004004# case and default should not have general statements after them
4005 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4006 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004007 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004008 \s*return\s+
4009 )/xg)
4010 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004011 ERROR("TRAILING_STATEMENTS",
4012 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004013 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004014
4015 # Check for }<nl>else {, these must be at the same
4016 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004017 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4018 $previndent == $indent) {
4019 if (ERROR("ELSE_AFTER_BRACE",
4020 "else should follow close brace '}'\n" . $hereprev) &&
4021 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4022 fix_delete_line($fixlinenr - 1, $prevrawline);
4023 fix_delete_line($fixlinenr, $rawline);
4024 my $fixedline = $prevrawline;
4025 $fixedline =~ s/}\s*$//;
4026 if ($fixedline !~ /^\+\s*$/) {
4027 fix_insert_line($fixlinenr, $fixedline);
4028 }
4029 $fixedline = $rawline;
4030 $fixedline =~ s/^(.\s*)else/$1} else/;
4031 fix_insert_line($fixlinenr, $fixedline);
4032 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004033 }
4034
Joe Perches8b8856f2014-08-06 16:11:14 -07004035 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4036 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004037 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4038
4039 # Find out what is on the end of the line after the
4040 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004041 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004042 $s =~ s/\n.*//g;
4043
4044 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004045 if (ERROR("WHILE_AFTER_BRACE",
4046 "while should follow close brace '}'\n" . $hereprev) &&
4047 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4048 fix_delete_line($fixlinenr - 1, $prevrawline);
4049 fix_delete_line($fixlinenr, $rawline);
4050 my $fixedline = $prevrawline;
4051 my $trailing = $rawline;
4052 $trailing =~ s/^\+//;
4053 $trailing = trim($trailing);
4054 $fixedline =~ s/}\s*$/} $trailing/;
4055 fix_insert_line($fixlinenr, $fixedline);
4056 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004057 }
4058 }
4059
Joe Perches95e2c602013-07-03 15:05:20 -07004060#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004061 while ($line =~ m{($Constant|$Lval)}g) {
4062 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004063
4064#gcc binary extension
4065 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004066 if (WARN("GCC_BINARY_CONSTANT",
4067 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4068 $fix) {
4069 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004070 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004071 s/\b$var\b/$hexval/;
4072 }
Joe Perches95e2c602013-07-03 15:05:20 -07004073 }
4074
4075#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004076 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004077 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004078#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004079 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004080#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004081 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4082#Ignore some three character SI units explicitly, like MiB and KHz
4083 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004084 while ($var =~ m{($Ident)}g) {
4085 my $word = $1;
4086 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004087 if ($check) {
4088 seed_camelcase_includes();
4089 if (!$file && !$camelcase_file_seeded) {
4090 seed_camelcase_file($realfile);
4091 $camelcase_file_seeded = 1;
4092 }
4093 }
Joe Perches7e781f62013-09-11 14:23:55 -07004094 if (!defined $camelcase{$word}) {
4095 $camelcase{$word} = 1;
4096 CHK("CAMELCASE",
4097 "Avoid CamelCase: <$word>\n" . $herecurr);
4098 }
Joe Perches34456862013-07-03 15:05:34 -07004099 }
Joe Perches323c1262012-12-17 16:02:07 -08004100 }
4101 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004102
4103#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004104 if ($line =~ /\#\s*define.*\\\s+$/) {
4105 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4106 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4107 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004108 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004109 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004110 }
4111
Andy Whitcroft653d4872007-06-23 17:16:34 -07004112#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004113 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004114 my $file = "$1.h";
4115 my $checkfile = "include/linux/$file";
4116 if (-f "$root/$checkfile" &&
4117 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004118 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004119 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004120 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004121 CHK("ARCH_INCLUDE_LINUX",
4122 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004123 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004124 WARN("INCLUDE_LINUX",
4125 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004126 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004127 }
4128 }
4129
Andy Whitcroft653d4872007-06-23 17:16:34 -07004130# multi-statement macros should be enclosed in a do while loop, grab the
4131# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004132# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004133 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4134 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004135 my $ln = $linenr;
4136 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004137 my ($off, $dstat, $dcond, $rest);
4138 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004139 my $has_flow_statement = 0;
4140 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004141 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004142 ctx_statement_block($linenr, $realcnt, 0);
4143 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004144 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004145 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004146
Joe Perches08a28432014-10-13 15:51:55 -07004147 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
4148 $has_arg_concat = 1 if ($ctx =~ /\#\#/);
4149
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004150 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004151 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004152 $dstat =~ s/\\\n.//g;
4153 $dstat =~ s/^\s*//s;
4154 $dstat =~ s/\s*$//s;
4155
4156 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004157 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4158 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004159 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004160 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004161 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004162
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004163 # Flatten any obvious string concatentation.
4164 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4165 $dstat =~ s/$Ident\s*("X*")/$1/)
4166 {
4167 }
4168
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004169 my $exceptions = qr{
4170 $Declare|
4171 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004172 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004173 DECLARE_PER_CPU|
4174 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004175 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004176 union|
4177 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004178 \.$Ident\s*=\s*|
4179 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004180 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004181 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004182 if ($dstat ne '' &&
4183 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4184 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004185 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004186 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004187 $dstat !~ /$exceptions/ &&
4188 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004189 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004190 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004191 $dstat !~ /^for\s*$Constant$/ && # for (...)
4192 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4193 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004194 $dstat !~ /^\({/ && # ({...
4195 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004196 {
4197 $ctx =~ s/\n*$//;
4198 my $herectx = $here . "\n";
4199 my $cnt = statement_rawlines($ctx);
4200
4201 for (my $n = 0; $n < $cnt; $n++) {
4202 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004203 }
4204
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004205 if ($dstat =~ /;/) {
4206 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4207 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4208 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004209 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004210 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004211 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004212 }
Joe Perches5023d342012-12-17 16:01:47 -08004213
Joe Perches08a28432014-10-13 15:51:55 -07004214# check for macros with flow control, but without ## concatenation
4215# ## concatenation is commonly a macro that defines a function so ignore those
4216 if ($has_flow_statement && !$has_arg_concat) {
4217 my $herectx = $here . "\n";
4218 my $cnt = statement_rawlines($ctx);
4219
4220 for (my $n = 0; $n < $cnt; $n++) {
4221 $herectx .= raw_line($linenr, $n) . "\n";
4222 }
4223 WARN("MACRO_WITH_FLOW_CONTROL",
4224 "Macros with flow control statements should be avoided\n" . "$herectx");
4225 }
4226
Joe Perches481eb482012-12-17 16:01:56 -08004227# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004228
4229 } else {
4230 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004231 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4232 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004233 $line =~ /^\+.*\\$/) {
4234 WARN("LINE_CONTINUATIONS",
4235 "Avoid unnecessary line continuations\n" . $herecurr);
4236 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004237 }
4238
Joe Perchesb13edf72012-07-30 14:41:24 -07004239# do {} while (0) macro tests:
4240# single-statement macros do not need to be enclosed in do while (0) loop,
4241# macro should not end with a semicolon
4242 if ($^V && $^V ge 5.10.0 &&
4243 $realfile !~ m@/vmlinux.lds.h$@ &&
4244 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4245 my $ln = $linenr;
4246 my $cnt = $realcnt;
4247 my ($off, $dstat, $dcond, $rest);
4248 my $ctx = '';
4249 ($dstat, $dcond, $ln, $cnt, $off) =
4250 ctx_statement_block($linenr, $realcnt, 0);
4251 $ctx = $dstat;
4252
4253 $dstat =~ s/\\\n.//g;
4254
4255 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4256 my $stmts = $2;
4257 my $semis = $3;
4258
4259 $ctx =~ s/\n*$//;
4260 my $cnt = statement_rawlines($ctx);
4261 my $herectx = $here . "\n";
4262
4263 for (my $n = 0; $n < $cnt; $n++) {
4264 $herectx .= raw_line($linenr, $n) . "\n";
4265 }
4266
Joe Perchesac8e97f2012-08-21 16:15:53 -07004267 if (($stmts =~ tr/;/;/) == 1 &&
4268 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004269 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4270 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4271 }
4272 if (defined $semis && $semis ne "") {
4273 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4274 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4275 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004276 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4277 $ctx =~ s/\n*$//;
4278 my $cnt = statement_rawlines($ctx);
4279 my $herectx = $here . "\n";
4280
4281 for (my $n = 0; $n < $cnt; $n++) {
4282 $herectx .= raw_line($linenr, $n) . "\n";
4283 }
4284
4285 WARN("TRAILING_SEMICOLON",
4286 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004287 }
4288 }
4289
Mike Frysinger080ba922009-01-06 14:41:25 -08004290# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4291# all assignments may have only one of the following with an assignment:
4292# .
4293# ALIGN(...)
4294# VMLINUX_SYMBOL(...)
4295 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004296 WARN("MISSING_VMLINUX_SYMBOL",
4297 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004298 }
4299
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004300# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004301 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4302 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004303 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004304 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004305 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4306 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004307 my @allowed = ();
4308 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004309 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004310 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004311 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004312 for my $chunk (@chunks) {
4313 my ($cond, $block) = @{$chunk};
4314
Andy Whitcroft773647a2008-03-28 14:15:58 -07004315 # If the condition carries leading newlines, then count those as offsets.
4316 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4317 my $offset = statement_rawlines($whitespace) - 1;
4318
Joe Perchesaad4f612012-03-23 15:02:19 -07004319 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004320 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4321
4322 # We have looked at and allowed this specific line.
4323 $suppress_ifbraces{$ln + $offset} = 1;
4324
4325 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004326 $ln += statement_rawlines($block) - 1;
4327
Andy Whitcroft773647a2008-03-28 14:15:58 -07004328 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004329
4330 $seen++ if ($block =~ /^\s*{/);
4331
Joe Perchesaad4f612012-03-23 15:02:19 -07004332 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004333 if (statement_lines($cond) > 1) {
4334 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004335 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004336 }
4337 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004338 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004339 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004340 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004341 if (statement_block_size($block) > 1) {
4342 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004343 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004344 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004345 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004346 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004347 if ($seen) {
4348 my $sum_allowed = 0;
4349 foreach (@allowed) {
4350 $sum_allowed += $_;
4351 }
4352 if ($sum_allowed == 0) {
4353 WARN("BRACES",
4354 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4355 } elsif ($sum_allowed != $allow &&
4356 $seen != $allow) {
4357 CHK("BRACES",
4358 "braces {} should be used on all arms of this statement\n" . $herectx);
4359 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004360 }
4361 }
4362 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004363 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004364 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004365 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004366
Andy Whitcroftcf655042008-03-04 14:28:20 -08004367 # Check the pre-context.
4368 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4369 #print "APW: ALLOWED: pre<$1>\n";
4370 $allowed = 1;
4371 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004372
4373 my ($level, $endln, @chunks) =
4374 ctx_statement_full($linenr, $realcnt, $-[0]);
4375
Andy Whitcroftcf655042008-03-04 14:28:20 -08004376 # Check the condition.
4377 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004378 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004379 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004380 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004381 }
4382 if (statement_lines($cond) > 1) {
4383 #print "APW: ALLOWED: cond<$cond>\n";
4384 $allowed = 1;
4385 }
4386 if ($block =~/\b(?:if|for|while)\b/) {
4387 #print "APW: ALLOWED: block<$block>\n";
4388 $allowed = 1;
4389 }
4390 if (statement_block_size($block) > 1) {
4391 #print "APW: ALLOWED: lines block<$block>\n";
4392 $allowed = 1;
4393 }
4394 # Check the post-context.
4395 if (defined $chunks[1]) {
4396 my ($cond, $block) = @{$chunks[1]};
4397 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004398 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004399 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004400 if ($block =~ /^\s*\{/) {
4401 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4402 $allowed = 1;
4403 }
4404 }
4405 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004406 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004407 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004408
Andy Whitcroftf0556632008-10-15 22:02:23 -07004409 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004410 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004411 }
4412
Joe Perches000d1cc12011-07-25 17:13:25 -07004413 WARN("BRACES",
4414 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004415 }
4416 }
4417
Joe Perches0979ae62012-12-17 16:01:59 -08004418# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004419 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004420 CHK("BRACES",
4421 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4422 }
Joe Perches77b9a532013-07-03 15:05:29 -07004423 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004424 CHK("BRACES",
4425 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4426 }
4427
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004428# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004429 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4430 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004431 WARN("VOLATILE",
4432 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004433 }
4434
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004435# Check for user-visible strings broken across lines, which breaks the ability
4436# to grep for the string. Make exceptions when the previous string ends in a
4437# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4438# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4439 if ($line =~ /^\+\s*"[X\t]*"/ &&
4440 $prevline =~ /"\s*$/ &&
4441 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4442 if (WARN("SPLIT_STRING",
4443 "quoted string split across lines\n" . $hereprev) &&
4444 $fix &&
4445 $prevrawline =~ /^\+.*"\s*$/ &&
4446 $last_coalesced_string_linenr != $linenr - 1) {
4447 my $extracted_string = get_quoted_string($line, $rawline);
4448 my $comma_close = "";
4449 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4450 $comma_close = $1;
4451 }
4452
4453 fix_delete_line($fixlinenr - 1, $prevrawline);
4454 fix_delete_line($fixlinenr, $rawline);
4455 my $fixedline = $prevrawline;
4456 $fixedline =~ s/"\s*$//;
4457 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4458 fix_insert_line($fixlinenr - 1, $fixedline);
4459 $fixedline = $rawline;
4460 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4461 if ($fixedline !~ /\+\s*$/) {
4462 fix_insert_line($fixlinenr, $fixedline);
4463 }
4464 $last_coalesced_string_linenr = $linenr;
4465 }
4466 }
4467
4468# check for missing a space in a string concatenation
4469 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4470 WARN('MISSING_SPACE',
4471 "break quoted strings at a space character\n" . $hereprev);
4472 }
4473
4474# check for spaces before a quoted newline
4475 if ($rawline =~ /^.*\".*\s\\n/) {
4476 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
4477 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
4478 $fix) {
4479 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
4480 }
4481
4482 }
4483
Joe Perchesf17dba42014-10-13 15:51:51 -07004484# concatenated string without spaces between elements
4485 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4486 CHK("CONCATENATED_STRING",
4487 "Concatenated strings should use spaces between elements\n" . $herecurr);
4488 }
4489
Joe Perches90ad30e2014-12-10 15:51:59 -08004490# uncoalesced string fragments
4491 if ($line =~ /"X*"\s*"/) {
4492 WARN("STRING_FRAGMENTS",
4493 "Consecutive strings are generally better as a single string\n" . $herecurr);
4494 }
4495
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004496# check for %L{u,d,i} in strings
4497 my $string;
4498 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4499 $string = substr($rawline, $-[1], $+[1] - $-[1]);
4500 $string =~ s/%%/__/g;
4501 if ($string =~ /(?<!%)%L[udi]/) {
4502 WARN("PRINTF_L",
4503 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
4504 last;
4505 }
4506 }
4507
4508# check for line continuations in quoted strings with odd counts of "
4509 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
4510 WARN("LINE_CONTINUATIONS",
4511 "Avoid line continuations in quoted strings\n" . $herecurr);
4512 }
4513
Andy Whitcroft00df3442007-06-08 13:47:06 -07004514# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004515 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004516 CHK("REDUNDANT_CODE",
4517 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004518 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004519 }
4520
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004521# check for needless "if (<foo>) fn(<foo>)" uses
4522 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4523 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4524 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4525 WARN('NEEDLESS_IF',
Fabio Estevam15160f92014-12-10 15:51:40 -08004526 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004527 }
4528 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004529
Joe Perchesebfdc402014-08-06 16:10:27 -07004530# check for unnecessary "Out of Memory" messages
4531 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4532 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4533 (defined $1 || defined $3) &&
4534 $linenr > 3) {
4535 my $testval = $2;
4536 my $testline = $lines[$linenr - 3];
4537
4538 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4539# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4540
4541 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4542 WARN("OOM_MESSAGE",
4543 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4544 }
4545 }
4546
Joe Perchesf78d98f2014-10-13 15:52:01 -07004547# check for logging functions with KERN_<LEVEL>
4548 if ($line !~ /printk\s*\(/ &&
4549 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4550 my $level = $1;
4551 if (WARN("UNNECESSARY_KERN_LEVEL",
4552 "Possible unnecessary $level\n" . $herecurr) &&
4553 $fix) {
4554 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4555 }
4556 }
4557
Joe Perchesabb08a52014-12-10 15:51:46 -08004558# check for mask then right shift without a parentheses
4559 if ($^V && $^V ge 5.10.0 &&
4560 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
4561 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
4562 WARN("MASK_THEN_SHIFT",
4563 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
4564 }
4565
Joe Perchesb75ac612014-12-10 15:52:02 -08004566# check for pointer comparisons to NULL
4567 if ($^V && $^V ge 5.10.0) {
4568 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
4569 my $val = $1;
4570 my $equal = "!";
4571 $equal = "" if ($4 eq "!=");
4572 if (CHK("COMPARISON_TO_NULL",
4573 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
4574 $fix) {
4575 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
4576 }
4577 }
4578 }
4579
Joe Perches8716de32013-09-11 14:24:05 -07004580# check for bad placement of section $InitAttribute (e.g.: __initdata)
4581 if ($line =~ /(\b$InitAttribute\b)/) {
4582 my $attr = $1;
4583 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4584 my $ptr = $1;
4585 my $var = $2;
4586 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4587 ERROR("MISPLACED_INIT",
4588 "$attr should be placed after $var\n" . $herecurr)) ||
4589 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4590 WARN("MISPLACED_INIT",
4591 "$attr should be placed after $var\n" . $herecurr))) &&
4592 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004593 $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 -07004594 }
4595 }
4596 }
4597
Joe Perchese970b882013-11-12 15:10:10 -08004598# check for $InitAttributeData (ie: __initdata) with const
4599 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4600 my $attr = $1;
4601 $attr =~ /($InitAttributePrefix)(.*)/;
4602 my $attr_prefix = $1;
4603 my $attr_type = $2;
4604 if (ERROR("INIT_ATTRIBUTE",
4605 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4606 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004607 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004608 s/$InitAttributeData/${attr_prefix}initconst/;
4609 }
4610 }
4611
4612# check for $InitAttributeConst (ie: __initconst) without const
4613 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4614 my $attr = $1;
4615 if (ERROR("INIT_ATTRIBUTE",
4616 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4617 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004618 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004619 /(^\+\s*(?:static\s+))/;
4620 $lead = rtrim($1);
4621 $lead = "$lead " if ($lead !~ /^\+$/);
4622 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004623 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08004624 }
4625 }
4626
Joe Perchesfbdb8132014-04-03 14:49:14 -07004627# don't use __constant_<foo> functions outside of include/uapi/
4628 if ($realfile !~ m@^include/uapi/@ &&
4629 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4630 my $constant_func = $1;
4631 my $func = $constant_func;
4632 $func =~ s/^__constant_//;
4633 if (WARN("CONSTANT_CONVERSION",
4634 "$constant_func should be $func\n" . $herecurr) &&
4635 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004636 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004637 }
4638 }
4639
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004640# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004641 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004642 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004643 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004644 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004645 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004646 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4647 }
4648 if ($delay > 2000) {
4649 WARN("LONG_UDELAY",
4650 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004651 }
4652 }
4653
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004654# warn about unexpectedly long msleep's
4655 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4656 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004657 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004658 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004659 }
4660 }
4661
Joe Perches36ec1932013-07-03 15:05:25 -07004662# check for comparisons of jiffies
4663 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4664 WARN("JIFFIES_COMPARISON",
4665 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4666 }
4667
Joe Perches9d7a34a2013-07-03 15:05:26 -07004668# check for comparisons of get_jiffies_64()
4669 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4670 WARN("JIFFIES_COMPARISON",
4671 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4672 }
4673
Andy Whitcroft00df3442007-06-08 13:47:06 -07004674# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004675# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004676# print "#ifdef in C files should be avoided\n";
4677# print "$herecurr";
4678# $clean = 0;
4679# }
4680
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004681# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004682 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004683 if (ERROR("SPACING",
4684 "exactly one space required after that #$1\n" . $herecurr) &&
4685 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004686 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004687 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4688 }
4689
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004690 }
4691
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004692# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004693 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4694 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004695 my $which = $1;
4696 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004697 CHK("UNCOMMENTED_DEFINITION",
4698 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004699 }
4700 }
4701# check for memory barriers without a comment.
4702 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4703 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004704 WARN("MEMORY_BARRIER",
4705 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004706 }
4707 }
4708# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004709 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004710 CHK("ARCH_DEFINES",
4711 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004712 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004713
Tobias Klauserd4977c72010-05-24 14:33:30 -07004714# Check that the storage class is at the beginning of a declaration
4715 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004716 WARN("STORAGE_CLASS",
4717 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004718 }
4719
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004720# check the location of the inline attribute, that it is between
4721# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004722 if ($line =~ /\b$Type\s+$Inline\b/ ||
4723 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004724 ERROR("INLINE_LOCATION",
4725 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004726 }
4727
Andy Whitcroft8905a672007-11-28 16:21:06 -08004728# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004729 if ($realfile !~ m@\binclude/uapi/@ &&
4730 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004731 if (WARN("INLINE",
4732 "plain inline is preferred over $1\n" . $herecurr) &&
4733 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004734 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004735
4736 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004737 }
4738
Joe Perches3d130fd2011-01-12 17:00:00 -08004739# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004740 if ($realfile !~ m@\binclude/uapi/@ &&
4741 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004742 WARN("PREFER_PACKED",
4743 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004744 }
4745
Joe Perches39b7e282011-07-25 17:13:24 -07004746# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004747 if ($realfile !~ m@\binclude/uapi/@ &&
4748 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004749 WARN("PREFER_ALIGNED",
4750 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004751 }
4752
Joe Perches5f14d3b2012-01-10 15:09:52 -08004753# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004754 if ($realfile !~ m@\binclude/uapi/@ &&
4755 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004756 if (WARN("PREFER_PRINTF",
4757 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4758 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004759 $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 -07004760
4761 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004762 }
4763
Joe Perches6061d942012-03-23 15:02:16 -07004764# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004765 if ($realfile !~ m@\binclude/uapi/@ &&
4766 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004767 if (WARN("PREFER_SCANF",
4768 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4769 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004770 $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 -07004771 }
Joe Perches6061d942012-03-23 15:02:16 -07004772 }
4773
Joe Perches619a9082014-12-10 15:51:35 -08004774# Check for __attribute__ weak, or __weak declarations (may have link issues)
4775 if ($^V && $^V ge 5.10.0 &&
4776 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4777 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4778 $line =~ /\b__weak\b/)) {
4779 ERROR("WEAK_DECLARATION",
4780 "Using weak declarations can have unintended link defects\n" . $herecurr);
4781 }
4782
Joe Perches8f53a9b2010-03-05 13:43:48 -08004783# check for sizeof(&)
4784 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004785 WARN("SIZEOF_ADDRESS",
4786 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004787 }
4788
Joe Perches66c80b62012-07-30 14:41:22 -07004789# check for sizeof without parenthesis
4790 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004791 if (WARN("SIZEOF_PARENTHESIS",
4792 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4793 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004794 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004795 }
Joe Perches66c80b62012-07-30 14:41:22 -07004796 }
4797
Joe Perches88982fe2012-12-17 16:02:00 -08004798# check for struct spinlock declarations
4799 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4800 WARN("USE_SPINLOCK_T",
4801 "struct spinlock should be spinlock_t\n" . $herecurr);
4802 }
4803
Joe Perchesa6962d72013-04-29 16:18:13 -07004804# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004805 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004806 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004807 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004808 if (WARN("PREFER_SEQ_PUTS",
4809 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4810 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004811 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004812 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004813 }
4814 }
4815
Andy Whitcroft554e1652012-01-10 15:09:57 -08004816# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004817 if ($^V && $^V ge 5.10.0 &&
4818 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004819 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004820
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004821 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004822 my $ms_val = $7;
4823 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004824
Andy Whitcroft554e1652012-01-10 15:09:57 -08004825 if ($ms_size =~ /^(0x|)0$/i) {
4826 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004827 "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 -08004828 } elsif ($ms_size =~ /^(0x|)1$/i) {
4829 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004830 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4831 }
4832 }
4833
Joe Perches98a9bba2014-01-23 15:54:52 -08004834# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4835 if ($^V && $^V ge 5.10.0 &&
4836 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4837 if (WARN("PREFER_ETHER_ADDR_COPY",
4838 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4839 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004840 $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 -08004841 }
4842 }
4843
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004844# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004845 if ($^V && $^V ge 5.10.0 &&
4846 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004847 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004848 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004849 my $call = $1;
4850 my $cast1 = deparenthesize($2);
4851 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004852 my $cast2 = deparenthesize($7);
4853 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004854 my $cast;
4855
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004856 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004857 $cast = "$cast1 or $cast2";
4858 } elsif ($cast1 ne "") {
4859 $cast = $cast1;
4860 } else {
4861 $cast = $cast2;
4862 }
4863 WARN("MINMAX",
4864 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004865 }
4866 }
4867
Joe Perches4a273192012-07-30 14:41:20 -07004868# check usleep_range arguments
4869 if ($^V && $^V ge 5.10.0 &&
4870 defined $stat &&
4871 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4872 my $min = $1;
4873 my $max = $7;
4874 if ($min eq $max) {
4875 WARN("USLEEP_RANGE",
4876 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4877 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4878 $min > $max) {
4879 WARN("USLEEP_RANGE",
4880 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4881 }
4882 }
4883
Joe Perches823b7942013-11-12 15:10:15 -08004884# check for naked sscanf
4885 if ($^V && $^V ge 5.10.0 &&
4886 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004887 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004888 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4889 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4890 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4891 my $lc = $stat =~ tr@\n@@;
4892 $lc = $lc + $linenr;
4893 my $stat_real = raw_line($linenr, 0);
4894 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4895 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4896 }
4897 WARN("NAKED_SSCANF",
4898 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4899 }
4900
Joe Perchesafc819a2014-06-04 16:12:08 -07004901# check for simple sscanf that should be kstrto<foo>
4902 if ($^V && $^V ge 5.10.0 &&
4903 defined $stat &&
4904 $line =~ /\bsscanf\b/) {
4905 my $lc = $stat =~ tr@\n@@;
4906 $lc = $lc + $linenr;
4907 my $stat_real = raw_line($linenr, 0);
4908 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4909 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4910 }
4911 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4912 my $format = $6;
4913 my $count = $format =~ tr@%@%@;
4914 if ($count == 1 &&
4915 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4916 WARN("SSCANF_TO_KSTRTO",
4917 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4918 }
4919 }
4920 }
4921
Joe Perches70dc8a42013-09-11 14:23:58 -07004922# check for new externs in .h files.
4923 if ($realfile =~ /\.h$/ &&
4924 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004925 if (CHK("AVOID_EXTERNS",
4926 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004927 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004928 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004929 }
4930 }
4931
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004932# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004933 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004934 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004935 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004936 my $function_name = $1;
4937 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004938
4939 my $s = $stat;
4940 if (defined $cond) {
4941 substr($s, 0, length($cond), '');
4942 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004943 if ($s =~ /^\s*;/ &&
4944 $function_name ne 'uninitialized_var')
4945 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004946 WARN("AVOID_EXTERNS",
4947 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004948 }
4949
4950 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004951 WARN("FUNCTION_ARGUMENTS",
4952 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004953 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004954
4955 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4956 $stat =~ /^.\s*extern\s+/)
4957 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004958 WARN("AVOID_EXTERNS",
4959 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004960 }
4961
4962# checks for new __setup's
4963 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4964 my $name = $1;
4965
4966 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004967 CHK("UNDOCUMENTED_SETUP",
4968 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004969 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004970 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004971
4972# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004973 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004974 WARN("UNNECESSARY_CASTS",
4975 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004976 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004977
Joe Perchesa640d252013-07-03 15:05:21 -07004978# alloc style
4979# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4980 if ($^V && $^V ge 5.10.0 &&
4981 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4982 CHK("ALLOC_SIZEOF_STRUCT",
4983 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4984 }
4985
Joe Perches60a55362014-06-04 16:12:07 -07004986# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4987 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004988 $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 -07004989 my $oldfunc = $3;
4990 my $a1 = $4;
4991 my $a2 = $10;
4992 my $newfunc = "kmalloc_array";
4993 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004994 my $r1 = $a1;
4995 my $r2 = $a2;
4996 if ($a1 =~ /^sizeof\s*\S/) {
4997 $r1 = $a2;
4998 $r2 = $a1;
4999 }
5000 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5001 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005002 if (WARN("ALLOC_WITH_MULTIPLY",
5003 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5004 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005005 $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 -07005006
5007 }
5008 }
5009 }
5010
Joe Perches972fdea2013-04-29 16:18:12 -07005011# check for krealloc arg reuse
5012 if ($^V && $^V ge 5.10.0 &&
5013 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5014 WARN("KREALLOC_ARG_REUSE",
5015 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5016 }
5017
Joe Perches5ce59ae2013-02-21 16:44:18 -08005018# check for alloc argument mismatch
5019 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5020 WARN("ALLOC_ARRAY_ARGS",
5021 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5022 }
5023
Joe Perchescaf2a542011-01-12 16:59:56 -08005024# check for multiple semicolons
5025 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005026 if (WARN("ONE_SEMICOLON",
5027 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5028 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005029 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005030 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005031 }
5032
Joe Perches0ab90192014-12-10 15:51:57 -08005033# check for #defines like: 1 << <digit> that could be BIT(digit)
5034 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5035 my $ull = "";
5036 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5037 if (CHK("BIT_MACRO",
5038 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5039 $fix) {
5040 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5041 }
5042 }
5043
Joe Perchese81f2392014-08-06 16:11:25 -07005044# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005045 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5046 my $has_break = 0;
5047 my $has_statement = 0;
5048 my $count = 0;
5049 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005050 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005051 $prevline--;
5052 my $rline = $rawlines[$prevline - 1];
5053 my $fline = $lines[$prevline - 1];
5054 last if ($fline =~ /^\@\@/);
5055 next if ($fline =~ /^\-/);
5056 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5057 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5058 next if ($fline =~ /^.[\s$;]*$/);
5059 $has_statement = 1;
5060 $count++;
5061 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5062 }
5063 if (!$has_break && $has_statement) {
5064 WARN("MISSING_BREAK",
5065 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5066 }
5067 }
5068
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005069# check for switch/default statements without a break;
5070 if ($^V && $^V ge 5.10.0 &&
5071 defined $stat &&
5072 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5073 my $ctx = '';
5074 my $herectx = $here . "\n";
5075 my $cnt = statement_rawlines($stat);
5076 for (my $n = 0; $n < $cnt; $n++) {
5077 $herectx .= raw_line($linenr, $n) . "\n";
5078 }
5079 WARN("DEFAULT_NO_BREAK",
5080 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005081 }
5082
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005083# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005084 if ($line =~ /\b__FUNCTION__\b/) {
5085 if (WARN("USE_FUNC",
5086 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5087 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005088 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005089 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005090 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005091
Joe Perches2c924882012-03-23 15:02:20 -07005092# check for use of yield()
5093 if ($line =~ /\byield\s*\(\s*\)/) {
5094 WARN("YIELD",
5095 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5096 }
5097
Joe Perches179f8f42013-07-03 15:05:30 -07005098# check for comparisons against true and false
5099 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5100 my $lead = $1;
5101 my $arg = $2;
5102 my $test = $3;
5103 my $otype = $4;
5104 my $trail = $5;
5105 my $op = "!";
5106
5107 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5108
5109 my $type = lc($otype);
5110 if ($type =~ /^(?:true|false)$/) {
5111 if (("$test" eq "==" && "$type" eq "true") ||
5112 ("$test" eq "!=" && "$type" eq "false")) {
5113 $op = "";
5114 }
5115
5116 CHK("BOOL_COMPARISON",
5117 "Using comparison to $otype is error prone\n" . $herecurr);
5118
5119## maybe suggesting a correct construct would better
5120## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5121
5122 }
5123 }
5124
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005125# check for semaphores initialized locked
5126 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005127 WARN("CONSIDER_COMPLETION",
5128 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005129 }
Joe Perches6712d852012-03-23 15:02:20 -07005130
Joe Perches67d0a072011-10-31 17:13:10 -07005131# recommend kstrto* over simple_strto* and strict_strto*
5132 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005133 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005134 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005135 }
Joe Perches6712d852012-03-23 15:02:20 -07005136
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005137# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005138 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005139 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005140 "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 -07005141 }
Joe Perches6712d852012-03-23 15:02:20 -07005142
Emese Revfy79404842010-03-05 13:43:53 -08005143# check for various ops structs, ensure they are const.
5144 my $struct_ops = qr{acpi_dock_ops|
5145 address_space_operations|
5146 backlight_ops|
5147 block_device_operations|
5148 dentry_operations|
5149 dev_pm_ops|
5150 dma_map_ops|
5151 extent_io_ops|
5152 file_lock_operations|
5153 file_operations|
5154 hv_ops|
5155 ide_dma_ops|
5156 intel_dvo_dev_ops|
5157 item_operations|
5158 iwl_ops|
5159 kgdb_arch|
5160 kgdb_io|
5161 kset_uevent_ops|
5162 lock_manager_operations|
5163 microcode_ops|
5164 mtrr_ops|
5165 neigh_ops|
5166 nlmsvc_binding|
5167 pci_raw_ops|
5168 pipe_buf_operations|
5169 platform_hibernation_ops|
5170 platform_suspend_ops|
5171 proto_ops|
5172 rpc_pipe_ops|
5173 seq_operations|
5174 snd_ac97_build_ops|
5175 soc_pcmcia_socket_ops|
5176 stacktrace_ops|
5177 sysfs_ops|
5178 tty_operations|
5179 usb_mon_operations|
5180 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005181 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08005182 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005183 WARN("CONST_STRUCT",
5184 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005185 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005186 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005187
5188# use of NR_CPUS is usually wrong
5189# ignore definitions of NR_CPUS and usage to define arrays as likely right
5190 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005191 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5192 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005193 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5194 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5195 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005196 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005197 WARN("NR_CPUS",
5198 "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 -07005199 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005200
Joe Perches52ea8502013-11-12 15:10:09 -08005201# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5202 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5203 ERROR("DEFINE_ARCH_HAS",
5204 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5205 }
5206
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005207# whine mightly about in_atomic
5208 if ($line =~ /\bin_atomic\s*\(/) {
5209 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005210 ERROR("IN_ATOMIC",
5211 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005212 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005213 WARN("IN_ATOMIC",
5214 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005215 }
5216 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005217
5218# check for lockdep_set_novalidate_class
5219 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5220 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5221 if ($realfile !~ m@^kernel/lockdep@ &&
5222 $realfile !~ m@^include/linux/lockdep@ &&
5223 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005224 ERROR("LOCKDEP",
5225 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005226 }
5227 }
Dave Jones88f88312011-01-12 16:59:59 -08005228
5229 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5230 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005231 WARN("EXPORTED_WORLD_WRITABLE",
5232 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005233 }
Joe Perches24358802014-04-03 14:49:13 -07005234
Joe Perches515a2352014-04-03 14:49:24 -07005235# Mode permission misuses where it seems decimal should be octal
5236# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5237 if ($^V && $^V ge 5.10.0 &&
5238 $line =~ /$mode_perms_search/) {
5239 foreach my $entry (@mode_permission_funcs) {
5240 my $func = $entry->[0];
5241 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005242
Joe Perches515a2352014-04-03 14:49:24 -07005243 my $skip_args = "";
5244 if ($arg_pos > 1) {
5245 $arg_pos--;
5246 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5247 }
5248 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5249 if ($line =~ /$test/) {
5250 my $val = $1;
5251 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005252
Joe Perches515a2352014-04-03 14:49:24 -07005253 if ($val !~ /^0$/ &&
5254 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5255 length($val) ne 4)) {
5256 ERROR("NON_OCTAL_PERMISSIONS",
5257 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5258 }
Joe Perches24358802014-04-03 14:49:13 -07005259 }
5260 }
5261 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005262 }
5263
5264 # If we have no input at all, then there is nothing to report on
5265 # so just keep quiet.
5266 if ($#rawlines == -1) {
5267 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005268 }
5269
Andy Whitcroft8905a672007-11-28 16:21:06 -08005270 # In mailback mode only produce a report in the negative, for
5271 # things that appear to be patches.
5272 if ($mailback && ($clean == 1 || !$is_patch)) {
5273 exit(0);
5274 }
5275
5276 # This is not a patch, and we are are in 'no-patch' mode so
5277 # just keep quiet.
5278 if (!$chk_patch && !$is_patch) {
5279 exit(0);
5280 }
5281
5282 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005283 ERROR("NOT_UNIFIED_DIFF",
5284 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005285 }
5286 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005287 ERROR("MISSING_SIGN_OFF",
5288 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005289 }
5290
Andy Whitcroft8905a672007-11-28 16:21:06 -08005291 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005292 if ($summary && !($clean == 1 && $quiet == 1)) {
5293 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005294 print "total: $cnt_error errors, $cnt_warn warnings, " .
5295 (($check)? "$cnt_chk checks, " : "") .
5296 "$cnt_lines lines checked\n";
5297 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005298 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005299
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005300 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005301
5302 if ($^V lt 5.10.0) {
5303 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5304 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5305 }
5306
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005307 # If there were whitespace errors which cleanpatch can fix
5308 # then suggest that.
5309 if ($rpt_cleaners) {
5310 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5311 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005312 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005313 }
5314 }
5315
Joe Perches91bfe482013-09-11 14:23:59 -07005316 hash_show_words(\%use_type, "Used");
5317 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005318
Joe Perchesd752fcc2014-08-06 16:11:05 -07005319 if ($clean == 0 && $fix &&
5320 ("@rawlines" ne "@fixed" ||
5321 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005322 my $newfile = $filename;
5323 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005324 my $linecount = 0;
5325 my $f;
5326
Joe Perchesd752fcc2014-08-06 16:11:05 -07005327 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5328
Joe Perches3705ce52013-07-03 15:05:31 -07005329 open($f, '>', $newfile)
5330 or die "$P: Can't open $newfile for write\n";
5331 foreach my $fixed_line (@fixed) {
5332 $linecount++;
5333 if ($file) {
5334 if ($linecount > 3) {
5335 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005336 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005337 }
5338 } else {
5339 print $f $fixed_line . "\n";
5340 }
5341 }
5342 close($f);
5343
5344 if (!$quiet) {
5345 print << "EOM";
5346Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5347
5348Do _NOT_ trust the results written to this file.
5349Do _NOT_ submit these changes without inspecting them for correctness.
5350
5351This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5352No warranties, expressed or implied...
5353
5354EOM
5355 }
5356 }
5357
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005358 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005359 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005360 }
5361 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005362 print << "EOM";
5363$vname has style problems, please review.
5364
5365If any of these errors are false positives, please report
5366them to the maintainer, see CHECKPATCH in MAINTAINERS.
5367EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005368 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005369
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005370 return $clean;
5371}