checkpatch.pl 75.6 KB
Newer Older
1
#!/usr/bin/perl -w
2
# (c) 2001, Dave Jones. (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
		}x;
148
149
150

# Notes to $Attribute:
# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
151
152
153
154
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
155
			__(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
156
157
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
158
159
			____cacheline_internodealigned_in_smp|
			__weak
160
		  }x;
161
our $Modifier;
162
163
164
165
166
167
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
168
our $Compare    = qr{<=|>=|==|!=|<|>};
169
170
171
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
172
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
173
174
		  }x;

175
176
177
178
our $NonptrType;
our $Type;
our $Declare;

179
180
181
182
183
184
185
186
187
188
189
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;

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

195
196
197
our $logFunctions = qr{(?x:
	printk|
	pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
198
	(dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
199
200
201
202
	WARN|
	panic
)};

203
204
our @typeList = (
	qr{void},
205
206
207
208
209
210
211
	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},
212
213
214
215
216
217
218
219
220
221
222
	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},
);
223
224
225
our @modifierList = (
	qr{fastcall},
);
226

227
228
229
230
231
232
our $allowed_asm_includes = qr{(?x:
	irq|
	memory
)};
# memory.h: ARM has a custom one

233
sub build_types {
234
235
	my $mods = "(?x:  \n" . join("|\n  ", @modifierList) . "\n)";
	my $all = "(?x:  \n" . join("|\n  ", @typeList) . "\n)";
236
	$Modifier	= qr{(?:$Attribute|$Sparse|$mods)};
237
	$NonptrType	= qr{
238
			(?:$Modifier\s+|const\s+)*
239
			(?:
240
				(?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
241
				(?:$typeTypedefs\b)|
242
				(?:${all}\b)
243
			)
244
			(?:\s+$Modifier|\s+const)*
245
246
		  }x;
	$Type	= qr{
247
			$NonptrType
248
			(?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
249
			(?:\s+$Inline|\s+$Modifier)*
250
251
252
253
		  }x;
	$Declare	= qr{(?:$Storage\s+)?$Type};
}
build_types();
254
255
256

$chk_signoff = 0 if ($file);

257
258
my @dep_includes = ();
my @dep_functions = ();
259
260
my $removal = "Documentation/feature-removal-schedule.txt";
if ($tree && -f "$root/$removal") {
261
	open(my $REMOVE, '<', "$root/$removal") ||
262
				die "$P: $removal: open failed - $!\n";
263
	while (<$REMOVE>) {
264
265
266
		if (/^Check:\s+(.*\S)/) {
			for my $entry (split(/[, ]+/, $1)) {
				if ($entry =~ m@include/(.*)@) {
267
268
					push(@dep_includes, $1);

269
270
271
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
272
			}
273
274
		}
	}
275
	close($REMOVE);
276
277
}

278
my @rawlines = ();
279
280
my @lines = ();
my $vname;
281
for my $filename (@ARGV) {
282
	my $FILE;
283
	if ($file) {
284
		open($FILE, '-|', "diff -u /dev/null $filename") ||
285
			die "$P: $filename: diff failed - $!\n";
286
287
	} elsif ($filename eq '-') {
		open($FILE, '<&STDIN');
288
	} else {
289
		open($FILE, '<', "$filename") ||
290
			die "$P: $filename: open failed - $!\n";
291
	}
292
293
294
295
296
	if ($filename eq '-') {
		$vname = 'Your patch';
	} else {
		$vname = $filename;
	}
297
	while (<$FILE>) {
298
299
300
		chomp;
		push(@rawlines, $_);
	}
301
	close($FILE);
302
	if (!process($filename)) {
303
304
305
		$exit = 1;
	}
	@rawlines = ();
306
	@lines = ();
307
308
309
310
311
}

exit($exit);

sub top_of_kernel_tree {
312
313
314
315
316
317
318
319
320
321
322
323
	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;
		}
324
	}
325
	return 1;
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
}

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;
}
348
sub copy_spacing {
349
	(my $res = shift) =~ tr/\t/ /c;
350
351
	return $res;
}
352

353
354
355
356
357
358
359
360
361
362
363
364
365
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));
}

366
367
368
369
370
371
372
373
374
375
376
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
377
378
379
380
381
382
sub sanitise_line {
	my ($line) = @_;

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

383
	my $qlen = 0;
384
385
	my $off = 0;
	my $c;
386

387
388
389
390
391
392
393
394
395
396
397
398
399
400
	# 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;
401
		}
402
		if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
403
404
405
406
			$sanitise_quote = '';
			substr($res, $off, 2, "$;$;");
			$off++;
			next;
407
		}
408
409
410
411
412
413
414
		if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
			$sanitise_quote = '//';

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
415
416
417
418
419
420
421

		# 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;
422
		}
423
424
425
426
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
427

428
429
430
431
432
433
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
434

435
		#print "c<$c> SQ<$sanitise_quote>\n";
436
437
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
438
439
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
440
441
442
443
444
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
445
446
	}

447
448
449
450
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

451
	# The pathname on a #include may be surrounded by '<' and '>'.
452
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
453
454
455
456
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
457
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
458
		my $clean = 'X' x length($1);
459
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
460
461
	}

462
463
464
	return $res;
}

465
466
467
468
469
470
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
471
	my $coff_set = 0;
472

473
474
	my $loff = 0;

475
476
	my $type = '';
	my $level = 0;
477
	my @stack = ();
478
	my $p;
479
480
	my $c;
	my $len = 0;
481
482

	my $remainder;
483
	while (1) {
484
485
		@stack = (['', 0]) if ($#stack == -1);

486
		#warn "CSB: blk<$blk> remain<$remain>\n";
487
488
489
490
		# If we are about to drop off the end, pull in more
		# context.
		if ($off >= $len) {
			for (; $remain > 0; $line++) {
491
				last if (!defined $lines[$line]);
492
				next if ($lines[$line] =~ /^-/);
493
				$remain--;
494
				$loff = $len;
495
				$blk .= $lines[$line] . "\n";
496
497
498
499
500
501
				$len = length($blk);
				$line++;
				last;
			}
			# Bail if there is no further context.
			#warn "CSB: blk<$blk> off<$off> len<$len>\n";
502
			if ($off >= $len) {
503
504
505
				last;
			}
		}
506
		$p = $c;
507
		$c = substr($blk, $off, 1);
508
		$remainder = substr($blk, $off);
509

510
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
511
512
513
514
515
516
517
518
519
520

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

521
522
523
524
525
526
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

527
		# An else is really a conditional as long as its not else if
528
529
530
531
532
533
534
535
		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";
536
537
		}

538
539
540
541
542
543
544
545
546
547
		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;
548
549
				$coff_set = 1;
				#warn "CSB: mark coff<$coff>\n";
550
551
552
553
554
555
556
557
558
559
560
			}
		}
		if (($type eq '' || $type eq '{') && $c eq '{') {
			$level++;
			$type = '{';
		}
		if ($type eq '{' && $c eq '}') {
			$level--;
			$type = ($level != 0)? '{' : '';

			if ($level == 0) {
561
562
563
				if (substr($blk, $off + 1, 1) eq ';') {
					$off++;
				}
564
565
566
567
568
				last;
			}
		}
		$off++;
	}
569
	# We are truly at the end, so shuffle to the next line.
570
	if ($off == $len) {
571
		$loff = $len + 1;
572
573
574
		$line++;
		$remain--;
	}
575
576
577
578
579
580
581

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

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

582
	#print "coff<$coff> soff<$off> loff<$loff>\n";
583
584
585
586
587

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

588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
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;
	}
}

631
632
633
634
635
636
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

637
	# Grab the first conditional/block pair.
638
639
	($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
640
	#print "F: c<$condition> s<$statement> remain<$remain>\n";
641
642
643
644
645
646
647
	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.
648
649
650
	for (;;) {
		($statement, $condition, $linenr, $remain, $off, $level) =
				ctx_statement_block($linenr, $remain, $off);
651
		#print "C: c<$condition> s<$statement> remain<$remain>\n";
652
		last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
653
654
		#print "C: push\n";
		push(@chunks, [ $condition, $statement ]);
655
656
657
	}

	return ($level, $linenr, @chunks);
658
659
}

660
sub ctx_block_get {
661
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
662
663
664
665
666
667
668
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

669
	my $level = 0;
670
	my @stack = ($level);
671
672
673
674
675
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
676
677
678
679
680
681
682
683
684
685

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

686
687
688
689
690
691
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
692

693
694
695
696
697
698
699
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
700

701
		if (!$outer || $level <= 1) {
702
			push(@res, $rawlines[$line]);
703
704
		}

705
		last if ($level == 0);
706
707
	}

708
	return ($level, @res);
709
710
711
712
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

713
714
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
715
716
717
718
}
sub ctx_block {
	my ($linenr, $remain) = @_;

719
720
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
721
722
}
sub ctx_statement {
723
724
725
726
727
728
	my ($linenr, $remain, $off) = @_;

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

731
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
732
}
733
734
735
736
737
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
738
739
740
741
742

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

	# Catch a comment on the end of the line itself.
743
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
744
745
746
747
748
749
750
	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++) {
751
752
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
		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);

775
	##print "LINE: $rawlines[$end_line - 1 ]\n";
776
777
778
779
780
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
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;
}

797
798
799
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
800

801
802
803
804
805
806
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
807
808
		}
	}
809
	$res =~ s/$/\$/;
810

811
	return $res;
812
813
}

814
my $av_preprocessor = 0;
815
my $av_pending;
816
my @av_paren_type;
817
my $av_pend_colon;
818
819
820

sub annotate_reset {
	$av_preprocessor = 0;
821
822
	$av_pending = '_';
	@av_paren_type = ('E');
823
	$av_pend_colon = 'O';
824
825
}

826
827
sub annotate_values {
	my ($stream, $type) = @_;
828

829
	my $res;
830
	my $var = '_' x length($stream);
831
832
	my $cur = $stream;

833
	print "$stream\n" if ($dbg_values > 1);
834
835

	while (length($cur)) {
836
		@av_paren_type = ('E') if ($#av_paren_type < 0);
837
		print " <" . join('', @av_paren_type) .
838
				"> <$type> <$av_pending>" if ($dbg_values > 1);
839
		if ($cur =~ /^(\s+)/o) {
840
841
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
842
				$type = pop(@av_paren_type);
843
				$av_preprocessor = 0;
844
845
			}

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

850
851
852
853
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

854
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
855
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
856
			$av_preprocessor = 1;
857
858
859
860
861
862
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

863
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
864
865
866
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
867

868
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
869
			print "PRE_START($1)\n" if ($dbg_values > 1);
870
			$av_preprocessor = 1;
871
872
873

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
874
			$type = 'E';
875

876
		} elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
877
878
879
880
881
			print "PRE_RESTART($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;

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

882
			$type = 'E';
883

884
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
885
886
887
888
889
890
891
892
			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);
893
			$type = 'E';
894
895

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

898
899
900
901
902
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

903
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
904
			print "SIZEOF($1)\n" if ($dbg_values > 1);
905
			if (defined $2) {
906
				$av_pending = 'V';
907
908
909
			}
			$type = 'N';

910
		} elsif ($cur =~ /^(if|while|for)\b/o) {
911
			print "COND($1)\n" if ($dbg_values > 1);
912
			$av_pending = 'E';
913
914
			$type = 'N';

915
916
917
918
919
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

920
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
921
			print "KEYWORD($1)\n" if ($dbg_values > 1);
922
923
924
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
925
			print "PAREN('$1')\n" if ($dbg_values > 1);
926
927
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
928
929
930
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
931
932
933
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
934
935
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
936
			} else {
937
				print "PAREN('$1')\n" if ($dbg_values > 1);
938
939
			}

940
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
941
			print "FUNC($1)\n" if ($dbg_values > 1);
942
			$type = 'V';
943
			$av_pending = 'V';
944

945
946
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
947
				$av_pend_colon = 'B';
948
949
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
950
951
952
953
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

954
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
955
			print "IDENT($1)\n" if ($dbg_values > 1);
956
957
958
			$type = 'V';

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

962
		} elsif ($cur =~/^(;|{|})/) {
963
			print "END($1)\n" if ($dbg_values > 1);
964
			$type = 'E';
965
966
			$av_pend_colon = 'O';

967
968
969
970
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

971
972
973
974
975
976
977
978
979
980
981
982
983
984
		} 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';
985

986
		} elsif ($cur =~ /^(\[)/o) {
987
			print "CLOSE($1)\n" if ($dbg_values > 1);
988
989
			$type = 'N';

990
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
991
992
993
994
995
996
997
998
999
1000
1001
1002
			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';

1003
		} elsif ($cur =~ /^($Operators)/o) {
1004
			print "OP($1)\n" if ($dbg_values > 1);
1005
1006
1007
1008
1009
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1010
			print "C($1)\n" if ($dbg_values > 1);
1011
1012
1013
1014
1015
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1016
	}
1017

1018
	return ($res, $var);
1019
1020
}

1021
sub possible {
1022
	my ($possible, $line) = @_;
1023
	my $notPermitted = qr{(?:
1024
1025
1026
1027
		^(?:
			$Modifier|
			$Storage|
			$Type|
1028
1029
1030
			DEFINE_\S+
		)$|
		^(?:
1031
1032
1033
1034
1035
1036
			goto|
			return|
			case|
			else|
			asm|__asm__|
			do
1037
		)(?:\s|$)|
1038
		^(?:typedef|struct|enum)\b
1039
1040
1041
	    )}x;
	warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
	if ($possible !~ $notPermitted) {
1042
1043
1044
1045
1046
1047
1048
		# 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;
1049
			for my $modifier (split(' ', $possible)) {
1050
1051
1052
1053
				if ($modifier !~ $notPermitted) {
					warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
					push(@modifierList, $modifier);
				}
1054
			}
1055
1056
1057
1058
1059

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1060
		build_types();
1061
1062
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1063
1064
1065
	}
}

1066
1067
my $prefix = '';

1068
sub report {
1069
1070
1071
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1072
1073
1074
1075
	my $line = $prefix . $_[0];

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

1076
	push(our @report, $line);
1077
1078

	return 1;
1079
1080
}
sub report_dump {
1081
	our @report;
1082
}
1083
sub ERROR {
1084
1085
1086
1087
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1088
1089
}
sub WARN {
1090
1091
1092
1093
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1094
1095
}
sub CHK {
1096
	if ($check && report("CHECK: $_[0]\n")) {
1097
1098
1099
		our $clean = 0;
		our $cnt_chk++;
	}
1100
1101
}

1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
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);
	}
}

1129
1130
1131
1132
1133
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1134
	my $prevrawline="";
1135
	my $stashline="";
1136
	my $stashrawline="";
1137

1138
	my $length;
1139
1140
1141
1142
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1143
	our $clean = 1;
1144
1145
1146
	my $signoff = 0;
	my $is_patch = 0;

1147
	our @report = ();
1148
1149
1150
1151
1152
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1153
1154
1155
1156
1157
1158
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1159
	my $comment_edge = 0;
1160
	my $first_line = 0;
1161
	my $p1_prefix = '';
1162