checkpatch.pl 70.9 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.29';
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
133
134
135
136
137
138
139
140
141
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|
142
143
			__kprobes|
			__ref
144
145
146
147
148
		}x;
our $Attribute	= qr{
			const|
			__read_mostly|
			__kprobes|
149
150
151
			__(?:mem|cpu|dev|)(?:initdata|init)|
			____cacheline_aligned|
			____cacheline_aligned_in_smp|
152
153
			____cacheline_internodealigned_in_smp|
			__weak
154
		  }x;
155
our $Modifier;
156
157
158
159
160
161
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{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
162
our $Compare    = qr{<=|>=|==|!=|<|>};
163
164
165
our $Operators	= qr{
			<=|>=|==|!=|
			=>|->|<<|>>|<|>|!|~|
166
			&&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
167
168
		  }x;

169
170
171
172
our $NonptrType;
our $Type;
our $Declare;

173
174
175
176
177
178
179
180
181
182
183
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;

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

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

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

$chk_signoff = 0 if ($file);

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

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

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

exit($exit);

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

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

333
334
335
336
337
338
339
340
341
342
343
344
345
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));
}

346
347
348
349
350
351
352
353
354
355
356
my $sanitise_quote = '';

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

	if ($in_comment) {
		$sanitise_quote = '*/';
	} else {
		$sanitise_quote = '';
	}
}
357
358
359
360
361
362
sub sanitise_line {
	my ($line) = @_;

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

363
	my $qlen = 0;
364
365
	my $off = 0;
	my $c;
366

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

			substr($res, $off, 2, $sanitise_quote);
			$off++;
			next;
		}
395
396
397
398
399
400
401

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

408
409
410
411
412
413
				substr($res, $off, 1, $c);
				next;
			} elsif ($sanitise_quote eq $c) {
				$sanitise_quote = '';
			}
		}
414

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

427
428
429
430
	if ($sanitise_quote eq '//') {
		$sanitise_quote = '';
	}

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

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

442
443
444
	return $res;
}

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

453
454
	my $loff = 0;

455
456
	my $type = '';
	my $level = 0;
457
	my @stack = ();
458
	my $p;
459
460
	my $c;
	my $len = 0;
461
462

	my $remainder;
463
	while (1) {
464
465
		@stack = (['', 0]) if ($#stack == -1);

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

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

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

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

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

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

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

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

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

559
	#print "coff<$coff> soff<$off> loff<$loff>\n";
560
561
562
563
564

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

565
566
567
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
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;
	}
}

608
609
610
611
612
613
sub ctx_statement_full {
	my ($linenr, $remain, $off) = @_;
	my ($statement, $condition, $level);

	my (@chunks);

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

	return ($level, $linenr, @chunks);
635
636
}

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

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

		$blk .= $rawlines[$line];
653
654
655
656
657
658
659
660
661
662

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

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

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

678
		if (!$outer || $level <= 1) {
679
			push(@res, $rawlines[$line]);
680
681
		}

682
		last if ($level == 0);
683
684
	}

685
	return ($level, @res);
686
687
688
689
}
sub ctx_block_outer {
	my ($linenr, $remain) = @_;

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

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

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

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

	return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
}
715
716
717
718
719

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

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

752
	##print "LINE: $rawlines[$end_line - 1 ]\n";
753
754
755
756
757
	##print "CMMT: $cmt\n";

	return ($cmt ne '');
}

758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
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;
}

774
775
776
sub cat_vet {
	my ($vet) = @_;
	my ($res, $coded);
777

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

788
	return $res;
789
790
}

791
my $av_preprocessor = 0;
792
my $av_pending;
793
my @av_paren_type;
794
my $av_pend_colon;
795
796
797

sub annotate_reset {
	$av_preprocessor = 0;
798
799
	$av_pending = '_';
	@av_paren_type = ('E');
800
	$av_pend_colon = 'O';
801
802
}

803
804
sub annotate_values {
	my ($stream, $type) = @_;
805

806
	my $res;
807
	my $var = '_' x length($stream);
808
809
	my $cur = $stream;

810
	print "$stream\n" if ($dbg_values > 1);
811
812

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

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

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

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

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

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

			push(@av_paren_type, $type);
			push(@av_paren_type, $type);
851
			$type = 'E';
852

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

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

859
			$type = 'E';
860

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

948
949
950
951
952
953
954
955
956
957
958
959
960
961
		} 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';
962

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

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

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

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

995
	return ($res, $var);
996
997
}

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

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

1043
1044
my $prefix = '';

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

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

1053
	push(our @report, $line);
1054
1055

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

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

1106
1107
1108
1109
1110
sub process {
	my $filename = shift;

	my $linenr=0;
	my $prevline="";
1111
	my $prevrawline="";
1112
	my $stashline="";
1113
	my $stashrawline="";
1114

1115
	my $length;
1116
1117
1118
1119
	my $indent;
	my $previndent=0;
	my $stashindent=0;

1120
	our $clean = 1;
1121
1122
1123
	my $signoff = 0;
	my $is_patch = 0;

1124
	our @report = ();
1125
1126
1127
1128
1129
	our $cnt_lines = 0;
	our $cnt_error = 0;
	our $cnt_warn = 0;
	our $cnt_chk = 0;

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

1140
1141
1142
	my $prev_values = 'E';

	# suppression flags
1143
	my %suppress_ifbraces;
1144
	my %suppress_whiletrailers;
1145

1146
	# Pre-scan the patch sanitizing the lines.
1147
	# Pre-scan the patch looking for any __setup documentation.
1148
	#
1149
1150
	my @setup_docs = ();
	my $setup_docs = 0;
1151
1152

	sanitise_line_reset();
1153
1154
	my $line;
	foreach my $rawline (@rawlines) {
1155
1156
		$linenr++;
		$line = $rawline;
1157

1158
		if ($rawline=~/^\+\+\+\s+(\S+)/) {