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

use strict;

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

Andy Whitcroft's avatar
Andy Whitcroft committed
13
my $V = '0.28';
14
15
16
17
18
19
20

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

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

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

my $exit = 0;

if ($#ARGV < 0) {
53
	print "usage: $P [options] patchfile\n";
54
	print "version: $V\n";
55
56
57
58
59
60
61
62
63
	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";
64
65
66
	exit(1);
}

67
68
my $dbg_values = 0;
my $dbg_possible = 0;
69
my $dbg_type = 0;
70
my $dbg_attr = 0;
71
for my $key (keys %debug) {
72
73
74
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
75
76
}

77
78
79
80
81
if ($terse) {
	$emacs = 1;
	$quiet++;
}

82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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);
	}
100
101
}

102
103
104
105
106
107
108
109
110
111
112
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|
113
114
			__kprobes|
			__ref
115
116
117
118
119
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
120
121
122
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
123
124
			____cacheline_internodealigned_in_smp|
			__weak
125
		  }x;
126
our $Modifier;
127
128
129
130
131
132
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
133
our $Compare    = qr{<=|>=|==|!=|<|>};
134
135
136
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
137
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
138
139
		  }x;

140
141
142
143
our $NonptrType;
our $Type;
our $Declare;

144
145
146
147
148
149
150
151
152
153
154
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;

155
156
157
158
159
our $typeTypedefs = qr{(?x:
	(?:__)?(?:u|s|be|le)(?:\d|\d\d)|
	atomic_t
)};

160
161
our @typeList = (
	qr{void},
162
163
164
165
166
167
168
	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},
169
170
171
172
173
174
175
176
177
178
179
	qr{unsigned},
	qr{float},
	qr{double},
	qr{bool},
	qr{struct\s+$Ident},
	qr{union\s+$Ident},
	qr{enum\s+$Ident},
	qr{${Ident}_t},
	qr{${Ident}_handler},
	qr{${Ident}_handler_fn},
);
180
181
182
our @modifierList = (
	qr{fastcall},
);
183
184

sub build_types {
185
186
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
187
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
188
	$NonptrType	= qr{
189
			(?:$Modifier\s+|const\s+)*
190
			(?:
191
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
192
				(?:$typeTypedefs\b)|
193
				(?:${all}\b)
194
			)
195
			(?:\s+$Modifier|\s+const)*
196
197
		  }x;
	$Type	= qr{
198
			$NonptrType
199
			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
200
			(?:\s+$Inline|\s+$Modifier)*
201
202
203
204
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
205
206
207

$chk_signoff = 0 if ($file);

208
209
my @dep_includes = ();
my @dep_functions = ();
210
211
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
212
	open(my $REMOVE, '<', "$root/$removal") ||
213
				die "$P: $removal: open failed - $!\n";
214
	while (<$REMOVE>) {
215
216
217
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
218
219
					push(@dep_includes, $1);

220
221
222
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
223
			}
224
225
		}
	}
226
	close($REMOVE);
227
228
}

229
my @rawlines = ();
230
231
my @lines = ();
my $vname;
232
for my $filename (@ARGV) {
233
	my $FILE;
234
	if ($file) {
235
		open($FILE, '-|', "diff -u /dev/null $filename") ||
236
			die "$P: $filename: diff failed - $!\n";
237
238
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
239
	} else {
240
		open($FILE, '<', "$filename") ||
241
			die "$P: $filename: open failed - $!\n";
242
	}
243
244
245
246
247
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
248
	while (<$FILE>) {
249
250
251
		chomp;
		push(@rawlines, $_);
	}
252
	close($FILE);
253
	if (!process($filename)) {
254
255
256
		$exit = 1;
	}
	@rawlines = ();
257
	@lines = ();
258
259
260
261
262
}

exit($exit);

sub top_of_kernel_tree {
263
264
265
266
267
268
269
270
271
272
273
274
	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;
		}
275
	}
276
	return 1;
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
}

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;
}
299
sub copy_spacing {
300
	(my $res = shift) =~ tr/\t/ /c;
301
302
	return $res;
}
303

304
305
306
307
308
309
310
311
312
313
314
315
316
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));
}

317
318
319
320
321
322
323
324
325
326
327
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
328
329
330
331
332
333
sub sanitise_line {
	my ($line) = @_;

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

334
	my $qlen = 0;
335
336
	my $off = 0;
	my $c;
337

338
339
340
341
342
343
344
345
346
347
348
349
350
351
	# 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;
352
		}
353
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
354
355
356
357
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
358
		}
359
360
361
362
363
364
365
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
366
367
368
369
370
371
372

		# 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;
373
		}
374
375
376
377
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
378

379
380
381
382
383
384
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
385

386
		#print "c<$c> SQ<$sanitise_quote>\n";
387
388
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
389
390
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
391
392
393
394
395
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
396
397
	}

398
399
400
401
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

402
	# The pathname on a #include may be surrounded by '<' and '>'.
403
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
404
405
406
407
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
408
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
409
		my $clean = 'X' x length($1);
410
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
411
412
	}

413
414
415
	return $res;
}

416
417
418
419
420
421
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
422
	my $coff_set = 0;
423

424
425
	my $loff = 0;

426
427
	my $type = '';
	my $level = 0;
428
	my @stack = ();
429
	my $p;
430
431
	my $c;
	my $len = 0;
432
433

	my $remainder;
434
	while (1) {
435
436
		@stack = (['', 0]) if ($#stack == -1);

437
		#warn "CSB: blk<$blk> remain<$remain>\n";
438
439
440
441
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
442
				last if (!defined $lines[$line]);
443
				next if ($lines[$line] =~ /^-/);
444
				$remain--;
445
				$loff = $len;
446
				$blk .= $lines[$line] . "\n";
447
448
449
450
451
452
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
453
			if ($off >= $len) {
454
455
456
				last;
			}
		}
457
		$p = $c;
458
		$c = substr($blk, $off, 1);
459
		$remainder = substr($blk, $off);
460

461
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
462
463
464
465
466
467
468
469
470
471

		# Handle nested #if/#else.
		if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
			push(@stack, [ $type, $level ]);
		} elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
			($type, $level) = @{$stack[$#stack - 1]};
		} elsif ($remainder =~ /^#\s*endif\b/) {
			($type, $level) = @{pop(@stack)};
		}

472
473
474
475
476
477
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

478
		# An else is really a conditional as long as its not else if
479
480
481
482
483
484
485
486
		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";
487
488
		}

489
490
491
492
493
494
495
496
497
498
		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;
499
500
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
517
	# We are truly at the end, so shuffle to the next line.
518
	if ($off == $len) {
519
		$loff = $len + 1;
520
521
522
		$line++;
		$remain--;
	}
523
524
525
526
527
528
529

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

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

530
	#print "coff<$coff> soff<$off> loff<$loff>\n";
531
532
533
534
535

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

536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
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;
	}
}

579
580
581
582
583
584
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

585
	# Grab the first conditional/block pair.
586
587
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
588
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
589
590
591
592
593
594
595
	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.
596
597
598
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
599
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
600
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
601
602
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
603
604
605
	}

	return ($level, $linenr, @chunks);
606
607
}

608
sub ctx_block_get {
609
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
610
611
612
613
614
615
616
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

617
	my $level = 0;
618
	my @stack = ($level);
619
620
621
622
623
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
624
625
626
627
628
629
630
631
632
633

		# Handle nested #if/#else.
		if ($rawlines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
			push(@stack, $level);
		} elsif ($rawlines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
			$level = $stack[$#stack - 1];
		} elsif ($rawlines[$line] =~ /^.\s*#\s*endif\b/) {
			$level = pop(@stack);
		}

634
635
636
637
638
639
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
640

641
642
643
644
645
646
647
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
648

649
		if (!$outer || $level <= 1) {
650
			push(@res, $rawlines[$line]);
651
652
		}

653
		last if ($level == 0);
654
655
	}

656
	return ($level, @res);
657
658
659
660
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

661
662
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
663
664
665
666
}
sub ctx_block {
	my ($linenr, $remain) = @_;

667
668
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
669
670
}
sub ctx_statement {
671
672
673
674
675
676
	my ($linenr, $remain, $off) = @_;

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

679
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
680
}
681
682
683
684
685
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
686
687
688
689
690

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

	# Catch a comment on the end of the line itself.
691
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
692
693
694
695
696
697
698
	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++) {
699
700
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
		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);

723
	##print "LINE: $rawlines[$end_line - 1 ]\n";
724
725
726
727
728
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
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;
}

745
746
747
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
748

749
750
751
752
753
754
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
755
756
		}
	}
757
	$res =~ s/$/\$/;
758

759
	return $res;
760
761
}

762
my $av_preprocessor = 0;
763
my $av_pending;
764
my @av_paren_type;
765
my $av_pend_colon;
766
767
768

sub annotate_reset {
	$av_preprocessor = 0;
769
770
	$av_pending = '_';
	@av_paren_type = ('E');
771
	$av_pend_colon = 'O';
772
773
}

774
775
sub annotate_values {
	my ($stream, $type) = @_;
776

777
	my $res;
778
	my $var = '_' x length($stream);
779
780
	my $cur = $stream;

781
	print "$stream\n" if ($dbg_values > 1);
782
783

	while (length($cur)) {
784
		@av_paren_type = ('E') if ($#av_paren_type < 0);
785
		print " <" . join('', @av_paren_type) .
786
				"> <$type> <$av_pending>" if ($dbg_values > 1);
787
		if ($cur =~ /^(\s+)/o) {
788
789
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
790
				$type = pop(@av_paren_type);
791
				$av_preprocessor = 0;
792
793
			}

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

798
799
800
801
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

802
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
803
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
804
			$av_preprocessor = 1;
805
806
807
808
809
810
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

811
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
812
813
814
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
815

816
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
817
			print "PRE_START($1)\n" if ($dbg_values > 1);
818
			$av_preprocessor = 1;
819
820
821

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
822
			$type = 'E';
823

824
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
825
826
827
828
829
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

830
			$type = 'E';
831

832
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
833
834
835
836
837
838
839
840
			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);
841
			$type = 'E';
842
843

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

846
847
848
849
850
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

851
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
852
			print "SIZEOF($1)\n" if ($dbg_values > 1);
853
			if (defined $2) {
854
				$av_pending = 'V';
855
856
857
			}
			$type = 'N';

858
		} elsif ($cur =~ /^(if|while|for)\b/o) {
859
			print "COND($1)\n" if ($dbg_values > 1);
860
			$av_pending = 'E';
861
862
			$type = 'N';

863
864
865
866
867
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

868
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
869
			print "KEYWORD($1)\n" if ($dbg_values > 1);
870
871
872
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
873
			print "PAREN('$1')\n" if ($dbg_values > 1);
874
875
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
876
877
878
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
879
880
881
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
882
883
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
884
			} else {
885
				print "PAREN('$1')\n" if ($dbg_values > 1);
886
887
			}

888
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
889
			print "FUNC($1)\n" if ($dbg_values > 1);
890
			$type = 'V';
891
			$av_pending = 'V';
892

893
894
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
895
				$av_pend_colon = 'B';
896
897
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
898
899
900
901
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

902
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
903
			print "IDENT($1)\n" if ($dbg_values > 1);
904
905
906
			$type = 'V';

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

910
		} elsif ($cur =~/^(;|{|})/) {
911
			print "END($1)\n" if ($dbg_values > 1);
912
			$type = 'E';
913
914
			$av_pend_colon = 'O';

915
916
917
918
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

919
920
921
922
923
924
925
926
927
928
929
930
931
932
		} 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';
933

934
		} elsif ($cur =~ /^(\[)/o) {
935
			print "CLOSE($1)\n" if ($dbg_values > 1);
936
937
			$type = 'N';

938
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
939
940
941
942
943
944
945
946
947
948
949
950
			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';

951
		} elsif ($cur =~ /^($Operators)/o) {
952
			print "OP($1)\n" if ($dbg_values > 1);
953
954
955
956
957
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
958
			print "C($1)\n" if ($dbg_values > 1);
959
960
961
962
963
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
964
	}
965

966
	return ($res, $var);
967
968
}

969
sub possible {
970
	my ($possible, $line) = @_;
971

972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
	print "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ /(?:
		^(?:
			$Modifier|
			$Storage|
			$Type|
			DEFINE_\S+|
			goto|
			return|
			case|
			else|
			asm|__asm__|
			do
		)$|
		^(?:typedef|struct|enum)\b
	    )/x) {
988
989
990
991
992
993
994
		# 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;
995
996
997
998
			for my $modifier (split(' ', $possible)) {
				warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
				push(@modifierList, $modifier);
			}
999
1000
1001
1002
1003

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1004
		build_types();
1005
1006
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1007
1008
1009
	}
}

1010
1011
my $prefix = '';

1012
sub report {
1013
1014
1015
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1016
1017
1018
1019
	my $line = $prefix . $_[0];

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

1020
	push(our @report, $line);
1021
1022

	return 1;
1023
1024
}
sub report_dump {
1025
	our @report;
1026
}
1027
sub ERROR {
1028
1029
1030
1031
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1032
1033
}
sub WARN {
1034
1035
1036
1037
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1038
1039
}
sub CHK {
1040
	if ($check && report("CHECK: $_[0]\n")) {
1041
1042
1043
		our $clean = 0;
		our $cnt_chk++;
	}
1044
1045
}

1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
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);
	}
}

1073
1074
1075
1076
1077
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1078
	my $prevrawline="";
1079
	my $stashline="";
1080
	my $stashrawline="";
1081

1082
	my $length;
1083
1084
1085
1086
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1087
	our $clean = 1;
1088
1089
1090
	my $signoff = 0;
	my $is_patch = 0;

1091
	our @report = ();
1092
1093
1094
1095
1096
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1097
1098
1099
1100
1101
1102
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1103
	my $comment_edge = 0;
1104
	my $first_line = 0;
1105
	my $p1_prefix = '';
1106

1107
1108
1109
	my $prev_values = 'E';

	# suppression flags
1110
	my %suppress_ifbraces;
1111
	my %suppress_whiletrailers;
1112

1113
	# Pre-scan the patch sanitizing the lines.
1114
	# Pre-scan the patch looking for any __setup documentation.
1115
	#
1116
1117
	my @setup_docs = ();
	my $setup_docs = 0;
1118
1119

	sanitise_line_reset();
1120
1121
	my $line;
	foreach my $rawline (@rawlines) {
1122
1123
		$linenr++;
		$line = $rawline;
1124

1125
		if ($rawline=~/^\+\+\+\s+(\S+)/) {
1126
1127
1128
1129
			$setup_docs = 0;
			if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
				$setup_docs = 1;
			}
1130
1131
1132
1133
1134
1135
1136
1137
1138
			#next;
		}
		if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
			$realline=$1-1;
			if (defined $2) {
				$realcnt=$3+1;
			} else {
				$realcnt=1+1;
			}
1139
			$in_comment = 0;
1140
1141
1142
1143
1144
1145

			# 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;
1146
1147
1148
1149
1150
1151
			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";
1152
				last if (!defined $rawlines[$ln - 1]);
1153
1154
1155
1156
1157
				if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
				    $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
					($edge) = $1;
					last;
				}
1158
1159
1160
1161
1162
1163
1164
1165
1166
			}
			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 &&
1167
			    $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)