checkpatch.pl 30.4 KB
Newer Older
1
2
#!/usr/bin/perl -w
# (c) 2001, Dave Jones. <davej@codemonkey.org.uk> (the file handling bit)
3
# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4
5
6
7
8
9
# (c) 2007, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite, etc)
# Licensed under the terms of the GNU GPL License version 2

use strict;

my $P = $0;
10
$P =~ s@.*/@@g;
11

12
my $V = '0.09';
13
14
15
16
17
18
19

use Getopt::Long qw(:config no_auto_abbrev);

my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
20
my $tst_type = 0;
21
22
23
24
25
GetOptions(
	'q|quiet'	=> \$quiet,
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
26
	'test-type!'	=> \$tst_type,
27
28
29
30
31
) or exit;

my $exit = 0;

if ($#ARGV < 0) {
32
	print "usage: $P [options] patchfile\n";
33
34
35
36
37
38
39
40
41
42
43
	print "version: $V\n";
	print "options: -q           => quiet\n";
	print "         --no-tree    => run without a kernel tree\n";
	exit(1);
}

if ($tree && !top_of_kernel_tree()) {
	print "Must be run from the top-level dir. of a kernel tree\n";
	exit(2);
}

44
45
my @dep_includes = ();
my @dep_functions = ();
46
47
48
49
my $removal = 'Documentation/feature-removal-schedule.txt';
if ($tree && -f $removal) {
	open(REMOVE, "<$removal") || die "$P: $removal: open failed - $!\n";
	while (<REMOVE>) {
50
51
52
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
53
54
					push(@dep_includes, $1);

55
56
57
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
58
			}
59
60
61
62
		}
	}
}

63
my @rawlines = ();
64
65
while (<>) {
	chomp;
66
	push(@rawlines, $_);
67
	if (eof(ARGV)) {
68
		if (!process($ARGV, @rawlines)) {
69
70
			$exit = 1;
		}
71
		@rawlines = ();
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
	}
}

exit($exit);

sub top_of_kernel_tree {
	if ((-f "COPYING") && (-f "CREDITS") && (-f "Kbuild") &&
	    (-f "MAINTAINERS") && (-f "Makefile") && (-f "README") &&
	    (-d "Documentation") && (-d "arch") && (-d "include") &&
	    (-d "drivers") && (-d "fs") && (-d "init") && (-d "ipc") &&
	    (-d "kernel") && (-d "lib") && (-d "scripts")) {
		return 1;
	}
	return 0;
}

sub expand_tabs {
	my ($str) = @_;

	my $res = '';
	my $n = 0;
	for my $c (split(//, $str)) {
		if ($c eq "\t") {
			$res .= ' ';
			$n++;
			for (; ($n % 8) != 0; $n++) {
				$res .= ' ';
			}
			next;
		}
		$res .= $c;
		$n++;
	}

	return $res;
}

109
110
111
112
113
114
115
116
117
118
119
120
121
sub line_stats {
	my ($line) = @_;

	# Drop the diff line leader and expand tabs
	$line =~ s/^.//;
	$line = expand_tabs($line);

	# Pick the indent from the front of the line.
	my ($white) = ($line =~ /^(\s*)/);

	return (length($line), length($white));
}

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
sub sanitise_line {
	my ($line) = @_;

	my $res = '';
	my $l = '';

	my $quote = '';

	foreach my $c (split(//, $line)) {
		if ($l ne "\\" && ($c eq "'" || $c eq '"')) {
			if ($quote eq '') {
				$quote = $c;
				$res .= $c;
				$l = $c;
				next;
			} elsif ($quote eq $c) {
				$quote = '';
			}
		}
		if ($quote && $c ne "\t") {
			$res .= "X";
		} else {
			$res .= $c;
		}

		$l = $c;
	}

	return $res;
}

153
sub ctx_block_get {
154
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
155
156
157
158
159
160
161
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

162
	my $level = 0;
163
164
165
166
167
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
168
169
170
171
172
173
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
174

175
176
177
178
179
180
181
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
182

183
		if (!$outer || $level <= 1) {
184
			push(@res, $rawlines[$line]);
185
186
		}

187
		last if ($level == 0);
188
189
	}

190
	return ($level, @res);
191
192
193
194
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

195
196
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
197
198
199
200
}
sub ctx_block {
	my ($linenr, $remain) = @_;

201
202
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
203
204
}
sub ctx_statement {
205
206
207
208
209
210
	my ($linenr, $remain, $off) = @_;

	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
	return @r;
}
sub ctx_block_level {
211
212
	my ($linenr, $remain) = @_;

213
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
214
215
216
217
218
219
}

sub ctx_locate_comment {
	my ($first_line, $end_line) = @_;

	# Catch a comment on the end of the line itself.
220
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*$@);
221
222
223
224
225
226
227
	return $current_comment if (defined $current_comment);

	# Look through the context and try and figure out if there is a
	# comment.
	my $in_comment = 0;
	$current_comment = '';
	for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
228
229
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
		if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
			$in_comment = 1;
		}
		if ($line =~ m@/\*@) {
			$in_comment = 1;
		}
		if (!$in_comment && $current_comment ne '') {
			$current_comment = '';
		}
		$current_comment .= $line . "\n" if ($in_comment);
		if ($line =~ m@\*/@) {
			$in_comment = 0;
		}
	}

	chomp($current_comment);
	return($current_comment);
}
sub ctx_has_comment {
	my ($first_line, $end_line) = @_;
	my $cmt = ctx_locate_comment($first_line, $end_line);

252
	##print "LINE: $rawlines[$end_line - 1 ]\n";
253
254
255
256
257
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

258
259
260
261
262
263
264
265
266
sub cat_vet {
	my ($vet) = @_;

	$vet =~ s/\t/^I/;
	$vet =~ s/$/\$/;

	return $vet;
}

267
268
269
270
271
272
273
my @report = ();
sub report {
	push(@report, $_[0]);
}
sub report_dump {
	@report;
}
274
sub ERROR {
275
	report("ERROR: $_[0]\n");
276
277
278
	our $clean = 0;
}
sub WARN {
279
	report("WARNING: $_[0]\n");
280
281
282
	our $clean = 0;
}
sub CHK {
283
	report("CHECK: $_[0]\n");
284
285
286
	our $clean = 0;
}

287
288
289
290
291
292
293
294
sub process {
	my $filename = shift;
	my @lines = @_;

	my $linenr=0;
	my $prevline="";
	my $stashline="";

295
	my $length;
296
297
298
299
	my $indent;
	my $previndent=0;
	my $stashindent=0;

300
	our $clean = 1;
301
302
303
304
305
306
307
308
309
310
311
	my $signoff = 0;
	my $is_patch = 0;

	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
	my $first_line = 0;

312
313
	my $Ident	= qr{[A-Za-z\d_]+};
	my $Storage	= qr{extern|static};
314
	my $Sparse	= qr{__user|__kernel|__force|__iomem|__must_check|__init_refok};
315
316
317
318
319
320
321
322
323
324
325
326
327
	my $NonptrType	= qr{
				\b
				(?:const\s+)?
				(?:unsigned\s+)?
				(?:
					void|
					char|
					short|
					int|
					long|
					unsigned|
					float|
					double|
328
					bool|
329
330
331
					long\s+int|
					long\s+long|
					long\s+long\s+int|
332
333
					u8|u16|u32|u64|
					s8|s16|s32|s64|
334
335
					struct\s+$Ident|
					union\s+$Ident|
336
					enum\s+$Ident|
337
338
339
340
341
342
343
					${Ident}_t
				)
				(?:\s+$Sparse)*
				\b
			  }x;
	my $Type	= qr{
				\b$NonptrType\b
344
345
				(?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
				(?:\s+$Sparse)*
346
347
			  }x;
	my $Declare	= qr{(?:$Storage\s+)?$Type};
348
349
350
351
	my $Attribute	= qr{const|__read_mostly|__init|__initdata|__meminit};

	my $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
	my $Lval	= qr{$Ident(?:$Member)*};
352

353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
	# Pre-scan the patch looking for any __setup documentation.
	my @setup_docs = ();
	my $setup_docs = 0;
	foreach my $line (@lines) {
		if ($line=~/^\+\+\+\s+(\S+)/) {
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
			next;
		}

		if ($setup_docs && $line =~ /^\+/) {
			push(@setup_docs, $line);
		}
	}

370
371
372
	foreach my $line (@lines) {
		$linenr++;

373
374
		my $rawline = $line;

375
376
377
#extract the filename as it passes
		if ($line=~/^\+\+\+\s+(\S+)/) {
			$realfile=$1;
378
			$realfile =~ s@^[^/]*/@@;
379
380
381
382
383
384
			$in_comment = 0;
			next;
		}
#extract the line range in the file after the patch is applied
		if ($line=~/^\@\@ -\d+,\d+ \+(\d+)(,(\d+))? \@\@/) {
			$is_patch = 1;
385
			$first_line = $linenr + 1;
386
387
388
389
390
391
392
393
394
395
			$in_comment = 0;
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
			next;
		}

396
397
398
399
# track the line number as we move through the hunk, note that
# new versions of GNU diff omit the leading space on completely
# blank context lines so we need to count that too.
		if ($line =~ /^( |\+|$)/) {
400
			$realline++;
401
			$realcnt-- if ($realcnt != 0);
402
403
404
405
406
407
408
409

			# track any sort of multi-line comment.  Obviously if
			# the added text or context do not include the whole
			# comment we will not see it. Such is life.
			#
			# Guestimate if this is a continuing comment.  If this
			# is the start of a diff block and this line starts
			# ' *' then it is very likely a comment.
410
			if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
411
412
413
414
415
416
417
418
419
				$in_comment = 1;
			}
			if ($line =~ m@/\*@) {
				$in_comment = 1;
			}
			if ($line =~ m@\*/@) {
				$in_comment = 0;
			}

420
421
			# Measure the line length and indent.
			($length, $indent) = line_stats($line);
422
423
424
425

			# Track the previous line.
			($prevline, $stashline) = ($stashline, $line);
			($previndent, $stashindent) = ($stashindent, $indent);
426
427
		} elsif ($realcnt == 1) {
			$realcnt--;
428
429
430
		}

#make up the handle for any error we report on this line
431
432
		$here = "#$linenr: ";
		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
433

434
		my $hereline = "$here\n$line\n";
435
436
		my $herecurr = "$here\n$line\n";
		my $hereprev = "$here\n$prevline\n$line\n";
437
438

#check the patch for a signoff:
439
		if ($line =~ /^\s*signed-off-by:/i) {
440
441
			# This is a signoff, if ugly, so do not double report.
			$signoff++;
442
			if (!($line =~ /^\s*Signed-off-by:/)) {
443
444
				WARN("Signed-off-by: is the preferred form\n" .
					$herecurr);
445
446
			}
			if ($line =~ /^\s*signed-off-by:\S/i) {
447
448
				WARN("need space after Signed-off-by:\n" .
					$herecurr);
449
450
451
			}
		}

452
453
# Check for wrappage within a valid hunk of the file
		if ($realcnt != 0 && $line !~ m{^(?:\+|-| |$)}) {
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
			ERROR("patch seems to be corrupt (line wrapped?)\n" .
				$herecurr);
		}

# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
		if (($realfile =~ /^$/ || $line =~ /^\+/) &&
		     !($line =~ m/^(
				[\x09\x0A\x0D\x20-\x7E]              # ASCII
				| [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
				|  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
				| [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
				|  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
				|  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
				| [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
				|  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
				)*$/x )) {
			ERROR("Invalid UTF-8\n" . $herecurr);
471
472
473
474
		}

#ignore lines being removed
		if ($line=~/^-/) {next;}
475

476
477
# check we are in a valid source file if not then ignore this hunk
		next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
478
479

#trailing whitespace
480
		if ($line =~ /^\+.*\S\s+$/ || $line =~ /^\+\s+$/) {
481
482
			my $herevet = "$here\n" . cat_vet($line) . "\n";
			ERROR("trailing whitespace\n" . $herevet);
483
484
		}
#80 column limit
485
		if ($line =~ /^\+/ && !($prevline=~/\/\*\*/) && $length > 80) {
486
			WARN("line over 80 characters\n" . $herecurr);
487
488
489
490
491
492
493
494
		}

# check we are in a valid source file *.[hc] if not then ignore this hunk
		next if ($realfile !~ /\.[hc]$/);

# at the beginning of a line any tabs must come first and anything
# more than 8 must use tabs.
		if ($line=~/^\+\s* \t\s*\S/ or $line=~/^\+\s*        \s*/) {
495
496
			my $herevet = "$here\n" . cat_vet($line) . "\n";
			ERROR("use tabs not spaces\n" . $herevet);
497
498
		}

499
# Remove comments from the line before processing.
500
501
502
503
504
505
506
507
		my $comment_edge = ($line =~ s@/\*.*\*/@@g) +
				   ($line =~ s@/\*.*@@) +
				   ($line =~ s@^(.).*\*/@$1@);

# The rest of our checks refer specifically to C style
# only apply those _outside_ comments.  Only skip
# lines in the middle of comments.
		next if (!$comment_edge && $in_comment);
508

509
510
511
512
513
514
# Standardise the strings and chars within the input to simplify matching.
		$line = sanitise_line($line);

#
# Checks which may be anchored in the context.
#
515

516
517
# Check for switch () and associated case and default
# statements should be at the same indent.
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
		if ($line=~/\bswitch\s*\(.*\)/) {
			my $err = '';
			my $sep = '';
			my @ctx = ctx_block_outer($linenr, $realcnt);
			shift(@ctx);
			for my $ctx (@ctx) {
				my ($clen, $cindent) = line_stats($ctx);
				if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
							$indent != $cindent) {
					$err .= "$sep$ctx\n";
					$sep = '';
				} else {
					$sep = "[...]\n";
				}
			}
			if ($err ne '') {
534
535
536
537
538
539
540
				ERROR("switch and case should be at the same indent\n$hereline\n$err\n");
			}
		}

# if/while/etc brace do not go on next line, unless defining a do while loop,
# or if that brace on the next line is for something else
		if ($line =~ /\b(?:(if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.#/) {
541
			my @ctx = ctx_statement($linenr, $realcnt, 0);
542
543
544
545
546
547
548
549
550
551
552
			my $ctx_ln = $linenr + $#ctx + 1;
			my $ctx_cnt = $realcnt - $#ctx - 1;
			my $ctx = join("\n", @ctx);

			while ($ctx_cnt > 0 && $lines[$ctx_ln - 1] =~ /^-/) {
				$ctx_ln++;
				$ctx_cnt--;
			}
			##warn "line<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>";

			if ($ctx !~ /{\s*/ && $ctx_cnt > 0 && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
553
				ERROR("That open brace { should be on the previous line\n" .
554
					"$here\n$ctx\n$lines[$ctx_ln - 1]");
555
556
557
558
559
560
			}
		}

#ignore lines not being added
		if ($line=~/^[^\+]/) {next;}

561
562
# TEST: allow direct testing of the type matcher.
		if ($tst_type && $line =~ /^.$Declare$/) {
563
			ERROR("TEST: is type $Declare\n" . $herecurr);
564
565
566
			next;
		}

567
568
569
570
571
572
# check for initialisation to aggregates open brace on the next line
		if ($prevline =~ /$Declare\s*$Ident\s*=\s*$/ &&
		    $line =~ /^.\s*{/) {
			ERROR("That open brace { should be on the previous line\n" . $hereprev);
		}

573
574
575
576
577
578
579
580
#
# Checks which are anchored on the added line.
#

# check for malformed paths in #include statements (uses RAW line)
		if ($rawline =~ m{^.#\s*include\s+[<"](.*)[">]}) {
			my $path = $1;
			if ($path =~ m{//}) {
581
582
				ERROR("malformed #include filename\n" .
					$herecurr);
583
584
585
586
587
			}
			# Sanitise this special form of string.
			$path = 'X' x length($path);
			$line =~ s{\<.*\>}{<$path>};
		}
588

589
# no C99 // comments
590
		if ($line =~ m{//}) {
591
			ERROR("do not use C99 // comments\n" . $herecurr);
592
		}
593
		# Remove C99 comments.
594
595
596
		$line =~ s@//.*@@;

#EXPORT_SYMBOL should immediately follow its function closing }.
597
598
599
		if (($line =~ /EXPORT_SYMBOL.*\((.*)\)/) ||
		    ($line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
			my $name = $1;
600
601
			if (($prevline !~ /^}/) &&
			   ($prevline !~ /^\+}/) &&
602
			   ($prevline !~ /^ }/) &&
603
			   ($prevline !~ /\b\Q$name\E(?:\s+$Attribute)?\s*(?:;|=)/)) {
604
				WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
605
606
607
			}
		}

608
609
610
611
612
# check for external initialisers.
		if ($line =~ /^.$Type\s*$Ident\s*=\s*(0|NULL);/) {
			ERROR("do not initialise externals to 0 or NULL\n" .
				$herecurr);
		}
613
# check for static initialisers.
614
		if ($line =~ /\s*static\s.*=\s*(0|NULL);/) {
615
616
			ERROR("do not initialise statics to 0 or NULL\n" .
				$herecurr);
617
618
		}

619
620
621
# check for new typedefs, only function parameters and sparse annotations
# make sense.
		if ($line =~ /\btypedef\s/ &&
622
		    $line !~ /\btypedef\s+$Type\s+\(\s*\*$Ident\s*\)\s*\(/ &&
623
		    $line !~ /\b__bitwise(?:__|)\b/) {
624
			WARN("do not add new typedefs\n" . $herecurr);
625
626
627
		}

# * goes on variable not on type
628
		if ($line =~ m{\($NonptrType(\*+)(?:\s+const)?\)}) {
629
630
			ERROR("\"(foo$1)\" should be \"(foo $1)\"\n" .
				$herecurr);
631
632

		} elsif ($line =~ m{\($NonptrType\s+(\*+)(?!\s+const)\s+\)}) {
633
634
			ERROR("\"(foo $1 )\" should be \"(foo $1)\"\n" .
				$herecurr);
635

636
		} elsif ($line =~ m{$NonptrType(\*+)(?:\s+$Attribute)?\s+[A-Za-z\d_]+}) {
637
638
			ERROR("\"foo$1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
639

640
		} elsif ($line =~ m{$NonptrType\s+(\*+)(?!\s+$Attribute)\s+[A-Za-z\d_]+}) {
641
642
			ERROR("\"foo $1 bar\" should be \"foo $1bar\"\n" .
				$herecurr);
643
644
645
646
647
648
649
650
651
		}

# # no BUG() or BUG_ON()
# 		if ($line =~ /\b(BUG|BUG_ON)\b/) {
# 			print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
# 			print "$herecurr";
# 			$clean = 0;
# 		}

652
653
654
655
656
# printk should use KERN_* levels.  Note that follow on printk's on the
# same line do not need a level, so we use the current block context
# to try and find and validate the current printk.  In summary the current
# printk includes all preceeding printk's which have no newline on the end.
# we assume the first bad printk is the one to report.
657
		if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
658
659
660
661
662
663
664
665
666
667
668
669
670
			my $ok = 0;
			for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
				#print "CHECK<$lines[$ln - 1]\n";
				# we have a preceeding printk if it ends
				# with "\n" ignore it, else it is to blame
				if ($lines[$ln - 1] =~ m{\bprintk\(}) {
					if ($rawlines[$ln - 1] !~ m{\\n"}) {
						$ok = 1;
					}
					last;
				}
			}
			if ($ok == 0) {
671
				WARN("printk() should include KERN_ facility level\n" . $herecurr);
672
			}
673
674
		}

675
676
# function brace can't be on same line, except for #defines of do while,
# or if closed on same line
677
		if (($line=~/$Type\s*[A-Za-z\d_]+\(.*\).* {/) and
678
		    !($line=~/\#define.*do\s{/) and !($line=~/}/)) {
679
			ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
680
		}
681

682
683
# check for spaces between functions and their parentheses.
		if ($line =~ /($Ident)\s+\(/ &&
684
		    $1 !~ /^(?:if|for|while|switch|return|volatile|__volatile__|__attribute__|format|__extension__|Copyright)$/ &&
685
		    $line !~ /$Type\s+\(/ && $line !~ /^.\#\s*define\b/) {
686
			WARN("no space between function name and open parenthesis '('\n" . $herecurr);
687
		}
688
# Check operator spacing.
689
690
691
		# Note we expand the line with the leading + as the real
		# line will be displayed with the leading + and the tabs
		# will therefore also expand that way.
692
		my $opline = $line;
693
		$opline = expand_tabs($opline);
694
		$opline =~ s/^./ /;
695
		if (!($line=~/\#\s*include/)) {
696
			my @elements = split(/(<<=|>>=|<=|>=|==|!=|\+=|-=|\*=|\/=|%=|\^=|\|=|&=|=>|->|<<|>>|<|>|=|!|~|&&|\|\||,|\^|\+\+|--|;|&|\||\+|-|\*|\/\/|\/)/, $opline);
697
			my $off = 0;
698
			for (my $n = 0; $n < $#elements; $n += 2) {
699
700
701
702
703
704
705
706
707
				$off += length($elements[$n]);

				my $a = '';
				$a = 'V' if ($elements[$n] ne '');
				$a = 'W' if ($elements[$n] =~ /\s$/);
				$a = 'B' if ($elements[$n] =~ /(\[|\()$/);
				$a = 'O' if ($elements[$n] eq '');
				$a = 'E' if ($elements[$n] eq '' && $n == 0);

708
				my $op = $elements[$n + 1];
709
710

				my $c = '';
711
				if (defined $elements[$n + 2]) {
712
713
714
715
					$c = 'V' if ($elements[$n + 2] ne '');
					$c = 'W' if ($elements[$n + 2] =~ /^\s/);
					$c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
					$c = 'O' if ($elements[$n + 2] eq '');
716
					$c = 'E' if ($elements[$n + 2] =~ /\s*\\$/);
717
718
				} else {
					$c = 'E';
719
720
				}

721
				# Pick up the preceeding and succeeding characters.
722
				my $ca = substr($opline, 0, $off);
723
				my $cc = '';
724
				if (length($opline) >= ($off + length($elements[$n + 1]))) {
725
					$cc = substr($opline, $off + length($elements[$n + 1]));
726
				}
727
				my $cb = "$ca$;$cc";
728

729
730
731
732
733
				my $ctx = "${a}x${c}";

				my $at = "(ctx:$ctx)";

				my $ptr = (" " x $off) . "^";
734
				my $hereptr = "$hereline$ptr\n";
735
736
737

				##print "<$s1:$op:$s2> <$elements[$n]:$elements[$n + 1]:$elements[$n + 2]>\n";

738
739
				# ; should have either the end of line or a space or \ after it
				if ($op eq ';') {
740
741
742
					if ($ctx !~ /.x[WEB]/ && $cc !~ /^\\/ &&
					    $cc !~ /^;/) {
						ERROR("need space after that '$op' $at\n" . $hereptr);
743
744
745
746
					}

				# // is a comment
				} elsif ($op eq '//') {
747
748
749

				# -> should have no spaces
				} elsif ($op eq '->') {
750
					if ($ctx =~ /Wx.|.xW/) {
751
						ERROR("no spaces around that '$op' $at\n" . $hereptr);
752
753
754
755
					}

				# , must have a space on the right.
				} elsif ($op eq ',') {
756
					if ($ctx !~ /.xW|.xE/ && $cc !~ /^}/) {
757
						ERROR("need space after that '$op' $at\n" . $hereptr);
758
759
760
761
					}

				# unary ! and unary ~ are allowed no space on the right
				} elsif ($op eq '!' or $op eq '~') {
762
					if ($ctx !~ /[WOEB]x./) {
763
						ERROR("need space before that '$op' $at\n" . $hereptr);
764
					}
765
					if ($ctx =~ /.xW/) {
766
						ERROR("no space after that '$op' $at\n" . $hereptr);
767
768
769
770
					}

				# unary ++ and unary -- are allowed no space on one side.
				} elsif ($op eq '++' or $op eq '--') {
771
					if ($ctx !~ /[WOB]x[^W]/ && $ctx !~ /[^W]x[WOBE]/) {
772
						ERROR("need space one side of that '$op' $at\n" . $hereptr);
773
					}
774
					if ($ctx =~ /Wx./ && $cc =~ /^;/) {
775
						ERROR("no space before that '$op' $at\n" . $hereptr);
776
					}
777
778
779
780
781
782
783
784
785
786
787
788
789

				# & is both unary and binary
				# unary:
				# 	a &b
				# binary (consistent spacing):
				#	a&b		OK
				#	a & b		OK
				#
				# boiling down to: if there is a space on the right then there
				# should be one on the left.
				#
				# - is the same
				#
790
				} elsif ($op eq '&' or $op eq '-') {
791
					if ($ctx !~ /VxV|[EW]x[WE]|[EWB]x[VO]/) {
792
						ERROR("need space before that '$op' $at\n" . $hereptr);
793
794
					}

795
796
797
798
799
				# * is the same as & only adding:
				# type:
				# 	(foo *)
				#	(foo **)
				#
800
				} elsif ($op eq '*') {
801
802
803
					if ($ca !~ /$Type$/ && $cb !~ /(\*$;|$;\*)/ &&
					    $ctx !~ /VxV|[EW]x[WE]|[EWB]x[VO]|OxV|WxB|BxB/) {
						ERROR("need space before that '$op' $at\n" . $hereptr);
804
805
806
807
808
809
					}

				# << and >> may either have or not have spaces both sides
				} elsif ($op eq '<<' or $op eq '>>' or $op eq '+' or $op eq '/' or
					 $op eq '^' or $op eq '|')
				{
810
					if ($ctx !~ /VxV|WxW|VxE|WxE/) {
811
812
						ERROR("need consistent spacing around '$op' $at\n" .
							$hereptr);
813
814
815
					}

				# All the others need spaces both sides.
816
				} elsif ($ctx !~ /[EW]x[WE]/) {
817
818
819
820
821
					# Ignore email addresses <foo@bar>
					if (!($op eq '<' && $cb =~ /$;\S+\@\S+>/) &&
					    !($op eq '>' && $cb =~ /<\S+\@\S+$;/)) {
						ERROR("need spaces around that '$op' $at\n" . $hereptr);
					}
822
				}
823
				$off += length($elements[$n + 1]);
824
825
826
			}
		}

827
828
829
830
831
# check for multiple assignments
		if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
			WARN("multiple assignments should be avoided\n" . $herecurr);
		}

832
833
834
835
836
837
838
839
840
841
842
843
844
845
## # check for multiple declarations, allowing for a function declaration
## # continuation.
## 		if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
## 		    $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
##
## 			# Remove any bracketed sections to ensure we do not
## 			# falsly report the parameters of functions.
## 			my $ln = $line;
## 			while ($ln =~ s/\([^\(\)]*\)//g) {
## 			}
## 			if ($ln =~ /,/) {
## 				WARN("declaring multiple variables together should be avoided\n" . $herecurr);
## 			}
## 		}
846

847
#need space before brace following if, while, etc
848
849
		if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
		    $line =~ /do{/) {
850
851
852
853
854
855
856
			ERROR("need a space before the open brace '{'\n" . $herecurr);
		}

# closing brace should have a space following it when it has anything
# on the line
		if ($line =~ /}(?!(?:,|;|\)))\S/) {
			ERROR("need a space after that close brace '}'\n" . $herecurr);
857
858
		}

859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
# check spacing on square brackets
		if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
			ERROR("no space after that open square bracket '['\n" . $herecurr);
		}
		if ($line =~ /\s\]/) {
			ERROR("no space before that close square bracket ']'\n" . $herecurr);
		}

# check spacing on paretheses
		if ($line =~ /\(\s/ && $line !~ /\(\s*$/) {
			ERROR("no space after that open parenthesis '('\n" . $herecurr);
		}
		if ($line =~ /\s\)/) {
			ERROR("no space before that close parenthesis ')'\n" . $herecurr);
		}

875
#goto labels aren't indented, allow a single space however
876
		if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
877
		   !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
878
			WARN("labels should not be indented\n" . $herecurr);
879
880
881
		}

# Need a space before open parenthesis after if, while etc
882
		if ($line=~/\b(if|while|for|switch)\(/) {
883
			ERROR("need a space before the open parenthesis '('\n" . $herecurr);
884
885
886
		}

# Check for illegal assignment in if conditional.
887
		if ($line=~/\bif\s*\(.*[^<>!=]=[^=].*\)/) {
888
			#next if ($line=~/\".*\Q$op\E.*\"/ or $line=~/\'\Q$op\E\'/);
889
			ERROR("do not use assignment in if condition\n" . $herecurr);
890
891
892
893
894
895
		}

		# Check for }<nl>else {, these must be at the same
		# indent level to be relevant to each other.
		if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
						$previndent == $indent) {
896
			ERROR("else should follow close brace '}'\n" . $hereprev);
897
898
899
900
901
902
903
904
905
906
907
		}

#studly caps, commented out until figure out how to distinguish between use of existing and adding new
#		if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
#		    print "No studly caps, use _\n";
#		    print "$herecurr";
#		    $clean = 0;
#		}

#no spaces allowed after \ in define
		if ($line=~/\#define.*\\\s$/) {
908
			WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
909
910
		}

911
912
#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
		if ($tree && $rawline =~ m{^.\#\s*include\s*\<asm\/(.*)\.h\>}) {
913
914
			my $checkfile = "include/linux/$1.h";
			if (-f $checkfile) {
915
916
				CHK("Use #include <linux/$1.h> instead of <asm/$1.h>\n" .
					$herecurr);
917
918
919
			}
		}

920
921
# if and else should not have general statements after it
		if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/ &&
922
923
		    $1 !~ /^\s*(?:\sif|{|\\|$)/) {
			ERROR("trailing statements should be on next line\n" . $herecurr);
924
925
		}

926
927
928
929
930
931
932
933
934
935
# multi-statement macros should be enclosed in a do while loop, grab the
# first statement and ensure its the whole macro if its not enclosed
# in a known goot container
		if (($prevline=~/\#define.*\\/) and
		   !($prevline=~/do\s+{/) and !($prevline=~/\(\{/) and
		   !($line=~/do.*{/) and !($line=~/\(\{/) and
		   !($line=~/^.\s*$Declare\s/)) {
			# Grab the first statement, if that is the entire macro
			# its ok.  This may start either on the #define line
			# or the one below.
936
937
			my $ln = $linenr;
			my $cnt = $realcnt;
938
			my $off = 0;
939

940
941
942
943
			# If the macro starts on the define line start
			# grabbing the statement after the identifier
			$prevline =~ m{^(.#\s*define\s*$Ident(?:\([^\)]*\))?\s*)(.*)\\\s*$};
			##print "1<$1> 2<$2>\n";
944
			if (defined $2 && $2 ne '') {
945
				$off = length($1);
946
947
948
				$ln--;
				$cnt++;
			}
949
			my @ctx = ctx_statement($ln, $cnt, $off);
950
951
952
953
954
955
956
957
958
			my $ctx_ln = $ln + $#ctx + 1;
			my $ctx = join("\n", @ctx);

			# Pull in any empty extension lines.
			while ($ctx =~ /\\$/ &&
			       $lines[$ctx_ln - 1] =~ /^.\s*(?:\\)?$/) {
				$ctx .= $lines[$ctx_ln - 1];
				$ctx_ln++;
			}
959
960
961

			if ($ctx =~ /\\$/) {
				if ($ctx =~ /;/) {
962
					ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
963
				} else {
964
					ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
965
				}
966
			}
967
968
		}

969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
# check for redundant bracing round if etc
		if ($line =~ /\b(if|while|for|else)\b/) {
			# Locate the end of the opening statement.
			my @control = ctx_statement($linenr, $realcnt, 0);
			my $nr = $linenr + (scalar(@control) - 1);
			my $cnt = $realcnt - (scalar(@control) - 1);

			my $off = $realcnt - $cnt;
			#print "$off: line<$line>end<" . $lines[$nr - 1] . ">\n";

			# If this is is a braced statement group check it
			if ($lines[$nr - 1] =~ /{\s*$/) {
				my ($lvl, @block) = ctx_block_level($nr, $cnt);

				my $stmt = join(' ', @block);
984
985
986
987
				$stmt =~ s/(^[^{]*){//;
				my $before = $1;
				$stmt =~ s/}([^}]*$)//;
				my $after = $1;
988
989
990
991
992
993
994
995
996
997
998

				#print "block<" . join(' ', @block) . "><" . scalar(@block) . ">\n";
				#print "stmt<$stmt>\n\n";

				# Count the ;'s if there is fewer than two
				# then there can only be one statement,
				# if there is a brace inside we cannot
				# trivially detect if its one statement.
				# Also nested if's often require braces to
				# disambiguate the else binding so shhh there.
				my @semi = ($stmt =~ /;/g);
999
				push(@semi, "/**/") if ($stmt =~ m@/\*@);
1000
1001
				##print "semi<" . scalar(@semi) . ">\n";
				if ($lvl == 0 && scalar(@semi) < 2 &&
1002
1003
				    $stmt !~ /{/ && $stmt !~ /\bif\b/ &&
				    $before !~ /}/ && $after !~ /{/) {
1004
1005
				    	my $herectx = "$here\n" . join("\n", @control, @block[1 .. $#block]) . "\n";
				    	shift(@block);
1006
					WARN("braces {} are not necessary for single statement blocks\n" . $herectx);
1007
1008
1009
1010
				}
			}
		}

1011
# don't include deprecated include files (uses RAW line)
1012
		for my $inc (@dep_includes) {
1013
			if ($rawline =~ m@\#\s*include\s*\<$inc>@) {
1014
				ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1015
1016
1017
			}
		}

1018
1019
# don't use deprecated functions
		for my $func (@dep_functions) {
1020
			if ($line =~ /\b$func\b/) {
1021
				ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
1022
1023
1024
1025
			}
		}

# no volatiles please
1026
		if ($line =~ /\bvolatile\b/ && $line !~ /\basm\s+volatile\b/) {
1027
			WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
1028
1029
		}

1030
1031
# warn about #if 0
		if ($line =~ /^.#\s*if\s+0\b/) {
1032
1033
			CHK("if this code is redundant consider removing it\n" .
				$herecurr);
1034
1035
		}

1036
1037
1038
1039
1040
1041
1042
1043
# check for needless kfree() checks
		if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
			my $expr = $1;
			if ($line =~ /\bkfree\(\Q$expr\E\);/) {
				WARN("kfree(NULL) is safe this check is probabally not required\n" . $hereprev);
			}
		}

1044
1045
1046
1047
1048
1049
1050
# warn about #ifdefs in C files
#		if ($line =~ /^.#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
#			print "#ifdef in C files should be avoided\n";
#			print "$herecurr";
#			$clean = 0;
#		}

1051
1052
1053
1054
1055
# warn about spacing in #ifdefs
		if ($line =~ /^.#\s*(ifdef|ifndef|elif)\s\s+/) {
			ERROR("exactly one space required after that #$1\n" . $herecurr);
		}

1056
1057
1058
1059
# check for spinlock_t definitions without a comment.
		if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/) {
			my $which = $1;
			if (!ctx_has_comment($first_line, $linenr)) {
1060
				CHK("$1 definition without comment\n" . $herecurr);
1061
1062
1063
1064
1065
			}
		}
# check for memory barriers without a comment.
		if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
			if (!ctx_has_comment($first_line, $linenr)) {
1066
				CHK("memory barrier without comment\n" . $herecurr);
1067
1068
1069
			}
		}
# check of hardware specific defines
1070
		if ($line =~ m@^.#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
1071
			CHK("architecture specific defines should be avoided\n" .  $herecurr);
1072
		}
1073

1074
1075
# check the location of the inline attribute, that it is between
# storage class and type.
1076
1077
		if ($line =~ /$Type\s+(?:inline|__always_inline|noinline)\b/ ||
		    $line =~ /\b(?:inline|__always_inline|noinline)\s+$Storage/) {
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
			ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
		}

# check for new externs in .c files.
		if ($line =~ /^.\s*extern\s/ && ($realfile =~ /\.c$/)) {
			WARN("externs should be avoided in .c files\n" .  $herecurr);
		}

# checks for new __setup's
		if ($rawline =~ /\b__setup\("([^"]*)"/) {
			my $name = $1;

			if (!grep(/$name/, @setup_docs)) {
				CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
			}
1093
		}
1094
1095
1096
	}

	if ($chk_patch && !$is_patch) {
1097
		ERROR("Does not appear to be a unified-diff format patch\n");
1098
1099
	}
	if ($is_patch && $chk_signoff && $signoff == 0) {
1100
		ERROR("Missing Signed-off-by: line(s)\n");
1101
1102
	}

1103
1104
1105
	if ($clean == 0 && ($chk_patch || $is_patch)) {
		print report_dump();
	}
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
	if ($clean == 1 && $quiet == 0) {
		print "Your patch has no obvious style problems and is ready for submission.\n"
	}
	if ($clean == 0 && $quiet == 0) {
		print "Your patch has style problems, please review.  If any of these errors\n";
		print "are false positives report them to the maintainer, see\n";
		print "CHECKPATCH in MAINTAINERS.\n";
	}
	return $clean;
}