checkpatch.pl 64.6 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

Andy Whitcroft's avatar
Andy Whitcroft committed
12
my $V = '0.22';
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_only;
21
my $emacs = 0;
22
my $terse = 0;
23
24
my $file = 0;
my $check = 0;
25
26
my $summary = 1;
my $mailback = 0;
27
my $summary_file = 0;
28
my $root;
29
my %debug;
30
GetOptions(
31
	'q|quiet+'	=> \$quiet,
32
33
34
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
35
	'emacs!'	=> \$emacs,
36
	'terse!'	=> \$terse,
37
38
39
40
	'file!'		=> \$file,
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
	'root=s'	=> \$root,
41
42
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
43
44
	'summary-file!'	=> \$summary_file,

45
	'debug=s'	=> \%debug,
46
	'test-only=s'	=> \$tst_only,
47
48
49
50
51
) or exit;

my $exit = 0;

if ($#ARGV < 0) {
52
	print "usage: $P [options] patchfile\n";
53
	print "version: $V\n";
54
55
56
57
58
59
60
61
62
	print "options: -q               => quiet\n";
	print "         --no-tree        => run without a kernel tree\n";
	print "         --terse          => one line per report\n";
	print "         --emacs          => emacs compile window format\n";
	print "         --file           => check a source file\n";
	print "         --strict         => enable more subjective tests\n";
	print "         --root           => path to the kernel tree root\n";
	print "         --no-summary     => suppress the per-file summary\n";
	print "         --summary-file   => include the filename in summary\n";
63
64
65
	exit(1);
}

66
67
my $dbg_values = 0;
my $dbg_possible = 0;
68
my $dbg_type = 0;
69
my $dbg_attr = 0;
70
71
72
73
for my $key (keys %debug) {
	eval "\${dbg_$key} = '$debug{$key}';"
}

74
75
76
77
78
if ($terse) {
	$emacs = 1;
	$quiet++;
}

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
if ($tree) {
	if (defined $root) {
		if (!top_of_kernel_tree($root)) {
			die "$P: $root: --root does not point at a valid tree\n";
		}
	} else {
		if (top_of_kernel_tree('.')) {
			$root = '.';
		} elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
						top_of_kernel_tree($1)) {
			$root = $1;
		}
	}

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

99
100
101
102
103
104
105
106
107
108
109
my $emitted_corrupt = 0;

our $Ident       = qr{[A-Za-z_][A-Za-z\d_]*};
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
110
			__kprobes
111
112
113
114
115
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
116
117
118
119
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
			____cacheline_internodealigned_in_smp
120
		  }x;
121
our $Modifier;
122
123
124
125
126
127
128
129
130
our $Inline	= qr{inline|__always_inline|noinline};
our $Member	= qr{->$Ident|\.$Ident|\[[^]]*\]};
our $Lval	= qr{$Ident(?:$Member)*};

our $Constant	= qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
our $Assignment	= qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
131
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
132
133
		  }x;

134
135
136
137
our $NonptrType;
our $Type;
our $Declare;

138
139
140
141
142
143
144
145
146
147
148
our $UTF8	= qr {
	[\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;

149
150
our @typeList = (
	qr{void},
151
152
153
154
155
156
157
	qr{(?:unsigned\s+)?char},
	qr{(?:unsigned\s+)?short},
	qr{(?:unsigned\s+)?int},
	qr{(?:unsigned\s+)?long},
	qr{(?:unsigned\s+)?long\s+int},
	qr{(?:unsigned\s+)?long\s+long},
	qr{(?:unsigned\s+)?long\s+long\s+int},
158
159
160
161
162
163
164
165
166
167
168
169
	qr{unsigned},
	qr{float},
	qr{double},
	qr{bool},
	qr{(?:__)?(?:u|s|be|le)(?:8|16|32|64)},
	qr{struct\s+$Ident},
	qr{union\s+$Ident},
	qr{enum\s+$Ident},
	qr{${Ident}_t},
	qr{${Ident}_handler},
	qr{${Ident}_handler_fn},
);
170
171
172
our @modifierList = (
	qr{fastcall},
);
173
174

sub build_types {
175
176
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
177
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
178
	$NonptrType	= qr{
179
			(?:$Modifier\s+|const\s+)*
180
			(?:
181
182
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
				(?:${all}\b)
183
			)
184
			(?:\s+$Modifier|\s+const)*
185
186
		  }x;
	$Type	= qr{
187
			$NonptrType
188
			(?:\s*\*+\s*const|\s*\*+|(?:\s*\[\s*\])+)?
189
			(?:\s+$Inline|\s+$Modifier)*
190
191
192
193
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
194
195
196

$chk_signoff = 0 if ($file);

197
198
my @dep_includes = ();
my @dep_functions = ();
199
200
201
202
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
	open(REMOVE, "<$root/$removal") ||
				die "$P: $removal: open failed - $!\n";
203
	while (<REMOVE>) {
204
205
206
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
207
208
					push(@dep_includes, $1);

209
210
211
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
212
			}
213
214
215
216
		}
	}
}

217
my @rawlines = ();
218
219
my @lines = ();
my $vname;
220
221
222
223
224
225
226
for my $filename (@ARGV) {
	if ($file) {
		open(FILE, "diff -u /dev/null $filename|") ||
			die "$P: $filename: diff failed - $!\n";
	} else {
		open(FILE, "<$filename") ||
			die "$P: $filename: open failed - $!\n";
227
	}
228
229
230
231
232
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
233
234
235
236
237
	while (<FILE>) {
		chomp;
		push(@rawlines, $_);
	}
	close(FILE);
238
	if (!process($filename)) {
239
240
241
		$exit = 1;
	}
	@rawlines = ();
242
	@lines = ();
243
244
245
246
247
}

exit($exit);

sub top_of_kernel_tree {
248
249
250
251
252
253
254
255
256
257
258
259
	my ($root) = @_;

	my @tree_check = (
		"COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
		"README", "Documentation", "arch", "include", "drivers",
		"fs", "init", "ipc", "kernel", "lib", "scripts",
	);

	foreach my $check (@tree_check) {
		if (! -e $root . '/' . $check) {
			return 0;
		}
260
	}
261
	return 1;
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
}

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;
}
284
sub copy_spacing {
285
	(my $res = shift) =~ tr/\t/ /c;
286
287
	return $res;
}
288

289
290
291
292
293
294
295
296
297
298
299
300
301
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));
}

302
303
304
305
306
307
308
309
310
311
312
my $sanitise_quote = '';

sub sanitise_line_reset {
	my ($in_comment) = @_;

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
313
314
315
316
317
318
sub sanitise_line {
	my ($line) = @_;

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

319
	my $qlen = 0;
320
321
	my $off = 0;
	my $c;
322

323
324
325
326
327
328
329
330
331
332
333
334
335
336
	# Always copy over the diff marker.
	$res = substr($line, 0, 1);

	for ($off = 1; $off < length($line); $off++) {
		$c = substr($line, $off, 1);

		# Comments we are wacking completly including the begin
		# and end, all to $;.
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
			$sanitise_quote = '*/';

			substr($res, $off, 2, "$;$;");
			$off++;
			next;
337
		}
338
		if (substr($line, $off, 2) eq '*/') {
339
340
341
342
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
343
		}
344
345
346
347
348
349
350

		# A \ in a string means ignore the next character.
		if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
		    $c eq "\\") {
			substr($res, $off, 2, 'XX');
			$off++;
			next;
351
		}
352
353
354
355
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
356

357
358
359
360
361
362
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
363

364
365
366
367
368
369
370
371
		#print "SQ:$sanitise_quote\n";
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
372
373
374
	}

	# The pathname on a #include may be surrounded by '<' and '>'.
375
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
376
377
378
379
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
380
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
381
		my $clean = 'X' x length($1);
382
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
383
384
	}

385
386
387
	return $res;
}

388
389
390
391
392
393
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
394
	my $coff_set = 0;
395

396
397
	my $loff = 0;

398
399
	my $type = '';
	my $level = 0;
400
	my $p;
401
402
	my $c;
	my $len = 0;
403
404

	my $remainder;
405
	while (1) {
406
		#warn "CSB: blk<$blk> remain<$remain>\n";
407
408
409
410
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
411
				next if ($lines[$line] =~ /^-/);
412
				$remain--;
413
				$loff = $len;
414
				$blk .= $lines[$line] . "\n";
415
416
417
418
419
420
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
421
			if ($off >= $len) {
422
423
424
				last;
			}
		}
425
		$p = $c;
426
		$c = substr($blk, $off, 1);
427
		$remainder = substr($blk, $off);
428

429
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
430
431
432
433
434
435
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

436
		# An else is really a conditional as long as its not else if
437
438
439
440
441
442
443
444
		if ($level == 0 && $coff_set == 0 &&
				(!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
				$remainder =~ /^(else)(?:\s|{)/ &&
				$remainder !~ /^else\s+if\b/) {
			$coff = $off + length($1) - 1;
			$coff_set = 1;
			#warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
			#warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
445
446
		}

447
448
449
450
451
452
453
454
455
456
		if (($type eq '' || $type eq '(') && $c eq '(') {
			$level++;
			$type = '(';
		}
		if ($type eq '(' && $c eq ')') {
			$level--;
			$type = ($level != 0)? '(' : '';

			if ($level == 0 && $coff < $soff) {
				$coff = $off;
457
458
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
475
	# We are truly at the end, so shuffle to the next line.
476
	if ($off == $len) {
477
		$loff = $len + 1;
478
479
480
		$line++;
		$remain--;
	}
481
482
483
484
485
486
487

	my $statement = substr($blk, $soff, $off - $soff + 1);
	my $condition = substr($blk, $soff, $coff - $soff + 1);

	#warn "STATEMENT<$statement>\n";
	#warn "CONDITION<$condition>\n";

488
	#print "coff<$coff> soff<$off> loff<$loff>\n";
489
490
491
492
493

	return ($statement, $condition,
			$line, $remain + 1, $off - $loff + 1, $level);
}

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
sub statement_lines {
	my ($stmt) = @_;

	# Strip the diff line prefixes and rip blank lines at start and end.
	$stmt =~ s/(^|\n)./$1/g;
	$stmt =~ s/^\s*//;
	$stmt =~ s/\s*$//;

	my @stmt_lines = ($stmt =~ /\n/g);

	return $#stmt_lines + 2;
}

sub statement_rawlines {
	my ($stmt) = @_;

	my @stmt_lines = ($stmt =~ /\n/g);

	return $#stmt_lines + 2;
}

sub statement_block_size {
	my ($stmt) = @_;

	$stmt =~ s/(^|\n)./$1/g;
	$stmt =~ s/^\s*{//;
	$stmt =~ s/}\s*$//;
	$stmt =~ s/^\s*//;
	$stmt =~ s/\s*$//;

	my @stmt_lines = ($stmt =~ /\n/g);
	my @stmt_statements = ($stmt =~ /;/g);

	my $stmt_lines = $#stmt_lines + 2;
	my $stmt_statements = $#stmt_statements + 1;

	if ($stmt_lines > $stmt_statements) {
		return $stmt_lines;
	} else {
		return $stmt_statements;
	}
}

537
538
539
540
541
542
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

543
	# Grab the first conditional/block pair.
544
545
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
546
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
547
548
549
550
551
552
553
	push(@chunks, [ $condition, $statement ]);
	if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
		return ($level, $linenr, @chunks);
	}

	# Pull in the following conditional/block pairs and see if they
	# could continue the statement.
554
555
556
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
557
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
558
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
559
560
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
561
562
563
	}

	return ($level, $linenr, @chunks);
564
565
}

566
sub ctx_block_get {
567
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
568
569
570
571
572
573
574
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

575
	my $level = 0;
576
577
578
579
580
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
581
582
583
584
585
586
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
587

588
589
590
591
592
593
594
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
595

596
		if (!$outer || $level <= 1) {
597
			push(@res, $rawlines[$line]);
598
599
		}

600
		last if ($level == 0);
601
602
	}

603
	return ($level, @res);
604
605
606
607
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

608
609
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
610
611
612
613
}
sub ctx_block {
	my ($linenr, $remain) = @_;

614
615
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
616
617
}
sub ctx_statement {
618
619
620
621
622
623
	my ($linenr, $remain, $off) = @_;

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

626
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
627
}
628
629
630
631
632
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
633
634
635
636
637

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

	# Catch a comment on the end of the line itself.
638
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
639
640
641
642
643
644
645
	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++) {
646
647
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
		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);

670
	##print "LINE: $rawlines[$end_line - 1 ]\n";
671
672
673
674
675
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
sub raw_line {
	my ($linenr, $cnt) = @_;

	my $offset = $linenr - 1;
	$cnt++;

	my $line;
	while ($cnt) {
		$line = $rawlines[$offset++];
		next if (defined($line) && $line =~ /^-/);
		$cnt--;
	}

	return $line;
}

692
693
694
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
695

696
697
698
699
700
701
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
702
703
		}
	}
704
	$res =~ s/$/\$/;
705

706
	return $res;
707
708
}

709
my $av_preprocessor = 0;
710
my $av_pending;
711
my @av_paren_type;
712
my $av_pend_colon;
713
714
715

sub annotate_reset {
	$av_preprocessor = 0;
716
717
	$av_pending = '_';
	@av_paren_type = ('E');
718
	$av_pend_colon = 'O';
719
720
}

721
722
sub annotate_values {
	my ($stream, $type) = @_;
723

724
	my $res;
725
	my $var = '_' x length($stream);
726
727
	my $cur = $stream;

728
	print "$stream\n" if ($dbg_values > 1);
729
730

	while (length($cur)) {
731
		@av_paren_type = ('E') if ($#av_paren_type < 0);
732
		print " <" . join('', @av_paren_type) .
733
				"> <$type> <$av_pending>" if ($dbg_values > 1);
734
		if ($cur =~ /^(\s+)/o) {
735
736
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
737
				$type = pop(@av_paren_type);
738
				$av_preprocessor = 0;
739
740
			}

741
		} elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\()/) {
742
			print "DECLARE($1)\n" if ($dbg_values > 1);
743
744
			$type = 'T';

745
746
747
748
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

749
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
750
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
751
			$av_preprocessor = 1;
752
753
754
755
756
757
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

758
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
759
760
761
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
762

763
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
764
			print "PRE_START($1)\n" if ($dbg_values > 1);
765
			$av_preprocessor = 1;
766
767
768

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
769
			$type = 'E';
770

771
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
772
773
774
775
776
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

			push(@av_paren_type, $av_paren_type[$#av_paren_type]);

777
			$type = 'E';
778

779
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
780
781
782
783
784
785
786
787
			print "PRE_END($1)\n" if ($dbg_values > 1);

			$av_preprocessor = 1;

			# Assume all arms of the conditional end as this
			# one does, and continue as if the #endif was not here.
			pop(@av_paren_type);
			push(@av_paren_type, $type);
788
			$type = 'E';
789
790

		} elsif ($cur =~ /^(\\\n)/o) {
791
			print "PRECONT($1)\n" if ($dbg_values > 1);
792

793
794
795
796
797
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

798
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
799
			print "SIZEOF($1)\n" if ($dbg_values > 1);
800
			if (defined $2) {
801
				$av_pending = 'V';
802
803
804
			}
			$type = 'N';

805
		} elsif ($cur =~ /^(if|while|for)\b/o) {
806
			print "COND($1)\n" if ($dbg_values > 1);
807
			$av_pending = 'E';
808
809
			$type = 'N';

810
811
812
813
814
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

815
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
816
			print "KEYWORD($1)\n" if ($dbg_values > 1);
817
818
819
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
820
			print "PAREN('$1')\n" if ($dbg_values > 1);
821
822
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
823
824
825
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
826
827
828
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
829
830
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
831
			} else {
832
				print "PAREN('$1')\n" if ($dbg_values > 1);
833
834
			}

835
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
836
			print "FUNC($1)\n" if ($dbg_values > 1);
837
			$type = 'V';
838
			$av_pending = 'V';
839

840
841
842
843
844
845
846
847
848
		} elsif ($cur =~ /^($Ident\s*):/) {
			if ($type eq 'E') {
				$av_pend_colon = 'L';
			} elsif ($type eq 'T') {
				$av_pend_colon = 'B';
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

849
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
850
			print "IDENT($1)\n" if ($dbg_values > 1);
851
852
853
			$type = 'V';

		} elsif ($cur =~ /^($Assignment)/o) {
854
			print "ASSIGN($1)\n" if ($dbg_values > 1);
855
856
			$type = 'N';

857
		} elsif ($cur =~/^(;|{|})/) {
858
			print "END($1)\n" if ($dbg_values > 1);
859
			$type = 'E';
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
			$av_pend_colon = 'O';

		} elsif ($cur =~ /^(\?)/o) {
			print "QUESTION($1)\n" if ($dbg_values > 1);
			$type = 'N';

		} elsif ($cur =~ /^(:)/o) {
			print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);

			substr($var, length($res), 1, $av_pend_colon);
			if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
				$type = 'E';
			} else {
				$type = 'N';
			}
			$av_pend_colon = 'O';
876

877
		} elsif ($cur =~ /^(;|\[)/o) {
878
			print "CLOSE($1)\n" if ($dbg_values > 1);
879
880
			$type = 'N';

881
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
882
883
884
885
886
887
888
889
890
891
892
893
			my $variant;

			print "OPV($1)\n" if ($dbg_values > 1);
			if ($type eq 'V') {
				$variant = 'B';
			} else {
				$variant = 'U';
			}

			substr($var, length($res), 1, $variant);
			$type = 'N';

894
		} elsif ($cur =~ /^($Operators)/o) {
895
			print "OP($1)\n" if ($dbg_values > 1);
896
897
898
899
900
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
901
			print "C($1)\n" if ($dbg_values > 1);
902
903
904
905
906
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
907
	}
908

909
	return ($res, $var);
910
911
}

912
sub possible {
913
	my ($possible, $line) = @_;
914

915
	print "CHECK<$possible> ($line)\n" if ($dbg_possible > 1);
916
	if ($possible !~ /^(?:$Modifier|$Storage|$Type|DEFINE_\S+)$/ &&
917
918
	    $possible ne 'goto' && $possible ne 'return' &&
	    $possible ne 'case' && $possible ne 'else' &&
919
	    $possible ne 'asm' && $possible ne '__asm__' &&
920
921
922
923
924
925
926
927
	    $possible !~ /^(typedef|struct|enum)\b/) {
		# Check for modifiers.
		$possible =~ s/\s*$Storage\s*//g;
		$possible =~ s/\s*$Sparse\s*//g;
		if ($possible =~ /^\s*$/) {

		} elsif ($possible =~ /\s/) {
			$possible =~ s/\s*$Type\s*//g;
928
929
930
931
			for my $modifier (split(' ', $possible)) {
				warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
				push(@modifierList, $modifier);
			}
932
933
934
935
936

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
937
938
939
940
		build_types();
	}
}

941
942
my $prefix = '';

943
sub report {
944
945
946
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
947
948
949
950
	my $line = $prefix . $_[0];

	$line = (split('\n', $line))[0] . "\n" if ($terse);

951
	push(our @report, $line);
952
953

	return 1;
954
955
}
sub report_dump {
956
	our @report;
957
}
958
sub ERROR {
959
960
961
962
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
963
964
}
sub WARN {
965
966
967
968
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
969
970
}
sub CHK {
971
	if ($check && report("CHECK: $_[0]\n")) {
972
973
974
		our $clean = 0;
		our $cnt_chk++;
	}
975
976
}

977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
sub check_absolute_file {
	my ($absolute, $herecurr) = @_;
	my $file = $absolute;

	##print "absolute<$absolute>\n";

	# See if any suffix of this path is a path within the tree.
	while ($file =~ s@^[^/]*/@@) {
		if (-f "$root/$file") {
			##print "file<$file>\n";
			last;
		}
	}
	if (! -f _)  {
		return 0;
	}

	# It is, so see if the prefix is acceptable.
	my $prefix = $absolute;
	substr($prefix, -length($file)) = '';

	##print "prefix<$prefix>\n";
	if ($prefix ne ".../") {
		WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
	}
}

1004
1005
1006
1007
1008
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1009
	my $prevrawline="";
1010
	my $stashline="";
1011
	my $stashrawline="";
1012

1013
	my $length;
1014
1015
1016
1017
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1018
	our $clean = 1;
1019
1020
1021
	my $signoff = 0;
	my $is_patch = 0;

1022
	our @report = ();
1023
1024
1025
1026
1027
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1028
1029
1030
1031
1032
1033
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1034
	my $comment_edge = 0;
1035
1036
	my $first_line = 0;

1037
1038
1039
	my $prev_values = 'E';

	# suppression flags
1040
	my %suppress_ifbraces;
1041

1042
	# Pre-scan the patch sanitizing the lines.
1043
	# Pre-scan the patch looking for any __setup documentation.
1044
	#
1045
1046
	my @setup_docs = ();
	my $setup_docs = 0;
1047
1048

	sanitise_line_reset();
1049
1050
	my $line;
	foreach my $rawline (@rawlines) {
1051
1052
		$linenr++;
		$line = $rawline;
1053

1054
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1055
1056
1057
1058
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1059
1060
1061
1062
1063
1064
1065
1066
1067
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1068
			$in_comment = 0;
1069
1070
1071
1072
1073
1074

			# Guestimate if this is a continuing comment.  Run
			# the context looking for a comment "edge".  If this
			# edge is a close comment then we must be in a comment
			# at context start.
			my $edge;
1075
1076
1077
1078
1079
1080
1081
1082
			my $cnt = $realcnt;
			for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
				next if (defined $rawlines[$ln - 1] &&
					 $rawlines[$ln - 1] =~ /^-/);
				$cnt--;
				#print "RAW<$rawlines[$ln - 1]>\n";
				($edge) = (defined $rawlines[$ln - 1] &&
					$rawlines[$ln - 1] =~ m@(/\*|\*/)@);
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
				last if (defined $edge);
			}
			if (defined $edge && $edge eq '*/') {
				$in_comment = 1;
			}

			# 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.
			if (!defined $edge &&
			    $rawlines[$linenr] =~ m@^.\s* \*(?:\s|$)@)
			{
				$in_comment = 1;
			}

			##print "COMMENT:$in_comment edge<$edge> $rawline\n";
			sanitise_line_reset($in_comment);

1101
		} elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1102
			# Standardise the strings and chars within the input to
1103
			# simplify matching -- only bother with positive lines.
1104
			$line = sanitise_line($rawline);
1105
		}
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
		push(@lines, $line);

		if ($realcnt > 1) {
			$realcnt-- if ($line =~ /^(?:\+| |$)/);
		} else {
			$realcnt = 0;
		}

		#print "==>$rawline\n";
		#print "-->$line\n";
1116
1117
1118
1119
1120
1121

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

1122
1123
	$prefix = '';

1124
1125
	$realcnt = 0;
	$linenr = 0;
1126
1127
1128
	foreach my $line (@lines) {
		$linenr++;

1129
		my $rawline = $rawlines[$linenr - 1];
1130

1131
#extract the line range in the file after the patch is applied
1132
		if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1133
			$is_patch = 1;
1134
			$first_line = $linenr + 1;
1135
1136
1137
1138
1139
1140
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1141
			annotate_reset();
1142
1143
			$prev_values = 'E';

1144
			%suppress_ifbraces = ();
1145
1146
			next;

1147
1148
1149
# 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.
1150
		} elsif ($line =~ /^( |\+|$)/) {
1151
			$realline++;
1152
			$realcnt-- if ($realcnt != 0);
1153

1154
			# Measure the line length and indent.
1155
			($length, $indent) = line_stats($rawline);
1156
1157
1158
1159

			# Track the previous line.
			($prevline, $stashline) = ($stashline, $line);
			($previndent, $stashindent) = ($stashindent, $indent);
1160
1161
			($prevrawline, $stashrawline) = ($stashrawline, $rawline);

1162
			#warn "line<$line>\n";
1163

1164
1165
		} elsif ($realcnt == 1) {
			$realcnt--;
1166
1167
1168
		}

#make up the handle for any error we report on this line
1169
1170
1171
		$prefix = "$filename:$realline: " if ($emacs && $file);
		$prefix = "$filename:$linenr: " if ($emacs && !$file);

1172
1173
		$here = "#$linenr: " if (!$file);
		$here = "#$realline: " if ($file);
1174
1175
1176
1177
1178
1179

		# extract the filename as it passes
		if ($line=~/^\+\+\+\s+(\S+)/) {
			$realfile = $1;
			$realfile =~ s@^[^/]*/@@;

1180
			if ($realfile =~ m@^include/asm/@) {
1181
1182
1183
1184
1185
				ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
			}
			next;
		}

1186
		$here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1187

1188
1189
1190
		my $hereline = "$here\n$rawline\n";
		my $herecurr = "$here\n$rawline\n";
		my $hereprev = "$here\n$prevrawline\n$rawline\n";