blob: 4d08b398411fdec9b6707b4cd0db2fd73f1b13fa [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070027my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $summary = 1;
29my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080030my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070031my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070032my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080033my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070034my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080035my %debug;
Joe Perches34456862013-07-03 15:05:34 -070036my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070037my %use_type = ();
38my @use = ();
39my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070040my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070041my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070042my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080043my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070044my $ignore_perl_version = 0;
45my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070046
47sub help {
48 my ($exitcode) = @_;
49
50 print << "EOM";
51Usage: $P [OPTION]... [FILE]...
52Version: $V
53
54Options:
55 -q, --quiet quiet
56 --no-tree run without a kernel tree
57 --no-signoff do not check for 'Signed-off-by' line
58 --patch treat FILE as patchfile (default)
59 --emacs emacs compile window format
60 --terse one line per report
61 -f, --file treat FILE as regular source file
62 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070063 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070064 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080065 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070066 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070067 --root=PATH PATH to the kernel tree root
68 --no-summary suppress the per-file summary
69 --mailback only produce a report in case of warnings/errors
70 --summary-file include the filename in summary
71 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
72 'values', 'possible', 'type', and 'attr' (default
73 is all off)
74 --test-only=WORD report only warnings/errors containing WORD
75 literally
Joe Perches3705ce52013-07-03 15:05:31 -070076 --fix EXPERIMENTAL - may create horrible results
77 If correctable single-line errors exist, create
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080081 --fix-inplace EXPERIMENTAL - may create horrible results
82 Is the same as --fix, but overwrites the input
83 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070084 --ignore-perl-version override checking of perl version. expect
85 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070086 -h, --help, --version display this help and exit
87
88When FILE is - read standard input.
89EOM
90
91 exit($exitcode);
92}
93
Joe Perches000d1cc12011-07-25 17:13:25 -070094my $conf = which_conf($configuration_file);
95if (-f $conf) {
96 my @conf_args;
97 open(my $conffile, '<', "$conf")
98 or warn "$P: Can't find a readable $configuration_file file $!\n";
99
100 while (<$conffile>) {
101 my $line = $_;
102
103 $line =~ s/\s*\n?$//g;
104 $line =~ s/^\s*//g;
105 $line =~ s/\s+/ /g;
106
107 next if ($line =~ m/^\s*#/);
108 next if ($line =~ m/^\s*$/);
109
110 my @words = split(" ", $line);
111 foreach my $word (@words) {
112 last if ($word =~ m/^#/);
113 push (@conf_args, $word);
114 }
115 }
116 close($conffile);
117 unshift(@ARGV, @conf_args) if @conf_args;
118}
119
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700120GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700122 'tree!' => \$tree,
123 'signoff!' => \$chk_signoff,
124 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700125 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800126 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700127 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700128 'subjective!' => \$check,
129 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700130 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700131 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700132 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800133 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700134 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800135 'summary!' => \$summary,
136 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800137 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700138 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800139 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700140 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800141 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700142 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700143 'h|help' => \$help,
144 'version' => \$help
145) or help(1);
146
147help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700148
Joe Perches9624b8d2014-01-23 15:54:44 -0800149$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700150$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800151
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700152my $exit = 0;
153
Dave Hansend62a2012013-09-11 14:23:56 -0700154if ($^V && $^V lt $minimum_perl_version) {
155 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
156 if (!$ignore_perl_version) {
157 exit(1);
158 }
159}
160
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700161if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700162 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700163 exit(1);
164}
165
Joe Perches91bfe482013-09-11 14:23:59 -0700166sub hash_save_array_words {
167 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700168
Joe Perches91bfe482013-09-11 14:23:59 -0700169 my @array = split(/,/, join(',', @$arrayRef));
170 foreach my $word (@array) {
171 $word =~ s/\s*\n?$//g;
172 $word =~ s/^\s*//g;
173 $word =~ s/\s+/ /g;
174 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700175
Joe Perches91bfe482013-09-11 14:23:59 -0700176 next if ($word =~ m/^\s*#/);
177 next if ($word =~ m/^\s*$/);
178
179 $hashRef->{$word}++;
180 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700181}
182
Joe Perches91bfe482013-09-11 14:23:59 -0700183sub hash_show_words {
184 my ($hashRef, $prefix) = @_;
185
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700188 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700189 print " $word";
190 }
191 print "\n\n";
192 }
193}
194
195hash_save_array_words(\%ignore_type, \@ignore);
196hash_save_array_words(\%use_type, \@use);
197
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800198my $dbg_values = 0;
199my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700200my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700201my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800202for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800203 ## no critic
204 eval "\${dbg_$key} = '$debug{$key}';";
205 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206}
207
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700208my $rpt_cleaners = 0;
209
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210if ($terse) {
211 $emacs = 1;
212 $quiet++;
213}
214
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700215if ($tree) {
216 if (defined $root) {
217 if (!top_of_kernel_tree($root)) {
218 die "$P: $root: --root does not point at a valid tree\n";
219 }
220 } else {
221 if (top_of_kernel_tree('.')) {
222 $root = '.';
223 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
224 top_of_kernel_tree($1)) {
225 $root = $1;
226 }
227 }
228
229 if (!defined $root) {
230 print "Must be run from the top-level dir. of a kernel tree\n";
231 exit(2);
232 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700233}
234
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235my $emitted_corrupt = 0;
236
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700237our $Ident = qr{
238 [A-Za-z_][A-Za-z\d_]*
239 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
240 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700241our $Storage = qr{extern|static|asmlinkage};
242our $Sparse = qr{
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800249 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700250 __ref|
251 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700252 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800253our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
254our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
255our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
256our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
257our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700258
Wolfram Sang52131292010-03-05 13:43:51 -0800259# Notes to $Attribute:
260# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700261our $Attribute = qr{
262 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277 __read_mostly|
278 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700279 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800282 ____cacheline_internodealigned_in_smp|
283 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700285our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700286our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700287our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
288our $Lval = qr{$Ident(?:$Member)*};
289
Joe Perches95e2c602013-07-03 15:05:20 -0700290our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
291our $Binary = qr{(?i)0b[01]+$Int_type?};
292our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
293our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700294our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800295our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
296our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
297our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800298our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700299our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800300our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700301our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700302our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303our $Operators = qr{
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700306 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700307 }x;
308
Joe Perches91cb5192014-04-03 14:49:32 -0700309our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
310
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700312our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700313our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800314our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700315our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800316our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700317our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800318
Joe Perches15662b32011-10-31 17:13:12 -0700319our $NON_ASCII_UTF8 = qr{
320 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700321 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
322 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
323 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
324 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
325 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
326 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
327}x;
328
Joe Perches15662b32011-10-31 17:13:12 -0700329our $UTF8 = qr{
330 [\x09\x0A\x0D\x20-\x7E] # ASCII
331 | $NON_ASCII_UTF8
332}x;
333
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700334our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700335 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700336 atomic_t
337)};
338
Joe Perches691e6692010-03-05 13:43:51 -0800339our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700340 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700341 (?:[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 -0700342 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700343 panic|
Joe Perches06668722013-11-12 15:10:07 -0800344 MODULE_[A-Z_]+|
345 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800346)};
347
Joe Perches20112472011-07-25 17:13:23 -0700348our $signature_tags = qr{(?xi:
349 Signed-off-by:|
350 Acked-by:|
351 Tested-by:|
352 Reviewed-by:|
353 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700354 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700355 To:|
356 Cc:
357)};
358
Joe Perches18130872014-08-06 16:11:22 -0700359our @typeListMisordered = (
360 qr{char\s+(?:un)?signed},
361 qr{int\s+(?:(?:un)?signed\s+)?short\s},
362 qr{int\s+short(?:\s+(?:un)?signed)},
363 qr{short\s+int(?:\s+(?:un)?signed)},
364 qr{(?:un)?signed\s+int\s+short},
365 qr{short\s+(?:un)?signed},
366 qr{long\s+int\s+(?:un)?signed},
367 qr{int\s+long\s+(?:un)?signed},
368 qr{long\s+(?:un)?signed\s+int},
369 qr{int\s+(?:un)?signed\s+long},
370 qr{int\s+(?:un)?signed},
371 qr{int\s+long\s+long\s+(?:un)?signed},
372 qr{long\s+long\s+int\s+(?:un)?signed},
373 qr{long\s+long\s+(?:un)?signed\s+int},
374 qr{long\s+long\s+(?:un)?signed},
375 qr{long\s+(?:un)?signed},
376);
377
Andy Whitcroft8905a672007-11-28 16:21:06 -0800378our @typeList = (
379 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700380 qr{(?:(?:un)?signed\s+)?char},
381 qr{(?:(?:un)?signed\s+)?short\s+int},
382 qr{(?:(?:un)?signed\s+)?short},
383 qr{(?:(?:un)?signed\s+)?int},
384 qr{(?:(?:un)?signed\s+)?long\s+int},
385 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
386 qr{(?:(?:un)?signed\s+)?long\s+long},
387 qr{(?:(?:un)?signed\s+)?long},
388 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389 qr{float},
390 qr{double},
391 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392 qr{struct\s+$Ident},
393 qr{union\s+$Ident},
394 qr{enum\s+$Ident},
395 qr{${Ident}_t},
396 qr{${Ident}_handler},
397 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700398 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800399);
Joe Perches8716de32013-09-11 14:24:05 -0700400our @typeListWithAttr = (
401 @typeList,
402 qr{struct\s+$InitAttribute\s+$Ident},
403 qr{union\s+$InitAttribute\s+$Ident},
404);
405
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700406our @modifierList = (
407 qr{fastcall},
408);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800409
Joe Perches24358802014-04-03 14:49:13 -0700410our @mode_permission_funcs = (
411 ["module_param", 3],
412 ["module_param_(?:array|named|string)", 4],
413 ["module_param_array_named", 5],
414 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
415 ["proc_create(?:_data|)", 2],
416 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
417);
418
Joe Perches515a2352014-04-03 14:49:24 -0700419#Create a search pattern for all these functions to speed up a loop below
420our $mode_perms_search = "";
421foreach my $entry (@mode_permission_funcs) {
422 $mode_perms_search .= '|' if ($mode_perms_search ne "");
423 $mode_perms_search .= $entry->[0];
424}
425
Wolfram Sang7840a942010-08-09 17:20:57 -0700426our $allowed_asm_includes = qr{(?x:
427 irq|
428 memory
429)};
430# memory.h: ARM has a custom one
431
Andy Whitcroft8905a672007-11-28 16:21:06 -0800432sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700433 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
434 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700435 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700436 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700437 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700439 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800440 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800441 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700442 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700443 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800444 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700445 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800446 }x;
Joe Perches18130872014-08-06 16:11:22 -0700447 $NonptrTypeMisordered = qr{
448 (?:$Modifier\s+|const\s+)*
449 (?:
450 (?:${Misordered}\b)
451 )
452 (?:\s+$Modifier|\s+const)*
453 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700454 $NonptrTypeWithAttr = qr{
455 (?:$Modifier\s+|const\s+)*
456 (?:
457 (?:typeof|__typeof__)\s*\([^\)]*\)|
458 (?:$typeTypedefs\b)|
459 (?:${allWithAttr}\b)
460 )
461 (?:\s+$Modifier|\s+const)*
462 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800463 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700464 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700465 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700466 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800467 }x;
Joe Perches18130872014-08-06 16:11:22 -0700468 $TypeMisordered = qr{
469 $NonptrTypeMisordered
470 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
471 (?:\s+$Inline|\s+$Modifier)*
472 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700473 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700474 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475}
476build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700477
Joe Perches7d2367a2011-07-25 17:13:22 -0700478our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700479
480# Using $balanced_parens, $LvalOrFunc, or $FuncArg
481# requires at least perl version v5.10.0
482# Any use must be runtime checked with $^V
483
484our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700485our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800486our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700487
Joe Perchesf8422302014-08-06 16:11:31 -0700488our $declaration_macros = qr{(?x:
489 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,2}\s*\(|
490 (?:$Storage\s+)?LIST_HEAD\s*\(|
491 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
492)};
493
Joe Perches7d2367a2011-07-25 17:13:22 -0700494sub deparenthesize {
495 my ($string) = @_;
496 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700497
498 while ($string =~ /^\s*\(.*\)\s*$/) {
499 $string =~ s@^\s*\(\s*@@;
500 $string =~ s@\s*\)\s*$@@;
501 }
502
Joe Perches7d2367a2011-07-25 17:13:22 -0700503 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700504
Joe Perches7d2367a2011-07-25 17:13:22 -0700505 return $string;
506}
507
Joe Perches34456862013-07-03 15:05:34 -0700508sub seed_camelcase_file {
509 my ($file) = @_;
510
511 return if (!(-f $file));
512
513 local $/;
514
515 open(my $include_file, '<', "$file")
516 or warn "$P: Can't read '$file' $!\n";
517 my $text = <$include_file>;
518 close($include_file);
519
520 my @lines = split('\n', $text);
521
522 foreach my $line (@lines) {
523 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
524 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
525 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800526 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
527 $camelcase{$1} = 1;
528 } 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 -0700529 $camelcase{$1} = 1;
530 }
531 }
532}
533
534my $camelcase_seeded = 0;
535sub seed_camelcase_includes {
536 return if ($camelcase_seeded);
537
538 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700539 my $camelcase_cache = "";
540 my @include_files = ();
541
542 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700543
Richard Genoud3645e322014-02-10 14:25:32 -0800544 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700545 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
546 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700547 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700548 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700549 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700550 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700551 @include_files = split('\n', $files);
552 foreach my $file (@include_files) {
553 my $date = POSIX::strftime("%Y%m%d%H%M",
554 localtime((stat $file)[9]));
555 $last_mod_date = $date if ($last_mod_date < $date);
556 }
557 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700558 }
Joe Perchesc707a812013-07-08 16:00:43 -0700559
560 if ($camelcase_cache ne "" && -f $camelcase_cache) {
561 open(my $camelcase_file, '<', "$camelcase_cache")
562 or warn "$P: Can't read '$camelcase_cache' $!\n";
563 while (<$camelcase_file>) {
564 chomp;
565 $camelcase{$_} = 1;
566 }
567 close($camelcase_file);
568
569 return;
570 }
571
Richard Genoud3645e322014-02-10 14:25:32 -0800572 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700573 $files = `git ls-files "include/*.h"`;
574 @include_files = split('\n', $files);
575 }
576
Joe Perches34456862013-07-03 15:05:34 -0700577 foreach my $file (@include_files) {
578 seed_camelcase_file($file);
579 }
Joe Perches351b2a12013-07-03 15:05:36 -0700580
Joe Perchesc707a812013-07-08 16:00:43 -0700581 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700582 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700583 open(my $camelcase_file, '>', "$camelcase_cache")
584 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700585 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
586 print $camelcase_file ("$_\n");
587 }
588 close($camelcase_file);
589 }
Joe Perches34456862013-07-03 15:05:34 -0700590}
591
Joe Perchesd311cd42014-08-06 16:10:57 -0700592sub git_commit_info {
593 my ($commit, $id, $desc) = @_;
594
595 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
596
597 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
598 $output =~ s/^\s*//gm;
599 my @lines = split("\n", $output);
600
601 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
602# Maybe one day convert this block of bash into something that returns
603# all matching commit ids, but it's very slow...
604#
605# echo "checking commits $1..."
606# git rev-list --remotes | grep -i "^$1" |
607# while read line ; do
608# git log --format='%H %s' -1 $line |
609# echo "commit $(cut -c 1-12,41-)"
610# done
611 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
612 } else {
613 $id = substr($lines[0], 0, 12);
614 $desc = substr($lines[0], 41);
615 }
616
617 return ($id, $desc);
618}
619
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700620$chk_signoff = 0 if ($file);
621
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700622my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800623my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700624my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700625my @fixed_inserted = ();
626my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700627my $fixlinenr = -1;
628
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800629my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700630for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800631 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700632 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800633 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700634 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800635 } elsif ($filename eq '-') {
636 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700637 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800638 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700639 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700640 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800641 if ($filename eq '-') {
642 $vname = 'Your patch';
643 } else {
644 $vname = $filename;
645 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800646 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700647 chomp;
648 push(@rawlines, $_);
649 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800650 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800651 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700652 $exit = 1;
653 }
654 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800655 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700656 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700657 @fixed_inserted = ();
658 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700659 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700660}
661
662exit($exit);
663
664sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700665 my ($root) = @_;
666
667 my @tree_check = (
668 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
669 "README", "Documentation", "arch", "include", "drivers",
670 "fs", "init", "ipc", "kernel", "lib", "scripts",
671 );
672
673 foreach my $check (@tree_check) {
674 if (! -e $root . '/' . $check) {
675 return 0;
676 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700677 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700678 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700679}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700680
Joe Perches20112472011-07-25 17:13:23 -0700681sub parse_email {
682 my ($formatted_email) = @_;
683
684 my $name = "";
685 my $address = "";
686 my $comment = "";
687
688 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
689 $name = $1;
690 $address = $2;
691 $comment = $3 if defined $3;
692 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
693 $address = $1;
694 $comment = $2 if defined $2;
695 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
696 $address = $1;
697 $comment = $2 if defined $2;
698 $formatted_email =~ s/$address.*$//;
699 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700700 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700701 $name =~ s/^\"|\"$//g;
702 # If there's a name left after stripping spaces and
703 # leading quotes, and the address doesn't have both
704 # leading and trailing angle brackets, the address
705 # is invalid. ie:
706 # "joe smith joe@smith.com" bad
707 # "joe smith <joe@smith.com" bad
708 if ($name ne "" && $address !~ /^<[^>]+>$/) {
709 $name = "";
710 $address = "";
711 $comment = "";
712 }
713 }
714
Joe Perches3705ce52013-07-03 15:05:31 -0700715 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700716 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700717 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700718 $address =~ s/^\<|\>$//g;
719
720 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
721 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
722 $name = "\"$name\"";
723 }
724
725 return ($name, $address, $comment);
726}
727
728sub format_email {
729 my ($name, $address) = @_;
730
731 my $formatted_email;
732
Joe Perches3705ce52013-07-03 15:05:31 -0700733 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700734 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700735 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700736
737 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
738 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
739 $name = "\"$name\"";
740 }
741
742 if ("$name" eq "") {
743 $formatted_email = "$address";
744 } else {
745 $formatted_email = "$name <$address>";
746 }
747
748 return $formatted_email;
749}
750
Joe Perchesd311cd42014-08-06 16:10:57 -0700751sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700752 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700753
Joe Perchesbd474ca2014-08-06 16:11:10 -0700754 foreach my $path (split(/:/, $ENV{PATH})) {
755 if (-e "$path/$bin") {
756 return "$path/$bin";
757 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700758 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700759
Joe Perchesbd474ca2014-08-06 16:11:10 -0700760 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700761}
762
Joe Perches000d1cc12011-07-25 17:13:25 -0700763sub which_conf {
764 my ($conf) = @_;
765
766 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
767 if (-e "$path/$conf") {
768 return "$path/$conf";
769 }
770 }
771
772 return "";
773}
774
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700775sub expand_tabs {
776 my ($str) = @_;
777
778 my $res = '';
779 my $n = 0;
780 for my $c (split(//, $str)) {
781 if ($c eq "\t") {
782 $res .= ' ';
783 $n++;
784 for (; ($n % 8) != 0; $n++) {
785 $res .= ' ';
786 }
787 next;
788 }
789 $res .= $c;
790 $n++;
791 }
792
793 return $res;
794}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700796 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700797 return $res;
798}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700799
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700800sub line_stats {
801 my ($line) = @_;
802
803 # Drop the diff line leader and expand tabs
804 $line =~ s/^.//;
805 $line = expand_tabs($line);
806
807 # Pick the indent from the front of the line.
808 my ($white) = ($line =~ /^(\s*)/);
809
810 return (length($line), length($white));
811}
812
Andy Whitcroft773647a2008-03-28 14:15:58 -0700813my $sanitise_quote = '';
814
815sub sanitise_line_reset {
816 my ($in_comment) = @_;
817
818 if ($in_comment) {
819 $sanitise_quote = '*/';
820 } else {
821 $sanitise_quote = '';
822 }
823}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700824sub sanitise_line {
825 my ($line) = @_;
826
827 my $res = '';
828 my $l = '';
829
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800830 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700831 my $off = 0;
832 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700833
Andy Whitcroft773647a2008-03-28 14:15:58 -0700834 # Always copy over the diff marker.
835 $res = substr($line, 0, 1);
836
837 for ($off = 1; $off < length($line); $off++) {
838 $c = substr($line, $off, 1);
839
840 # Comments we are wacking completly including the begin
841 # and end, all to $;.
842 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
843 $sanitise_quote = '*/';
844
845 substr($res, $off, 2, "$;$;");
846 $off++;
847 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800848 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700849 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700850 $sanitise_quote = '';
851 substr($res, $off, 2, "$;$;");
852 $off++;
853 next;
854 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700855 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
856 $sanitise_quote = '//';
857
858 substr($res, $off, 2, $sanitise_quote);
859 $off++;
860 next;
861 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700862
863 # A \ in a string means ignore the next character.
864 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
865 $c eq "\\") {
866 substr($res, $off, 2, 'XX');
867 $off++;
868 next;
869 }
870 # Regular quotes.
871 if ($c eq "'" || $c eq '"') {
872 if ($sanitise_quote eq '') {
873 $sanitise_quote = $c;
874
875 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700876 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700877 } elsif ($sanitise_quote eq $c) {
878 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700879 }
880 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700881
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800882 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700883 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
884 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700885 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
886 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700887 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
888 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700889 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700890 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700891 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800892 }
893
Daniel Walker113f04a2009-09-21 17:04:35 -0700894 if ($sanitise_quote eq '//') {
895 $sanitise_quote = '';
896 }
897
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800898 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700899 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800900 my $clean = 'X' x length($1);
901 $res =~ s@\<.*\>@<$clean>@;
902
903 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700904 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800905 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700906 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907 }
908
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700909 return $res;
910}
911
Joe Perchesa6962d72013-04-29 16:18:13 -0700912sub get_quoted_string {
913 my ($line, $rawline) = @_;
914
915 return "" if ($line !~ m/(\"[X]+\")/g);
916 return substr($rawline, $-[0], $+[0] - $-[0]);
917}
918
Andy Whitcroft8905a672007-11-28 16:21:06 -0800919sub ctx_statement_block {
920 my ($linenr, $remain, $off) = @_;
921 my $line = $linenr - 1;
922 my $blk = '';
923 my $soff = $off;
924 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700925 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800926
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800927 my $loff = 0;
928
Andy Whitcroft8905a672007-11-28 16:21:06 -0800929 my $type = '';
930 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800931 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800932 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800933 my $c;
934 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800935
936 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800937 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800938 @stack = (['', 0]) if ($#stack == -1);
939
Andy Whitcroft773647a2008-03-28 14:15:58 -0700940 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800941 # If we are about to drop off the end, pull in more
942 # context.
943 if ($off >= $len) {
944 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700945 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800946 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800947 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800948 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800949 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800950 $len = length($blk);
951 $line++;
952 last;
953 }
954 # Bail if there is no further context.
955 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800956 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800957 last;
958 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800959 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
960 $level++;
961 $type = '#';
962 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800963 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800964 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800965 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800966 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800967
Andy Whitcroft773647a2008-03-28 14:15:58 -0700968 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800969
970 # Handle nested #if/#else.
971 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
972 push(@stack, [ $type, $level ]);
973 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
974 ($type, $level) = @{$stack[$#stack - 1]};
975 } elsif ($remainder =~ /^#\s*endif\b/) {
976 ($type, $level) = @{pop(@stack)};
977 }
978
Andy Whitcroft8905a672007-11-28 16:21:06 -0800979 # Statement ends at the ';' or a close '}' at the
980 # outermost level.
981 if ($level == 0 && $c eq ';') {
982 last;
983 }
984
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800985 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700986 if ($level == 0 && $coff_set == 0 &&
987 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
988 $remainder =~ /^(else)(?:\s|{)/ &&
989 $remainder !~ /^else\s+if\b/) {
990 $coff = $off + length($1) - 1;
991 $coff_set = 1;
992 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
993 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800994 }
995
Andy Whitcroft8905a672007-11-28 16:21:06 -0800996 if (($type eq '' || $type eq '(') && $c eq '(') {
997 $level++;
998 $type = '(';
999 }
1000 if ($type eq '(' && $c eq ')') {
1001 $level--;
1002 $type = ($level != 0)? '(' : '';
1003
1004 if ($level == 0 && $coff < $soff) {
1005 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001006 $coff_set = 1;
1007 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001008 }
1009 }
1010 if (($type eq '' || $type eq '{') && $c eq '{') {
1011 $level++;
1012 $type = '{';
1013 }
1014 if ($type eq '{' && $c eq '}') {
1015 $level--;
1016 $type = ($level != 0)? '{' : '';
1017
1018 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001019 if (substr($blk, $off + 1, 1) eq ';') {
1020 $off++;
1021 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001022 last;
1023 }
1024 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001025 # Preprocessor commands end at the newline unless escaped.
1026 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1027 $level--;
1028 $type = '';
1029 $off++;
1030 last;
1031 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001032 $off++;
1033 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001034 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001035 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001036 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001037 $line++;
1038 $remain--;
1039 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001040
1041 my $statement = substr($blk, $soff, $off - $soff + 1);
1042 my $condition = substr($blk, $soff, $coff - $soff + 1);
1043
1044 #warn "STATEMENT<$statement>\n";
1045 #warn "CONDITION<$condition>\n";
1046
Andy Whitcroft773647a2008-03-28 14:15:58 -07001047 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001048
1049 return ($statement, $condition,
1050 $line, $remain + 1, $off - $loff + 1, $level);
1051}
1052
Andy Whitcroftcf655042008-03-04 14:28:20 -08001053sub statement_lines {
1054 my ($stmt) = @_;
1055
1056 # Strip the diff line prefixes and rip blank lines at start and end.
1057 $stmt =~ s/(^|\n)./$1/g;
1058 $stmt =~ s/^\s*//;
1059 $stmt =~ s/\s*$//;
1060
1061 my @stmt_lines = ($stmt =~ /\n/g);
1062
1063 return $#stmt_lines + 2;
1064}
1065
1066sub statement_rawlines {
1067 my ($stmt) = @_;
1068
1069 my @stmt_lines = ($stmt =~ /\n/g);
1070
1071 return $#stmt_lines + 2;
1072}
1073
1074sub statement_block_size {
1075 my ($stmt) = @_;
1076
1077 $stmt =~ s/(^|\n)./$1/g;
1078 $stmt =~ s/^\s*{//;
1079 $stmt =~ s/}\s*$//;
1080 $stmt =~ s/^\s*//;
1081 $stmt =~ s/\s*$//;
1082
1083 my @stmt_lines = ($stmt =~ /\n/g);
1084 my @stmt_statements = ($stmt =~ /;/g);
1085
1086 my $stmt_lines = $#stmt_lines + 2;
1087 my $stmt_statements = $#stmt_statements + 1;
1088
1089 if ($stmt_lines > $stmt_statements) {
1090 return $stmt_lines;
1091 } else {
1092 return $stmt_statements;
1093 }
1094}
1095
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001096sub ctx_statement_full {
1097 my ($linenr, $remain, $off) = @_;
1098 my ($statement, $condition, $level);
1099
1100 my (@chunks);
1101
Andy Whitcroftcf655042008-03-04 14:28:20 -08001102 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001103 ($statement, $condition, $linenr, $remain, $off, $level) =
1104 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001105 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001106 push(@chunks, [ $condition, $statement ]);
1107 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1108 return ($level, $linenr, @chunks);
1109 }
1110
1111 # Pull in the following conditional/block pairs and see if they
1112 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001113 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001114 ($statement, $condition, $linenr, $remain, $off, $level) =
1115 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001116 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001117 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001118 #print "C: push\n";
1119 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001120 }
1121
1122 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001123}
1124
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001125sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001126 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001127 my $line;
1128 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001129 my $blk = '';
1130 my @o;
1131 my @c;
1132 my @res = ();
1133
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001134 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001135 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001136 for ($line = $start; $remain > 0; $line++) {
1137 next if ($rawlines[$line] =~ /^-/);
1138 $remain--;
1139
1140 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001141
1142 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001143 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001144 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001145 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001146 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001147 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001148 $level = pop(@stack);
1149 }
1150
Andy Whitcroft01464f32010-10-26 14:23:19 -07001151 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001152 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1153 if ($off > 0) {
1154 $off--;
1155 next;
1156 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001157
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001158 if ($c eq $close && $level > 0) {
1159 $level--;
1160 last if ($level == 0);
1161 } elsif ($c eq $open) {
1162 $level++;
1163 }
1164 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001165
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001166 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001167 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001168 }
1169
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001170 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001171 }
1172
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001173 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001174}
1175sub ctx_block_outer {
1176 my ($linenr, $remain) = @_;
1177
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001178 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1179 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001180}
1181sub ctx_block {
1182 my ($linenr, $remain) = @_;
1183
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001184 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1185 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001186}
1187sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001188 my ($linenr, $remain, $off) = @_;
1189
1190 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1191 return @r;
1192}
1193sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001194 my ($linenr, $remain) = @_;
1195
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001196 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001197}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001198sub ctx_statement_level {
1199 my ($linenr, $remain, $off) = @_;
1200
1201 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1202}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001203
1204sub ctx_locate_comment {
1205 my ($first_line, $end_line) = @_;
1206
1207 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001208 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001209 return $current_comment if (defined $current_comment);
1210
1211 # Look through the context and try and figure out if there is a
1212 # comment.
1213 my $in_comment = 0;
1214 $current_comment = '';
1215 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001216 my $line = $rawlines[$linenr - 1];
1217 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001218 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1219 $in_comment = 1;
1220 }
1221 if ($line =~ m@/\*@) {
1222 $in_comment = 1;
1223 }
1224 if (!$in_comment && $current_comment ne '') {
1225 $current_comment = '';
1226 }
1227 $current_comment .= $line . "\n" if ($in_comment);
1228 if ($line =~ m@\*/@) {
1229 $in_comment = 0;
1230 }
1231 }
1232
1233 chomp($current_comment);
1234 return($current_comment);
1235}
1236sub ctx_has_comment {
1237 my ($first_line, $end_line) = @_;
1238 my $cmt = ctx_locate_comment($first_line, $end_line);
1239
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001240 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001241 ##print "CMMT: $cmt\n";
1242
1243 return ($cmt ne '');
1244}
1245
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001246sub raw_line {
1247 my ($linenr, $cnt) = @_;
1248
1249 my $offset = $linenr - 1;
1250 $cnt++;
1251
1252 my $line;
1253 while ($cnt) {
1254 $line = $rawlines[$offset++];
1255 next if (defined($line) && $line =~ /^-/);
1256 $cnt--;
1257 }
1258
1259 return $line;
1260}
1261
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001262sub cat_vet {
1263 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001264 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001265
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001266 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001267 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1268 $res .= $1;
1269 if ($2 ne '') {
1270 $coded = sprintf("^%c", unpack('C', $2) + 64);
1271 $res .= $coded;
1272 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001273 }
1274 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001275
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001276 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001277}
1278
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001279my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001280my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001281my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001282my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001283
1284sub annotate_reset {
1285 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001286 $av_pending = '_';
1287 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001288 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001289}
1290
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001291sub annotate_values {
1292 my ($stream, $type) = @_;
1293
1294 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001295 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001296 my $cur = $stream;
1297
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001298 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001299
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001300 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001301 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001302 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001303 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001304 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001305 print "WS($1)\n" if ($dbg_values > 1);
1306 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001307 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001308 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001309 }
1310
Florian Micklerc023e4732011-01-12 16:59:58 -08001311 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001312 print "CAST($1)\n" if ($dbg_values > 1);
1313 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001314 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001315
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001316 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001317 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001318 $type = 'T';
1319
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001320 } elsif ($cur =~ /^($Modifier)\s*/) {
1321 print "MODIFIER($1)\n" if ($dbg_values > 1);
1322 $type = 'T';
1323
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001324 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001325 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001326 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001327 push(@av_paren_type, $type);
1328 if ($2 ne '') {
1329 $av_pending = 'N';
1330 }
1331 $type = 'E';
1332
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001333 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001334 print "UNDEF($1)\n" if ($dbg_values > 1);
1335 $av_preprocessor = 1;
1336 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001337
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001338 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001339 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001340 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001341
1342 push(@av_paren_type, $type);
1343 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001344 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001345
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001346 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001347 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1348 $av_preprocessor = 1;
1349
1350 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1351
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001352 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001353
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001354 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001355 print "PRE_END($1)\n" if ($dbg_values > 1);
1356
1357 $av_preprocessor = 1;
1358
1359 # Assume all arms of the conditional end as this
1360 # one does, and continue as if the #endif was not here.
1361 pop(@av_paren_type);
1362 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001363 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001364
1365 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001366 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001367
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001368 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1369 print "ATTR($1)\n" if ($dbg_values > 1);
1370 $av_pending = $type;
1371 $type = 'N';
1372
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001373 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001375 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001376 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001377 }
1378 $type = 'N';
1379
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001380 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001381 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001382 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001383 $type = 'N';
1384
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001385 } elsif ($cur =~/^(case)/o) {
1386 print "CASE($1)\n" if ($dbg_values > 1);
1387 $av_pend_colon = 'C';
1388 $type = 'N';
1389
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001390 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001391 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001392 $type = 'N';
1393
1394 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001395 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001396 push(@av_paren_type, $av_pending);
1397 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001398 $type = 'N';
1399
1400 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001401 my $new_type = pop(@av_paren_type);
1402 if ($new_type ne '_') {
1403 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001404 print "PAREN('$1') -> $type\n"
1405 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001406 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001407 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001408 }
1409
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001410 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001411 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001412 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001413 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001414
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001415 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1416 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001417 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001418 } elsif ($type eq 'E') {
1419 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001420 }
1421 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1422 $type = 'V';
1423
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001424 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001425 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001426 $type = 'V';
1427
1428 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001429 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001430 $type = 'N';
1431
Andy Whitcroftcf655042008-03-04 14:28:20 -08001432 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001433 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001434 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001435 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001436
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001437 } elsif ($cur =~/^(,)/) {
1438 print "COMMA($1)\n" if ($dbg_values > 1);
1439 $type = 'C';
1440
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001441 } elsif ($cur =~ /^(\?)/o) {
1442 print "QUESTION($1)\n" if ($dbg_values > 1);
1443 $type = 'N';
1444
1445 } elsif ($cur =~ /^(:)/o) {
1446 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1447
1448 substr($var, length($res), 1, $av_pend_colon);
1449 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1450 $type = 'E';
1451 } else {
1452 $type = 'N';
1453 }
1454 $av_pend_colon = 'O';
1455
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001456 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001457 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001458 $type = 'N';
1459
Andy Whitcroft0d413862008-10-15 22:02:16 -07001460 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001461 my $variant;
1462
1463 print "OPV($1)\n" if ($dbg_values > 1);
1464 if ($type eq 'V') {
1465 $variant = 'B';
1466 } else {
1467 $variant = 'U';
1468 }
1469
1470 substr($var, length($res), 1, $variant);
1471 $type = 'N';
1472
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001473 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001474 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001475 if ($1 ne '++' && $1 ne '--') {
1476 $type = 'N';
1477 }
1478
1479 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001480 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001481 }
1482 if (defined $1) {
1483 $cur = substr($cur, length($1));
1484 $res .= $type x length($1);
1485 }
1486 }
1487
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001488 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001489}
1490
Andy Whitcroft8905a672007-11-28 16:21:06 -08001491sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001492 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001493 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001494 ^(?:
1495 $Modifier|
1496 $Storage|
1497 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001498 DEFINE_\S+
1499 )$|
1500 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001501 goto|
1502 return|
1503 case|
1504 else|
1505 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001506 do|
1507 \#|
1508 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001509 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001510 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001511 )}x;
1512 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1513 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001514 # Check for modifiers.
1515 $possible =~ s/\s*$Storage\s*//g;
1516 $possible =~ s/\s*$Sparse\s*//g;
1517 if ($possible =~ /^\s*$/) {
1518
1519 } elsif ($possible =~ /\s/) {
1520 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001521 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001522 if ($modifier !~ $notPermitted) {
1523 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1524 push(@modifierList, $modifier);
1525 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001526 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001527
1528 } else {
1529 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1530 push(@typeList, $possible);
1531 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001532 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001533 } else {
1534 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001535 }
1536}
1537
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001538my $prefix = '';
1539
Joe Perches000d1cc12011-07-25 17:13:25 -07001540sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001541 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001542
Joe Perchescbec18a2014-04-03 14:49:19 -07001543 return defined $use_type{$type} if (scalar keys %use_type > 0);
1544
1545 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001546}
1547
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001548sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001549 my ($level, $type, $msg) = @_;
1550
1551 if (!show_type($type) ||
1552 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001553 return 0;
1554 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001555 my $line;
1556 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001557 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001558 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001559 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001560 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001561 $line = (split('\n', $line))[0] . "\n" if ($terse);
1562
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001563 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001564
1565 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001566}
Joe Perchescbec18a2014-04-03 14:49:19 -07001567
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001568sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001569 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001570}
Joe Perches000d1cc12011-07-25 17:13:25 -07001571
Joe Perchesd752fcc2014-08-06 16:11:05 -07001572sub fixup_current_range {
1573 my ($lineRef, $offset, $length) = @_;
1574
1575 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1576 my $o = $1;
1577 my $l = $2;
1578 my $no = $o + $offset;
1579 my $nl = $l + $length;
1580 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1581 }
1582}
1583
1584sub fix_inserted_deleted_lines {
1585 my ($linesRef, $insertedRef, $deletedRef) = @_;
1586
1587 my $range_last_linenr = 0;
1588 my $delta_offset = 0;
1589
1590 my $old_linenr = 0;
1591 my $new_linenr = 0;
1592
1593 my $next_insert = 0;
1594 my $next_delete = 0;
1595
1596 my @lines = ();
1597
1598 my $inserted = @{$insertedRef}[$next_insert++];
1599 my $deleted = @{$deletedRef}[$next_delete++];
1600
1601 foreach my $old_line (@{$linesRef}) {
1602 my $save_line = 1;
1603 my $line = $old_line; #don't modify the array
1604 if ($line =~ /^(?:\+\+\+\|\-\-\-)\s+\S+/) { #new filename
1605 $delta_offset = 0;
1606 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1607 $range_last_linenr = $new_linenr;
1608 fixup_current_range(\$line, $delta_offset, 0);
1609 }
1610
1611 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1612 $deleted = @{$deletedRef}[$next_delete++];
1613 $save_line = 0;
1614 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1615 }
1616
1617 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1618 push(@lines, ${$inserted}{'LINE'});
1619 $inserted = @{$insertedRef}[$next_insert++];
1620 $new_linenr++;
1621 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1622 }
1623
1624 if ($save_line) {
1625 push(@lines, $line);
1626 $new_linenr++;
1627 }
1628
1629 $old_linenr++;
1630 }
1631
1632 return @lines;
1633}
1634
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001635sub fix_insert_line {
1636 my ($linenr, $line) = @_;
1637
1638 my $inserted = {
1639 LINENR => $linenr,
1640 LINE => $line,
1641 };
1642 push(@fixed_inserted, $inserted);
1643}
1644
1645sub fix_delete_line {
1646 my ($linenr, $line) = @_;
1647
1648 my $deleted = {
1649 LINENR => $linenr,
1650 LINE => $line,
1651 };
1652
1653 push(@fixed_deleted, $deleted);
1654}
1655
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001656sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001657 my ($type, $msg) = @_;
1658
1659 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001660 our $clean = 0;
1661 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001662 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001663 }
Joe Perches3705ce52013-07-03 15:05:31 -07001664 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001665}
1666sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001667 my ($type, $msg) = @_;
1668
1669 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001670 our $clean = 0;
1671 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001672 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001673 }
Joe Perches3705ce52013-07-03 15:05:31 -07001674 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001675}
1676sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001677 my ($type, $msg) = @_;
1678
1679 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001680 our $clean = 0;
1681 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001682 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001683 }
Joe Perches3705ce52013-07-03 15:05:31 -07001684 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001685}
1686
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001687sub check_absolute_file {
1688 my ($absolute, $herecurr) = @_;
1689 my $file = $absolute;
1690
1691 ##print "absolute<$absolute>\n";
1692
1693 # See if any suffix of this path is a path within the tree.
1694 while ($file =~ s@^[^/]*/@@) {
1695 if (-f "$root/$file") {
1696 ##print "file<$file>\n";
1697 last;
1698 }
1699 }
1700 if (! -f _) {
1701 return 0;
1702 }
1703
1704 # It is, so see if the prefix is acceptable.
1705 my $prefix = $absolute;
1706 substr($prefix, -length($file)) = '';
1707
1708 ##print "prefix<$prefix>\n";
1709 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001710 WARN("USE_RELATIVE_PATH",
1711 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001712 }
1713}
1714
Joe Perches3705ce52013-07-03 15:05:31 -07001715sub trim {
1716 my ($string) = @_;
1717
Joe Perchesb34c6482013-09-11 14:24:01 -07001718 $string =~ s/^\s+|\s+$//g;
1719
1720 return $string;
1721}
1722
1723sub ltrim {
1724 my ($string) = @_;
1725
1726 $string =~ s/^\s+//;
1727
1728 return $string;
1729}
1730
1731sub rtrim {
1732 my ($string) = @_;
1733
1734 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001735
1736 return $string;
1737}
1738
Joe Perches52ea8502013-11-12 15:10:09 -08001739sub string_find_replace {
1740 my ($string, $find, $replace) = @_;
1741
1742 $string =~ s/$find/$replace/g;
1743
1744 return $string;
1745}
1746
Joe Perches3705ce52013-07-03 15:05:31 -07001747sub tabify {
1748 my ($leading) = @_;
1749
1750 my $source_indent = 8;
1751 my $max_spaces_before_tab = $source_indent - 1;
1752 my $spaces_to_tab = " " x $source_indent;
1753
1754 #convert leading spaces to tabs
1755 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1756 #Remove spaces before a tab
1757 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1758
1759 return "$leading";
1760}
1761
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001762sub pos_last_openparen {
1763 my ($line) = @_;
1764
1765 my $pos = 0;
1766
1767 my $opens = $line =~ tr/\(/\(/;
1768 my $closes = $line =~ tr/\)/\)/;
1769
1770 my $last_openparen = 0;
1771
1772 if (($opens == 0) || ($closes >= $opens)) {
1773 return -1;
1774 }
1775
1776 my $len = length($line);
1777
1778 for ($pos = 0; $pos < $len; $pos++) {
1779 my $string = substr($line, $pos);
1780 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1781 $pos += length($1) - 1;
1782 } elsif (substr($line, $pos, 1) eq '(') {
1783 $last_openparen = $pos;
1784 } elsif (index($string, '(') == -1) {
1785 last;
1786 }
1787 }
1788
Joe Perches91cb5192014-04-03 14:49:32 -07001789 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001790}
1791
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001792sub process {
1793 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001794
1795 my $linenr=0;
1796 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001797 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001798 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001799 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001800
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001801 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001802 my $indent;
1803 my $previndent=0;
1804 my $stashindent=0;
1805
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001806 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001807 my $signoff = 0;
1808 my $is_patch = 0;
1809
Joe Perches29ee1b02014-08-06 16:10:35 -07001810 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07001811 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches13f19372014-08-06 16:10:59 -07001812 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001813 my $non_utf8_charset = 0;
1814
Joe Perches365dd4e2014-08-06 16:10:42 -07001815 my $last_blank_line = 0;
1816
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001817 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001818 our $cnt_lines = 0;
1819 our $cnt_error = 0;
1820 our $cnt_warn = 0;
1821 our $cnt_chk = 0;
1822
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001823 # Trace the real file/line as we go.
1824 my $realfile = '';
1825 my $realline = 0;
1826 my $realcnt = 0;
1827 my $here = '';
1828 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001829 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001830 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001831 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001832
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001833 my $prev_values = 'E';
1834
1835 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001836 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001837 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001838 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001839 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001840
Joe Perches7e51f192013-09-11 14:23:57 -07001841 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001842
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001843 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001844 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001845 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001846 my @setup_docs = ();
1847 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001848
Joe Perchesd8b07712013-11-12 15:10:06 -08001849 my $camelcase_file_seeded = 0;
1850
Andy Whitcroft773647a2008-03-28 14:15:58 -07001851 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001852 my $line;
1853 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001854 $linenr++;
1855 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001856
Joe Perches3705ce52013-07-03 15:05:31 -07001857 push(@fixed, $rawline) if ($fix);
1858
Andy Whitcroft773647a2008-03-28 14:15:58 -07001859 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001860 $setup_docs = 0;
1861 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1862 $setup_docs = 1;
1863 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001864 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001865 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001866 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1867 $realline=$1-1;
1868 if (defined $2) {
1869 $realcnt=$3+1;
1870 } else {
1871 $realcnt=1+1;
1872 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001873 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001874
1875 # Guestimate if this is a continuing comment. Run
1876 # the context looking for a comment "edge". If this
1877 # edge is a close comment then we must be in a comment
1878 # at context start.
1879 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001880 my $cnt = $realcnt;
1881 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1882 next if (defined $rawlines[$ln - 1] &&
1883 $rawlines[$ln - 1] =~ /^-/);
1884 $cnt--;
1885 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001886 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001887 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1888 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1889 ($edge) = $1;
1890 last;
1891 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001892 }
1893 if (defined $edge && $edge eq '*/') {
1894 $in_comment = 1;
1895 }
1896
1897 # Guestimate if this is a continuing comment. If this
1898 # is the start of a diff block and this line starts
1899 # ' *' then it is very likely a comment.
1900 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001901 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001902 {
1903 $in_comment = 1;
1904 }
1905
1906 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1907 sanitise_line_reset($in_comment);
1908
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001909 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001910 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001911 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001912 $line = sanitise_line($rawline);
1913 }
1914 push(@lines, $line);
1915
1916 if ($realcnt > 1) {
1917 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1918 } else {
1919 $realcnt = 0;
1920 }
1921
1922 #print "==>$rawline\n";
1923 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001924
1925 if ($setup_docs && $line =~ /^\+/) {
1926 push(@setup_docs, $line);
1927 }
1928 }
1929
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001930 $prefix = '';
1931
Andy Whitcroft773647a2008-03-28 14:15:58 -07001932 $realcnt = 0;
1933 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07001934 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001935 foreach my $line (@lines) {
1936 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07001937 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001938 my $sline = $line; #copy of $line
1939 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001940
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001941 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001942
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001943#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001944 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001945 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001946 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001947 $realline=$1-1;
1948 if (defined $2) {
1949 $realcnt=$3+1;
1950 } else {
1951 $realcnt=1+1;
1952 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001953 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001954 $prev_values = 'E';
1955
Andy Whitcroft773647a2008-03-28 14:15:58 -07001956 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001957 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001958 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001959 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001960 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001961
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001962# track the line number as we move through the hunk, note that
1963# new versions of GNU diff omit the leading space on completely
1964# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001965 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001966 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001967 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001968
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001969 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001970 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001971
1972 # Track the previous line.
1973 ($prevline, $stashline) = ($stashline, $line);
1974 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001975 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1976
Andy Whitcroft773647a2008-03-28 14:15:58 -07001977 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001978
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001979 } elsif ($realcnt == 1) {
1980 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001981 }
1982
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001983 my $hunk_line = ($realcnt != 0);
1984
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001985#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001986 $prefix = "$filename:$realline: " if ($emacs && $file);
1987 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1988
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001989 $here = "#$linenr: " if (!$file);
1990 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001991
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001992 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001993 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001994 if ($line =~ /^diff --git.*?(\S+)$/) {
1995 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001996 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001997 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07001998 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001999 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002000 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002001 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002002 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002003
2004 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002005 if (!$file && $tree && $p1_prefix ne '' &&
2006 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002007 WARN("PATCH_PREFIX",
2008 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002009 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002010
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002011 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002012 ERROR("MODIFIED_INCLUDE_ASM",
2013 "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 -07002014 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002015 $found_file = 1;
2016 }
2017
2018 if ($found_file) {
2019 if ($realfile =~ m@^(drivers/net/|net/)@) {
2020 $check = 1;
2021 } else {
2022 $check = $check_orig;
2023 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002024 next;
2025 }
2026
Randy Dunlap389834b2007-06-08 13:47:03 -07002027 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002028
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002029 my $hereline = "$here\n$rawline\n";
2030 my $herecurr = "$here\n$rawline\n";
2031 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002032
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002033 $cnt_lines++ if ($realcnt != 0);
2034
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002035# Check for incorrect file permissions
2036 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2037 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002038 if ($realfile !~ m@scripts/@ &&
2039 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002040 ERROR("EXECUTE_PERMISSIONS",
2041 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002042 }
2043 }
2044
Joe Perches20112472011-07-25 17:13:23 -07002045# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002046 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002047 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002048 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002049 }
2050
2051# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002052 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002053 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002054 my $space_before = $1;
2055 my $sign_off = $2;
2056 my $space_after = $3;
2057 my $email = $4;
2058 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2059
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002060 if ($sign_off !~ /$signature_tags/) {
2061 WARN("BAD_SIGN_OFF",
2062 "Non-standard signature: $sign_off\n" . $herecurr);
2063 }
Joe Perches20112472011-07-25 17:13:23 -07002064 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002065 if (WARN("BAD_SIGN_OFF",
2066 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2067 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002068 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002069 "$ucfirst_sign_off $email";
2070 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002071 }
Joe Perches20112472011-07-25 17:13:23 -07002072 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002073 if (WARN("BAD_SIGN_OFF",
2074 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2075 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002076 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002077 "$ucfirst_sign_off $email";
2078 }
2079
Joe Perches20112472011-07-25 17:13:23 -07002080 }
2081 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002082 if (WARN("BAD_SIGN_OFF",
2083 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2084 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002085 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002086 "$ucfirst_sign_off $email";
2087 }
Joe Perches20112472011-07-25 17:13:23 -07002088 }
2089
2090 my ($email_name, $email_address, $comment) = parse_email($email);
2091 my $suggested_email = format_email(($email_name, $email_address));
2092 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002093 ERROR("BAD_SIGN_OFF",
2094 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002095 } else {
2096 my $dequoted = $suggested_email;
2097 $dequoted =~ s/^"//;
2098 $dequoted =~ s/" </ </;
2099 # Don't force email to have quotes
2100 # Allow just an angle bracketed address
2101 if ("$dequoted$comment" ne $email &&
2102 "<$email_address>$comment" ne $email &&
2103 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002104 WARN("BAD_SIGN_OFF",
2105 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002106 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002107 }
Joe Perches7e51f192013-09-11 14:23:57 -07002108
2109# Check for duplicate signatures
2110 my $sig_nospace = $line;
2111 $sig_nospace =~ s/\s//g;
2112 $sig_nospace = lc($sig_nospace);
2113 if (defined $signatures{$sig_nospace}) {
2114 WARN("BAD_SIGN_OFF",
2115 "Duplicate signature\n" . $herecurr);
2116 } else {
2117 $signatures{$sig_nospace} = 1;
2118 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002119 }
2120
Joe Perches9b3189eb2014-06-04 16:12:10 -07002121# Check for old stable address
2122 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2123 ERROR("STABLE_ADDRESS",
2124 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2125 }
2126
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002127# Check for unwanted Gerrit info
2128 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2129 ERROR("GERRIT_CHANGE_ID",
2130 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2131 }
2132
Joe Perchesd311cd42014-08-06 16:10:57 -07002133# Check for improperly formed commit descriptions
2134 if ($in_commit_log &&
2135 $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
Joe Perches66881732014-09-09 14:50:55 -07002136 !($line =~ /\b[Cc]ommit [0-9a-f]{12,40} \("/ ||
2137 ($line =~ /\b[Cc]ommit [0-9a-f]{12,40}\s*$/ &&
2138 defined $rawlines[$linenr] &&
2139 $rawlines[$linenr] =~ /^\s*\("/))) {
Joe Perchesd311cd42014-08-06 16:10:57 -07002140 $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
2141 my $init_char = $1;
2142 my $orig_commit = lc($2);
2143 my $id = '01234567890ab';
2144 my $desc = 'commit description';
2145 ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
2146 ERROR("GIT_COMMIT_ID",
Joe Perches3f6316b42014-08-29 15:18:26 -07002147 "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 -07002148 }
2149
Joe Perches13f19372014-08-06 16:10:59 -07002150# Check for added, moved or deleted files
2151 if (!$reported_maintainer_file && !$in_commit_log &&
2152 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2153 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2154 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2155 (defined($1) || defined($2))))) {
2156 $reported_maintainer_file = 1;
2157 WARN("FILE_PATH_CHANGES",
2158 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2159 }
2160
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002161# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002162 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002163 ERROR("CORRUPTED_PATCH",
2164 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002165 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002166 }
2167
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002168# Check for absolute kernel paths.
2169 if ($tree) {
2170 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2171 my $file = $1;
2172
2173 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2174 check_absolute_file($1, $herecurr)) {
2175 #
2176 } else {
2177 check_absolute_file($file, $herecurr);
2178 }
2179 }
2180 }
2181
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002182# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2183 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002184 $rawline !~ m/^$UTF8*$/) {
2185 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2186
2187 my $blank = copy_spacing($rawline);
2188 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2189 my $hereptr = "$hereline$ptr\n";
2190
Joe Perches34d99212011-07-25 17:13:26 -07002191 CHK("INVALID_UTF8",
2192 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002193 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002194
Joe Perches15662b32011-10-31 17:13:12 -07002195# Check if it's the start of a commit log
2196# (not a header line and we haven't seen the patch filename)
2197 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002198 !($rawline =~ /^\s+\S/ ||
2199 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002200 $in_header_lines = 0;
2201 $in_commit_log = 1;
2202 }
2203
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002204# Check if there is UTF-8 in a commit log when a mail header has explicitly
2205# declined it, i.e defined some charset where it is missing.
2206 if ($in_header_lines &&
2207 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2208 $1 !~ /utf-8/i) {
2209 $non_utf8_charset = 1;
2210 }
2211
2212 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002213 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002214 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002215 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2216 }
2217
Andy Whitcroft306708542008-10-15 22:02:28 -07002218# ignore non-hunk lines and lines being removed
2219 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002220
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002221#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002222 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002223 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002224 if (ERROR("DOS_LINE_ENDINGS",
2225 "DOS line endings\n" . $herevet) &&
2226 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002227 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002228 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002229 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2230 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002231 if (ERROR("TRAILING_WHITESPACE",
2232 "trailing whitespace\n" . $herevet) &&
2233 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002234 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002235 }
2236
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002237 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002238 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002239
Josh Triplett4783f892013-11-12 15:10:12 -08002240# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002241 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002242 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2243 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002244 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2245 my $msg_type = \&ERROR;
2246 $msg_type = \&CHK if ($file);
2247 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002248 "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 -08002249 }
2250
Andi Kleen33549572010-05-24 14:33:29 -07002251# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002252# Only applies when adding the entry originally, after that we do not have
2253# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002254 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002255 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002256 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002257 my $cnt = $realcnt;
2258 my $ln = $linenr + 1;
2259 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002260 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002261 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002262 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002263 $f = $lines[$ln - 1];
2264 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2265 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002266
2267 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002268 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002269
Joe Perches8d73e0e2014-08-06 16:10:46 -07002270 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002271 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002272 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002273 $length = -1;
2274 }
2275
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002276 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002277 $f =~ s/#.*//;
2278 $f =~ s/^\s+//;
2279 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002280 if ($f =~ /^\s*config\s/) {
2281 $is_end = 1;
2282 last;
2283 }
Andi Kleen33549572010-05-24 14:33:29 -07002284 $length++;
2285 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002286 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002287 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2288 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002289 }
2290
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002291# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2292 if ($realfile =~ /Kconfig/ &&
2293 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2294 WARN("CONFIG_EXPERIMENTAL",
2295 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2296 }
2297
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002298 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2299 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2300 my $flag = $1;
2301 my $replacement = {
2302 'EXTRA_AFLAGS' => 'asflags-y',
2303 'EXTRA_CFLAGS' => 'ccflags-y',
2304 'EXTRA_CPPFLAGS' => 'cppflags-y',
2305 'EXTRA_LDFLAGS' => 'ldflags-y',
2306 };
2307
2308 WARN("DEPRECATED_VARIABLE",
2309 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2310 }
2311
Rob Herringbff5da42014-01-23 15:54:51 -08002312# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002313 if (defined $root &&
2314 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2315 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2316
Rob Herringbff5da42014-01-23 15:54:51 -08002317 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2318
Florian Vaussardcc933192014-04-03 14:49:27 -07002319 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2320 my $vp_file = $dt_path . "vendor-prefixes.txt";
2321
Rob Herringbff5da42014-01-23 15:54:51 -08002322 foreach my $compat (@compats) {
2323 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002324 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2325 my $compat3 = $compat;
2326 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2327 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002328 if ( $? >> 8 ) {
2329 WARN("UNDOCUMENTED_DT_STRING",
2330 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2331 }
2332
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002333 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2334 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002335 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002336 if ( $? >> 8 ) {
2337 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002338 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002339 }
2340 }
2341 }
2342
Andy Whitcroft5368df202008-10-15 22:02:27 -07002343# check we are in a valid source file if not then ignore this hunk
2344 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2345
Joe Perches6cd7f382012-12-17 16:01:54 -08002346#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002347 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002348 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002349 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002350 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002351 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002352 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002353 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002354 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002355 }
2356
Josh Triplettca56dc02012-03-23 15:02:21 -07002357# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002358# to grep for the string. Make exceptions when the previous string ends in a
2359# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2360# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002361 if ($line =~ /^\+\s*"/ &&
2362 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002363 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002364 WARN("SPLIT_STRING",
2365 "quoted string split across lines\n" . $hereprev);
2366 }
2367
Dan Carpenterece96592014-08-06 16:11:29 -07002368# check for missing a space in a string concatination
2369 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
2370 WARN('MISSING_SPACE',
2371 "break quoted strings at a space character\n" . $hereprev);
2372 }
2373
Joe Perches5e79d962010-03-05 13:43:55 -08002374# check for spaces before a quoted newline
2375 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002376 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2377 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2378 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002379 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
Joe Perches3705ce52013-07-03 15:05:31 -07002380 }
2381
Joe Perches5e79d962010-03-05 13:43:55 -08002382 }
2383
Andy Whitcroft8905a672007-11-28 16:21:06 -08002384# check for adding lines without a newline.
2385 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002386 WARN("MISSING_EOF_NEWLINE",
2387 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002388 }
2389
Mike Frysinger42e41c52009-09-21 17:04:40 -07002390# Blackfin: use hi/lo macros
2391 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2392 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2393 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002394 ERROR("LO_MACRO",
2395 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002396 }
2397 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2398 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002399 ERROR("HI_MACRO",
2400 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002401 }
2402 }
2403
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002404# check we are in a valid source file C or perl if not then ignore this hunk
2405 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002406
2407# at the beginning of a line any tabs must come first and anything
2408# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002409 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2410 $rawline =~ /^\+\s* \s*/) {
2411 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002412 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002413 if (ERROR("CODE_INDENT",
2414 "code indent should use tabs where possible\n" . $herevet) &&
2415 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002416 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002417 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002418 }
2419
Alberto Panizzo08e44362010-03-05 13:43:54 -08002420# check for space before tabs.
2421 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2422 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002423 if (WARN("SPACE_BEFORE_TAB",
2424 "please, no space before tabs\n" . $herevet) &&
2425 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002426 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002427 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002428 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002429 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002430 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002431 }
2432
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002433# check for && or || at the start of a line
2434 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2435 CHK("LOGICAL_CONTINUATIONS",
2436 "Logical continuations should be on the previous line\n" . $hereprev);
2437 }
2438
2439# check multi-line statement indentation matches previous line
2440 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002441 $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 -07002442 $prevline =~ /^\+(\t*)(.*)$/;
2443 my $oldindent = $1;
2444 my $rest = $2;
2445
2446 my $pos = pos_last_openparen($rest);
2447 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002448 $line =~ /^(\+| )([ \t]*)/;
2449 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002450
2451 my $goodtabindent = $oldindent .
2452 "\t" x ($pos / 8) .
2453 " " x ($pos % 8);
2454 my $goodspaceindent = $oldindent . " " x $pos;
2455
2456 if ($newindent ne $goodtabindent &&
2457 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002458
2459 if (CHK("PARENTHESIS_ALIGNMENT",
2460 "Alignment should match open parenthesis\n" . $hereprev) &&
2461 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002462 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002463 s/^\+[ \t]*/\+$goodtabindent/;
2464 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002465 }
2466 }
2467 }
2468
Joe Perches308cc8d2014-08-06 16:11:27 -07002469 if ($line =~ /^\+.*\(\s*$Type\s*\)[ \t]+(?!$Assignment|$Arithmetic|{)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002470 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002471 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002472 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002473 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002474 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002475 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002476 }
2477
Joe Perches05880602012-10-04 17:13:35 -07002478 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002479 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002480 $rawline =~ /^\+[ \t]*\*/ &&
2481 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002482 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2483 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2484 }
2485
2486 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002487 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2488 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002489 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002490 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2491 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2492 "networking block comments start with * on subsequent lines\n" . $hereprev);
2493 }
2494
2495 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002496 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2497 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2498 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2499 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002500 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2501 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2502 }
2503
Joe Perches7f619192014-08-06 16:10:39 -07002504# check for missing blank lines after struct/union declarations
2505# with exceptions for various attributes and macros
2506 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2507 $line =~ /^\+/ &&
2508 !($line =~ /^\+\s*$/ ||
2509 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2510 $line =~ /^\+\s*MODULE_/i ||
2511 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2512 $line =~ /^\+[a-z_]*init/ ||
2513 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2514 $line =~ /^\+\s*DECLARE/ ||
2515 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002516 if (CHK("LINE_SPACING",
2517 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2518 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002519 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002520 }
Joe Perches7f619192014-08-06 16:10:39 -07002521 }
2522
Joe Perches365dd4e2014-08-06 16:10:42 -07002523# check for multiple consecutive blank lines
2524 if ($prevline =~ /^[\+ ]\s*$/ &&
2525 $line =~ /^\+\s*$/ &&
2526 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002527 if (CHK("LINE_SPACING",
2528 "Please don't use multiple blank lines\n" . $hereprev) &&
2529 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002530 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002531 }
2532
Joe Perches365dd4e2014-08-06 16:10:42 -07002533 $last_blank_line = $linenr;
2534 }
2535
Joe Perches3b617e32014-04-03 14:49:28 -07002536# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002537 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2538 # actual declarations
2539 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002540 # function pointer declarations
2541 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002542 # foo bar; where foo is some local typedef or #define
2543 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2544 # known declaration macros
2545 $prevline =~ /^\+\s+$declaration_macros/) &&
2546 # for "else if" which can look like "$Ident $Ident"
2547 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2548 # other possible extensions of declaration lines
2549 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2550 # not starting a section or a macro "\" extended line
2551 $prevline =~ /(?:\{\s*|\\)$/) &&
2552 # looks like a declaration
2553 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002554 # function pointer declarations
2555 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002556 # foo bar; where foo is some local typedef or #define
2557 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2558 # known declaration macros
2559 $sline =~ /^\+\s+$declaration_macros/ ||
2560 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002561 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002562 # start or end of block or continuation of declaration
2563 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2564 # bitfield continuation
2565 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2566 # other possible extensions of declaration lines
2567 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2568 # indentation of previous and current line are the same
2569 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002570 if (WARN("LINE_SPACING",
2571 "Missing a blank line after 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 Perches3b617e32014-04-03 14:49:28 -07002575 }
2576
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002577# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002578# Exceptions:
2579# 1) within comments
2580# 2) indented preprocessor commands
2581# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002582 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002583 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002584 if (WARN("LEADING_SPACE",
2585 "please, no spaces at the start of a line\n" . $herevet) &&
2586 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002587 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002588 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002589 }
2590
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002591# check we are in a valid C source file if not then ignore this hunk
2592 next if ($realfile !~ /\.(h|c)$/);
2593
Joe Perches032a4c02014-08-06 16:10:29 -07002594# check indentation of any line with a bare else
2595# if the previous line is a break or return and is indented 1 tab more...
2596 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
2597 my $tabs = length($1) + 1;
2598 if ($prevline =~ /^\+\t{$tabs,$tabs}(?:break|return)\b/) {
2599 WARN("UNNECESSARY_ELSE",
2600 "else is not generally useful after a break or return\n" . $hereprev);
2601 }
2602 }
2603
Joe Perchesc00df192014-08-06 16:11:01 -07002604# check indentation of a line with a break;
2605# if the previous line is a goto or return and is indented the same # of tabs
2606 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
2607 my $tabs = $1;
2608 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
2609 WARN("UNNECESSARY_BREAK",
2610 "break is not useful after a goto or return\n" . $hereprev);
2611 }
2612 }
2613
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002614# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2615 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2616 WARN("CONFIG_EXPERIMENTAL",
2617 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2618 }
2619
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002620# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002621 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002622 WARN("CVS_KEYWORD",
2623 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002624 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002625
Mike Frysinger42e41c52009-09-21 17:04:40 -07002626# Blackfin: don't use __builtin_bfin_[cs]sync
2627 if ($line =~ /__builtin_bfin_csync/) {
2628 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002629 ERROR("CSYNC",
2630 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002631 }
2632 if ($line =~ /__builtin_bfin_ssync/) {
2633 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002634 ERROR("SSYNC",
2635 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002636 }
2637
Joe Perches56e77d72013-02-21 16:44:14 -08002638# check for old HOTPLUG __dev<foo> section markings
2639 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2640 WARN("HOTPLUG_SECTION",
2641 "Using $1 is unnecessary\n" . $herecurr);
2642 }
2643
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002644# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002645 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2646 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002647#print "LINE<$line>\n";
2648 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002649 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002650 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002651 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002652 $stat =~ s/\n./\n /g;
2653 $cond =~ s/\n./\n /g;
2654
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002655#print "linenr<$linenr> <$stat>\n";
2656 # If this statement has no statement boundaries within
2657 # it there is no point in retrying a statement scan
2658 # until we hit end of it.
2659 my $frag = $stat; $frag =~ s/;+\s*$//;
2660 if ($frag !~ /(?:{|;)/) {
2661#print "skip<$line_nr_next>\n";
2662 $suppress_statement = $line_nr_next;
2663 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002664
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002665 # Find the real next line.
2666 $realline_next = $line_nr_next;
2667 if (defined $realline_next &&
2668 (!defined $lines[$realline_next - 1] ||
2669 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2670 $realline_next++;
2671 }
2672
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002673 my $s = $stat;
2674 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002675
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002676 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002677 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002678
2679 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002680 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002681
Andy Whitcroft463f2862009-09-21 17:04:34 -07002682 } elsif ($s =~ /^.\s*else\b/s) {
2683
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002684 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002685 } 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 -07002686 my $type = $1;
2687 $type =~ s/\s+/ /g;
2688 possible($type, "A:" . $s);
2689
Andy Whitcroft8905a672007-11-28 16:21:06 -08002690 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002691 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002692 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002693 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002694
2695 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002696 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002697 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002698 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002699
2700 # Check for any sort of function declaration.
2701 # int foo(something bar, other baz);
2702 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002703 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 -08002704 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002705
Andy Whitcroftcf655042008-03-04 14:28:20 -08002706 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002707 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002708 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002709
Andy Whitcroft8905a672007-11-28 16:21:06 -08002710 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002711 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002712
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002713 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002714 }
2715 }
2716 }
2717
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002718 }
2719
Andy Whitcroft653d4872007-06-23 17:16:34 -07002720#
2721# Checks which may be anchored in the context.
2722#
2723
2724# Check for switch () and associated case and default
2725# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002726 if ($line=~/\bswitch\s*\(.*\)/) {
2727 my $err = '';
2728 my $sep = '';
2729 my @ctx = ctx_block_outer($linenr, $realcnt);
2730 shift(@ctx);
2731 for my $ctx (@ctx) {
2732 my ($clen, $cindent) = line_stats($ctx);
2733 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2734 $indent != $cindent) {
2735 $err .= "$sep$ctx\n";
2736 $sep = '';
2737 } else {
2738 $sep = "[...]\n";
2739 }
2740 }
2741 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002742 ERROR("SWITCH_CASE_INDENT_LEVEL",
2743 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002744 }
2745 }
2746
2747# if/while/etc brace do not go on next line, unless defining a do while loop,
2748# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07002749 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 -07002750 my $pre_ctx = "$1$2";
2751
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002752 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002753
2754 if ($line =~ /^\+\t{6,}/) {
2755 WARN("DEEP_INDENTATION",
2756 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2757 }
2758
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002759 my $ctx_cnt = $realcnt - $#ctx - 1;
2760 my $ctx = join("\n", @ctx);
2761
Andy Whitcroft548596d2008-07-23 21:29:01 -07002762 my $ctx_ln = $linenr;
2763 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002764
Andy Whitcroft548596d2008-07-23 21:29:01 -07002765 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2766 defined $lines[$ctx_ln - 1] &&
2767 $lines[$ctx_ln - 1] =~ /^-/)) {
2768 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2769 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002770 $ctx_ln++;
2771 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002772
Andy Whitcroft53210162008-07-23 21:29:03 -07002773 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2774 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002775
Joe Perchesd752fcc2014-08-06 16:11:05 -07002776 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002777 ERROR("OPEN_BRACE",
2778 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002779 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002780 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002781 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2782 $ctx =~ /\)\s*\;\s*$/ &&
2783 defined $lines[$ctx_ln - 1])
2784 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002785 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2786 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002787 WARN("TRAILING_SEMICOLON",
2788 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002789 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002790 }
2791 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002792 }
2793
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002794# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07002795 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 -08002796 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2797 ctx_statement_block($linenr, $realcnt, 0)
2798 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002799 my ($s, $c) = ($stat, $cond);
2800
2801 substr($s, 0, length($c), '');
2802
2803 # Make sure we remove the line prefixes as we have
2804 # none on the first line, and are going to readd them
2805 # where necessary.
2806 $s =~ s/\n./\n/gs;
2807
2808 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002809 my @newlines = ($c =~ /\n/gs);
2810 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002811
2812 # We want to check the first line inside the block
2813 # starting at the end of the conditional, so remove:
2814 # 1) any blank line termination
2815 # 2) any opening brace { on end of the line
2816 # 3) any do (...) {
2817 my $continuation = 0;
2818 my $check = 0;
2819 $s =~ s/^.*\bdo\b//;
2820 $s =~ s/^\s*{//;
2821 if ($s =~ s/^\s*\\//) {
2822 $continuation = 1;
2823 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002824 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002825 $check = 1;
2826 $cond_lines++;
2827 }
2828
2829 # Also ignore a loop construct at the end of a
2830 # preprocessor statement.
2831 if (($prevline =~ /^.\s*#\s*define\s/ ||
2832 $prevline =~ /\\\s*$/) && $continuation == 0) {
2833 $check = 0;
2834 }
2835
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002836 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002837 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002838 while ($cond_ptr != $cond_lines) {
2839 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002840
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002841 # If we see an #else/#elif then the code
2842 # is not linear.
2843 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2844 $check = 0;
2845 }
2846
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002847 # Ignore:
2848 # 1) blank lines, they should be at 0,
2849 # 2) preprocessor lines, and
2850 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002851 if ($continuation ||
2852 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002853 $s =~ /^\s*#\s*?/ ||
2854 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002855 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002856 if ($s =~ s/^.*?\n//) {
2857 $cond_lines++;
2858 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002859 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002860 }
2861
2862 my (undef, $sindent) = line_stats("+" . $s);
2863 my $stat_real = raw_line($linenr, $cond_lines);
2864
2865 # Check if either of these lines are modified, else
2866 # this is not this patch's fault.
2867 if (!defined($stat_real) ||
2868 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2869 $check = 0;
2870 }
2871 if (defined($stat_real) && $cond_lines > 1) {
2872 $stat_real = "[...]\n$stat_real";
2873 }
2874
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002875 #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 -07002876
2877 if ($check && (($sindent % 8) != 0 ||
2878 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002879 WARN("SUSPECT_CODE_INDENT",
2880 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002881 }
2882 }
2883
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002884 # Track the 'values' across context and added lines.
2885 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002886 my ($curr_values, $curr_vars) =
2887 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002888 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002889 if ($dbg_values) {
2890 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002891 print "$linenr > .$outline\n";
2892 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002893 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002894 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002895 $prev_values = substr($curr_values, -1);
2896
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002897#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002898 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002899
Andy Whitcroft653d4872007-06-23 17:16:34 -07002900# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002901 if ($dbg_type) {
2902 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002903 ERROR("TEST_TYPE",
2904 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002905 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002906 ERROR("TEST_NOT_TYPE",
2907 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002908 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002909 next;
2910 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002911# TEST: allow direct testing of the attribute matcher.
2912 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002913 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002914 ERROR("TEST_ATTR",
2915 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002916 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002917 ERROR("TEST_NOT_ATTR",
2918 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002919 }
2920 next;
2921 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002922
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002923# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002924 if ($line =~ /^.\s*{/ &&
2925 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002926 if (ERROR("OPEN_BRACE",
2927 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002928 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
2929 fix_delete_line($fixlinenr - 1, $prevrawline);
2930 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002931 my $fixedline = $prevrawline;
2932 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002933 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002934 $fixedline = $line;
2935 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002936 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002937 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002938 }
2939
Andy Whitcroft653d4872007-06-23 17:16:34 -07002940#
2941# Checks which are anchored on the added line.
2942#
2943
2944# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002945 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002946 my $path = $1;
2947 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002948 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002949 "malformed #include filename\n" . $herecurr);
2950 }
2951 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2952 ERROR("UAPI_INCLUDE",
2953 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002954 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002955 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002956
2957# no C99 // comments
2958 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002959 if (ERROR("C99_COMMENTS",
2960 "do not use C99 // comments\n" . $herecurr) &&
2961 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002962 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07002963 if ($line =~ /\/\/(.*)$/) {
2964 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07002965 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07002966 }
2967 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002968 }
2969 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002970 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002971 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002972
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002973# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2974# the whole statement.
2975#print "APW <$lines[$realline_next - 1]>\n";
2976 if (defined $realline_next &&
2977 exists $lines[$realline_next - 1] &&
2978 !defined $suppress_export{$realline_next} &&
2979 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2980 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002981 # Handle definitions which produce identifiers with
2982 # a prefix:
2983 # XXX(foo);
2984 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002985 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002986 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002987 $name =~ /^${Ident}_$2/) {
2988#print "FOO C name<$name>\n";
2989 $suppress_export{$realline_next} = 1;
2990
2991 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002992 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002993 ^.DEFINE_$Ident\(\Q$name\E\)|
2994 ^.DECLARE_$Ident\(\Q$name\E\)|
2995 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002996 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2997 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002998 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002999#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3000 $suppress_export{$realline_next} = 2;
3001 } else {
3002 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003003 }
3004 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003005 if (!defined $suppress_export{$linenr} &&
3006 $prevline =~ /^.\s*$/ &&
3007 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3008 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3009#print "FOO B <$lines[$linenr - 1]>\n";
3010 $suppress_export{$linenr} = 2;
3011 }
3012 if (defined $suppress_export{$linenr} &&
3013 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003014 WARN("EXPORT_SYMBOL",
3015 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003016 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003017
Joe Eloff5150bda2010-08-09 17:21:00 -07003018# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003019 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
3020 if (ERROR("GLOBAL_INITIALISERS",
3021 "do not initialise globals to 0 or NULL\n" .
3022 $herecurr) &&
3023 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003024 $fixed[$fixlinenr] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003025 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003026 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003027# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07003028 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
3029 if (ERROR("INITIALISED_STATIC",
3030 "do not initialise statics to 0 or NULL\n" .
3031 $herecurr) &&
3032 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003033 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003034 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003035 }
3036
Joe Perches18130872014-08-06 16:11:22 -07003037# check for misordered declarations of char/short/int/long with signed/unsigned
3038 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3039 my $tmp = trim($1);
3040 WARN("MISORDERED_TYPE",
3041 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3042 }
3043
Joe Perchescb710ec2010-10-26 14:23:20 -07003044# check for static const char * arrays.
3045 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003046 WARN("STATIC_CONST_CHAR_ARRAY",
3047 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003048 $herecurr);
3049 }
3050
3051# check for static char foo[] = "bar" declarations.
3052 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003053 WARN("STATIC_CONST_CHAR_ARRAY",
3054 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003055 $herecurr);
3056 }
3057
Joe Perches9b0fa602014-04-03 14:49:18 -07003058# check for non-global char *foo[] = {"bar", ...} declarations.
3059 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3060 WARN("STATIC_CONST_CHAR_ARRAY",
3061 "char * array declaration might be better as static const\n" .
3062 $herecurr);
3063 }
3064
Joe Perchesb36190c2014-01-27 17:07:18 -08003065# check for function declarations without arguments like "int foo()"
3066 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3067 if (ERROR("FUNCTION_WITHOUT_ARGS",
3068 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3069 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003070 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003071 }
3072 }
3073
Joe Perches92e112f2013-12-13 11:36:22 -07003074# check for uses of DEFINE_PCI_DEVICE_TABLE
3075 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3076 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3077 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3078 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003079 $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 -07003080 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003081 }
3082
Andy Whitcroft653d4872007-06-23 17:16:34 -07003083# check for new typedefs, only function parameters and sparse annotations
3084# make sense.
3085 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003086 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003087 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003088 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003089 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003090 WARN("NEW_TYPEDEFS",
3091 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003092 }
3093
3094# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003095 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003096 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3097 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003098 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003099
Andy Whitcroft65863862009-01-06 14:41:21 -08003100 # Should start with a space.
3101 $to =~ s/^(\S)/ $1/;
3102 # Should not end with a space.
3103 $to =~ s/\s+$//;
3104 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003105 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003106 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003107
Joe Perches3705ce52013-07-03 15:05:31 -07003108## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003109 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003110 if (ERROR("POINTER_LOCATION",
3111 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3112 $fix) {
3113 my $sub_from = $ident;
3114 my $sub_to = $ident;
3115 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003116 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003117 s@\Q$sub_from\E@$sub_to@;
3118 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003119 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003120 }
3121 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3122 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003123 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003124
Andy Whitcroft65863862009-01-06 14:41:21 -08003125 # Should start with a space.
3126 $to =~ s/^(\S)/ $1/;
3127 # Should not end with a space.
3128 $to =~ s/\s+$//;
3129 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003130 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003131 }
3132 # Modifiers should have spaces.
3133 $to =~ s/(\b$Modifier$)/$1 /;
3134
Joe Perches3705ce52013-07-03 15:05:31 -07003135## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003136 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003137 if (ERROR("POINTER_LOCATION",
3138 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3139 $fix) {
3140
3141 my $sub_from = $match;
3142 my $sub_to = $match;
3143 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003144 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003145 s@\Q$sub_from\E@$sub_to@;
3146 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003147 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003148 }
3149
3150# # no BUG() or BUG_ON()
3151# if ($line =~ /\b(BUG|BUG_ON)\b/) {
3152# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3153# print "$herecurr";
3154# $clean = 0;
3155# }
3156
Andy Whitcroft8905a672007-11-28 16:21:06 -08003157 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003158 WARN("LINUX_VERSION_CODE",
3159 "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 -08003160 }
3161
Joe Perches17441222011-06-15 15:08:17 -07003162# check for uses of printk_ratelimit
3163 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003164 WARN("PRINTK_RATELIMITED",
3165"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003166 }
3167
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003168# printk should use KERN_* levels. Note that follow on printk's on the
3169# same line do not need a level, so we use the current block context
3170# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003171# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003172# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003173 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003174 my $ok = 0;
3175 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3176 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003177 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003178 # with "\n" ignore it, else it is to blame
3179 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3180 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3181 $ok = 1;
3182 }
3183 last;
3184 }
3185 }
3186 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003187 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3188 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003189 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003190 }
3191
Joe Perches243f3802012-05-31 16:26:09 -07003192 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3193 my $orig = $1;
3194 my $level = lc($orig);
3195 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003196 my $level2 = $level;
3197 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003198 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003199 "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 -07003200 }
3201
3202 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003203 if (WARN("PREFER_PR_LEVEL",
3204 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3205 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003206 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003207 s/\bpr_warning\b/pr_warn/;
3208 }
Joe Perches243f3802012-05-31 16:26:09 -07003209 }
3210
Joe Perchesdc139312013-02-21 16:44:13 -08003211 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3212 my $orig = $1;
3213 my $level = lc($orig);
3214 $level = "warn" if ($level eq "warning");
3215 $level = "dbg" if ($level eq "debug");
3216 WARN("PREFER_DEV_LEVEL",
3217 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3218 }
3219
Andy Whitcroft653d4872007-06-23 17:16:34 -07003220# function brace can't be on same line, except for #defines of do while,
3221# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003222 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003223 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003224 if (ERROR("OPEN_BRACE",
3225 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3226 $fix) {
3227 fix_delete_line($fixlinenr, $rawline);
3228 my $fixed_line = $rawline;
3229 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3230 my $line1 = $1;
3231 my $line2 = $2;
3232 fix_insert_line($fixlinenr, ltrim($line1));
3233 fix_insert_line($fixlinenr, "\+{");
3234 if ($line2 !~ /^\s*$/) {
3235 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3236 }
3237 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003238 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003239
Andy Whitcroft8905a672007-11-28 16:21:06 -08003240# open braces for enum, union and struct go on the same line.
3241 if ($line =~ /^.\s*{/ &&
3242 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003243 if (ERROR("OPEN_BRACE",
3244 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3245 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3246 fix_delete_line($fixlinenr - 1, $prevrawline);
3247 fix_delete_line($fixlinenr, $rawline);
3248 my $fixedline = rtrim($prevrawline) . " {";
3249 fix_insert_line($fixlinenr, $fixedline);
3250 $fixedline = $rawline;
3251 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3252 if ($fixedline !~ /^\+\s*$/) {
3253 fix_insert_line($fixlinenr, $fixedline);
3254 }
3255 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003256 }
3257
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003258# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003259 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3260 if (WARN("SPACING",
3261 "missing space after $1 definition\n" . $herecurr) &&
3262 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003263 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003264 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3265 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003266 }
3267
Joe Perches31070b52014-01-23 15:54:49 -08003268# Function pointer declarations
3269# check spacing between type, funcptr, and args
3270# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003271 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003272 my $declare = $1;
3273 my $pre_pointer_space = $2;
3274 my $post_pointer_space = $3;
3275 my $funcname = $4;
3276 my $post_funcname_space = $5;
3277 my $pre_args_space = $6;
3278
Joe Perches91f72e92014-04-03 14:49:12 -07003279# the $Declare variable will capture all spaces after the type
3280# so check it for a missing trailing missing space but pointer return types
3281# don't need a space so don't warn for those.
3282 my $post_declare_space = "";
3283 if ($declare =~ /(\s+)$/) {
3284 $post_declare_space = $1;
3285 $declare = rtrim($declare);
3286 }
3287 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003288 WARN("SPACING",
3289 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003290 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003291 }
3292
3293# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003294# This test is not currently implemented because these declarations are
3295# equivalent to
3296# int foo(int bar, ...)
3297# and this is form shouldn't/doesn't generate a checkpatch warning.
3298#
3299# elsif ($declare =~ /\s{2,}$/) {
3300# WARN("SPACING",
3301# "Multiple spaces after return type\n" . $herecurr);
3302# }
Joe Perches31070b52014-01-23 15:54:49 -08003303
3304# unnecessary space "type ( *funcptr)(args...)"
3305 if (defined $pre_pointer_space &&
3306 $pre_pointer_space =~ /^\s/) {
3307 WARN("SPACING",
3308 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3309 }
3310
3311# unnecessary space "type (* funcptr)(args...)"
3312 if (defined $post_pointer_space &&
3313 $post_pointer_space =~ /^\s/) {
3314 WARN("SPACING",
3315 "Unnecessary space before function pointer name\n" . $herecurr);
3316 }
3317
3318# unnecessary space "type (*funcptr )(args...)"
3319 if (defined $post_funcname_space &&
3320 $post_funcname_space =~ /^\s/) {
3321 WARN("SPACING",
3322 "Unnecessary space after function pointer name\n" . $herecurr);
3323 }
3324
3325# unnecessary space "type (*funcptr) (args...)"
3326 if (defined $pre_args_space &&
3327 $pre_args_space =~ /^\s/) {
3328 WARN("SPACING",
3329 "Unnecessary space before function pointer arguments\n" . $herecurr);
3330 }
3331
3332 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003333 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003334 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003335 }
3336 }
3337
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003338# check for spacing round square brackets; allowed:
3339# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003340# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3341# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003342 while ($line =~ /(.*?\s)\[/g) {
3343 my ($where, $prefix) = ($-[1], $1);
3344 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003345 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003346 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003347 if (ERROR("BRACKET_SPACE",
3348 "space prohibited before open square bracket '['\n" . $herecurr) &&
3349 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003350 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003351 s/^(\+.*?)\s+\[/$1\[/;
3352 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003353 }
3354 }
3355
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003356# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003357 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003358 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003359 my $ctx_before = substr($line, 0, $-[1]);
3360 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003361
3362 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003363 if ($name =~ /^(?:
3364 if|for|while|switch|return|case|
3365 volatile|__volatile__|
3366 __attribute__|format|__extension__|
3367 asm|__asm__)$/x)
3368 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003369 # cpp #define statements have non-optional spaces, ie
3370 # if there is a space between the name and the open
3371 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003372 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003373
3374 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003375 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003376
3377 # If this whole things ends with a type its most
3378 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003379 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003380
3381 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003382 if (WARN("SPACING",
3383 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3384 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003385 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003386 s/\b$name\s+\(/$name\(/;
3387 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003388 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003389 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003390
Andy Whitcroft653d4872007-06-23 17:16:34 -07003391# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003392 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003393 my $fixed_line = "";
3394 my $line_fixed = 0;
3395
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003396 my $ops = qr{
3397 <<=|>>=|<=|>=|==|!=|
3398 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3399 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003400 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003401 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003402 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003403 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003404
3405## print("element count: <" . $#elements . ">\n");
3406## foreach my $el (@elements) {
3407## print("el: <$el>\n");
3408## }
3409
3410 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003411 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003412
Joe Perches3705ce52013-07-03 15:05:31 -07003413 foreach my $el (@elements) {
3414 push(@fix_elements, substr($rawline, $off, length($el)));
3415 $off += length($el);
3416 }
3417
3418 $off = 0;
3419
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003420 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003421 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003422
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003423 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003424
3425 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3426
3427## print("n: <$n> good: <$good>\n");
3428
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003429 $off += length($elements[$n]);
3430
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003431 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003432 my $ca = substr($opline, 0, $off);
3433 my $cc = '';
3434 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3435 $cc = substr($opline, $off + length($elements[$n + 1]));
3436 }
3437 my $cb = "$ca$;$cc";
3438
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003439 my $a = '';
3440 $a = 'V' if ($elements[$n] ne '');
3441 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003442 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003443 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3444 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003445 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003446
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003447 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003448
3449 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003450 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003451 $c = 'V' if ($elements[$n + 2] ne '');
3452 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003453 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003454 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3455 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003456 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003457 } else {
3458 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003459 }
3460
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003461 my $ctx = "${a}x${c}";
3462
3463 my $at = "(ctx:$ctx)";
3464
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003465 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003466 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003467
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003468 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003469 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003470
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003471 # Get the full operator variant.
3472 my $opv = $op . substr($curr_vars, $off, 1);
3473
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003474 # Ignore operators passed as parameters.
3475 if ($op_type ne 'V' &&
3476 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3477
Andy Whitcroftcf655042008-03-04 14:28:20 -08003478# # Ignore comments
3479# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003480
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003481 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003482 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003483 if ($ctx !~ /.x[WEBC]/ &&
3484 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003485 if (ERROR("SPACING",
3486 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003487 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003488 $line_fixed = 1;
3489 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003490 }
3491
3492 # // is a comment
3493 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003494
Joe Perchesb00e4812014-04-03 14:49:33 -07003495 # : when part of a bitfield
3496 } elsif ($opv eq ':B') {
3497 # skip the bitfield test for now
3498
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003499 # No spaces for:
3500 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003501 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003502 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003503 if (ERROR("SPACING",
3504 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003505 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003506 if (defined $fix_elements[$n + 2]) {
3507 $fix_elements[$n + 2] =~ s/^\s+//;
3508 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003509 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003510 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003511 }
3512
3513 # , must have a space on the right.
3514 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003515 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003516 if (ERROR("SPACING",
3517 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003518 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003519 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003520 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003521 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003522 }
3523
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003524 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003525 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003526 #warn "'*' is part of type\n";
3527
3528 # unary operators should have a space before and
3529 # none after. May be left adjacent to another
3530 # unary operator, or a cast
3531 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003532 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003533 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003534 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003535 if (ERROR("SPACING",
3536 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003537 if ($n != $last_after + 2) {
3538 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3539 $line_fixed = 1;
3540 }
Joe Perches3705ce52013-07-03 15:05:31 -07003541 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003542 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003543 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003544 # A unary '*' may be const
3545
3546 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003547 if (ERROR("SPACING",
3548 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003549 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003550 if (defined $fix_elements[$n + 2]) {
3551 $fix_elements[$n + 2] =~ s/^\s+//;
3552 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003553 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003554 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003555 }
3556
3557 # unary ++ and unary -- are allowed no space on one side.
3558 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003559 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003560 if (ERROR("SPACING",
3561 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003562 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003563 $line_fixed = 1;
3564 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003565 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003566 if ($ctx =~ /Wx[BE]/ ||
3567 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003568 if (ERROR("SPACING",
3569 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003570 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003571 $line_fixed = 1;
3572 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003573 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003574 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003575 if (ERROR("SPACING",
3576 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003577 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003578 if (defined $fix_elements[$n + 2]) {
3579 $fix_elements[$n + 2] =~ s/^\s+//;
3580 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003581 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003582 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003583 }
3584
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003585 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003586 } elsif ($op eq '<<' or $op eq '>>' or
3587 $op eq '&' or $op eq '^' or $op eq '|' or
3588 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003589 $op eq '*' or $op eq '/' or
3590 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003591 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003592 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003593 if (ERROR("SPACING",
3594 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003595 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3596 if (defined $fix_elements[$n + 2]) {
3597 $fix_elements[$n + 2] =~ s/^\s+//;
3598 }
Joe Perches3705ce52013-07-03 15:05:31 -07003599 $line_fixed = 1;
3600 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003601 }
3602
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003603 # A colon needs no spaces before when it is
3604 # terminating a case value or a label.
3605 } elsif ($opv eq ':C' || $opv eq ':L') {
3606 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003607 if (ERROR("SPACING",
3608 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003609 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003610 $line_fixed = 1;
3611 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003612 }
3613
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003614 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003615 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003616 my $ok = 0;
3617
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003618 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003619 if (($op eq '<' &&
3620 $cc =~ /^\S+\@\S+>/) ||
3621 ($op eq '>' &&
3622 $ca =~ /<\S+\@\S+$/))
3623 {
3624 $ok = 1;
3625 }
3626
Joe Perches84731622013-11-12 15:10:05 -08003627 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003628 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003629 my $msg_type = \&ERROR;
3630 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3631
3632 if (&{$msg_type}("SPACING",
3633 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003634 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3635 if (defined $fix_elements[$n + 2]) {
3636 $fix_elements[$n + 2] =~ s/^\s+//;
3637 }
Joe Perches3705ce52013-07-03 15:05:31 -07003638 $line_fixed = 1;
3639 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003640 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003641 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003642 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003643
3644## print("n: <$n> GOOD: <$good>\n");
3645
3646 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003647 }
Joe Perches3705ce52013-07-03 15:05:31 -07003648
3649 if (($#elements % 2) == 0) {
3650 $fixed_line = $fixed_line . $fix_elements[$#elements];
3651 }
3652
Joe Perches194f66f2014-08-06 16:11:03 -07003653 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
3654 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07003655 }
3656
3657
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003658 }
3659
Joe Perches786b6322013-07-03 15:05:32 -07003660# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003661 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003662 if (WARN("SPACING",
3663 "space prohibited before semicolon\n" . $herecurr) &&
3664 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003665 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07003666 s/^(\+.*\S)\s+;/$1;/;
3667 }
3668 }
3669
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003670# check for multiple assignments
3671 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003672 CHK("MULTIPLE_ASSIGNMENTS",
3673 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003674 }
3675
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003676## # check for multiple declarations, allowing for a function declaration
3677## # continuation.
3678## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3679## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3680##
3681## # Remove any bracketed sections to ensure we do not
3682## # falsly report the parameters of functions.
3683## my $ln = $line;
3684## while ($ln =~ s/\([^\(\)]*\)//g) {
3685## }
3686## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003687## WARN("MULTIPLE_DECLARATION",
3688## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003689## }
3690## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003691
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003692#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003693 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3694 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003695 if (ERROR("SPACING",
3696 "space required before the open brace '{'\n" . $herecurr) &&
3697 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003698 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003699 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003700 }
3701
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003702## # check for blank lines before declarations
3703## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3704## $prevrawline =~ /^.\s*$/) {
3705## WARN("SPACING",
3706## "No blank lines before declarations\n" . $hereprev);
3707## }
3708##
3709
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003710# closing brace should have a space following it when it has anything
3711# on the line
3712 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003713 if (ERROR("SPACING",
3714 "space required after that close brace '}'\n" . $herecurr) &&
3715 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003716 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003717 s/}((?!(?:,|;|\)))\S)/} $1/;
3718 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003719 }
3720
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003721# check spacing on square brackets
3722 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003723 if (ERROR("SPACING",
3724 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3725 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003726 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003727 s/\[\s+/\[/;
3728 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003729 }
3730 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003731 if (ERROR("SPACING",
3732 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3733 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003734 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003735 s/\s+\]/\]/;
3736 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003737 }
3738
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003739# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003740 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3741 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003742 if (ERROR("SPACING",
3743 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3744 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003745 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003746 s/\(\s+/\(/;
3747 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003748 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003749 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003750 $line !~ /for\s*\(.*;\s+\)/ &&
3751 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003752 if (ERROR("SPACING",
3753 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3754 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003755 print("fixlinenr: <$fixlinenr> fixed[fixlinenr]: <$fixed[$fixlinenr]>\n");
3756 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003757 s/\s+\)/\)/;
3758 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003759 }
3760
Joe Perchese2826fd2014-08-06 16:10:48 -07003761# check unnecessary parentheses around addressof/dereference single $Lvals
3762# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3763
3764 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
3765 CHK("UNNECESSARY_PARENTHESES",
3766 "Unnecessary parentheses around $1\n" . $herecurr);
3767 }
3768
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003769#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003770 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003771 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003772 if (WARN("INDENTED_LABEL",
3773 "labels should not be indented\n" . $herecurr) &&
3774 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003775 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003776 s/^(.)\s+/$1/;
3777 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003778 }
3779
Joe Perches5b9553a2014-04-03 14:49:21 -07003780# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003781 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003782 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003783 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003784 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3785 my $value = $1;
3786 $value = deparenthesize($value);
3787 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3788 ERROR("RETURN_PARENTHESES",
3789 "return is not a function, parentheses are not required\n" . $herecurr);
3790 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003791 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003792 ERROR("SPACING",
3793 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003794 }
3795 }
Joe Perches507e5142013-11-12 15:10:13 -08003796
Joe Perchesb43ae212014-06-23 13:22:07 -07003797# unnecessary return in a void function
3798# at end-of-function, with the previous line a single leading tab, then return;
3799# and the line before that not a goto label target like "out:"
3800 if ($sline =~ /^[ \+]}\s*$/ &&
3801 $prevline =~ /^\+\treturn\s*;\s*$/ &&
3802 $linenr >= 3 &&
3803 $lines[$linenr - 3] =~ /^[ +]/ &&
3804 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07003805 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07003806 "void function return statements are not generally useful\n" . $hereprev);
3807 }
Joe Perches9819cf22014-06-04 16:12:09 -07003808
Joe Perches189248d2014-01-23 15:54:47 -08003809# if statements using unnecessary parentheses - ie: if ((foo == bar))
3810 if ($^V && $^V ge 5.10.0 &&
3811 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3812 my $openparens = $1;
3813 my $count = $openparens =~ tr@\(@\(@;
3814 my $msg = "";
3815 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3816 my $comp = $4; #Not $1 because of $LvalOrFunc
3817 $msg = " - maybe == should be = ?" if ($comp eq "==");
3818 WARN("UNNECESSARY_PARENTHESES",
3819 "Unnecessary parentheses$msg\n" . $herecurr);
3820 }
3821 }
3822
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003823# Return of what appears to be an errno should normally be -'ve
3824 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3825 my $name = $1;
3826 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003827 WARN("USE_NEGATIVE_ERRNO",
3828 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003829 }
3830 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003831
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003832# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003833 if ($line =~ /\b(if|while|for|switch)\(/) {
3834 if (ERROR("SPACING",
3835 "space required before the open parenthesis '('\n" . $herecurr) &&
3836 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003837 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003838 s/\b(if|while|for|switch)\(/$1 \(/;
3839 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003840 }
3841
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003842# Check for illegal assignment in if conditional -- and check for trailing
3843# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003844 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003845 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3846 ctx_statement_block($linenr, $realcnt, 0)
3847 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003848 my ($stat_next) = ctx_statement_block($line_nr_next,
3849 $remain_next, $off_next);
3850 $stat_next =~ s/\n./\n /g;
3851 ##print "stat<$stat> stat_next<$stat_next>\n";
3852
3853 if ($stat_next =~ /^\s*while\b/) {
3854 # If the statement carries leading newlines,
3855 # then count those as offsets.
3856 my ($whitespace) =
3857 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3858 my $offset =
3859 statement_rawlines($whitespace) - 1;
3860
3861 $suppress_whiletrailers{$line_nr_next +
3862 $offset} = 1;
3863 }
3864 }
3865 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003866 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003867 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003868 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003869
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003870 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003871 ERROR("ASSIGN_IN_IF",
3872 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003873 }
3874
3875 # Find out what is on the end of the line after the
3876 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003877 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003878 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003879 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003880 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3881 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003882 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003883 # Find out how long the conditional actually is.
3884 my @newlines = ($c =~ /\n/gs);
3885 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003886 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003887
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003888 $stat_real = raw_line($linenr, $cond_lines)
3889 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003890 if (defined($stat_real) && $cond_lines > 1) {
3891 $stat_real = "[...]\n$stat_real";
3892 }
3893
Joe Perches000d1cc12011-07-25 17:13:25 -07003894 ERROR("TRAILING_STATEMENTS",
3895 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003896 }
3897 }
3898
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003899# Check for bitwise tests written as boolean
3900 if ($line =~ /
3901 (?:
3902 (?:\[|\(|\&\&|\|\|)
3903 \s*0[xX][0-9]+\s*
3904 (?:\&\&|\|\|)
3905 |
3906 (?:\&\&|\|\|)
3907 \s*0[xX][0-9]+\s*
3908 (?:\&\&|\|\||\)|\])
3909 )/x)
3910 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003911 WARN("HEXADECIMAL_BOOLEAN_TEST",
3912 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003913 }
3914
Andy Whitcroft8905a672007-11-28 16:21:06 -08003915# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003916 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3917 my $s = $1;
3918 $s =~ s/$;//g; # Remove any comments
3919 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003920 ERROR("TRAILING_STATEMENTS",
3921 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003922 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003923 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003924# if should not continue a brace
3925 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003926 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07003927 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003928 $herecurr);
3929 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003930# case and default should not have general statements after them
3931 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3932 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003933 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003934 \s*return\s+
3935 )/xg)
3936 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003937 ERROR("TRAILING_STATEMENTS",
3938 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003939 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003940
3941 # Check for }<nl>else {, these must be at the same
3942 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07003943 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
3944 $previndent == $indent) {
3945 if (ERROR("ELSE_AFTER_BRACE",
3946 "else should follow close brace '}'\n" . $hereprev) &&
3947 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3948 fix_delete_line($fixlinenr - 1, $prevrawline);
3949 fix_delete_line($fixlinenr, $rawline);
3950 my $fixedline = $prevrawline;
3951 $fixedline =~ s/}\s*$//;
3952 if ($fixedline !~ /^\+\s*$/) {
3953 fix_insert_line($fixlinenr, $fixedline);
3954 }
3955 $fixedline = $rawline;
3956 $fixedline =~ s/^(.\s*)else/$1} else/;
3957 fix_insert_line($fixlinenr, $fixedline);
3958 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003959 }
3960
Joe Perches8b8856f2014-08-06 16:11:14 -07003961 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
3962 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003963 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3964
3965 # Find out what is on the end of the line after the
3966 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003967 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003968 $s =~ s/\n.*//g;
3969
3970 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07003971 if (ERROR("WHILE_AFTER_BRACE",
3972 "while should follow close brace '}'\n" . $hereprev) &&
3973 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3974 fix_delete_line($fixlinenr - 1, $prevrawline);
3975 fix_delete_line($fixlinenr, $rawline);
3976 my $fixedline = $prevrawline;
3977 my $trailing = $rawline;
3978 $trailing =~ s/^\+//;
3979 $trailing = trim($trailing);
3980 $fixedline =~ s/}\s*$/} $trailing/;
3981 fix_insert_line($fixlinenr, $fixedline);
3982 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003983 }
3984 }
3985
Joe Perches95e2c602013-07-03 15:05:20 -07003986#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003987 while ($line =~ m{($Constant|$Lval)}g) {
3988 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003989
3990#gcc binary extension
3991 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003992 if (WARN("GCC_BINARY_CONSTANT",
3993 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3994 $fix) {
3995 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07003996 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003997 s/\b$var\b/$hexval/;
3998 }
Joe Perches95e2c602013-07-03 15:05:20 -07003999 }
4000
4001#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004002 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004003 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004004#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004005 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004006#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07004007 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004008 while ($var =~ m{($Ident)}g) {
4009 my $word = $1;
4010 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004011 if ($check) {
4012 seed_camelcase_includes();
4013 if (!$file && !$camelcase_file_seeded) {
4014 seed_camelcase_file($realfile);
4015 $camelcase_file_seeded = 1;
4016 }
4017 }
Joe Perches7e781f62013-09-11 14:23:55 -07004018 if (!defined $camelcase{$word}) {
4019 $camelcase{$word} = 1;
4020 CHK("CAMELCASE",
4021 "Avoid CamelCase: <$word>\n" . $herecurr);
4022 }
Joe Perches34456862013-07-03 15:05:34 -07004023 }
Joe Perches323c1262012-12-17 16:02:07 -08004024 }
4025 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004026
4027#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004028 if ($line =~ /\#\s*define.*\\\s+$/) {
4029 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4030 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4031 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004032 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004033 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004034 }
4035
Andy Whitcroft653d4872007-06-23 17:16:34 -07004036#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004037 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004038 my $file = "$1.h";
4039 my $checkfile = "include/linux/$file";
4040 if (-f "$root/$checkfile" &&
4041 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004042 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004043 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004044 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004045 CHK("ARCH_INCLUDE_LINUX",
4046 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004047 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004048 WARN("INCLUDE_LINUX",
4049 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004050 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004051 }
4052 }
4053
Andy Whitcroft653d4872007-06-23 17:16:34 -07004054# multi-statement macros should be enclosed in a do while loop, grab the
4055# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004056# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004057 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4058 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004059 my $ln = $linenr;
4060 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004061 my ($off, $dstat, $dcond, $rest);
4062 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004063 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004064 ctx_statement_block($linenr, $realcnt, 0);
4065 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004066 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004067 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004068
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004069 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004070 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004071 $dstat =~ s/\\\n.//g;
4072 $dstat =~ s/^\s*//s;
4073 $dstat =~ s/\s*$//s;
4074
4075 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004076 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4077 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08004078 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004079 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004080 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004081
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004082 # Flatten any obvious string concatentation.
4083 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
4084 $dstat =~ s/$Ident\s*("X*")/$1/)
4085 {
4086 }
4087
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004088 my $exceptions = qr{
4089 $Declare|
4090 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004091 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004092 DECLARE_PER_CPU|
4093 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004094 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004095 union|
4096 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004097 \.$Ident\s*=\s*|
4098 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004099 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004100 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004101 if ($dstat ne '' &&
4102 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4103 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004104 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004105 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004106 $dstat !~ /$exceptions/ &&
4107 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004108 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004109 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004110 $dstat !~ /^for\s*$Constant$/ && # for (...)
4111 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4112 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004113 $dstat !~ /^\({/ && # ({...
4114 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004115 {
4116 $ctx =~ s/\n*$//;
4117 my $herectx = $here . "\n";
4118 my $cnt = statement_rawlines($ctx);
4119
4120 for (my $n = 0; $n < $cnt; $n++) {
4121 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004122 }
4123
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004124 if ($dstat =~ /;/) {
4125 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4126 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4127 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004128 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004129 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004130 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004131 }
Joe Perches5023d342012-12-17 16:01:47 -08004132
Joe Perches481eb482012-12-17 16:01:56 -08004133# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004134
4135 } else {
4136 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004137 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4138 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004139 $line =~ /^\+.*\\$/) {
4140 WARN("LINE_CONTINUATIONS",
4141 "Avoid unnecessary line continuations\n" . $herecurr);
4142 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004143 }
4144
Joe Perchesb13edf72012-07-30 14:41:24 -07004145# do {} while (0) macro tests:
4146# single-statement macros do not need to be enclosed in do while (0) loop,
4147# macro should not end with a semicolon
4148 if ($^V && $^V ge 5.10.0 &&
4149 $realfile !~ m@/vmlinux.lds.h$@ &&
4150 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4151 my $ln = $linenr;
4152 my $cnt = $realcnt;
4153 my ($off, $dstat, $dcond, $rest);
4154 my $ctx = '';
4155 ($dstat, $dcond, $ln, $cnt, $off) =
4156 ctx_statement_block($linenr, $realcnt, 0);
4157 $ctx = $dstat;
4158
4159 $dstat =~ s/\\\n.//g;
4160
4161 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4162 my $stmts = $2;
4163 my $semis = $3;
4164
4165 $ctx =~ s/\n*$//;
4166 my $cnt = statement_rawlines($ctx);
4167 my $herectx = $here . "\n";
4168
4169 for (my $n = 0; $n < $cnt; $n++) {
4170 $herectx .= raw_line($linenr, $n) . "\n";
4171 }
4172
Joe Perchesac8e97f2012-08-21 16:15:53 -07004173 if (($stmts =~ tr/;/;/) == 1 &&
4174 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004175 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4176 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4177 }
4178 if (defined $semis && $semis ne "") {
4179 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4180 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4181 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004182 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4183 $ctx =~ s/\n*$//;
4184 my $cnt = statement_rawlines($ctx);
4185 my $herectx = $here . "\n";
4186
4187 for (my $n = 0; $n < $cnt; $n++) {
4188 $herectx .= raw_line($linenr, $n) . "\n";
4189 }
4190
4191 WARN("TRAILING_SEMICOLON",
4192 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004193 }
4194 }
4195
Mike Frysinger080ba922009-01-06 14:41:25 -08004196# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4197# all assignments may have only one of the following with an assignment:
4198# .
4199# ALIGN(...)
4200# VMLINUX_SYMBOL(...)
4201 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004202 WARN("MISSING_VMLINUX_SYMBOL",
4203 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004204 }
4205
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004206# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004207 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4208 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004209 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004210 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004211 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4212 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004213 my @allowed = ();
4214 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004215 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004216 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004217 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004218 for my $chunk (@chunks) {
4219 my ($cond, $block) = @{$chunk};
4220
Andy Whitcroft773647a2008-03-28 14:15:58 -07004221 # If the condition carries leading newlines, then count those as offsets.
4222 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4223 my $offset = statement_rawlines($whitespace) - 1;
4224
Joe Perchesaad4f612012-03-23 15:02:19 -07004225 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004226 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4227
4228 # We have looked at and allowed this specific line.
4229 $suppress_ifbraces{$ln + $offset} = 1;
4230
4231 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004232 $ln += statement_rawlines($block) - 1;
4233
Andy Whitcroft773647a2008-03-28 14:15:58 -07004234 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004235
4236 $seen++ if ($block =~ /^\s*{/);
4237
Joe Perchesaad4f612012-03-23 15:02:19 -07004238 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004239 if (statement_lines($cond) > 1) {
4240 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004241 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004242 }
4243 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004244 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004245 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004246 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004247 if (statement_block_size($block) > 1) {
4248 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004249 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004250 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004251 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004252 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004253 if ($seen) {
4254 my $sum_allowed = 0;
4255 foreach (@allowed) {
4256 $sum_allowed += $_;
4257 }
4258 if ($sum_allowed == 0) {
4259 WARN("BRACES",
4260 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4261 } elsif ($sum_allowed != $allow &&
4262 $seen != $allow) {
4263 CHK("BRACES",
4264 "braces {} should be used on all arms of this statement\n" . $herectx);
4265 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004266 }
4267 }
4268 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004269 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004270 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004271 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004272
Andy Whitcroftcf655042008-03-04 14:28:20 -08004273 # Check the pre-context.
4274 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4275 #print "APW: ALLOWED: pre<$1>\n";
4276 $allowed = 1;
4277 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004278
4279 my ($level, $endln, @chunks) =
4280 ctx_statement_full($linenr, $realcnt, $-[0]);
4281
Andy Whitcroftcf655042008-03-04 14:28:20 -08004282 # Check the condition.
4283 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004284 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004285 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004286 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004287 }
4288 if (statement_lines($cond) > 1) {
4289 #print "APW: ALLOWED: cond<$cond>\n";
4290 $allowed = 1;
4291 }
4292 if ($block =~/\b(?:if|for|while)\b/) {
4293 #print "APW: ALLOWED: block<$block>\n";
4294 $allowed = 1;
4295 }
4296 if (statement_block_size($block) > 1) {
4297 #print "APW: ALLOWED: lines block<$block>\n";
4298 $allowed = 1;
4299 }
4300 # Check the post-context.
4301 if (defined $chunks[1]) {
4302 my ($cond, $block) = @{$chunks[1]};
4303 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004304 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004305 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004306 if ($block =~ /^\s*\{/) {
4307 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4308 $allowed = 1;
4309 }
4310 }
4311 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004312 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004313 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004314
Andy Whitcroftf0556632008-10-15 22:02:23 -07004315 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004316 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004317 }
4318
Joe Perches000d1cc12011-07-25 17:13:25 -07004319 WARN("BRACES",
4320 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004321 }
4322 }
4323
Joe Perches0979ae62012-12-17 16:01:59 -08004324# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004325 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004326 CHK("BRACES",
4327 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
4328 }
Joe Perches77b9a532013-07-03 15:05:29 -07004329 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08004330 CHK("BRACES",
4331 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
4332 }
4333
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004334# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004335 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4336 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004337 WARN("VOLATILE",
4338 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004339 }
4340
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004341# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004342 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004343 CHK("REDUNDANT_CODE",
4344 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004345 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004346 }
4347
Andy Whitcroft03df4b52012-12-17 16:01:52 -08004348# check for needless "if (<foo>) fn(<foo>)" uses
4349 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
4350 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
4351 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
4352 WARN('NEEDLESS_IF',
4353 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07004354 }
4355 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004356
Joe Perchesebfdc402014-08-06 16:10:27 -07004357# check for unnecessary "Out of Memory" messages
4358 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
4359 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
4360 (defined $1 || defined $3) &&
4361 $linenr > 3) {
4362 my $testval = $2;
4363 my $testline = $lines[$linenr - 3];
4364
4365 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
4366# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4367
4368 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4369 WARN("OOM_MESSAGE",
4370 "Possible unnecessary 'out of memory' message\n" . $hereprev);
4371 }
4372 }
4373
Joe Perches8716de32013-09-11 14:24:05 -07004374# check for bad placement of section $InitAttribute (e.g.: __initdata)
4375 if ($line =~ /(\b$InitAttribute\b)/) {
4376 my $attr = $1;
4377 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4378 my $ptr = $1;
4379 my $var = $2;
4380 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
4381 ERROR("MISPLACED_INIT",
4382 "$attr should be placed after $var\n" . $herecurr)) ||
4383 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
4384 WARN("MISPLACED_INIT",
4385 "$attr should be placed after $var\n" . $herecurr))) &&
4386 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004387 $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 -07004388 }
4389 }
4390 }
4391
Joe Perchese970b8842013-11-12 15:10:10 -08004392# check for $InitAttributeData (ie: __initdata) with const
4393 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
4394 my $attr = $1;
4395 $attr =~ /($InitAttributePrefix)(.*)/;
4396 my $attr_prefix = $1;
4397 my $attr_type = $2;
4398 if (ERROR("INIT_ATTRIBUTE",
4399 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4400 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004401 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004402 s/$InitAttributeData/${attr_prefix}initconst/;
4403 }
4404 }
4405
4406# check for $InitAttributeConst (ie: __initconst) without const
4407 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4408 my $attr = $1;
4409 if (ERROR("INIT_ATTRIBUTE",
4410 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4411 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004412 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08004413 /(^\+\s*(?:static\s+))/;
4414 $lead = rtrim($1);
4415 $lead = "$lead " if ($lead !~ /^\+$/);
4416 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07004417 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08004418 }
4419 }
4420
Joe Perchesfbdb8132014-04-03 14:49:14 -07004421# don't use __constant_<foo> functions outside of include/uapi/
4422 if ($realfile !~ m@^include/uapi/@ &&
4423 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4424 my $constant_func = $1;
4425 my $func = $constant_func;
4426 $func =~ s/^__constant_//;
4427 if (WARN("CONSTANT_CONVERSION",
4428 "$constant_func should be $func\n" . $herecurr) &&
4429 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004430 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07004431 }
4432 }
4433
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004434# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004435 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004436 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004437 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004438 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004439 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004440 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4441 }
4442 if ($delay > 2000) {
4443 WARN("LONG_UDELAY",
4444 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004445 }
4446 }
4447
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004448# warn about unexpectedly long msleep's
4449 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4450 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004451 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004452 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004453 }
4454 }
4455
Joe Perches36ec1932013-07-03 15:05:25 -07004456# check for comparisons of jiffies
4457 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4458 WARN("JIFFIES_COMPARISON",
4459 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4460 }
4461
Joe Perches9d7a34a2013-07-03 15:05:26 -07004462# check for comparisons of get_jiffies_64()
4463 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4464 WARN("JIFFIES_COMPARISON",
4465 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4466 }
4467
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004468# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004469# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004470# print "#ifdef in C files should be avoided\n";
4471# print "$herecurr";
4472# $clean = 0;
4473# }
4474
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004475# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004476 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004477 if (ERROR("SPACING",
4478 "exactly one space required after that #$1\n" . $herecurr) &&
4479 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004480 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004481 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4482 }
4483
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004484 }
4485
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004486# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004487 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4488 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004489 my $which = $1;
4490 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004491 CHK("UNCOMMENTED_DEFINITION",
4492 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004493 }
4494 }
4495# check for memory barriers without a comment.
4496 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4497 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004498 WARN("MEMORY_BARRIER",
4499 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004500 }
4501 }
4502# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004503 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004504 CHK("ARCH_DEFINES",
4505 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004506 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004507
Tobias Klauserd4977c72010-05-24 14:33:30 -07004508# Check that the storage class is at the beginning of a declaration
4509 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004510 WARN("STORAGE_CLASS",
4511 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004512 }
4513
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004514# check the location of the inline attribute, that it is between
4515# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004516 if ($line =~ /\b$Type\s+$Inline\b/ ||
4517 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004518 ERROR("INLINE_LOCATION",
4519 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004520 }
4521
Andy Whitcroft8905a672007-11-28 16:21:06 -08004522# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004523 if ($realfile !~ m@\binclude/uapi/@ &&
4524 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004525 if (WARN("INLINE",
4526 "plain inline is preferred over $1\n" . $herecurr) &&
4527 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004528 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004529
4530 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004531 }
4532
Joe Perches3d130fd2011-01-12 17:00:00 -08004533# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004534 if ($realfile !~ m@\binclude/uapi/@ &&
4535 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004536 WARN("PREFER_PACKED",
4537 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004538 }
4539
Joe Perches39b7e282011-07-25 17:13:24 -07004540# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004541 if ($realfile !~ m@\binclude/uapi/@ &&
4542 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004543 WARN("PREFER_ALIGNED",
4544 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004545 }
4546
Joe Perches5f14d3b2012-01-10 15:09:52 -08004547# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004548 if ($realfile !~ m@\binclude/uapi/@ &&
4549 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004550 if (WARN("PREFER_PRINTF",
4551 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4552 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004553 $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 -07004554
4555 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004556 }
4557
Joe Perches6061d942012-03-23 15:02:16 -07004558# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004559 if ($realfile !~ m@\binclude/uapi/@ &&
4560 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004561 if (WARN("PREFER_SCANF",
4562 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4563 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004564 $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 -07004565 }
Joe Perches6061d942012-03-23 15:02:16 -07004566 }
4567
Joe Perches8f53a9b2010-03-05 13:43:48 -08004568# check for sizeof(&)
4569 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004570 WARN("SIZEOF_ADDRESS",
4571 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004572 }
4573
Joe Perches66c80b62012-07-30 14:41:22 -07004574# check for sizeof without parenthesis
4575 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004576 if (WARN("SIZEOF_PARENTHESIS",
4577 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4578 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004579 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004580 }
Joe Perches66c80b62012-07-30 14:41:22 -07004581 }
4582
Joe Perches428e2fd2011-05-24 17:13:39 -07004583# check for line continuations in quoted strings with odd counts of "
4584 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004585 WARN("LINE_CONTINUATIONS",
4586 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004587 }
4588
Joe Perches88982fe2012-12-17 16:02:00 -08004589# check for struct spinlock declarations
4590 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4591 WARN("USE_SPINLOCK_T",
4592 "struct spinlock should be spinlock_t\n" . $herecurr);
4593 }
4594
Joe Perchesa6962d72013-04-29 16:18:13 -07004595# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004596 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004597 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004598 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004599 if (WARN("PREFER_SEQ_PUTS",
4600 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4601 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004602 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004603 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004604 }
4605 }
4606
Andy Whitcroft554e1652012-01-10 15:09:57 -08004607# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004608 if ($^V && $^V ge 5.10.0 &&
4609 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004610 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004611
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004612 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004613 my $ms_val = $7;
4614 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004615
Andy Whitcroft554e1652012-01-10 15:09:57 -08004616 if ($ms_size =~ /^(0x|)0$/i) {
4617 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004618 "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 -08004619 } elsif ($ms_size =~ /^(0x|)1$/i) {
4620 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004621 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4622 }
4623 }
4624
Joe Perches98a9bba2014-01-23 15:54:52 -08004625# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4626 if ($^V && $^V ge 5.10.0 &&
4627 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4628 if (WARN("PREFER_ETHER_ADDR_COPY",
4629 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4630 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004631 $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 -08004632 }
4633 }
4634
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004635# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004636 if ($^V && $^V ge 5.10.0 &&
4637 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004638 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004639 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004640 my $call = $1;
4641 my $cast1 = deparenthesize($2);
4642 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004643 my $cast2 = deparenthesize($7);
4644 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004645 my $cast;
4646
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004647 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004648 $cast = "$cast1 or $cast2";
4649 } elsif ($cast1 ne "") {
4650 $cast = $cast1;
4651 } else {
4652 $cast = $cast2;
4653 }
4654 WARN("MINMAX",
4655 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004656 }
4657 }
4658
Joe Perches4a273192012-07-30 14:41:20 -07004659# check usleep_range arguments
4660 if ($^V && $^V ge 5.10.0 &&
4661 defined $stat &&
4662 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4663 my $min = $1;
4664 my $max = $7;
4665 if ($min eq $max) {
4666 WARN("USLEEP_RANGE",
4667 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4668 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4669 $min > $max) {
4670 WARN("USLEEP_RANGE",
4671 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4672 }
4673 }
4674
Joe Perches823b7942013-11-12 15:10:15 -08004675# check for naked sscanf
4676 if ($^V && $^V ge 5.10.0 &&
4677 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004678 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004679 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4680 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4681 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4682 my $lc = $stat =~ tr@\n@@;
4683 $lc = $lc + $linenr;
4684 my $stat_real = raw_line($linenr, 0);
4685 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4686 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4687 }
4688 WARN("NAKED_SSCANF",
4689 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4690 }
4691
Joe Perchesafc819a2014-06-04 16:12:08 -07004692# check for simple sscanf that should be kstrto<foo>
4693 if ($^V && $^V ge 5.10.0 &&
4694 defined $stat &&
4695 $line =~ /\bsscanf\b/) {
4696 my $lc = $stat =~ tr@\n@@;
4697 $lc = $lc + $linenr;
4698 my $stat_real = raw_line($linenr, 0);
4699 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4700 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4701 }
4702 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
4703 my $format = $6;
4704 my $count = $format =~ tr@%@%@;
4705 if ($count == 1 &&
4706 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
4707 WARN("SSCANF_TO_KSTRTO",
4708 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
4709 }
4710 }
4711 }
4712
Joe Perches70dc8a42013-09-11 14:23:58 -07004713# check for new externs in .h files.
4714 if ($realfile =~ /\.h$/ &&
4715 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004716 if (CHK("AVOID_EXTERNS",
4717 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004718 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004719 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07004720 }
4721 }
4722
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004723# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004724 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004725 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004726 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004727 my $function_name = $1;
4728 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004729
4730 my $s = $stat;
4731 if (defined $cond) {
4732 substr($s, 0, length($cond), '');
4733 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004734 if ($s =~ /^\s*;/ &&
4735 $function_name ne 'uninitialized_var')
4736 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004737 WARN("AVOID_EXTERNS",
4738 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004739 }
4740
4741 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004742 WARN("FUNCTION_ARGUMENTS",
4743 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004744 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004745
4746 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4747 $stat =~ /^.\s*extern\s+/)
4748 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004749 WARN("AVOID_EXTERNS",
4750 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004751 }
4752
4753# checks for new __setup's
4754 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4755 my $name = $1;
4756
4757 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004758 CHK("UNDOCUMENTED_SETUP",
4759 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004760 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004761 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004762
4763# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004764 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004765 WARN("UNNECESSARY_CASTS",
4766 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004767 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004768
Joe Perchesa640d252013-07-03 15:05:21 -07004769# alloc style
4770# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4771 if ($^V && $^V ge 5.10.0 &&
4772 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4773 CHK("ALLOC_SIZEOF_STRUCT",
4774 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4775 }
4776
Joe Perches60a55362014-06-04 16:12:07 -07004777# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4778 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07004779 $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 -07004780 my $oldfunc = $3;
4781 my $a1 = $4;
4782 my $a2 = $10;
4783 my $newfunc = "kmalloc_array";
4784 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07004785 my $r1 = $a1;
4786 my $r2 = $a2;
4787 if ($a1 =~ /^sizeof\s*\S/) {
4788 $r1 = $a2;
4789 $r2 = $a1;
4790 }
4791 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
4792 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07004793 if (WARN("ALLOC_WITH_MULTIPLY",
4794 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
4795 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004796 $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 -07004797
4798 }
4799 }
4800 }
4801
Joe Perches972fdea2013-04-29 16:18:12 -07004802# check for krealloc arg reuse
4803 if ($^V && $^V ge 5.10.0 &&
4804 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4805 WARN("KREALLOC_ARG_REUSE",
4806 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4807 }
4808
Joe Perches5ce59ae2013-02-21 16:44:18 -08004809# check for alloc argument mismatch
4810 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4811 WARN("ALLOC_ARRAY_ARGS",
4812 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4813 }
4814
Joe Perchescaf2a542011-01-12 16:59:56 -08004815# check for multiple semicolons
4816 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004817 if (WARN("ONE_SEMICOLON",
4818 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4819 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004820 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004821 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004822 }
4823
Joe Perchese81f2392014-08-06 16:11:25 -07004824# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08004825 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4826 my $has_break = 0;
4827 my $has_statement = 0;
4828 my $count = 0;
4829 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07004830 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08004831 $prevline--;
4832 my $rline = $rawlines[$prevline - 1];
4833 my $fline = $lines[$prevline - 1];
4834 last if ($fline =~ /^\@\@/);
4835 next if ($fline =~ /^\-/);
4836 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4837 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4838 next if ($fline =~ /^.[\s$;]*$/);
4839 $has_statement = 1;
4840 $count++;
4841 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4842 }
4843 if (!$has_break && $has_statement) {
4844 WARN("MISSING_BREAK",
4845 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4846 }
4847 }
4848
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004849# check for switch/default statements without a break;
4850 if ($^V && $^V ge 5.10.0 &&
4851 defined $stat &&
4852 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4853 my $ctx = '';
4854 my $herectx = $here . "\n";
4855 my $cnt = statement_rawlines($stat);
4856 for (my $n = 0; $n < $cnt; $n++) {
4857 $herectx .= raw_line($linenr, $n) . "\n";
4858 }
4859 WARN("DEFAULT_NO_BREAK",
4860 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004861 }
4862
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004863# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004864 if ($line =~ /\b__FUNCTION__\b/) {
4865 if (WARN("USE_FUNC",
4866 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4867 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004868 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004869 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004870 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004871
Joe Perches2c924882012-03-23 15:02:20 -07004872# check for use of yield()
4873 if ($line =~ /\byield\s*\(\s*\)/) {
4874 WARN("YIELD",
4875 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4876 }
4877
Joe Perches179f8f42013-07-03 15:05:30 -07004878# check for comparisons against true and false
4879 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4880 my $lead = $1;
4881 my $arg = $2;
4882 my $test = $3;
4883 my $otype = $4;
4884 my $trail = $5;
4885 my $op = "!";
4886
4887 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4888
4889 my $type = lc($otype);
4890 if ($type =~ /^(?:true|false)$/) {
4891 if (("$test" eq "==" && "$type" eq "true") ||
4892 ("$test" eq "!=" && "$type" eq "false")) {
4893 $op = "";
4894 }
4895
4896 CHK("BOOL_COMPARISON",
4897 "Using comparison to $otype is error prone\n" . $herecurr);
4898
4899## maybe suggesting a correct construct would better
4900## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4901
4902 }
4903 }
4904
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004905# check for semaphores initialized locked
4906 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004907 WARN("CONSIDER_COMPLETION",
4908 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004909 }
Joe Perches6712d852012-03-23 15:02:20 -07004910
Joe Perches67d0a072011-10-31 17:13:10 -07004911# recommend kstrto* over simple_strto* and strict_strto*
4912 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004913 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004914 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004915 }
Joe Perches6712d852012-03-23 15:02:20 -07004916
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004917# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07004918 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004919 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07004920 "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 -07004921 }
Joe Perches6712d852012-03-23 15:02:20 -07004922
Emese Revfy79404842010-03-05 13:43:53 -08004923# check for various ops structs, ensure they are const.
4924 my $struct_ops = qr{acpi_dock_ops|
4925 address_space_operations|
4926 backlight_ops|
4927 block_device_operations|
4928 dentry_operations|
4929 dev_pm_ops|
4930 dma_map_ops|
4931 extent_io_ops|
4932 file_lock_operations|
4933 file_operations|
4934 hv_ops|
4935 ide_dma_ops|
4936 intel_dvo_dev_ops|
4937 item_operations|
4938 iwl_ops|
4939 kgdb_arch|
4940 kgdb_io|
4941 kset_uevent_ops|
4942 lock_manager_operations|
4943 microcode_ops|
4944 mtrr_ops|
4945 neigh_ops|
4946 nlmsvc_binding|
4947 pci_raw_ops|
4948 pipe_buf_operations|
4949 platform_hibernation_ops|
4950 platform_suspend_ops|
4951 proto_ops|
4952 rpc_pipe_ops|
4953 seq_operations|
4954 snd_ac97_build_ops|
4955 soc_pcmcia_socket_ops|
4956 stacktrace_ops|
4957 sysfs_ops|
4958 tty_operations|
4959 usb_mon_operations|
4960 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004961 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004962 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004963 WARN("CONST_STRUCT",
4964 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004965 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004966 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004967
4968# use of NR_CPUS is usually wrong
4969# ignore definitions of NR_CPUS and usage to define arrays as likely right
4970 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004971 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4972 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004973 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4974 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4975 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004976 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004977 WARN("NR_CPUS",
4978 "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 -07004979 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004980
Joe Perches52ea8502013-11-12 15:10:09 -08004981# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4982 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4983 ERROR("DEFINE_ARCH_HAS",
4984 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4985 }
4986
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004987# check for %L{u,d,i} in strings
4988 my $string;
4989 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4990 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004991 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004992 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004993 WARN("PRINTF_L",
4994 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004995 last;
4996 }
4997 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004998
4999# whine mightly about in_atomic
5000 if ($line =~ /\bin_atomic\s*\(/) {
5001 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005002 ERROR("IN_ATOMIC",
5003 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005004 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005005 WARN("IN_ATOMIC",
5006 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005007 }
5008 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005009
5010# check for lockdep_set_novalidate_class
5011 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5012 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5013 if ($realfile !~ m@^kernel/lockdep@ &&
5014 $realfile !~ m@^include/linux/lockdep@ &&
5015 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005016 ERROR("LOCKDEP",
5017 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005018 }
5019 }
Dave Jones88f88312011-01-12 16:59:59 -08005020
5021 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
5022 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005023 WARN("EXPORTED_WORLD_WRITABLE",
5024 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005025 }
Joe Perches24358802014-04-03 14:49:13 -07005026
Joe Perches515a2352014-04-03 14:49:24 -07005027# Mode permission misuses where it seems decimal should be octal
5028# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5029 if ($^V && $^V ge 5.10.0 &&
5030 $line =~ /$mode_perms_search/) {
5031 foreach my $entry (@mode_permission_funcs) {
5032 my $func = $entry->[0];
5033 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005034
Joe Perches515a2352014-04-03 14:49:24 -07005035 my $skip_args = "";
5036 if ($arg_pos > 1) {
5037 $arg_pos--;
5038 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5039 }
5040 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5041 if ($line =~ /$test/) {
5042 my $val = $1;
5043 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005044
Joe Perches515a2352014-04-03 14:49:24 -07005045 if ($val !~ /^0$/ &&
5046 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5047 length($val) ne 4)) {
5048 ERROR("NON_OCTAL_PERMISSIONS",
5049 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
5050 }
Joe Perches24358802014-04-03 14:49:13 -07005051 }
5052 }
5053 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005054 }
5055
5056 # If we have no input at all, then there is nothing to report on
5057 # so just keep quiet.
5058 if ($#rawlines == -1) {
5059 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005060 }
5061
Andy Whitcroft8905a672007-11-28 16:21:06 -08005062 # In mailback mode only produce a report in the negative, for
5063 # things that appear to be patches.
5064 if ($mailback && ($clean == 1 || !$is_patch)) {
5065 exit(0);
5066 }
5067
5068 # This is not a patch, and we are are in 'no-patch' mode so
5069 # just keep quiet.
5070 if (!$chk_patch && !$is_patch) {
5071 exit(0);
5072 }
5073
5074 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005075 ERROR("NOT_UNIFIED_DIFF",
5076 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005077 }
5078 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005079 ERROR("MISSING_SIGN_OFF",
5080 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005081 }
5082
Andy Whitcroft8905a672007-11-28 16:21:06 -08005083 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005084 if ($summary && !($clean == 1 && $quiet == 1)) {
5085 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005086 print "total: $cnt_error errors, $cnt_warn warnings, " .
5087 (($check)? "$cnt_chk checks, " : "") .
5088 "$cnt_lines lines checked\n";
5089 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005090 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005091
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005092 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005093
5094 if ($^V lt 5.10.0) {
5095 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
5096 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
5097 }
5098
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005099 # If there were whitespace errors which cleanpatch can fix
5100 # then suggest that.
5101 if ($rpt_cleaners) {
5102 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
5103 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07005104 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07005105 }
5106 }
5107
Joe Perches91bfe482013-09-11 14:23:59 -07005108 hash_show_words(\%use_type, "Used");
5109 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07005110
Joe Perchesd752fcc2014-08-06 16:11:05 -07005111 if ($clean == 0 && $fix &&
5112 ("@rawlines" ne "@fixed" ||
5113 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08005114 my $newfile = $filename;
5115 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07005116 my $linecount = 0;
5117 my $f;
5118
Joe Perchesd752fcc2014-08-06 16:11:05 -07005119 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
5120
Joe Perches3705ce52013-07-03 15:05:31 -07005121 open($f, '>', $newfile)
5122 or die "$P: Can't open $newfile for write\n";
5123 foreach my $fixed_line (@fixed) {
5124 $linecount++;
5125 if ($file) {
5126 if ($linecount > 3) {
5127 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07005128 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07005129 }
5130 } else {
5131 print $f $fixed_line . "\n";
5132 }
5133 }
5134 close($f);
5135
5136 if (!$quiet) {
5137 print << "EOM";
5138Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
5139
5140Do _NOT_ trust the results written to this file.
5141Do _NOT_ submit these changes without inspecting them for correctness.
5142
5143This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5144No warranties, expressed or implied...
5145
5146EOM
5147 }
5148 }
5149
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005150 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005151 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005152 }
5153 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005154 print << "EOM";
5155$vname has style problems, please review.
5156
5157If any of these errors are false positives, please report
5158them to the maintainer, see CHECKPATCH in MAINTAINERS.
5159EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005160 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005161
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005162 return $clean;
5163}