blob: 853dc7f9f7516330da295e6fbd45749e935c56c2 [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
949 return "" if ($line !~ m/(\"[X]+\")/g);
950 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;
1850
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001851 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001852 our $cnt_lines = 0;
1853 our $cnt_error = 0;
1854 our $cnt_warn = 0;
1855 our $cnt_chk = 0;
1856
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001857 # Trace the real file/line as we go.
1858 my $realfile = '';
1859 my $realline = 0;
1860 my $realcnt = 0;
1861 my $here = '';
1862 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001863 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001864 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001865 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001866
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001867 my $prev_values = 'E';
1868
1869 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001870 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001871 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001872 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001873 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001874
Joe Perches7e51f192013-09-11 14:23:57 -07001875 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001876
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001877 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001878 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001879 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001880 my @setup_docs = ();
1881 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001882
Joe Perchesd8b07712013-11-12 15:10:06 -08001883 my $camelcase_file_seeded = 0;
1884
Andy Whitcroft773647a2008-03-28 14:15:58 -07001885 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001886 my $line;
1887 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001888 $linenr++;
1889 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001890
Joe Perches3705ce52013-07-03 15:05:31 -07001891 push(@fixed, $rawline) if ($fix);
1892
Andy Whitcroft773647a2008-03-28 14:15:58 -07001893 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001894 $setup_docs = 0;
1895 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1896 $setup_docs = 1;
1897 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001898 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001899 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001900 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1901 $realline=$1-1;
1902 if (defined $2) {
1903 $realcnt=$3+1;
1904 } else {
1905 $realcnt=1+1;
1906 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001907 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001908
1909 # Guestimate if this is a continuing comment. Run
1910 # the context looking for a comment "edge". If this
1911 # edge is a close comment then we must be in a comment
1912 # at context start.
1913 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001914 my $cnt = $realcnt;
1915 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1916 next if (defined $rawlines[$ln - 1] &&
1917 $rawlines[$ln - 1] =~ /^-/);
1918 $cnt--;
1919 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001920 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001921 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1922 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1923 ($edge) = $1;
1924 last;
1925 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001926 }
1927 if (defined $edge && $edge eq '*/') {
1928 $in_comment = 1;
1929 }
1930
1931 # Guestimate if this is a continuing comment. If this
1932 # is the start of a diff block and this line starts
1933 # ' *' then it is very likely a comment.
1934 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001935 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001936 {
1937 $in_comment = 1;
1938 }
1939
1940 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1941 sanitise_line_reset($in_comment);
1942
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001943 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001944 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001945 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001946 $line = sanitise_line($rawline);
1947 }
1948 push(@lines, $line);
1949
1950 if ($realcnt > 1) {
1951 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1952 } else {
1953 $realcnt = 0;
1954 }
1955
1956 #print "==>$rawline\n";
1957 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001958
1959 if ($setup_docs && $line =~ /^\+/) {
1960 push(@setup_docs, $line);
1961 }
1962 }
1963
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001964 $prefix = '';
1965
Andy Whitcroft773647a2008-03-28 14:15:58 -07001966 $realcnt = 0;
1967 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001968 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001969 foreach my $line (@lines) {
1970 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001971 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001972 my $sline = $line; #copy of $line
1973 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001974
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001975 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001976
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001977#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001978 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001979 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001980 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001981 $realline=$1-1;
1982 if (defined $2) {
1983 $realcnt=$3+1;
1984 } else {
1985 $realcnt=1+1;
1986 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001987 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001988 $prev_values = 'E';
1989
Andy Whitcroft773647a2008-03-28 14:15:58 -07001990 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001991 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001992 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001993 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001994 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001995
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001996# track the line number as we move through the hunk, note that
1997# new versions of GNU diff omit the leading space on completely
1998# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001999 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002000 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002001 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002002
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002003 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002004 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002005
2006 # Track the previous line.
2007 ($prevline, $stashline) = ($stashline, $line);
2008 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002009 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2010
Andy Whitcroft773647a2008-03-28 14:15:58 -07002011 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002012
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002013 } elsif ($realcnt == 1) {
2014 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002015 }
2016
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002017 my $hunk_line = ($realcnt != 0);
2018
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002019#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07002020 $prefix = "$filename:$realline: " if ($emacs && $file);
2021 $prefix = "$filename:$linenr: " if ($emacs && !$file);
2022
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002023 $here = "#$linenr: " if (!$file);
2024 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002025
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002026 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002027 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002028 if ($line =~ /^diff --git.*?(\S+)$/) {
2029 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002030 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002031 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002032 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002033 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002034 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002035 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002036 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002037
2038 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002039 if (!$file && $tree && $p1_prefix ne '' &&
2040 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002041 WARN("PATCH_PREFIX",
2042 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002043 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002044
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002045 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002046 ERROR("MODIFIED_INCLUDE_ASM",
2047 "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 -07002048 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002049 $found_file = 1;
2050 }
2051
2052 if ($found_file) {
2053 if ($realfile =~ m@^(drivers/net/|net/)@) {
2054 $check = 1;
2055 } else {
2056 $check = $check_orig;
2057 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002058 next;
2059 }
2060
Randy Dunlap389834b2007-06-08 13:47:03 -07002061 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002062
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002063 my $hereline = "$here\n$rawline\n";
2064 my $herecurr = "$here\n$rawline\n";
2065 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002066
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002067 $cnt_lines++ if ($realcnt != 0);
2068
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002069# Check for incorrect file permissions
2070 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2071 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002072 if ($realfile !~ m@scripts/@ &&
2073 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002074 ERROR("EXECUTE_PERMISSIONS",
2075 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002076 }
2077 }
2078
Joe Perches20112472011-07-25 17:13:23 -07002079# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002080 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002081 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002082 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002083 }
2084
2085# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002086 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002087 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002088 my $space_before = $1;
2089 my $sign_off = $2;
2090 my $space_after = $3;
2091 my $email = $4;
2092 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2093
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002094 if ($sign_off !~ /$signature_tags/) {
2095 WARN("BAD_SIGN_OFF",
2096 "Non-standard signature: $sign_off\n" . $herecurr);
2097 }
Joe Perches20112472011-07-25 17:13:23 -07002098 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002099 if (WARN("BAD_SIGN_OFF",
2100 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2101 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002102 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002103 "$ucfirst_sign_off $email";
2104 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002105 }
Joe Perches20112472011-07-25 17:13:23 -07002106 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002107 if (WARN("BAD_SIGN_OFF",
2108 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2109 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002110 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002111 "$ucfirst_sign_off $email";
2112 }
2113
Joe Perches20112472011-07-25 17:13:23 -07002114 }
2115 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002116 if (WARN("BAD_SIGN_OFF",
2117 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2118 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002119 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002120 "$ucfirst_sign_off $email";
2121 }
Joe Perches20112472011-07-25 17:13:23 -07002122 }
2123
2124 my ($email_name, $email_address, $comment) = parse_email($email);
2125 my $suggested_email = format_email(($email_name, $email_address));
2126 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002127 ERROR("BAD_SIGN_OFF",
2128 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002129 } else {
2130 my $dequoted = $suggested_email;
2131 $dequoted =~ s/^"//;
2132 $dequoted =~ s/" </ </;
2133 # Don't force email to have quotes
2134 # Allow just an angle bracketed address
2135 if ("$dequoted$comment" ne $email &&
2136 "<$email_address>$comment" ne $email &&
2137 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002138 WARN("BAD_SIGN_OFF",
2139 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002140 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002141 }
Joe Perches7e51f192013-09-11 14:23:57 -07002142
2143# Check for duplicate signatures
2144 my $sig_nospace = $line;
2145 $sig_nospace =~ s/\s//g;
2146 $sig_nospace = lc($sig_nospace);
2147 if (defined $signatures{$sig_nospace}) {
2148 WARN("BAD_SIGN_OFF",
2149 "Duplicate signature\n" . $herecurr);
2150 } else {
2151 $signatures{$sig_nospace} = 1;
2152 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002153 }
2154
Joe Perches9b3189e2014-06-04 16:12:10 -07002155# Check for old stable address
2156 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2157 ERROR("STABLE_ADDRESS",
2158 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2159 }
2160
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002161# Check for unwanted Gerrit info
2162 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2163 ERROR("GERRIT_CHANGE_ID",
2164 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2165 }
2166
Joe Perchesd311cd42014-08-06 16:10:57 -07002167# Check for improperly formed commit descriptions
2168 if ($in_commit_log &&
2169 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
Joe Perches66881732014-09-09 14:50:55 -07002170 !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ ||
2171 ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ &&
2172 defined $rawlines[$linenr] &&
2173 $rawlines[$linenr] =~ /^\s*\("/))) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002174 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2175 my $init_char = $1;
2176 my $orig_commit = lc($2);
2177 my $id = '01234567890ab';
2178 my $desc = 'commit description';
2179 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2180 ERROR("GIT_COMMIT_ID",
Joe Perches3f6316b2014-08-29 15:18:26 -07002181 "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 -07002182 }
2183
Joe Perches13f19372014-08-06 16:10:59 -07002184# Check for added, moved or deleted files
2185 if (!$reported_maintainer_file && !$in_commit_log &&
2186 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2187 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2188 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2189 (defined($1) || defined($2))))) {
2190 $reported_maintainer_file = 1;
2191 WARN("FILE_PATH_CHANGES",
2192 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2193 }
2194
Andy Whitcroft00df3442007-06-08 13:47:06 -07002195# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002196 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002197 ERROR("CORRUPTED_PATCH",
2198 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002199 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002200 }
2201
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002202# Check for absolute kernel paths.
2203 if ($tree) {
2204 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2205 my $file = $1;
2206
2207 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2208 check_absolute_file($1, $herecurr)) {
2209 #
2210 } else {
2211 check_absolute_file($file, $herecurr);
2212 }
2213 }
2214 }
2215
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002216# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2217 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002218 $rawline !~ m/^$UTF8*$/) {
2219 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2220
2221 my $blank = copy_spacing($rawline);
2222 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2223 my $hereptr = "$hereline$ptr\n";
2224
Joe Perches34d99212011-07-25 17:13:26 -07002225 CHK("INVALID_UTF8",
2226 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002227 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002228
Joe Perches15662b32011-10-31 17:13:12 -07002229# Check if it's the start of a commit log
2230# (not a header line and we haven't seen the patch filename)
2231 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002232 !($rawline =~ /^\s+\S/ ||
2233 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002234 $in_header_lines = 0;
2235 $in_commit_log = 1;
2236 }
2237
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002238# Check if there is UTF-8 in a commit log when a mail header has explicitly
2239# declined it, i.e defined some charset where it is missing.
2240 if ($in_header_lines &&
2241 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2242 $1 !~ /utf-8/i) {
2243 $non_utf8_charset = 1;
2244 }
2245
2246 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002247 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002248 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002249 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2250 }
2251
Kees Cook66b47b42014-10-13 15:51:57 -07002252# Check for various typo / spelling mistakes
Joe Perches36061e32014-12-10 15:51:43 -08002253 if (defined($misspellings) && ($in_commit_log || $line =~ /^\+/)) {
Kees Cook66b47b42014-10-13 15:51:57 -07002254 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:$|[^a-z@])/gi) {
2255 my $typo = $1;
2256 my $typo_fix = $spelling_fix{lc($typo)};
2257 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2258 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2259 my $msg_type = \&WARN;
2260 $msg_type = \&CHK if ($file);
2261 if (&{$msg_type}("TYPO_SPELLING",
2262 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2263 $fix) {
2264 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2265 }
2266 }
2267 }
2268
Andy Whitcroft306708542008-10-15 22:02:28 -07002269# ignore non-hunk lines and lines being removed
2270 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002271
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002272#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002273 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002274 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002275 if (ERROR("DOS_LINE_ENDINGS",
2276 "DOS line endings\n" . $herevet) &&
2277 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002278 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002279 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002280 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2281 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002282 if (ERROR("TRAILING_WHITESPACE",
2283 "trailing whitespace\n" . $herevet) &&
2284 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002285 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002286 }
2287
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002288 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002289 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002290
Josh Triplett4783f892013-11-12 15:10:12 -08002291# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002292 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002293 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2294 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002295 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2296 my $msg_type = \&ERROR;
2297 $msg_type = \&CHK if ($file);
2298 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002299 "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 -08002300 }
2301
Andi Kleen33549572010-05-24 14:33:29 -07002302# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002303# Only applies when adding the entry originally, after that we do not have
2304# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002305 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002306 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002307 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002308 my $cnt = $realcnt;
2309 my $ln = $linenr + 1;
2310 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002311 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002312 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002313 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002314 $f = $lines[$ln - 1];
2315 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2316 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002317
2318 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002319 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002320
Joe Perches8d73e0e2014-08-06 16:10:46 -07002321 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002322 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002323 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002324 $length = -1;
2325 }
2326
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002327 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002328 $f =~ s/#.*//;
2329 $f =~ s/^\s+//;
2330 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002331 if ($f =~ /^\s*config\s/) {
2332 $is_end = 1;
2333 last;
2334 }
Andi Kleen33549572010-05-24 14:33:29 -07002335 $length++;
2336 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002337 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2338 WARN("CONFIG_DESCRIPTION",
2339 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2340 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002341 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002342 }
2343
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002344# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2345 if ($realfile =~ /Kconfig/ &&
2346 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2347 WARN("CONFIG_EXPERIMENTAL",
2348 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2349 }
2350
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002351 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2352 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2353 my $flag = $1;
2354 my $replacement = {
2355 'EXTRA_AFLAGS' => 'asflags-y',
2356 'EXTRA_CFLAGS' => 'ccflags-y',
2357 'EXTRA_CPPFLAGS' => 'cppflags-y',
2358 'EXTRA_LDFLAGS' => 'ldflags-y',
2359 };
2360
2361 WARN("DEPRECATED_VARIABLE",
2362 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2363 }
2364
Rob Herringbff5da42014-01-23 15:54:51 -08002365# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002366 if (defined $root &&
2367 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2368 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2369
Rob Herringbff5da42014-01-23 15:54:51 -08002370 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2371
Florian Vaussardcc933192014-04-03 14:49:27 -07002372 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2373 my $vp_file = $dt_path . "vendor-prefixes.txt";
2374
Rob Herringbff5da42014-01-23 15:54:51 -08002375 foreach my $compat (@compats) {
2376 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002377 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2378 my $compat3 = $compat;
2379 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2380 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002381 if ( $? >> 8 ) {
2382 WARN("UNDOCUMENTED_DT_STRING",
2383 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2384 }
2385
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002386 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2387 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002388 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002389 if ( $? >> 8 ) {
2390 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002391 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002392 }
2393 }
2394 }
2395
Andy Whitcroft5368df22008-10-15 22:02:27 -07002396# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002397 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002398
Joe Perches6cd7f382012-12-17 16:01:54 -08002399#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002400 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002401 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002402 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002403 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002404 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002405 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002406 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002407 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002408 }
2409
Josh Triplettca56dc02012-03-23 15:02:21 -07002410# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002411# to grep for the string. Make exceptions when the previous string ends in a
2412# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2413# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002414 if ($line =~ /^\+\s*"/ &&
2415 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002416 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002417 WARN("SPLIT_STRING",
2418 "quoted string split across lines\n" . $hereprev);
2419 }
2420
Dan Carpenterece96592014-08-06 16:11:29 -07002421# check for missing a space in a string concatination
2422 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
2423 WARN('MISSING_SPACE',
2424 "break quoted strings at a space character\n" . $hereprev);
2425 }
2426
Joe Perches5e79d962010-03-05 13:43:55 -08002427# check for spaces before a quoted newline
2428 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002429 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2430 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2431 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002432 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
Joe Perches3705ce52013-07-03 15:05:31 -07002433 }
2434
Joe Perches5e79d962010-03-05 13:43:55 -08002435 }
2436
Andy Whitcroft8905a672007-11-28 16:21:06 -08002437# check for adding lines without a newline.
2438 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002439 WARN("MISSING_EOF_NEWLINE",
2440 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002441 }
2442
Mike Frysinger42e41c52009-09-21 17:04:40 -07002443# Blackfin: use hi/lo macros
2444 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2445 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2446 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002447 ERROR("LO_MACRO",
2448 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002449 }
2450 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2451 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002452 ERROR("HI_MACRO",
2453 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002454 }
2455 }
2456
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002457# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002458 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002459
2460# at the beginning of a line any tabs must come first and anything
2461# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002462 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2463 $rawline =~ /^\+\s* \s*/) {
2464 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002465 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002466 if (ERROR("CODE_INDENT",
2467 "code indent should use tabs where possible\n" . $herevet) &&
2468 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002469 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002470 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002471 }
2472
Alberto Panizzo08e44362010-03-05 13:43:54 -08002473# check for space before tabs.
2474 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2475 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002476 if (WARN("SPACE_BEFORE_TAB",
2477 "please, no space before tabs\n" . $herevet) &&
2478 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002479 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002480 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002481 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002482 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002483 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002484 }
2485
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002486# check for && or || at the start of a line
2487 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2488 CHK("LOGICAL_CONTINUATIONS",
2489 "Logical continuations should be on the previous line\n" . $hereprev);
2490 }
2491
2492# check multi-line statement indentation matches previous line
2493 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002494 $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 -07002495 $prevline =~ /^\+(\t*)(.*)$/;
2496 my $oldindent = $1;
2497 my $rest = $2;
2498
2499 my $pos = pos_last_openparen($rest);
2500 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002501 $line =~ /^(\+| )([ \t]*)/;
2502 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002503
2504 my $goodtabindent = $oldindent .
2505 "\t" x ($pos / 8) .
2506 " " x ($pos % 8);
2507 my $goodspaceindent = $oldindent . " " x $pos;
2508
2509 if ($newindent ne $goodtabindent &&
2510 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002511
2512 if (CHK("PARENTHESIS_ALIGNMENT",
2513 "Alignment should match open parenthesis\n" . $hereprev) &&
2514 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002515 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002516 s/^\+[ \t]*/\+$goodtabindent/;
2517 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002518 }
2519 }
2520 }
2521
Joe Perches04941aa2014-12-10 15:51:37 -08002522 if ($line =~ /^\+.*(\w+\s*)?\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|[,;\({\[\<\>])/ &&
2523 (!defined($1) || $1 !~ /sizeof\s*/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002524 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002525 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002526 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002527 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002528 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002529 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002530 }
2531
Joe Perches05880602012-10-04 17:13:35 -07002532 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002533 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002534 $rawline =~ /^\+[ \t]*\*/ &&
2535 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002536 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2537 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2538 }
2539
2540 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002541 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2542 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002543 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002544 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2545 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2546 "networking block comments start with * on subsequent lines\n" . $hereprev);
2547 }
2548
2549 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002550 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2551 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2552 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2553 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002554 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2555 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2556 }
2557
Joe Perches7f619192014-08-06 16:10:39 -07002558# check for missing blank lines after struct/union declarations
2559# with exceptions for various attributes and macros
2560 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2561 $line =~ /^\+/ &&
2562 !($line =~ /^\+\s*$/ ||
2563 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2564 $line =~ /^\+\s*MODULE_/i ||
2565 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2566 $line =~ /^\+[a-z_]*init/ ||
2567 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2568 $line =~ /^\+\s*DECLARE/ ||
2569 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002570 if (CHK("LINE_SPACING",
2571 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2572 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002573 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002574 }
Joe Perches7f619192014-08-06 16:10:39 -07002575 }
2576
Joe Perches365dd4e2014-08-06 16:10:42 -07002577# check for multiple consecutive blank lines
2578 if ($prevline =~ /^[\+ ]\s*$/ &&
2579 $line =~ /^\+\s*$/ &&
2580 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002581 if (CHK("LINE_SPACING",
2582 "Please don't use multiple blank lines\n" . $hereprev) &&
2583 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002584 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002585 }
2586
Joe Perches365dd4e2014-08-06 16:10:42 -07002587 $last_blank_line = $linenr;
2588 }
2589
Joe Perches3b617e32014-04-03 14:49:28 -07002590# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002591 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2592 # actual declarations
2593 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002594 # function pointer declarations
2595 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002596 # foo bar; where foo is some local typedef or #define
2597 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2598 # known declaration macros
2599 $prevline =~ /^\+\s+$declaration_macros/) &&
2600 # for "else if" which can look like "$Ident $Ident"
2601 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2602 # other possible extensions of declaration lines
2603 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2604 # not starting a section or a macro "\" extended line
2605 $prevline =~ /(?:\{\s*|\\)$/) &&
2606 # looks like a declaration
2607 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002608 # function pointer declarations
2609 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002610 # foo bar; where foo is some local typedef or #define
2611 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2612 # known declaration macros
2613 $sline =~ /^\+\s+$declaration_macros/ ||
2614 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002615 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002616 # start or end of block or continuation of declaration
2617 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2618 # bitfield continuation
2619 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2620 # other possible extensions of declaration lines
2621 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2622 # indentation of previous and current line are the same
2623 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002624 if (WARN("LINE_SPACING",
2625 "Missing a blank line after declarations\n" . $hereprev) &&
2626 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002627 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002628 }
Joe Perches3b617e32014-04-03 14:49:28 -07002629 }
2630
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002631# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002632# Exceptions:
2633# 1) within comments
2634# 2) indented preprocessor commands
2635# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002636 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002637 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002638 if (WARN("LEADING_SPACE",
2639 "please, no spaces at the start of a line\n" . $herevet) &&
2640 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002641 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002642 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002643 }
2644
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002645# check we are in a valid C source file if not then ignore this hunk
2646 next if ($realfile !~ /\.(h|c)$/);
2647
Joe Perches032a4c02014-08-06 16:10:29 -07002648# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07002649# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07002650# if the previous line is a break or return and is indented 1 tab more...
2651 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2652 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07002653 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
2654 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
2655 defined $lines[$linenr] &&
2656 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07002657 WARN("UNNECESSARY_ELSE",
2658 "else is not generally useful after a break or return\n" . $hereprev);
2659 }
2660 }
2661
Joe Perchesc00df192014-08-06 16:11:01 -07002662# check indentation of a line with a break;
2663# if the previous line is a goto or return and is indented the same # of tabs
2664 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2665 my $tabs = $1;
2666 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2667 WARN("UNNECESSARY_BREAK",
2668 "break is not useful after a goto or return\n" . $hereprev);
2669 }
2670 }
2671
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002672# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2673 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2674 WARN("CONFIG_EXPERIMENTAL",
2675 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2676 }
2677
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002678# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002679 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002680 WARN("CVS_KEYWORD",
2681 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002682 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002683
Mike Frysinger42e41c52009-09-21 17:04:40 -07002684# Blackfin: don't use __builtin_bfin_[cs]sync
2685 if ($line =~ /__builtin_bfin_csync/) {
2686 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002687 ERROR("CSYNC",
2688 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002689 }
2690 if ($line =~ /__builtin_bfin_ssync/) {
2691 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002692 ERROR("SSYNC",
2693 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002694 }
2695
Joe Perches56e77d72013-02-21 16:44:14 -08002696# check for old HOTPLUG __dev<foo> section markings
2697 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2698 WARN("HOTPLUG_SECTION",
2699 "Using $1 is unnecessary\n" . $herecurr);
2700 }
2701
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002702# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002703 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2704 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002705#print "LINE<$line>\n";
2706 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002707 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002708 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002709 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002710 $stat =~ s/\n./\n /g;
2711 $cond =~ s/\n./\n /g;
2712
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002713#print "linenr<$linenr> <$stat>\n";
2714 # If this statement has no statement boundaries within
2715 # it there is no point in retrying a statement scan
2716 # until we hit end of it.
2717 my $frag = $stat; $frag =~ s/;+\s*$//;
2718 if ($frag !~ /(?:{|;)/) {
2719#print "skip<$line_nr_next>\n";
2720 $suppress_statement = $line_nr_next;
2721 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002722
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002723 # Find the real next line.
2724 $realline_next = $line_nr_next;
2725 if (defined $realline_next &&
2726 (!defined $lines[$realline_next - 1] ||
2727 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2728 $realline_next++;
2729 }
2730
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002731 my $s = $stat;
2732 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002733
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002734 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002735 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002736
2737 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002738 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002739
Andy Whitcroft463f2862009-09-21 17:04:34 -07002740 } elsif ($s =~ /^.\s*else\b/s) {
2741
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002742 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002743 } 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 -07002744 my $type = $1;
2745 $type =~ s/\s+/ /g;
2746 possible($type, "A:" . $s);
2747
Andy Whitcroft8905a672007-11-28 16:21:06 -08002748 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002749 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002750 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002751 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002752
2753 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002754 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002755 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002756 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002757
2758 # Check for any sort of function declaration.
2759 # int foo(something bar, other baz);
2760 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002761 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 -08002762 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002763
Andy Whitcroftcf655042008-03-04 14:28:20 -08002764 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002765 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002766 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002767
Andy Whitcroft8905a672007-11-28 16:21:06 -08002768 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002769 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002770
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002771 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002772 }
2773 }
2774 }
2775
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002776 }
2777
Andy Whitcroft653d4872007-06-23 17:16:34 -07002778#
2779# Checks which may be anchored in the context.
2780#
2781
2782# Check for switch () and associated case and default
2783# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002784 if ($line=~/\bswitch\s*\(.*\)/) {
2785 my $err = '';
2786 my $sep = '';
2787 my @ctx = ctx_block_outer($linenr, $realcnt);
2788 shift(@ctx);
2789 for my $ctx (@ctx) {
2790 my ($clen, $cindent) = line_stats($ctx);
2791 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2792 $indent != $cindent) {
2793 $err .= "$sep$ctx\n";
2794 $sep = '';
2795 } else {
2796 $sep = "[...]\n";
2797 }
2798 }
2799 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002800 ERROR("SWITCH_CASE_INDENT_LEVEL",
2801 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002802 }
2803 }
2804
2805# if/while/etc brace do not go on next line, unless defining a do while loop,
2806# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07002807 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 -07002808 my $pre_ctx = "$1$2";
2809
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002810 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002811
2812 if ($line =~ /^\+\t{6,}/) {
2813 WARN("DEEP_INDENTATION",
2814 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2815 }
2816
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002817 my $ctx_cnt = $realcnt - $#ctx - 1;
2818 my $ctx = join("\n", @ctx);
2819
Andy Whitcroft548596d2008-07-23 21:29:01 -07002820 my $ctx_ln = $linenr;
2821 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002822
Andy Whitcroft548596d2008-07-23 21:29:01 -07002823 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2824 defined $lines[$ctx_ln - 1] &&
2825 $lines[$ctx_ln - 1] =~ /^-/)) {
2826 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2827 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002828 $ctx_ln++;
2829 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002830
Andy Whitcroft53210162008-07-23 21:29:03 -07002831 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2832 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002833
Joe Perchesd752fcc2014-08-06 16:11:05 -07002834 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002835 ERROR("OPEN_BRACE",
2836 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002837 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002838 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002839 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2840 $ctx =~ /\)\s*\;\s*$/ &&
2841 defined $lines[$ctx_ln - 1])
2842 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002843 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2844 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002845 WARN("TRAILING_SEMICOLON",
2846 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002847 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002848 }
2849 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002850 }
2851
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002852# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07002853 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 -08002854 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2855 ctx_statement_block($linenr, $realcnt, 0)
2856 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002857 my ($s, $c) = ($stat, $cond);
2858
2859 substr($s, 0, length($c), '');
2860
2861 # Make sure we remove the line prefixes as we have
2862 # none on the first line, and are going to readd them
2863 # where necessary.
2864 $s =~ s/\n./\n/gs;
2865
2866 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002867 my @newlines = ($c =~ /\n/gs);
2868 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002869
2870 # We want to check the first line inside the block
2871 # starting at the end of the conditional, so remove:
2872 # 1) any blank line termination
2873 # 2) any opening brace { on end of the line
2874 # 3) any do (...) {
2875 my $continuation = 0;
2876 my $check = 0;
2877 $s =~ s/^.*\bdo\b//;
2878 $s =~ s/^\s*{//;
2879 if ($s =~ s/^\s*\\//) {
2880 $continuation = 1;
2881 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002882 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002883 $check = 1;
2884 $cond_lines++;
2885 }
2886
2887 # Also ignore a loop construct at the end of a
2888 # preprocessor statement.
2889 if (($prevline =~ /^.\s*#\s*define\s/ ||
2890 $prevline =~ /\\\s*$/) && $continuation == 0) {
2891 $check = 0;
2892 }
2893
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002894 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002895 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002896 while ($cond_ptr != $cond_lines) {
2897 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002898
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002899 # If we see an #else/#elif then the code
2900 # is not linear.
2901 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2902 $check = 0;
2903 }
2904
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002905 # Ignore:
2906 # 1) blank lines, they should be at 0,
2907 # 2) preprocessor lines, and
2908 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002909 if ($continuation ||
2910 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002911 $s =~ /^\s*#\s*?/ ||
2912 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002913 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002914 if ($s =~ s/^.*?\n//) {
2915 $cond_lines++;
2916 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002917 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002918 }
2919
2920 my (undef, $sindent) = line_stats("+" . $s);
2921 my $stat_real = raw_line($linenr, $cond_lines);
2922
2923 # Check if either of these lines are modified, else
2924 # this is not this patch's fault.
2925 if (!defined($stat_real) ||
2926 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2927 $check = 0;
2928 }
2929 if (defined($stat_real) && $cond_lines > 1) {
2930 $stat_real = "[...]\n$stat_real";
2931 }
2932
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002933 #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 -07002934
2935 if ($check && (($sindent % 8) != 0 ||
2936 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002937 WARN("SUSPECT_CODE_INDENT",
2938 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002939 }
2940 }
2941
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002942 # Track the 'values' across context and added lines.
2943 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002944 my ($curr_values, $curr_vars) =
2945 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002946 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002947 if ($dbg_values) {
2948 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002949 print "$linenr > .$outline\n";
2950 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002951 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002952 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002953 $prev_values = substr($curr_values, -1);
2954
Andy Whitcroft00df3442007-06-08 13:47:06 -07002955#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002956 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002957
Andy Whitcroft653d4872007-06-23 17:16:34 -07002958# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002959 if ($dbg_type) {
2960 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002961 ERROR("TEST_TYPE",
2962 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002963 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002964 ERROR("TEST_NOT_TYPE",
2965 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002966 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002967 next;
2968 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002969# TEST: allow direct testing of the attribute matcher.
2970 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002971 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002972 ERROR("TEST_ATTR",
2973 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002974 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002975 ERROR("TEST_NOT_ATTR",
2976 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002977 }
2978 next;
2979 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002980
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002981# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002982 if ($line =~ /^.\s*{/ &&
2983 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002984 if (ERROR("OPEN_BRACE",
2985 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002986 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2987 fix_delete_line($fixlinenr - 1, $prevrawline);
2988 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002989 my $fixedline = $prevrawline;
2990 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002991 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002992 $fixedline = $line;
2993 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002994 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002995 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002996 }
2997
Andy Whitcroft653d4872007-06-23 17:16:34 -07002998#
2999# Checks which are anchored on the added line.
3000#
3001
3002# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003003 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003004 my $path = $1;
3005 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003006 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003007 "malformed #include filename\n" . $herecurr);
3008 }
3009 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3010 ERROR("UAPI_INCLUDE",
3011 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003012 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003013 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003014
3015# no C99 // comments
3016 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003017 if (ERROR("C99_COMMENTS",
3018 "do not use C99 // comments\n" . $herecurr) &&
3019 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003020 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003021 if ($line =~ /\/\/(.*)$/) {
3022 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003023 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003024 }
3025 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003026 }
3027 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003028 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003029 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003030
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003031# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3032# the whole statement.
3033#print "APW <$lines[$realline_next - 1]>\n";
3034 if (defined $realline_next &&
3035 exists $lines[$realline_next - 1] &&
3036 !defined $suppress_export{$realline_next} &&
3037 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3038 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003039 # Handle definitions which produce identifiers with
3040 # a prefix:
3041 # XXX(foo);
3042 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003043 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003044 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003045 $name =~ /^${Ident}_$2/) {
3046#print "FOO C name<$name>\n";
3047 $suppress_export{$realline_next} = 1;
3048
3049 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003050 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003051 ^.DEFINE_$Ident\(\Q$name\E\)|
3052 ^.DECLARE_$Ident\(\Q$name\E\)|
3053 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003054 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3055 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003056 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003057#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3058 $suppress_export{$realline_next} = 2;
3059 } else {
3060 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003061 }
3062 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003063 if (!defined $suppress_export{$linenr} &&
3064 $prevline =~ /^.\s*$/ &&
3065 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3066 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3067#print "FOO B <$lines[$linenr - 1]>\n";
3068 $suppress_export{$linenr} = 2;
3069 }
3070 if (defined $suppress_export{$linenr} &&
3071 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003072 WARN("EXPORT_SYMBOL",
3073 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003074 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003075
Joe Eloff5150bda2010-08-09 17:21:00 -07003076# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003077 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3078 if (ERROR("GLOBAL_INITIALISERS",
3079 "do not initialise globals to 0 or NULL\n" .
3080 $herecurr) &&
3081 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003082 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003083 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003084 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003085# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003086 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3087 if (ERROR("INITIALISED_STATIC",
3088 "do not initialise statics to 0 or NULL\n" .
3089 $herecurr) &&
3090 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003091 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003092 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003093 }
3094
Joe Perches18130872014-08-06 16:11:22 -07003095# check for misordered declarations of char/short/int/long with signed/unsigned
3096 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3097 my $tmp = trim($1);
3098 WARN("MISORDERED_TYPE",
3099 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3100 }
3101
Joe Perchescb710ec2010-10-26 14:23:20 -07003102# check for static const char * arrays.
3103 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003104 WARN("STATIC_CONST_CHAR_ARRAY",
3105 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003106 $herecurr);
3107 }
3108
3109# check for static char foo[] = "bar" declarations.
3110 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003111 WARN("STATIC_CONST_CHAR_ARRAY",
3112 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003113 $herecurr);
3114 }
3115
Joe Perches9b0fa602014-04-03 14:49:18 -07003116# check for non-global char *foo[] = {"bar", ...} declarations.
3117 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3118 WARN("STATIC_CONST_CHAR_ARRAY",
3119 "char * array declaration might be better as static const\n" .
3120 $herecurr);
3121 }
3122
Joe Perchesb36190c2014-01-27 17:07:18 -08003123# check for function declarations without arguments like "int foo()"
3124 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3125 if (ERROR("FUNCTION_WITHOUT_ARGS",
3126 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3127 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003128 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003129 }
3130 }
3131
Joe Perches92e112f2013-12-13 11:36:22 -07003132# check for uses of DEFINE_PCI_DEVICE_TABLE
3133 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3134 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3135 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3136 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003137 $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 -07003138 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003139 }
3140
Andy Whitcroft653d4872007-06-23 17:16:34 -07003141# check for new typedefs, only function parameters and sparse annotations
3142# make sense.
3143 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003144 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003145 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003146 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003147 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003148 WARN("NEW_TYPEDEFS",
3149 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003150 }
3151
3152# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003153 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003154 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3155 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003156 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003157
Andy Whitcroft65863862009-01-06 14:41:21 -08003158 # Should start with a space.
3159 $to =~ s/^(\S)/ $1/;
3160 # Should not end with a space.
3161 $to =~ s/\s+$//;
3162 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003163 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003164 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003165
Joe Perches3705ce52013-07-03 15:05:31 -07003166## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003167 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003168 if (ERROR("POINTER_LOCATION",
3169 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3170 $fix) {
3171 my $sub_from = $ident;
3172 my $sub_to = $ident;
3173 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003174 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003175 s@\Q$sub_from\E@$sub_to@;
3176 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003177 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003178 }
3179 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3180 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003181 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003182
Andy Whitcroft65863862009-01-06 14:41:21 -08003183 # Should start with a space.
3184 $to =~ s/^(\S)/ $1/;
3185 # Should not end with a space.
3186 $to =~ s/\s+$//;
3187 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003188 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003189 }
3190 # Modifiers should have spaces.
3191 $to =~ s/(\b$Modifier$)/$1 /;
3192
Joe Perches3705ce52013-07-03 15:05:31 -07003193## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003194 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003195 if (ERROR("POINTER_LOCATION",
3196 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3197 $fix) {
3198
3199 my $sub_from = $match;
3200 my $sub_to = $match;
3201 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003202 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003203 s@\Q$sub_from\E@$sub_to@;
3204 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003205 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003206 }
3207
3208# # no BUG() or BUG_ON()
3209# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3210# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3211# print "$herecurr";
3212# $clean = 0;
3213# }
3214
Andy Whitcroft8905a672007-11-28 16:21:06 -08003215 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003216 WARN("LINUX_VERSION_CODE",
3217 "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 -08003218 }
3219
Joe Perches17441222011-06-15 15:08:17 -07003220# check for uses of printk_ratelimit
3221 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003222 WARN("PRINTK_RATELIMITED",
3223"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003224 }
3225
Andy Whitcroft00df3442007-06-08 13:47:06 -07003226# printk should use KERN_* levels. Note that follow on printk's on the
3227# same line do not need a level, so we use the current block context
3228# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003229# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003230# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003231 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003232 my $ok = 0;
3233 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3234 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003235 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003236 # with "\n" ignore it, else it is to blame
3237 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3238 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3239 $ok = 1;
3240 }
3241 last;
3242 }
3243 }
3244 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003245 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3246 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003247 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003248 }
3249
Joe Perches243f3802012-05-31 16:26:09 -07003250 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3251 my $orig = $1;
3252 my $level = lc($orig);
3253 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003254 my $level2 = $level;
3255 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003256 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003257 "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 -07003258 }
3259
3260 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003261 if (WARN("PREFER_PR_LEVEL",
3262 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3263 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003264 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003265 s/\bpr_warning\b/pr_warn/;
3266 }
Joe Perches243f3802012-05-31 16:26:09 -07003267 }
3268
Joe Perchesdc139312013-02-21 16:44:13 -08003269 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3270 my $orig = $1;
3271 my $level = lc($orig);
3272 $level = "warn" if ($level eq "warning");
3273 $level = "dbg" if ($level eq "debug");
3274 WARN("PREFER_DEV_LEVEL",
3275 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3276 }
3277
Andy Whitcroft653d4872007-06-23 17:16:34 -07003278# function brace can't be on same line, except for #defines of do while,
3279# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003280 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003281 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003282 if (ERROR("OPEN_BRACE",
3283 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3284 $fix) {
3285 fix_delete_line($fixlinenr, $rawline);
3286 my $fixed_line = $rawline;
3287 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3288 my $line1 = $1;
3289 my $line2 = $2;
3290 fix_insert_line($fixlinenr, ltrim($line1));
3291 fix_insert_line($fixlinenr, "\+{");
3292 if ($line2 !~ /^\s*$/) {
3293 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3294 }
3295 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003296 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003297
Andy Whitcroft8905a672007-11-28 16:21:06 -08003298# open braces for enum, union and struct go on the same line.
3299 if ($line =~ /^.\s*{/ &&
3300 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003301 if (ERROR("OPEN_BRACE",
3302 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3303 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3304 fix_delete_line($fixlinenr - 1, $prevrawline);
3305 fix_delete_line($fixlinenr, $rawline);
3306 my $fixedline = rtrim($prevrawline) . " {";
3307 fix_insert_line($fixlinenr, $fixedline);
3308 $fixedline = $rawline;
3309 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3310 if ($fixedline !~ /^\+\s*$/) {
3311 fix_insert_line($fixlinenr, $fixedline);
3312 }
3313 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003314 }
3315
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003316# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003317 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3318 if (WARN("SPACING",
3319 "missing space after $1 definition\n" . $herecurr) &&
3320 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003321 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003322 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3323 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003324 }
3325
Joe Perches31070b52014-01-23 15:54:49 -08003326# Function pointer declarations
3327# check spacing between type, funcptr, and args
3328# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003329 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003330 my $declare = $1;
3331 my $pre_pointer_space = $2;
3332 my $post_pointer_space = $3;
3333 my $funcname = $4;
3334 my $post_funcname_space = $5;
3335 my $pre_args_space = $6;
3336
Joe Perches91f72e92014-04-03 14:49:12 -07003337# the $Declare variable will capture all spaces after the type
3338# so check it for a missing trailing missing space but pointer return types
3339# don't need a space so don't warn for those.
3340 my $post_declare_space = "";
3341 if ($declare =~ /(\s+)$/) {
3342 $post_declare_space = $1;
3343 $declare = rtrim($declare);
3344 }
3345 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003346 WARN("SPACING",
3347 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003348 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003349 }
3350
3351# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003352# This test is not currently implemented because these declarations are
3353# equivalent to
3354# int foo(int bar, ...)
3355# and this is form shouldn't/doesn't generate a checkpatch warning.
3356#
3357# elsif ($declare =~ /\s{2,}$/) {
3358# WARN("SPACING",
3359# "Multiple spaces after return type\n" . $herecurr);
3360# }
Joe Perches31070b52014-01-23 15:54:49 -08003361
3362# unnecessary space "type ( *funcptr)(args...)"
3363 if (defined $pre_pointer_space &&
3364 $pre_pointer_space =~ /^\s/) {
3365 WARN("SPACING",
3366 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3367 }
3368
3369# unnecessary space "type (* funcptr)(args...)"
3370 if (defined $post_pointer_space &&
3371 $post_pointer_space =~ /^\s/) {
3372 WARN("SPACING",
3373 "Unnecessary space before function pointer name\n" . $herecurr);
3374 }
3375
3376# unnecessary space "type (*funcptr )(args...)"
3377 if (defined $post_funcname_space &&
3378 $post_funcname_space =~ /^\s/) {
3379 WARN("SPACING",
3380 "Unnecessary space after function pointer name\n" . $herecurr);
3381 }
3382
3383# unnecessary space "type (*funcptr) (args...)"
3384 if (defined $pre_args_space &&
3385 $pre_args_space =~ /^\s/) {
3386 WARN("SPACING",
3387 "Unnecessary space before function pointer arguments\n" . $herecurr);
3388 }
3389
3390 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003391 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003392 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003393 }
3394 }
3395
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003396# check for spacing round square brackets; allowed:
3397# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003398# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3399# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003400 while ($line =~ /(.*?\s)\[/g) {
3401 my ($where, $prefix) = ($-[1], $1);
3402 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003403 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003404 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003405 if (ERROR("BRACKET_SPACE",
3406 "space prohibited before open square bracket '['\n" . $herecurr) &&
3407 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003408 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003409 s/^(\+.*?)\s+\[/$1\[/;
3410 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003411 }
3412 }
3413
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003414# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003415 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003416 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003417 my $ctx_before = substr($line, 0, $-[1]);
3418 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003419
3420 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003421 if ($name =~ /^(?:
3422 if|for|while|switch|return|case|
3423 volatile|__volatile__|
3424 __attribute__|format|__extension__|
3425 asm|__asm__)$/x)
3426 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003427 # cpp #define statements have non-optional spaces, ie
3428 # if there is a space between the name and the open
3429 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003430 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003431
3432 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003433 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003434
3435 # If this whole things ends with a type its most
3436 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003437 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003438
3439 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003440 if (WARN("SPACING",
3441 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3442 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003443 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003444 s/\b$name\s+\(/$name\(/;
3445 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003446 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003447 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003448
Andy Whitcroft653d4872007-06-23 17:16:34 -07003449# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003450 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003451 my $fixed_line = "";
3452 my $line_fixed = 0;
3453
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003454 my $ops = qr{
3455 <<=|>>=|<=|>=|==|!=|
3456 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3457 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003458 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003459 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003460 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003461 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003462
3463## print("element count: <" . $#elements . ">\n");
3464## foreach my $el (@elements) {
3465## print("el: <$el>\n");
3466## }
3467
3468 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003469 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003470
Joe Perches3705ce52013-07-03 15:05:31 -07003471 foreach my $el (@elements) {
3472 push(@fix_elements, substr($rawline, $off, length($el)));
3473 $off += length($el);
3474 }
3475
3476 $off = 0;
3477
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003478 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003479 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003480
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003481 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003482
3483 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3484
3485## print("n: <$n> good: <$good>\n");
3486
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003487 $off += length($elements[$n]);
3488
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003489 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003490 my $ca = substr($opline, 0, $off);
3491 my $cc = '';
3492 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3493 $cc = substr($opline, $off + length($elements[$n + 1]));
3494 }
3495 my $cb = "$ca$;$cc";
3496
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003497 my $a = '';
3498 $a = 'V' if ($elements[$n] ne '');
3499 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003500 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003501 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3502 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003503 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003504
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003505 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003506
3507 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003508 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003509 $c = 'V' if ($elements[$n + 2] ne '');
3510 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003511 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003512 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3513 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003514 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003515 } else {
3516 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003517 }
3518
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003519 my $ctx = "${a}x${c}";
3520
3521 my $at = "(ctx:$ctx)";
3522
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003523 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003524 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003525
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003526 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003527 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003528
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003529 # Get the full operator variant.
3530 my $opv = $op . substr($curr_vars, $off, 1);
3531
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003532 # Ignore operators passed as parameters.
3533 if ($op_type ne 'V' &&
3534 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3535
Andy Whitcroftcf655042008-03-04 14:28:20 -08003536# # Ignore comments
3537# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003538
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003539 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003540 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003541 if ($ctx !~ /.x[WEBC]/ &&
3542 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003543 if (ERROR("SPACING",
3544 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003545 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003546 $line_fixed = 1;
3547 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003548 }
3549
3550 # // is a comment
3551 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003552
Joe Perchesb00e4812014-04-03 14:49:33 -07003553 # : when part of a bitfield
3554 } elsif ($opv eq ':B') {
3555 # skip the bitfield test for now
3556
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003557 # No spaces for:
3558 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003559 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003560 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003561 if (ERROR("SPACING",
3562 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003563 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003564 if (defined $fix_elements[$n + 2]) {
3565 $fix_elements[$n + 2] =~ s/^\s+//;
3566 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003567 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003568 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003569 }
3570
Joe Perches23810972014-12-10 15:51:32 -08003571 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003572 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08003573 my $rtrim_before = 0;
3574 my $space_after = 0;
3575 if ($ctx =~ /Wx./) {
3576 if (ERROR("SPACING",
3577 "space prohibited before that '$op' $at\n" . $hereptr)) {
3578 $line_fixed = 1;
3579 $rtrim_before = 1;
3580 }
3581 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003582 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003583 if (ERROR("SPACING",
3584 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003585 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003586 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08003587 $space_after = 1;
3588 }
3589 }
3590 if ($rtrim_before || $space_after) {
3591 if ($rtrim_before) {
3592 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
3593 } else {
3594 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
3595 }
3596 if ($space_after) {
3597 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003598 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003599 }
3600
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003601 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003602 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003603 #warn "'*' is part of type\n";
3604
3605 # unary operators should have a space before and
3606 # none after. May be left adjacent to another
3607 # unary operator, or a cast
3608 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003609 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003610 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003611 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003612 if (ERROR("SPACING",
3613 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003614 if ($n != $last_after + 2) {
3615 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3616 $line_fixed = 1;
3617 }
Joe Perches3705ce52013-07-03 15:05:31 -07003618 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003619 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003620 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003621 # A unary '*' may be const
3622
3623 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003624 if (ERROR("SPACING",
3625 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003626 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003627 if (defined $fix_elements[$n + 2]) {
3628 $fix_elements[$n + 2] =~ s/^\s+//;
3629 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003630 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003631 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003632 }
3633
3634 # unary ++ and unary -- are allowed no space on one side.
3635 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003636 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003637 if (ERROR("SPACING",
3638 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003639 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003640 $line_fixed = 1;
3641 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003642 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003643 if ($ctx =~ /Wx[BE]/ ||
3644 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003645 if (ERROR("SPACING",
3646 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003647 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003648 $line_fixed = 1;
3649 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003650 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003651 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003652 if (ERROR("SPACING",
3653 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003654 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003655 if (defined $fix_elements[$n + 2]) {
3656 $fix_elements[$n + 2] =~ s/^\s+//;
3657 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003658 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003659 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003660 }
3661
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003662 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003663 } elsif ($op eq '<<' or $op eq '>>' or
3664 $op eq '&' or $op eq '^' or $op eq '|' or
3665 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003666 $op eq '*' or $op eq '/' or
3667 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003668 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003669 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003670 if (ERROR("SPACING",
3671 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003672 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3673 if (defined $fix_elements[$n + 2]) {
3674 $fix_elements[$n + 2] =~ s/^\s+//;
3675 }
Joe Perches3705ce52013-07-03 15:05:31 -07003676 $line_fixed = 1;
3677 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003678 }
3679
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003680 # A colon needs no spaces before when it is
3681 # terminating a case value or a label.
3682 } elsif ($opv eq ':C' || $opv eq ':L') {
3683 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003684 if (ERROR("SPACING",
3685 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003686 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003687 $line_fixed = 1;
3688 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003689 }
3690
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003691 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003692 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003693 my $ok = 0;
3694
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003695 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003696 if (($op eq '<' &&
3697 $cc =~ /^\S+\@\S+>/) ||
3698 ($op eq '>' &&
3699 $ca =~ /<\S+\@\S+$/))
3700 {
3701 $ok = 1;
3702 }
3703
Joe Perches84731622013-11-12 15:10:05 -08003704 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003705 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003706 my $msg_type = \&ERROR;
3707 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3708
3709 if (&{$msg_type}("SPACING",
3710 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003711 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3712 if (defined $fix_elements[$n + 2]) {
3713 $fix_elements[$n + 2] =~ s/^\s+//;
3714 }
Joe Perches3705ce52013-07-03 15:05:31 -07003715 $line_fixed = 1;
3716 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003717 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003718 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003719 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003720
3721## print("n: <$n> GOOD: <$good>\n");
3722
3723 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003724 }
Joe Perches3705ce52013-07-03 15:05:31 -07003725
3726 if (($#elements % 2) == 0) {
3727 $fixed_line = $fixed_line . $fix_elements[$#elements];
3728 }
3729
Joe Perches194f66f2014-08-06 16:11:03 -07003730 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3731 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003732 }
3733
3734
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003735 }
3736
Joe Perches786b6322013-07-03 15:05:32 -07003737# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003738 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003739 if (WARN("SPACING",
3740 "space prohibited before semicolon\n" . $herecurr) &&
3741 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003742 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003743 s/^(\+.*\S)\s+;/$1;/;
3744 }
3745 }
3746
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003747# check for multiple assignments
3748 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003749 CHK("MULTIPLE_ASSIGNMENTS",
3750 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003751 }
3752
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003753## # check for multiple declarations, allowing for a function declaration
3754## # continuation.
3755## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3756## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3757##
3758## # Remove any bracketed sections to ensure we do not
3759## # falsly report the parameters of functions.
3760## my $ln = $line;
3761## while ($ln =~ s/\([^\(\)]*\)//g) {
3762## }
3763## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003764## WARN("MULTIPLE_DECLARATION",
3765## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003766## }
3767## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003768
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003769#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003770 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3771 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003772 if (ERROR("SPACING",
3773 "space required before the open brace '{'\n" . $herecurr) &&
3774 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003775 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003776 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003777 }
3778
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003779## # check for blank lines before declarations
3780## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3781## $prevrawline =~ /^.\s*$/) {
3782## WARN("SPACING",
3783## "No blank lines before declarations\n" . $hereprev);
3784## }
3785##
3786
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003787# closing brace should have a space following it when it has anything
3788# on the line
3789 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003790 if (ERROR("SPACING",
3791 "space required after that close brace '}'\n" . $herecurr) &&
3792 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003793 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003794 s/}((?!(?:,|;|\)))\S)/} $1/;
3795 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003796 }
3797
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003798# check spacing on square brackets
3799 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003800 if (ERROR("SPACING",
3801 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3802 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003803 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003804 s/\[\s+/\[/;
3805 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003806 }
3807 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003808 if (ERROR("SPACING",
3809 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3810 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003811 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003812 s/\s+\]/\]/;
3813 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003814 }
3815
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003816# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003817 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3818 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003819 if (ERROR("SPACING",
3820 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3821 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003822 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003823 s/\(\s+/\(/;
3824 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003825 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003826 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003827 $line !~ /for\s*\(.*;\s+\)/ &&
3828 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003829 if (ERROR("SPACING",
3830 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3831 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003832 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003833 s/\s+\)/\)/;
3834 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003835 }
3836
Joe Perchese2826fd2014-08-06 16:10:48 -07003837# check unnecessary parentheses around addressof/dereference single $Lvals
3838# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3839
3840 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3841 CHK("UNNECESSARY_PARENTHESES",
3842 "Unnecessary parentheses around $1\n" . $herecurr);
3843 }
3844
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003845#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003846 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003847 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003848 if (WARN("INDENTED_LABEL",
3849 "labels should not be indented\n" . $herecurr) &&
3850 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003851 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003852 s/^(.)\s+/$1/;
3853 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003854 }
3855
Joe Perches5b9553a2014-04-03 14:49:21 -07003856# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003857 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003858 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003859 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003860 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3861 my $value = $1;
3862 $value = deparenthesize($value);
3863 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3864 ERROR("RETURN_PARENTHESES",
3865 "return is not a function, parentheses are not required\n" . $herecurr);
3866 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003867 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003868 ERROR("SPACING",
3869 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003870 }
3871 }
Joe Perches507e5142013-11-12 15:10:13 -08003872
Joe Perchesb43ae212014-06-23 13:22:07 -07003873# unnecessary return in a void function
3874# at end-of-function, with the previous line a single leading tab, then return;
3875# and the line before that not a goto label target like "out:"
3876 if ($sline =~ /^[ \+]}\s*$/ &&
3877 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3878 $linenr >= 3 &&
3879 $lines[$linenr - 3] =~ /^[ +]/ &&
3880 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003881 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003882 "void function return statements are not generally useful\n" . $hereprev);
3883 }
Joe Perches9819cf22014-06-04 16:12:09 -07003884
Joe Perches189248d2014-01-23 15:54:47 -08003885# if statements using unnecessary parentheses - ie: if ((foo == bar))
3886 if ($^V && $^V ge 5.10.0 &&
3887 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3888 my $openparens = $1;
3889 my $count = $openparens =~ tr@\(@\(@;
3890 my $msg = "";
3891 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3892 my $comp = $4; #Not $1 because of $LvalOrFunc
3893 $msg = " - maybe == should be = ?" if ($comp eq "==");
3894 WARN("UNNECESSARY_PARENTHESES",
3895 "Unnecessary parentheses$msg\n" . $herecurr);
3896 }
3897 }
3898
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003899# Return of what appears to be an errno should normally be -'ve
3900 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3901 my $name = $1;
3902 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003903 WARN("USE_NEGATIVE_ERRNO",
3904 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003905 }
3906 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003907
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003908# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003909 if ($line =~ /\b(if|while|for|switch)\(/) {
3910 if (ERROR("SPACING",
3911 "space required before the open parenthesis '('\n" . $herecurr) &&
3912 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003913 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003914 s/\b(if|while|for|switch)\(/$1 \(/;
3915 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003916 }
3917
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003918# Check for illegal assignment in if conditional -- and check for trailing
3919# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003920 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003921 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3922 ctx_statement_block($linenr, $realcnt, 0)
3923 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003924 my ($stat_next) = ctx_statement_block($line_nr_next,
3925 $remain_next, $off_next);
3926 $stat_next =~ s/\n./\n /g;
3927 ##print "stat<$stat> stat_next<$stat_next>\n";
3928
3929 if ($stat_next =~ /^\s*while\b/) {
3930 # If the statement carries leading newlines,
3931 # then count those as offsets.
3932 my ($whitespace) =
3933 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3934 my $offset =
3935 statement_rawlines($whitespace) - 1;
3936
3937 $suppress_whiletrailers{$line_nr_next +
3938 $offset} = 1;
3939 }
3940 }
3941 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003942 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003943 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003944 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003945
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003946 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003947 ERROR("ASSIGN_IN_IF",
3948 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003949 }
3950
3951 # Find out what is on the end of the line after the
3952 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003953 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003954 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003955 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003956 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3957 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003958 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003959 # Find out how long the conditional actually is.
3960 my @newlines = ($c =~ /\n/gs);
3961 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003962 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003963
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003964 $stat_real = raw_line($linenr, $cond_lines)
3965 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003966 if (defined($stat_real) && $cond_lines > 1) {
3967 $stat_real = "[...]\n$stat_real";
3968 }
3969
Joe Perches000d1cc12011-07-25 17:13:25 -07003970 ERROR("TRAILING_STATEMENTS",
3971 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003972 }
3973 }
3974
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003975# Check for bitwise tests written as boolean
3976 if ($line =~ /
3977 (?:
3978 (?:\[|\(|\&\&|\|\|)
3979 \s*0[xX][0-9]+\s*
3980 (?:\&\&|\|\|)
3981 |
3982 (?:\&\&|\|\|)
3983 \s*0[xX][0-9]+\s*
3984 (?:\&\&|\|\||\)|\])
3985 )/x)
3986 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003987 WARN("HEXADECIMAL_BOOLEAN_TEST",
3988 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003989 }
3990
Andy Whitcroft8905a672007-11-28 16:21:06 -08003991# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003992 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3993 my $s = $1;
3994 $s =~ s/$;//g; # Remove any comments
3995 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003996 ERROR("TRAILING_STATEMENTS",
3997 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003998 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003999 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004000# if should not continue a brace
4001 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004002 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004003 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004004 $herecurr);
4005 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004006# case and default should not have general statements after them
4007 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4008 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004009 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004010 \s*return\s+
4011 )/xg)
4012 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004013 ERROR("TRAILING_STATEMENTS",
4014 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004015 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004016
4017 # Check for }<nl>else {, these must be at the same
4018 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004019 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4020 $previndent == $indent) {
4021 if (ERROR("ELSE_AFTER_BRACE",
4022 "else should follow close brace '}'\n" . $hereprev) &&
4023 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4024 fix_delete_line($fixlinenr - 1, $prevrawline);
4025 fix_delete_line($fixlinenr, $rawline);
4026 my $fixedline = $prevrawline;
4027 $fixedline =~ s/}\s*$//;
4028 if ($fixedline !~ /^\+\s*$/) {
4029 fix_insert_line($fixlinenr, $fixedline);
4030 }
4031 $fixedline = $rawline;
4032 $fixedline =~ s/^(.\s*)else/$1} else/;
4033 fix_insert_line($fixlinenr, $fixedline);
4034 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004035 }
4036
Joe Perches8b8856f2014-08-06 16:11:14 -07004037 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4038 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004039 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4040
4041 # Find out what is on the end of the line after the
4042 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004043 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004044 $s =~ s/\n.*//g;
4045
4046 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004047 if (ERROR("WHILE_AFTER_BRACE",
4048 "while should follow close brace '}'\n" . $hereprev) &&
4049 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4050 fix_delete_line($fixlinenr - 1, $prevrawline);
4051 fix_delete_line($fixlinenr, $rawline);
4052 my $fixedline = $prevrawline;
4053 my $trailing = $rawline;
4054 $trailing =~ s/^\+//;
4055 $trailing = trim($trailing);
4056 $fixedline =~ s/}\s*$/} $trailing/;
4057 fix_insert_line($fixlinenr, $fixedline);
4058 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004059 }
4060 }
4061
Joe Perches95e2c602013-07-03 15:05:20 -07004062#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004063 while ($line =~ m{($Constant|$Lval)}g) {
4064 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004065
4066#gcc binary extension
4067 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004068 if (WARN("GCC_BINARY_CONSTANT",
4069 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4070 $fix) {
4071 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004072 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004073 s/\b$var\b/$hexval/;
4074 }
Joe Perches95e2c602013-07-03 15:05:20 -07004075 }
4076
4077#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004078 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004079 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004080#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004081 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004082#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07004083 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[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 Perchesf17dba42014-10-13 15:51:51 -07004435# concatenated string without spaces between elements
4436 if ($line =~ /"X+"[A-Z_]+/ || $line =~ /[A-Z_]+"X+"/) {
4437 CHK("CONCATENATED_STRING",
4438 "Concatenated strings should use spaces between elements\n" . $herecurr);
4439 }
4440
Andy Whitcroft00df3442007-06-08 13:47:06 -07004441# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004442 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004443 CHK("REDUNDANT_CODE",
4444 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004445 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004446 }
4447
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004448# check for needless "if (<foo>) fn(<foo>)" uses
4449 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4450 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4451 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4452 WARN('NEEDLESS_IF',
Fabio Estevam15160f92014-12-10 15:51:40 -08004453 "$1(NULL) is safe and this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004454 }
4455 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004456
Joe Perchesebfdc402014-08-06 16:10:27 -07004457# check for unnecessary "Out of Memory" messages
4458 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4459 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4460 (defined $1 || defined $3) &&
4461 $linenr > 3) {
4462 my $testval = $2;
4463 my $testline = $lines[$linenr - 3];
4464
4465 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4466# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4467
4468 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4469 WARN("OOM_MESSAGE",
4470 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4471 }
4472 }
4473
Joe Perchesf78d98f2014-10-13 15:52:01 -07004474# check for logging functions with KERN_<LEVEL>
4475 if ($line !~ /printk\s*\(/ &&
4476 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
4477 my $level = $1;
4478 if (WARN("UNNECESSARY_KERN_LEVEL",
4479 "Possible unnecessary $level\n" . $herecurr) &&
4480 $fix) {
4481 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
4482 }
4483 }
4484
Joe Perches8716de32013-09-11 14:24:05 -07004485# check for bad placement of section $InitAttribute (e.g.: __initdata)
4486 if ($line =~ /(\b$InitAttribute\b)/) {
4487 my $attr = $1;
4488 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4489 my $ptr = $1;
4490 my $var = $2;
4491 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4492 ERROR("MISPLACED_INIT",
4493 "$attr should be placed after $var\n" . $herecurr)) ||
4494 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4495 WARN("MISPLACED_INIT",
4496 "$attr should be placed after $var\n" . $herecurr))) &&
4497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004498 $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 -07004499 }
4500 }
4501 }
4502
Joe Perchese970b882013-11-12 15:10:10 -08004503# check for $InitAttributeData (ie: __initdata) with const
4504 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4505 my $attr = $1;
4506 $attr =~ /($InitAttributePrefix)(.*)/;
4507 my $attr_prefix = $1;
4508 my $attr_type = $2;
4509 if (ERROR("INIT_ATTRIBUTE",
4510 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4511 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004512 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004513 s/$InitAttributeData/${attr_prefix}initconst/;
4514 }
4515 }
4516
4517# check for $InitAttributeConst (ie: __initconst) without const
4518 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4519 my $attr = $1;
4520 if (ERROR("INIT_ATTRIBUTE",
4521 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4522 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004523 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08004524 /(^\+\s*(?:static\s+))/;
4525 $lead = rtrim($1);
4526 $lead = "$lead " if ($lead !~ /^\+$/);
4527 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004528 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08004529 }
4530 }
4531
Joe Perchesfbdb8132014-04-03 14:49:14 -07004532# don't use __constant_<foo> functions outside of include/uapi/
4533 if ($realfile !~ m@^include/uapi/@ &&
4534 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4535 my $constant_func = $1;
4536 my $func = $constant_func;
4537 $func =~ s/^__constant_//;
4538 if (WARN("CONSTANT_CONVERSION",
4539 "$constant_func should be $func\n" . $herecurr) &&
4540 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004541 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004542 }
4543 }
4544
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004545# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004546 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004547 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004548 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004549 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004550 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004551 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4552 }
4553 if ($delay > 2000) {
4554 WARN("LONG_UDELAY",
4555 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004556 }
4557 }
4558
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004559# warn about unexpectedly long msleep's
4560 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4561 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004562 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004563 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004564 }
4565 }
4566
Joe Perches36ec1932013-07-03 15:05:25 -07004567# check for comparisons of jiffies
4568 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4569 WARN("JIFFIES_COMPARISON",
4570 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4571 }
4572
Joe Perches9d7a34a2013-07-03 15:05:26 -07004573# check for comparisons of get_jiffies_64()
4574 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4575 WARN("JIFFIES_COMPARISON",
4576 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4577 }
4578
Andy Whitcroft00df3442007-06-08 13:47:06 -07004579# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004580# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004581# print "#ifdef in C files should be avoided\n";
4582# print "$herecurr";
4583# $clean = 0;
4584# }
4585
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004586# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004587 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004588 if (ERROR("SPACING",
4589 "exactly one space required after that #$1\n" . $herecurr) &&
4590 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004591 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004592 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4593 }
4594
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004595 }
4596
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004597# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004598 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4599 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004600 my $which = $1;
4601 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004602 CHK("UNCOMMENTED_DEFINITION",
4603 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004604 }
4605 }
4606# check for memory barriers without a comment.
4607 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4608 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004609 WARN("MEMORY_BARRIER",
4610 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004611 }
4612 }
4613# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004614 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004615 CHK("ARCH_DEFINES",
4616 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004617 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004618
Tobias Klauserd4977c72010-05-24 14:33:30 -07004619# Check that the storage class is at the beginning of a declaration
4620 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004621 WARN("STORAGE_CLASS",
4622 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004623 }
4624
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004625# check the location of the inline attribute, that it is between
4626# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004627 if ($line =~ /\b$Type\s+$Inline\b/ ||
4628 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004629 ERROR("INLINE_LOCATION",
4630 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004631 }
4632
Andy Whitcroft8905a672007-11-28 16:21:06 -08004633# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004634 if ($realfile !~ m@\binclude/uapi/@ &&
4635 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004636 if (WARN("INLINE",
4637 "plain inline is preferred over $1\n" . $herecurr) &&
4638 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004639 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004640
4641 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004642 }
4643
Joe Perches3d130fd2011-01-12 17:00:00 -08004644# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004645 if ($realfile !~ m@\binclude/uapi/@ &&
4646 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004647 WARN("PREFER_PACKED",
4648 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004649 }
4650
Joe Perches39b7e282011-07-25 17:13:24 -07004651# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004652 if ($realfile !~ m@\binclude/uapi/@ &&
4653 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004654 WARN("PREFER_ALIGNED",
4655 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004656 }
4657
Joe Perches5f14d3b2012-01-10 15:09:52 -08004658# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004659 if ($realfile !~ m@\binclude/uapi/@ &&
4660 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004661 if (WARN("PREFER_PRINTF",
4662 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4663 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004664 $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 -07004665
4666 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004667 }
4668
Joe Perches6061d942012-03-23 15:02:16 -07004669# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004670 if ($realfile !~ m@\binclude/uapi/@ &&
4671 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004672 if (WARN("PREFER_SCANF",
4673 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4674 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004675 $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 -07004676 }
Joe Perches6061d942012-03-23 15:02:16 -07004677 }
4678
Joe Perches619a9082014-12-10 15:51:35 -08004679# Check for __attribute__ weak, or __weak declarations (may have link issues)
4680 if ($^V && $^V ge 5.10.0 &&
4681 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4682 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
4683 $line =~ /\b__weak\b/)) {
4684 ERROR("WEAK_DECLARATION",
4685 "Using weak declarations can have unintended link defects\n" . $herecurr);
4686 }
4687
Joe Perches8f53a9b2010-03-05 13:43:48 -08004688# check for sizeof(&)
4689 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004690 WARN("SIZEOF_ADDRESS",
4691 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004692 }
4693
Joe Perches66c80b62012-07-30 14:41:22 -07004694# check for sizeof without parenthesis
4695 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004696 if (WARN("SIZEOF_PARENTHESIS",
4697 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4698 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004699 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004700 }
Joe Perches66c80b62012-07-30 14:41:22 -07004701 }
4702
Joe Perches428e2fd2011-05-24 17:13:39 -07004703# check for line continuations in quoted strings with odd counts of "
4704 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004705 WARN("LINE_CONTINUATIONS",
4706 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004707 }
4708
Joe Perches88982fe2012-12-17 16:02:00 -08004709# check for struct spinlock declarations
4710 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4711 WARN("USE_SPINLOCK_T",
4712 "struct spinlock should be spinlock_t\n" . $herecurr);
4713 }
4714
Joe Perchesa6962d72013-04-29 16:18:13 -07004715# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004716 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004717 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004718 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004719 if (WARN("PREFER_SEQ_PUTS",
4720 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4721 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004722 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004723 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004724 }
4725 }
4726
Andy Whitcroft554e1652012-01-10 15:09:57 -08004727# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004728 if ($^V && $^V ge 5.10.0 &&
4729 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004730 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004731
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004732 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004733 my $ms_val = $7;
4734 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004735
Andy Whitcroft554e1652012-01-10 15:09:57 -08004736 if ($ms_size =~ /^(0x|)0$/i) {
4737 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004738 "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 -08004739 } elsif ($ms_size =~ /^(0x|)1$/i) {
4740 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004741 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4742 }
4743 }
4744
Joe Perches98a9bba2014-01-23 15:54:52 -08004745# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4746 if ($^V && $^V ge 5.10.0 &&
4747 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4748 if (WARN("PREFER_ETHER_ADDR_COPY",
4749 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4750 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004751 $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 -08004752 }
4753 }
4754
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004755# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004756 if ($^V && $^V ge 5.10.0 &&
4757 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004758 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004759 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004760 my $call = $1;
4761 my $cast1 = deparenthesize($2);
4762 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004763 my $cast2 = deparenthesize($7);
4764 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004765 my $cast;
4766
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004767 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004768 $cast = "$cast1 or $cast2";
4769 } elsif ($cast1 ne "") {
4770 $cast = $cast1;
4771 } else {
4772 $cast = $cast2;
4773 }
4774 WARN("MINMAX",
4775 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004776 }
4777 }
4778
Joe Perches4a273192012-07-30 14:41:20 -07004779# check usleep_range arguments
4780 if ($^V && $^V ge 5.10.0 &&
4781 defined $stat &&
4782 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4783 my $min = $1;
4784 my $max = $7;
4785 if ($min eq $max) {
4786 WARN("USLEEP_RANGE",
4787 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4788 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4789 $min > $max) {
4790 WARN("USLEEP_RANGE",
4791 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4792 }
4793 }
4794
Joe Perches823b7942013-11-12 15:10:15 -08004795# check for naked sscanf
4796 if ($^V && $^V ge 5.10.0 &&
4797 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004798 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004799 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4800 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4801 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4802 my $lc = $stat =~ tr@\n@@;
4803 $lc = $lc + $linenr;
4804 my $stat_real = raw_line($linenr, 0);
4805 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4806 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4807 }
4808 WARN("NAKED_SSCANF",
4809 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4810 }
4811
Joe Perchesafc819a2014-06-04 16:12:08 -07004812# check for simple sscanf that should be kstrto<foo>
4813 if ($^V && $^V ge 5.10.0 &&
4814 defined $stat &&
4815 $line =~ /\bsscanf\b/) {
4816 my $lc = $stat =~ tr@\n@@;
4817 $lc = $lc + $linenr;
4818 my $stat_real = raw_line($linenr, 0);
4819 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4820 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4821 }
4822 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4823 my $format = $6;
4824 my $count = $format =~ tr@%@%@;
4825 if ($count == 1 &&
4826 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4827 WARN("SSCANF_TO_KSTRTO",
4828 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4829 }
4830 }
4831 }
4832
Joe Perches70dc8a42013-09-11 14:23:58 -07004833# check for new externs in .h files.
4834 if ($realfile =~ /\.h$/ &&
4835 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004836 if (CHK("AVOID_EXTERNS",
4837 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004838 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004839 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004840 }
4841 }
4842
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004843# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004844 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004845 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004846 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004847 my $function_name = $1;
4848 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004849
4850 my $s = $stat;
4851 if (defined $cond) {
4852 substr($s, 0, length($cond), '');
4853 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004854 if ($s =~ /^\s*;/ &&
4855 $function_name ne 'uninitialized_var')
4856 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004857 WARN("AVOID_EXTERNS",
4858 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004859 }
4860
4861 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004862 WARN("FUNCTION_ARGUMENTS",
4863 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004864 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004865
4866 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4867 $stat =~ /^.\s*extern\s+/)
4868 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004869 WARN("AVOID_EXTERNS",
4870 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004871 }
4872
4873# checks for new __setup's
4874 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4875 my $name = $1;
4876
4877 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004878 CHK("UNDOCUMENTED_SETUP",
4879 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004880 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004881 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004882
4883# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004884 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004885 WARN("UNNECESSARY_CASTS",
4886 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004887 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004888
Joe Perchesa640d252013-07-03 15:05:21 -07004889# alloc style
4890# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4891 if ($^V && $^V ge 5.10.0 &&
4892 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4893 CHK("ALLOC_SIZEOF_STRUCT",
4894 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4895 }
4896
Joe Perches60a55362014-06-04 16:12:07 -07004897# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4898 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004899 $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 -07004900 my $oldfunc = $3;
4901 my $a1 = $4;
4902 my $a2 = $10;
4903 my $newfunc = "kmalloc_array";
4904 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004905 my $r1 = $a1;
4906 my $r2 = $a2;
4907 if ($a1 =~ /^sizeof\s*\S/) {
4908 $r1 = $a2;
4909 $r2 = $a1;
4910 }
4911 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4912 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07004913 if (WARN("ALLOC_WITH_MULTIPLY",
4914 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4915 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004916 $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 -07004917
4918 }
4919 }
4920 }
4921
Joe Perches972fdea2013-04-29 16:18:12 -07004922# check for krealloc arg reuse
4923 if ($^V && $^V ge 5.10.0 &&
4924 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4925 WARN("KREALLOC_ARG_REUSE",
4926 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4927 }
4928
Joe Perches5ce59ae2013-02-21 16:44:18 -08004929# check for alloc argument mismatch
4930 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4931 WARN("ALLOC_ARRAY_ARGS",
4932 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4933 }
4934
Joe Perchescaf2a542011-01-12 16:59:56 -08004935# check for multiple semicolons
4936 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004937 if (WARN("ONE_SEMICOLON",
4938 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4939 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004940 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004941 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004942 }
4943
Joe Perchese81f2392014-08-06 16:11:25 -07004944# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08004945 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4946 my $has_break = 0;
4947 my $has_statement = 0;
4948 my $count = 0;
4949 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07004950 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08004951 $prevline--;
4952 my $rline = $rawlines[$prevline - 1];
4953 my $fline = $lines[$prevline - 1];
4954 last if ($fline =~ /^\@\@/);
4955 next if ($fline =~ /^\-/);
4956 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4957 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4958 next if ($fline =~ /^.[\s$;]*$/);
4959 $has_statement = 1;
4960 $count++;
4961 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4962 }
4963 if (!$has_break && $has_statement) {
4964 WARN("MISSING_BREAK",
4965 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4966 }
4967 }
4968
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004969# check for switch/default statements without a break;
4970 if ($^V && $^V ge 5.10.0 &&
4971 defined $stat &&
4972 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4973 my $ctx = '';
4974 my $herectx = $here . "\n";
4975 my $cnt = statement_rawlines($stat);
4976 for (my $n = 0; $n < $cnt; $n++) {
4977 $herectx .= raw_line($linenr, $n) . "\n";
4978 }
4979 WARN("DEFAULT_NO_BREAK",
4980 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004981 }
4982
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004983# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004984 if ($line =~ /\b__FUNCTION__\b/) {
4985 if (WARN("USE_FUNC",
4986 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4987 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004988 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004989 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004990 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004991
Joe Perches2c924882012-03-23 15:02:20 -07004992# check for use of yield()
4993 if ($line =~ /\byield\s*\(\s*\)/) {
4994 WARN("YIELD",
4995 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4996 }
4997
Joe Perches179f8f42013-07-03 15:05:30 -07004998# check for comparisons against true and false
4999 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5000 my $lead = $1;
5001 my $arg = $2;
5002 my $test = $3;
5003 my $otype = $4;
5004 my $trail = $5;
5005 my $op = "!";
5006
5007 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5008
5009 my $type = lc($otype);
5010 if ($type =~ /^(?:true|false)$/) {
5011 if (("$test" eq "==" && "$type" eq "true") ||
5012 ("$test" eq "!=" && "$type" eq "false")) {
5013 $op = "";
5014 }
5015
5016 CHK("BOOL_COMPARISON",
5017 "Using comparison to $otype is error prone\n" . $herecurr);
5018
5019## maybe suggesting a correct construct would better
5020## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5021
5022 }
5023 }
5024
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005025# check for semaphores initialized locked
5026 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005027 WARN("CONSIDER_COMPLETION",
5028 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005029 }
Joe Perches6712d852012-03-23 15:02:20 -07005030
Joe Perches67d0a072011-10-31 17:13:10 -07005031# recommend kstrto* over simple_strto* and strict_strto*
5032 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005033 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005034 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005035 }
Joe Perches6712d852012-03-23 15:02:20 -07005036
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005037# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005038 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005039 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005040 "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 -07005041 }
Joe Perches6712d852012-03-23 15:02:20 -07005042
Emese Revfy79404842010-03-05 13:43:53 -08005043# check for various ops structs, ensure they are const.
5044 my $struct_ops = qr{acpi_dock_ops|
5045 address_space_operations|
5046 backlight_ops|
5047 block_device_operations|
5048 dentry_operations|
5049 dev_pm_ops|
5050 dma_map_ops|
5051 extent_io_ops|
5052 file_lock_operations|
5053 file_operations|
5054 hv_ops|
5055 ide_dma_ops|
5056 intel_dvo_dev_ops|
5057 item_operations|
5058 iwl_ops|
5059 kgdb_arch|
5060 kgdb_io|
5061 kset_uevent_ops|
5062 lock_manager_operations|
5063 microcode_ops|
5064 mtrr_ops|
5065 neigh_ops|
5066 nlmsvc_binding|
5067 pci_raw_ops|
5068 pipe_buf_operations|
5069 platform_hibernation_ops|
5070 platform_suspend_ops|
5071 proto_ops|
5072 rpc_pipe_ops|
5073 seq_operations|
5074 snd_ac97_build_ops|
5075 soc_pcmcia_socket_ops|
5076 stacktrace_ops|
5077 sysfs_ops|
5078 tty_operations|
5079 usb_mon_operations|
5080 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005081 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08005082 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005083 WARN("CONST_STRUCT",
5084 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005085 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005086 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005087
5088# use of NR_CPUS is usually wrong
5089# ignore definitions of NR_CPUS and usage to define arrays as likely right
5090 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005091 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5092 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005093 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5094 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5095 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005096 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005097 WARN("NR_CPUS",
5098 "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 -07005099 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005100
Joe Perches52ea8502013-11-12 15:10:09 -08005101# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5102 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5103 ERROR("DEFINE_ARCH_HAS",
5104 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5105 }
5106
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005107# check for %L{u,d,i} in strings
5108 my $string;
5109 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5110 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07005111 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005112 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005113 WARN("PRINTF_L",
5114 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005115 last;
5116 }
5117 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005118
5119# whine mightly about in_atomic
5120 if ($line =~ /\bin_atomic\s*\(/) {
5121 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005122 ERROR("IN_ATOMIC",
5123 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005124 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005125 WARN("IN_ATOMIC",
5126 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005127 }
5128 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005129
5130# check for lockdep_set_novalidate_class
5131 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5132 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5133 if ($realfile !~ m@^kernel/lockdep@ &&
5134 $realfile !~ m@^include/linux/lockdep@ &&
5135 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005136 ERROR("LOCKDEP",
5137 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005138 }
5139 }
Dave Jones88f88312011-01-12 16:59:59 -08005140
5141 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5142 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005143 WARN("EXPORTED_WORLD_WRITABLE",
5144 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005145 }
Joe Perches24358802014-04-03 14:49:13 -07005146
Joe Perches515a2352014-04-03 14:49:24 -07005147# Mode permission misuses where it seems decimal should be octal
5148# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5149 if ($^V && $^V ge 5.10.0 &&
5150 $line =~ /$mode_perms_search/) {
5151 foreach my $entry (@mode_permission_funcs) {
5152 my $func = $entry->[0];
5153 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005154
Joe Perches515a2352014-04-03 14:49:24 -07005155 my $skip_args = "";
5156 if ($arg_pos > 1) {
5157 $arg_pos--;
5158 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5159 }
5160 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5161 if ($line =~ /$test/) {
5162 my $val = $1;
5163 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005164
Joe Perches515a2352014-04-03 14:49:24 -07005165 if ($val !~ /^0$/ &&
5166 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5167 length($val) ne 4)) {
5168 ERROR("NON_OCTAL_PERMISSIONS",
5169 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5170 }
Joe Perches24358802014-04-03 14:49:13 -07005171 }
5172 }
5173 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005174 }
5175
5176 # If we have no input at all, then there is nothing to report on
5177 # so just keep quiet.
5178 if ($#rawlines == -1) {
5179 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005180 }
5181
Andy Whitcroft8905a672007-11-28 16:21:06 -08005182 # In mailback mode only produce a report in the negative, for
5183 # things that appear to be patches.
5184 if ($mailback && ($clean == 1 || !$is_patch)) {
5185 exit(0);
5186 }
5187
5188 # This is not a patch, and we are are in 'no-patch' mode so
5189 # just keep quiet.
5190 if (!$chk_patch && !$is_patch) {
5191 exit(0);
5192 }
5193
5194 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005195 ERROR("NOT_UNIFIED_DIFF",
5196 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005197 }
5198 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005199 ERROR("MISSING_SIGN_OFF",
5200 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005201 }
5202
Andy Whitcroft8905a672007-11-28 16:21:06 -08005203 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005204 if ($summary && !($clean == 1 && $quiet == 1)) {
5205 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005206 print "total: $cnt_error errors, $cnt_warn warnings, " .
5207 (($check)? "$cnt_chk checks, " : "") .
5208 "$cnt_lines lines checked\n";
5209 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005210 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005211
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005212 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005213
5214 if ($^V lt 5.10.0) {
5215 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5216 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5217 }
5218
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005219 # If there were whitespace errors which cleanpatch can fix
5220 # then suggest that.
5221 if ($rpt_cleaners) {
5222 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5223 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005224 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005225 }
5226 }
5227
Joe Perches91bfe482013-09-11 14:23:59 -07005228 hash_show_words(\%use_type, "Used");
5229 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005230
Joe Perchesd752fcc2014-08-06 16:11:05 -07005231 if ($clean == 0 && $fix &&
5232 ("@rawlines" ne "@fixed" ||
5233 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005234 my $newfile = $filename;
5235 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005236 my $linecount = 0;
5237 my $f;
5238
Joe Perchesd752fcc2014-08-06 16:11:05 -07005239 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5240
Joe Perches3705ce52013-07-03 15:05:31 -07005241 open($f, '>', $newfile)
5242 or die "$P: Can't open $newfile for write\n";
5243 foreach my $fixed_line (@fixed) {
5244 $linecount++;
5245 if ($file) {
5246 if ($linecount > 3) {
5247 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005248 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005249 }
5250 } else {
5251 print $f $fixed_line . "\n";
5252 }
5253 }
5254 close($f);
5255
5256 if (!$quiet) {
5257 print << "EOM";
5258Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5259
5260Do _NOT_ trust the results written to this file.
5261Do _NOT_ submit these changes without inspecting them for correctness.
5262
5263This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5264No warranties, expressed or implied...
5265
5266EOM
5267 }
5268 }
5269
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005270 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005271 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005272 }
5273 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005274 print << "EOM";
5275$vname has style problems, please review.
5276
5277If any of these errors are false positives, please report
5278them to the maintainer, see CHECKPATCH in MAINTAINERS.
5279EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005280 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005281
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005282 return $clean;
5283}