checkpatch.pl 74.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
198
199
200
201
202
our $logFunctions = qr{(?x:
	printk|
	pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
	dev_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
	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

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

$chk_signoff = 0 if ($file);

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

263
264
265
				} elsif ($entry !~ m@/@) {
					push(@dep_functions, $entry);
				}
266
			}
267
268
		}
	}
269
	close($REMOVE);
270
271
}

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

exit($exit);

sub top_of_kernel_tree {
306
307
308
309
310
311
312
313
314
315
316
317
	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;
		}
318
	}
319
	return 1;
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
}

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;
}
342
sub copy_spacing {
343
	(my $res = shift) =~ tr/\t/ /c;
344
345
	return $res;
}
346

347
348
349
350
351
352
353
354
355
356
357
358
359
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));
}

360
361
362
363
364
365
366
367
368
369
370
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
371
372
373
374
375
376
sub sanitise_line {
	my ($line) = @_;

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

377
	my $qlen = 0;
378
379
	my $off = 0;
	my $c;
380

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

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
409
410
411
412
413
414
415

		# 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;
416
		}
417
418
419
420
		# Regular quotes.
		if ($c eq "'" || $c eq '"') {
			if ($sanitise_quote eq '') {
				$sanitise_quote = $c;
421

422
423
424
425
426
427
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
428

429
		#print "c<$c> SQ<$sanitise_quote>\n";
430
431
		if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
			substr($res, $off, 1, $;);
432
433
		} elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
			substr($res, $off, 1, $;);
434
435
436
437
438
		} elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
			substr($res, $off, 1, 'X');
		} else {
			substr($res, $off, 1, $c);
		}
439
440
	}

441
442
443
444
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

445
	# The pathname on a #include may be surrounded by '<' and '>'.
446
	if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
447
448
449
450
		my $clean = 'X' x length($1);
		$res =~ s@\<.*\>@<$clean>@;

	# The whole of a #error is a string.
451
	} elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
452
		my $clean = 'X' x length($1);
453
		$res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
454
455
	}

456
457
458
	return $res;
}

459
460
461
462
463
464
sub ctx_statement_block {
	my ($linenr, $remain, $off) = @_;
	my $line = $linenr - 1;
	my $blk = '';
	my $soff = $off;
	my $coff = $off - 1;
465
	my $coff_set = 0;
466

467
468
	my $loff = 0;

469
470
	my $type = '';
	my $level = 0;
471
	my @stack = ();
472
	my $p;
473
474
	my $c;
	my $len = 0;
475
476

	my $remainder;
477
	while (1) {
478
479
		@stack = (['', 0]) if ($#stack == -1);

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

504
		#warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
505
506
507
508
509
510
511
512
513
514

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

515
516
517
518
519
520
		# Statement ends at the ';' or a close '}' at the
		# outermost level.
		if ($level == 0 && $c eq ';') {
			last;
		}

521
		# An else is really a conditional as long as its not else if
522
523
524
525
526
527
528
529
		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";
530
531
		}

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

			if ($level == 0) {
				last;
			}
		}
		$off++;
	}
560
	# We are truly at the end, so shuffle to the next line.
561
	if ($off == $len) {
562
		$loff = $len + 1;
563
564
565
		$line++;
		$remain--;
	}
566
567
568
569
570
571
572

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

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

573
	#print "coff<$coff> soff<$off> loff<$loff>\n";
574
575
576
577
578

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

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
611
612
613
614
615
616
617
618
619
620
621
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;
	}
}

622
623
624
625
626
627
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

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

	return ($level, $linenr, @chunks);
649
650
}

651
sub ctx_block_get {
652
	my ($linenr, $remain, $outer, $open, $close, $off) = @_;
653
654
655
656
657
658
659
	my $line;
	my $start = $linenr - 1;
	my $blk = '';
	my @o;
	my @c;
	my @res = ();

660
	my $level = 0;
661
	my @stack = ($level);
662
663
664
665
666
	for ($line = $start; $remain > 0; $line++) {
		next if ($rawlines[$line] =~ /^-/);
		$remain--;

		$blk .= $rawlines[$line];
667
668
669
670
671
672
673
674
675
676

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

677
678
679
680
681
682
		foreach my $c (split(//, $rawlines[$line])) {
			##print "C<$c>L<$level><$open$close>O<$off>\n";
			if ($off > 0) {
				$off--;
				next;
			}
683

684
685
686
687
688
689
690
			if ($c eq $close && $level > 0) {
				$level--;
				last if ($level == 0);
			} elsif ($c eq $open) {
				$level++;
			}
		}
691

692
		if (!$outer || $level <= 1) {
693
			push(@res, $rawlines[$line]);
694
695
		}

696
		last if ($level == 0);
697
698
	}

699
	return ($level, @res);
700
701
702
703
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

704
705
	my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
	return @r;
706
707
708
709
}
sub ctx_block {
	my ($linenr, $remain) = @_;

710
711
	my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
	return @r;
712
713
}
sub ctx_statement {
714
715
716
717
718
719
	my ($linenr, $remain, $off) = @_;

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

722
	return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
723
}
724
725
726
727
728
sub ctx_statement_level {
	my ($linenr, $remain, $off) = @_;

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
729
730
731
732
733

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

	# Catch a comment on the end of the line itself.
734
	my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
735
736
737
738
739
740
741
	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++) {
742
743
		my $line = $rawlines[$linenr - 1];
		#warn "           $line\n";
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
		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);

766
	##print "LINE: $rawlines[$end_line - 1 ]\n";
767
768
769
770
771
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
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;
}

788
789
790
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
791

792
793
794
795
796
797
	$res = '';
	while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
		$res .= $1;
		if ($2 ne '') {
			$coded = sprintf("^%c", unpack('C', $2) + 64);
			$res .= $coded;
798
799
		}
	}
800
	$res =~ s/$/\$/;
801

802
	return $res;
803
804
}

805
my $av_preprocessor = 0;
806
my $av_pending;
807
my @av_paren_type;
808
my $av_pend_colon;
809
810
811

sub annotate_reset {
	$av_preprocessor = 0;
812
813
	$av_pending = '_';
	@av_paren_type = ('E');
814
	$av_pend_colon = 'O';
815
816
}

817
818
sub annotate_values {
	my ($stream, $type) = @_;
819

820
	my $res;
821
	my $var = '_' x length($stream);
822
823
	my $cur = $stream;

824
	print "$stream\n" if ($dbg_values > 1);
825
826

	while (length($cur)) {
827
		@av_paren_type = ('E') if ($#av_paren_type < 0);
828
		print " <" . join('', @av_paren_type) .
829
				"> <$type> <$av_pending>" if ($dbg_values > 1);
830
		if ($cur =~ /^(\s+)/o) {
831
832
			print "WS($1)\n" if ($dbg_values > 1);
			if ($1 =~ /\n/ && $av_preprocessor) {
833
				$type = pop(@av_paren_type);
834
				$av_preprocessor = 0;
835
836
			}

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

841
842
843
844
		} elsif ($cur =~ /^($Modifier)\s*/) {
			print "MODIFIER($1)\n" if ($dbg_values > 1);
			$type = 'T';

845
		} elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
846
			print "DEFINE($1,$2)\n" if ($dbg_values > 1);
847
			$av_preprocessor = 1;
848
849
850
851
852
853
			push(@av_paren_type, $type);
			if ($2 ne '') {
				$av_pending = 'N';
			}
			$type = 'E';

854
		} elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
855
856
857
			print "UNDEF($1)\n" if ($dbg_values > 1);
			$av_preprocessor = 1;
			push(@av_paren_type, $type);
858

859
		} elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
860
			print "PRE_START($1)\n" if ($dbg_values > 1);
861
			$av_preprocessor = 1;
862
863
864

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
865
			$type = 'E';
866

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

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

873
			$type = 'E';
874

875
		} elsif ($cur =~ /^(\#\s*(?:endif))/o) {
876
877
878
879
880
881
882
883
			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);
884
			$type = 'E';
885
886

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

889
890
891
892
893
		} elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
			print "ATTR($1)\n" if ($dbg_values > 1);
			$av_pending = $type;
			$type = 'N';

894
		} elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
895
			print "SIZEOF($1)\n" if ($dbg_values > 1);
896
			if (defined $2) {
897
				$av_pending = 'V';
898
899
900
			}
			$type = 'N';

901
		} elsif ($cur =~ /^(if|while|for)\b/o) {
902
			print "COND($1)\n" if ($dbg_values > 1);
903
			$av_pending = 'E';
904
905
			$type = 'N';

906
907
908
909
910
		} elsif ($cur =~/^(case)/o) {
			print "CASE($1)\n" if ($dbg_values > 1);
			$av_pend_colon = 'C';
			$type = 'N';

911
		} elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
912
			print "KEYWORD($1)\n" if ($dbg_values > 1);
913
914
915
			$type = 'N';

		} elsif ($cur =~ /^(\()/o) {
916
			print "PAREN('$1')\n" if ($dbg_values > 1);
917
918
			push(@av_paren_type, $av_pending);
			$av_pending = '_';
919
920
921
			$type = 'N';

		} elsif ($cur =~ /^(\))/o) {
922
923
924
			my $new_type = pop(@av_paren_type);
			if ($new_type ne '_') {
				$type = $new_type;
925
926
				print "PAREN('$1') -> $type\n"
							if ($dbg_values > 1);
927
			} else {
928
				print "PAREN('$1')\n" if ($dbg_values > 1);
929
930
			}

931
		} elsif ($cur =~ /^($Ident)\s*\(/o) {
932
			print "FUNC($1)\n" if ($dbg_values > 1);
933
			$type = 'V';
934
			$av_pending = 'V';
935

936
937
		} elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
			if (defined $2 && $type eq 'C' || $type eq 'T') {
938
				$av_pend_colon = 'B';
939
940
			} elsif ($type eq 'E') {
				$av_pend_colon = 'L';
941
942
943
944
			}
			print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
			$type = 'V';

945
		} elsif ($cur =~ /^($Ident|$Constant)/o) {
946
			print "IDENT($1)\n" if ($dbg_values > 1);
947
948
949
			$type = 'V';

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

953
		} elsif ($cur =~/^(;|{|})/) {
954
			print "END($1)\n" if ($dbg_values > 1);
955
			$type = 'E';
956
957
			$av_pend_colon = 'O';

958
959
960
961
		} elsif ($cur =~/^(,)/) {
			print "COMMA($1)\n" if ($dbg_values > 1);
			$type = 'C';

962
963
964
965
966
967
968
969
970
971
972
973
974
975
		} 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';
976

977
		} elsif ($cur =~ /^(\[)/o) {
978
			print "CLOSE($1)\n" if ($dbg_values > 1);
979
980
			$type = 'N';

981
		} elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
982
983
984
985
986
987
988
989
990
991
992
993
			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';

994
		} elsif ($cur =~ /^($Operators)/o) {
995
			print "OP($1)\n" if ($dbg_values > 1);
996
997
998
999
1000
			if ($1 ne '++' && $1 ne '--') {
				$type = 'N';
			}

		} elsif ($cur =~ /(^.)/o) {
1001
			print "C($1)\n" if ($dbg_values > 1);
1002
1003
1004
1005
1006
		}
		if (defined $1) {
			$cur = substr($cur, length($1));
			$res .= $type x length($1);
		}
1007
	}
1008

1009
	return ($res, $var);
1010
1011
}

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

		} else {
			warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
			push(@typeList, $possible);
		}
1051
		build_types();
1052
1053
	} else {
		warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1054
1055
1056
	}
}

1057
1058
my $prefix = '';

1059
sub report {
1060
1061
1062
	if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
		return 0;
	}
1063
1064
1065
1066
	my $line = $prefix . $_[0];

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

1067
	push(our @report, $line);
1068
1069

	return 1;
1070
1071
}
sub report_dump {
1072
	our @report;
1073
}
1074
sub ERROR {
1075
1076
1077
1078
	if (report("ERROR: $_[0]\n")) {
		our $clean = 0;
		our $cnt_error++;
	}
1079
1080
}
sub WARN {
1081
1082
1083
1084
	if (report("WARNING: $_[0]\n")) {
		our $clean = 0;
		our $cnt_warn++;
	}
1085
1086
}
sub CHK {
1087
	if ($check && report("CHECK: $_[0]\n")) {
1088
1089
1090
		our $clean = 0;
		our $cnt_chk++;
	}
1091
1092
}

1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
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);
	}
}

1120
1121
1122
1123
1124
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1125
	my $prevrawline="";
1126
	my $stashline="";
1127
	my $stashrawline="";
1128

1129
	my $length;
1130
1131
1132
1133
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1134
	our $clean = 1;
1135
1136
1137
	my $signoff = 0;
	my $is_patch = 0;

1138
	our @report = ();
1139
1140
1141
1142
1143
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

1144
1145
1146
1147
1148
1149
	# Trace the real file/line as we go.
	my $realfile = '';
	my $realline = 0;
	my $realcnt = 0;
	my $here = '';
	my $in_comment = 0;
1150
	my $comment_edge = 0;
1151
	my $first_line = 0;
1152
	my $p1_prefix = '';
1153

1154
1155
1156
	my $prev_values = 'E';

	# suppression flags
1157
	my %suppress_ifbraces;
1158
	my %suppress_whiletrailers;
1159
	my %suppress_export;
1160

1161
	# Pre-scan the patch sanitizing the lines.
1162
	# Pre-scan the patch looking for any __setup documentation.