checkpatch.pl 72 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
# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5
# (c) 2008,2009, 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.30';
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
my $help = 0;

sub help {
	my ($exitcode) = @_;

	print << "EOM";
Usage: $P [OPTION]... [FILE]...
Version: $V

Options:
  -q, --quiet                quiet
  --no-tree                  run without a kernel tree
  --no-signoff               do not check for 'Signed-off-by' line
  --patch                    treat FILE as patchfile (default)
  --emacs                    emacs compile window format
  --terse                    one line per report
  -f, --file                 treat FILE as regular source file
  --subjective, --strict     enable more subjective tests
  --root=PATH                PATH to the kernel tree root
  --no-summary               suppress the per-file summary
  --mailback                 only produce a report in case of warnings/errors
  --summary-file             include the filename in summary
  --debug KEY=[0|1]          turn on/off debugging of KEY, where KEY is one of
                             'values', 'possible', 'type', and 'attr' (default
                             is all off)
  --test-only=WORD           report only warnings/errors containing WORD
                             literally
  -h, --help, --version      display this help and exit

When FILE is - read standard input.
EOM

	exit($exitcode);
}

66
GetOptions(
67
	'q|quiet+'	=> \$quiet,
68
69
70
	'tree!'		=> \$tree,
	'signoff!'	=> \$chk_signoff,
	'patch!'	=> \$chk_patch,
71
	'emacs!'	=> \$emacs,
72
	'terse!'	=> \$terse,
73
	'f|file!'	=> \$file,
74
75
76
	'subjective!'	=> \$check,
	'strict!'	=> \$check,
	'root=s'	=> \$root,
77
78
	'summary!'	=> \$summary,
	'mailback!'	=> \$mailback,
79
80
	'summary-file!'	=> \$summary_file,

81
	'debug=s'	=> \%debug,
82
	'test-only=s'	=> \$tst_only,
83
84
85
86
87
	'h|help'	=> \$help,
	'version'	=> \$help
) or help(1);

help(0) if ($help);
88
89
90
91

my $exit = 0;

if ($#ARGV < 0) {
92
	print "$P: no input files\n";
93
94
95
	exit(1);
}

96
97
my $dbg_values = 0;
my $dbg_possible = 0;
98
my $dbg_type = 0;
99
my $dbg_attr = 0;
100
for my $key (keys %debug) {
101
102
103
	## no critic
	eval "\${dbg_$key} = '$debug{$key}';";
	die "$@" if ($@);
104
105
}

106
107
108
109
110
if ($terse) {
	$emacs = 1;
	$quiet++;
}

111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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);
	}
129
130
}

131
132
my $emitted_corrupt = 0;

133
134
135
136
our $Ident	= qr{
			[A-Za-z_][A-Za-z\d_]*
			(?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
		}x;
137
138
139
140
141
142
143
144
our $Storage	= qr{extern|static|asmlinkage};
our $Sparse	= qr{
			__user|
			__kernel|
			__force|
			__iomem|
			__must_check|
			__init_refok|
145
146
			__kprobes|
			__ref
147
148
149
150
151
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
152
153
154
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
155
156
			____cacheline_internodealigned_in_smp|
			__weak
157
		  }x;
158
our $Modifier;
159
160
161
162
163
164
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
165
our $Compare    = qr{<=|>=|==|!=|<|>};
166
167
168
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
169
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
170
171
		  }x;

172
173
174
175
our $NonptrType;
our $Type;
our $Declare;

176
177
178
179
180
181
182
183
184
185
186
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;

187
our $typeTypedefs = qr{(?x:
188
	(?:__)?(?:u|s|be|le)(?:8|16|32|64)|
189
190
191
	atomic_t
)};

192
193
our @typeList = (
	qr{void},
194
195
196
197
198
199
200
	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},
201
202
203
204
205
206
207
208
209
210
211
	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},
);
212
213
214
our @modifierList = (
	qr{fastcall},
);
215
216

sub build_types {
217
218
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
219
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
220
	$NonptrType	= qr{
221
			(?:$Modifier\s+|const\s+)*
222
			(?:
223
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
224
				(?:$typeTypedefs\b)|
225
				(?:${all}\b)
226
			)
227
			(?:\s+$Modifier|\s+const)*
228
229
		  }x;
	$Type	= qr{
230
			$NonptrType
231
			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
232
			(?:\s+$Inline|\s+$Modifier)*
233
234
235
236
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
237
238
239

$chk_signoff = 0 if ($file);

240
241
my @dep_includes = ();
my @dep_functions = ();
242
243
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
244
	open(my $REMOVE, '<', "$root/$removal") ||
245
				die "$P: $removal: open failed - $!\n";
246
	while (<$REMOVE>) {
247
248
249
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
250
251
					push(@dep_includes, $1);

252
253
254
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
255
			}
256
257
		}
	}
258
	close($REMOVE);
259
260
}

261
my @rawlines = ();
262
263
my @lines = ();
my $vname;
264
for my $filename (@ARGV) {
265
	my $FILE;
266
	if ($file) {
267
		open($FILE, '-|', "diff -u /dev/null $filename") ||
268
			die "$P: $filename: diff failed - $!\n";
269
270
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
271
	} else {
272
		open($FILE, '<', "$filename") ||
273
			die "$P: $filename: open failed - $!\n";
274
	}
275
276
277
278
279
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
280
	while (<$FILE>) {
281
282
283
		chomp;
		push(@rawlines, $_);
	}
284
	close($FILE);
285
	if (!process($filename)) {
286
287
288
		$exit = 1;
	}
	@rawlines = ();
289
	@lines = ();
290
291
292
293
294
}

exit($exit);

sub top_of_kernel_tree {
295
296
297
298
299
300
301
302
303
304
305
306
	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;
		}
307
	}
308
	return 1;
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
}

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;
}
331
sub copy_spacing {
332
	(my $res = shift) =~ tr/\t/ /c;
333
334
	return $res;
}
335

336
337
338
339
340
341
342
343
344
345
346
347
348
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));
}

349
350
351
352
353
354
355
356
357
358
359
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
360
361
362
363
364
365
sub sanitise_line {
	my ($line) = @_;

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

366
	my $qlen = 0;
367
368
	my $off = 0;
	my $c;
369

370
371
372
373
374
375
376
377
378
379
380
381
382
383
	# 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;
384
		}
385
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
386
387
388
389
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
390
		}
391
392
393
394
395
396
397
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
398
399
400
401
402
403
404

		# 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;
405
		}
406
407
408
409
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
410

411
412
413
414
415
416
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
417

418
		#print "c<$c> SQ<$sanitise_quote>\n";
419
420
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
421
422
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
423
424
425
426
427
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
428
429
	}

430
431
432
433
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

434
	# The pathname on a #include may be surrounded by '<' and '>'.
435
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
436
437
438
439
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
440
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
441
		my $clean = 'X' x length($1);
442
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
443
444
	}

445
446
447
	return $res;
}

448
449
450
451
452
453
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
454
	my $coff_set = 0;
455

456
457
	my $loff = 0;

458
459
	my $type = '';
	my $level = 0;
460
	my @stack = ();
461
	my $p;
462
463
	my $c;
	my $len = 0;
464
465

	my $remainder;
466
	while (1) {
467
468
		@stack = (['', 0]) if ($#stack == -1);

469
		#warn "CSB: blk<$blk> remain<$remain>\n";
470
471
472
473
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
474
				last if (!defined $lines[$line]);
475
				next if ($lines[$line] =~ /^-/);
476
				$remain--;
477
				$loff = $len;
478
				$blk .= $lines[$line] . "\n";
479
480
481
482
483
484
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
485
			if ($off >= $len) {
486
487
488
				last;
			}
		}
489
		$p = $c;
490
		$c = substr($blk, $off, 1);
491
		$remainder = substr($blk, $off);
492

493
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
494
495
496
497
498
499
500
501
502
503

		# 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)};
		}

504
505
506
507
508
509
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

510
		# An else is really a conditional as long as its not else if
511
512
513
514
515
516
517
518
		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";
519
520
		}

521
522
523
524
525
526
527
528
529
530
		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;
531
532
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
549
	# We are truly at the end, so shuffle to the next line.
550
	if ($off == $len) {
551
		$loff = $len + 1;
552
553
554
		$line++;
		$remain--;
	}
555
556
557
558
559
560
561

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

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

562
	#print "coff<$coff> soff<$off> loff<$loff>\n";
563
564
565
566
567

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

568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
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;
	}
}

611
612
613
614
615
616
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

617
	# Grab the first conditional/block pair.
618
619
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
620
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
621
622
623
624
625
626
627
	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.
628
629
630
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
631
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
632
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
633
634
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
635
636
637
	}

	return ($level, $linenr, @chunks);
638
639
}

640
sub ctx_block_get {
641
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
642
643
644
645
646
647
648
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

649
	my $level = 0;
650
	my @stack = ($level);
651
652
653
654
655
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
656
657
658
659
660
661
662
663
664
665

		# 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);
		}

666
667
668
669
670
671
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
672

673
674
675
676
677
678
679
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
680

681
		if (!$outer || $level <= 1) {
682
			push(@res, $rawlines[$line]);
683
684
		}

685
		last if ($level == 0);
686
687
	}

688
	return ($level, @res);
689
690
691
692
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

693
694
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
695
696
697
698
}
sub ctx_block {
	my ($linenr, $remain) = @_;

699
700
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
701
702
}
sub ctx_statement {
703
704
705
706
707
708
	my ($linenr, $remain, $off) = @_;

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

711
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
712
}
713
714
715
716
717
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
718
719
720
721
722

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

	# Catch a comment on the end of the line itself.
723
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
724
725
726
727
728
729
730
	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++) {
731
732
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
		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);

755
	##print "LINE: $rawlines[$end_line - 1 ]\n";
756
757
758
759
760
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
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;
}

777
778
779
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
780

781
782
783
784
785
786
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
787
788
		}
	}
789
	$res =~ s/$/\$/;
790

791
	return $res;
792
793
}

794
my $av_preprocessor = 0;
795
my $av_pending;
796
my @av_paren_type;
797
my $av_pend_colon;
798
799
800

sub annotate_reset {
	$av_preprocessor = 0;
801
802
	$av_pending = '_';
	@av_paren_type = ('E');
803
	$av_pend_colon = 'O';
804
805
}

806
807
sub annotate_values {
	my ($stream, $type) = @_;
808

809
	my $res;
810
	my $var = '_' x length($stream);
811
812
	my $cur = $stream;

813
	print "$stream\n" if ($dbg_values > 1);
814
815

	while (length($cur)) {
816
		@av_paren_type = ('E') if ($#av_paren_type < 0);
817
		print " <" . join('', @av_paren_type) .
818
				"> <$type> <$av_pending>" if ($dbg_values > 1);
819
		if ($cur =~ /^(\s+)/o) {
820
821
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
822
				$type = pop(@av_paren_type);
823
				$av_preprocessor = 0;
824
825
			}

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

830
831
832
833
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

834
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
835
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
836
			$av_preprocessor = 1;
837
838
839
840
841
842
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

843
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
844
845
846
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
847

848
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
849
			print "PRE_START($1)\n" if ($dbg_values > 1);
850
			$av_preprocessor = 1;
851
852
853

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
854
			$type = 'E';
855

856
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
857
858
859
860
861
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

862
			$type = 'E';
863

864
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
865
866
867
868
869
870
871
872
			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);
873
			$type = 'E';
874
875

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

878
879
880
881
882
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

883
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
884
			print "SIZEOF($1)\n" if ($dbg_values > 1);
885
			if (defined $2) {
886
				$av_pending = 'V';
887
888
889
			}
			$type = 'N';

890
		} elsif ($cur =~ /^(if|while|for)\b/o) {
891
			print "COND($1)\n" if ($dbg_values > 1);
892
			$av_pending = 'E';
893
894
			$type = 'N';

895
896
897
898
899
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

900
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
901
			print "KEYWORD($1)\n" if ($dbg_values > 1);
902
903
904
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
905
			print "PAREN('$1')\n" if ($dbg_values > 1);
906
907
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
908
909
910
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
911
912
913
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
914
915
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
916
			} else {
917
				print "PAREN('$1')\n" if ($dbg_values > 1);
918
919
			}

920
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
921
			print "FUNC($1)\n" if ($dbg_values > 1);
922
			$type = 'V';
923
			$av_pending = 'V';
924

925
926
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
927
				$av_pend_colon = 'B';
928
929
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
930
931
932
933
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

934
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
935
			print "IDENT($1)\n" if ($dbg_values > 1);
936
937
938
			$type = 'V';

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

942
		} elsif ($cur =~/^(;|{|})/) {
943
			print "END($1)\n" if ($dbg_values > 1);
944
			$type = 'E';
945
946
			$av_pend_colon = 'O';

947
948
949
950
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

951
952
953
954
955
956
957
958
959
960
961
962
963
964
		} 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';
965

966
		} elsif ($cur =~ /^(\[)/o) {
967
			print "CLOSE($1)\n" if ($dbg_values > 1);
968
969
			$type = 'N';

970
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
971
972
973
974
975
976
977
978
979
980
981
982
			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';

983
		} elsif ($cur =~ /^($Operators)/o) {
984
			print "OP($1)\n" if ($dbg_values > 1);
985
986
987
988
989
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
990
			print "C($1)\n" if ($dbg_values > 1);
991
992
993
994
995
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
996
	}
997

998
	return ($res, $var);
999
1000
}

1001
sub possible {
1002
	my ($possible, $line) = @_;
1003
	my $notPermitted = qr{(?:
1004
1005
1006
1007
		^(?:
			$Modifier|
			$Storage|
			$Type|
1008
1009
1010
			DEFINE_\S+
		)$|
		^(?:
1011
1012
1013
1014
1015
1016
			goto|
			return|
			case|
			else|
			asm|__asm__|
			do
1017
		)(?:\s|$)|
1018
		^(?:typedef|struct|enum)\b
1019
1020
1021
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1022
1023
1024
1025
1026
1027
1028
		# 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;
1029
			for my $modifier (split(' ', $possible)) {
1030
1031
1032
1033
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1034
			}
1035
1036
1037
1038
1039

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1040
		build_types();
1041
1042
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1043
1044
1045
	}
}

1046
1047
my $prefix = '';

1048
sub report {
1049
1050
1051
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1052
1053
1054
1055
	my $line = $prefix . $_[0];

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

1056
	push(our @report, $line);
1057
1058

	return 1;
1059
1060
}
sub report_dump {
1061
	our @report;
1062
}
1063
sub ERROR {
1064
1065
1066
1067
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1068
1069
}
sub WARN {
1070
1071
1072
1073
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1074
1075
}
sub CHK {
1076
	if ($check && report("CHECK: $_[0]\n")) {
1077
1078
1079
		our $clean = 0;
		our $cnt_chk++;
	}
1080
1081
}

1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
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);
	}
}

1109
1110
1111
1112
1113
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1114
	my $prevrawline="";
1115
	my $stashline="";
1116
	my $stashrawline="";
1117

1118
	my $length;
1119
1120
1121
1122
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1123
	our $clean = 1;
1124
1125
1126
	my $signoff = 0;
	my $is_patch = 0;

1127
	our @report = ();
1128
1129
1130
1131
1132
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1133
1134
1135
1136
1137
1138
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1139
	my $comment_edge = 0;
1140
	my $first_line = 0;
1141
	my $p1_prefix = '';
1142

1143
1144
1145
	my $prev_values = 'E';

	# suppression flags
1146
	my %suppress_ifbraces;
1147
	my %suppress_whiletrailers;
1148
	my %suppress_export;
1149

1150
	# Pre-scan the patch sanitizing the lines.
1151
	# Pre-scan the patch looking for any __setup documentation.
1152
	#
1153
1154
	my @setup_docs = ();
	my $setup_docs = 0;
1155
1156

	sanitise_line_reset();
1157
1158
	my $line;
	foreach my $rawline (@rawlines) {