PageRenderTime 76ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 0ms

/qemu/scripts/checkpatch.pl

https://github.com/dbennett455/panda
Perl | 2907 lines | 2571 code | 233 blank | 103 comment | 270 complexity | 895d26e9dc0e629d3cc24853b1b7dce1 MD5 | raw file
Possible License(s): GPL-2.0, BSD-3-Clause, GPL-3.0, Apache-2.0, LGPL-2.1
  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)
  4. # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
  5. # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
  6. # Licensed under the terms of the GNU GPL License version 2
  7. use strict;
  8. my $P = $0;
  9. $P =~ s@.*/@@g;
  10. my $V = '0.31';
  11. use Getopt::Long qw(:config no_auto_abbrev);
  12. my $quiet = 0;
  13. my $tree = 1;
  14. my $chk_signoff = 1;
  15. my $chk_patch = 1;
  16. my $tst_only;
  17. my $emacs = 0;
  18. my $terse = 0;
  19. my $file = 0;
  20. my $check = 0;
  21. my $summary = 1;
  22. my $mailback = 0;
  23. my $summary_file = 0;
  24. my $root;
  25. my %debug;
  26. my $help = 0;
  27. sub help {
  28. my ($exitcode) = @_;
  29. print << "EOM";
  30. Usage: $P [OPTION]... [FILE]...
  31. Version: $V
  32. Options:
  33. -q, --quiet quiet
  34. --no-tree run without a kernel tree
  35. --no-signoff do not check for 'Signed-off-by' line
  36. --patch treat FILE as patchfile (default)
  37. --emacs emacs compile window format
  38. --terse one line per report
  39. -f, --file treat FILE as regular source file
  40. --subjective, --strict enable more subjective tests
  41. --root=PATH PATH to the kernel tree root
  42. --no-summary suppress the per-file summary
  43. --mailback only produce a report in case of warnings/errors
  44. --summary-file include the filename in summary
  45. --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
  46. 'values', 'possible', 'type', and 'attr' (default
  47. is all off)
  48. --test-only=WORD report only warnings/errors containing WORD
  49. literally
  50. -h, --help, --version display this help and exit
  51. When FILE is - read standard input.
  52. EOM
  53. exit($exitcode);
  54. }
  55. GetOptions(
  56. 'q|quiet+' => \$quiet,
  57. 'tree!' => \$tree,
  58. 'signoff!' => \$chk_signoff,
  59. 'patch!' => \$chk_patch,
  60. 'emacs!' => \$emacs,
  61. 'terse!' => \$terse,
  62. 'f|file!' => \$file,
  63. 'subjective!' => \$check,
  64. 'strict!' => \$check,
  65. 'root=s' => \$root,
  66. 'summary!' => \$summary,
  67. 'mailback!' => \$mailback,
  68. 'summary-file!' => \$summary_file,
  69. 'debug=s' => \%debug,
  70. 'test-only=s' => \$tst_only,
  71. 'h|help' => \$help,
  72. 'version' => \$help
  73. ) or help(1);
  74. help(0) if ($help);
  75. my $exit = 0;
  76. if ($#ARGV < 0) {
  77. print "$P: no input files\n";
  78. exit(1);
  79. }
  80. my $dbg_values = 0;
  81. my $dbg_possible = 0;
  82. my $dbg_type = 0;
  83. my $dbg_attr = 0;
  84. for my $key (keys %debug) {
  85. ## no critic
  86. eval "\${dbg_$key} = '$debug{$key}';";
  87. die "$@" if ($@);
  88. }
  89. my $rpt_cleaners = 0;
  90. if ($terse) {
  91. $emacs = 1;
  92. $quiet++;
  93. }
  94. if ($tree) {
  95. if (defined $root) {
  96. if (!top_of_kernel_tree($root)) {
  97. die "$P: $root: --root does not point at a valid tree\n";
  98. }
  99. } else {
  100. if (top_of_kernel_tree('.')) {
  101. $root = '.';
  102. } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
  103. top_of_kernel_tree($1)) {
  104. $root = $1;
  105. }
  106. }
  107. if (!defined $root) {
  108. print "Must be run from the top-level dir. of a kernel tree\n";
  109. exit(2);
  110. }
  111. }
  112. my $emitted_corrupt = 0;
  113. our $Ident = qr{
  114. [A-Za-z_][A-Za-z\d_]*
  115. (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
  116. }x;
  117. our $Storage = qr{extern|static|asmlinkage};
  118. our $Sparse = qr{
  119. __user|
  120. __kernel|
  121. __force|
  122. __iomem|
  123. __must_check|
  124. __init_refok|
  125. __kprobes|
  126. __ref
  127. }x;
  128. # Notes to $Attribute:
  129. # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
  130. our $Attribute = qr{
  131. const|
  132. __percpu|
  133. __nocast|
  134. __safe|
  135. __bitwise__|
  136. __packed__|
  137. __packed2__|
  138. __naked|
  139. __maybe_unused|
  140. __always_unused|
  141. __noreturn|
  142. __used|
  143. __cold|
  144. __noclone|
  145. __deprecated|
  146. __read_mostly|
  147. __kprobes|
  148. __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
  149. ____cacheline_aligned|
  150. ____cacheline_aligned_in_smp|
  151. ____cacheline_internodealigned_in_smp|
  152. __weak
  153. }x;
  154. our $Modifier;
  155. our $Inline = qr{inline|__always_inline|noinline};
  156. our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
  157. our $Lval = qr{$Ident(?:$Member)*};
  158. our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
  159. our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
  160. our $Compare = qr{<=|>=|==|!=|<|>};
  161. our $Operators = qr{
  162. <=|>=|==|!=|
  163. =>|->|<<|>>|<|>|!|~|
  164. &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
  165. }x;
  166. our $NonptrType;
  167. our $Type;
  168. our $Declare;
  169. our $UTF8 = qr {
  170. [\x09\x0A\x0D\x20-\x7E] # ASCII
  171. | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
  172. | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
  173. | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
  174. | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
  175. | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
  176. | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
  177. | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
  178. }x;
  179. our $typeTypedefs = qr{(?x:
  180. (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
  181. atomic_t
  182. )};
  183. our $logFunctions = qr{(?x:
  184. printk|
  185. pr_(debug|dbg|vdbg|devel|info|warning|err|notice|alert|crit|emerg|cont)|
  186. (dev|netdev|netif)_(printk|dbg|vdbg|info|warn|err|notice|alert|crit|emerg|WARN)|
  187. WARN|
  188. panic
  189. )};
  190. our @typeList = (
  191. qr{void},
  192. qr{(?:unsigned\s+)?char},
  193. qr{(?:unsigned\s+)?short},
  194. qr{(?:unsigned\s+)?int},
  195. qr{(?:unsigned\s+)?long},
  196. qr{(?:unsigned\s+)?long\s+int},
  197. qr{(?:unsigned\s+)?long\s+long},
  198. qr{(?:unsigned\s+)?long\s+long\s+int},
  199. qr{unsigned},
  200. qr{float},
  201. qr{double},
  202. qr{bool},
  203. qr{struct\s+$Ident},
  204. qr{union\s+$Ident},
  205. qr{enum\s+$Ident},
  206. qr{${Ident}_t},
  207. qr{${Ident}_handler},
  208. qr{${Ident}_handler_fn},
  209. );
  210. our @modifierList = (
  211. qr{fastcall},
  212. );
  213. our $allowed_asm_includes = qr{(?x:
  214. irq|
  215. memory
  216. )};
  217. # memory.h: ARM has a custom one
  218. sub build_types {
  219. my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
  220. my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
  221. $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
  222. $NonptrType = qr{
  223. (?:$Modifier\s+|const\s+)*
  224. (?:
  225. (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
  226. (?:$typeTypedefs\b)|
  227. (?:${all}\b)
  228. )
  229. (?:\s+$Modifier|\s+const)*
  230. }x;
  231. $Type = qr{
  232. $NonptrType
  233. (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
  234. (?:\s+$Inline|\s+$Modifier)*
  235. }x;
  236. $Declare = qr{(?:$Storage\s+)?$Type};
  237. }
  238. build_types();
  239. $chk_signoff = 0 if ($file);
  240. my @dep_includes = ();
  241. my @dep_functions = ();
  242. my $removal = "Documentation/feature-removal-schedule.txt";
  243. if ($tree && -f "$root/$removal") {
  244. open(my $REMOVE, '<', "$root/$removal") ||
  245. die "$P: $removal: open failed - $!\n";
  246. while (<$REMOVE>) {
  247. if (/^Check:\s+(.*\S)/) {
  248. for my $entry (split(/[, ]+/, $1)) {
  249. if ($entry =~ m@include/(.*)@) {
  250. push(@dep_includes, $1);
  251. } elsif ($entry !~ m@/@) {
  252. push(@dep_functions, $entry);
  253. }
  254. }
  255. }
  256. }
  257. close($REMOVE);
  258. }
  259. my @rawlines = ();
  260. my @lines = ();
  261. my $vname;
  262. for my $filename (@ARGV) {
  263. my $FILE;
  264. if ($file) {
  265. open($FILE, '-|', "diff -u /dev/null $filename") ||
  266. die "$P: $filename: diff failed - $!\n";
  267. } elsif ($filename eq '-') {
  268. open($FILE, '<&STDIN');
  269. } else {
  270. open($FILE, '<', "$filename") ||
  271. die "$P: $filename: open failed - $!\n";
  272. }
  273. if ($filename eq '-') {
  274. $vname = 'Your patch';
  275. } else {
  276. $vname = $filename;
  277. }
  278. while (<$FILE>) {
  279. chomp;
  280. push(@rawlines, $_);
  281. }
  282. close($FILE);
  283. if (!process($filename)) {
  284. $exit = 1;
  285. }
  286. @rawlines = ();
  287. @lines = ();
  288. }
  289. exit($exit);
  290. sub top_of_kernel_tree {
  291. my ($root) = @_;
  292. my @tree_check = (
  293. "COPYING", "MAINTAINERS", "Makefile",
  294. "README", "docs", "VERSION",
  295. "vl.c"
  296. );
  297. foreach my $check (@tree_check) {
  298. if (! -e $root . '/' . $check) {
  299. return 0;
  300. }
  301. }
  302. return 1;
  303. }
  304. sub expand_tabs {
  305. my ($str) = @_;
  306. my $res = '';
  307. my $n = 0;
  308. for my $c (split(//, $str)) {
  309. if ($c eq "\t") {
  310. $res .= ' ';
  311. $n++;
  312. for (; ($n % 8) != 0; $n++) {
  313. $res .= ' ';
  314. }
  315. next;
  316. }
  317. $res .= $c;
  318. $n++;
  319. }
  320. return $res;
  321. }
  322. sub copy_spacing {
  323. (my $res = shift) =~ tr/\t/ /c;
  324. return $res;
  325. }
  326. sub line_stats {
  327. my ($line) = @_;
  328. # Drop the diff line leader and expand tabs
  329. $line =~ s/^.//;
  330. $line = expand_tabs($line);
  331. # Pick the indent from the front of the line.
  332. my ($white) = ($line =~ /^(\s*)/);
  333. return (length($line), length($white));
  334. }
  335. my $sanitise_quote = '';
  336. sub sanitise_line_reset {
  337. my ($in_comment) = @_;
  338. if ($in_comment) {
  339. $sanitise_quote = '*/';
  340. } else {
  341. $sanitise_quote = '';
  342. }
  343. }
  344. sub sanitise_line {
  345. my ($line) = @_;
  346. my $res = '';
  347. my $l = '';
  348. my $qlen = 0;
  349. my $off = 0;
  350. my $c;
  351. # Always copy over the diff marker.
  352. $res = substr($line, 0, 1);
  353. for ($off = 1; $off < length($line); $off++) {
  354. $c = substr($line, $off, 1);
  355. # Comments we are wacking completly including the begin
  356. # and end, all to $;.
  357. if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
  358. $sanitise_quote = '*/';
  359. substr($res, $off, 2, "$;$;");
  360. $off++;
  361. next;
  362. }
  363. if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
  364. $sanitise_quote = '';
  365. substr($res, $off, 2, "$;$;");
  366. $off++;
  367. next;
  368. }
  369. if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
  370. $sanitise_quote = '//';
  371. substr($res, $off, 2, $sanitise_quote);
  372. $off++;
  373. next;
  374. }
  375. # A \ in a string means ignore the next character.
  376. if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
  377. $c eq "\\") {
  378. substr($res, $off, 2, 'XX');
  379. $off++;
  380. next;
  381. }
  382. # Regular quotes.
  383. if ($c eq "'" || $c eq '"') {
  384. if ($sanitise_quote eq '') {
  385. $sanitise_quote = $c;
  386. substr($res, $off, 1, $c);
  387. next;
  388. } elsif ($sanitise_quote eq $c) {
  389. $sanitise_quote = '';
  390. }
  391. }
  392. #print "c<$c> SQ<$sanitise_quote>\n";
  393. if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
  394. substr($res, $off, 1, $;);
  395. } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
  396. substr($res, $off, 1, $;);
  397. } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
  398. substr($res, $off, 1, 'X');
  399. } else {
  400. substr($res, $off, 1, $c);
  401. }
  402. }
  403. if ($sanitise_quote eq '//') {
  404. $sanitise_quote = '';
  405. }
  406. # The pathname on a #include may be surrounded by '<' and '>'.
  407. if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
  408. my $clean = 'X' x length($1);
  409. $res =~ s@\<.*\>@<$clean>@;
  410. # The whole of a #error is a string.
  411. } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
  412. my $clean = 'X' x length($1);
  413. $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
  414. }
  415. return $res;
  416. }
  417. sub ctx_statement_block {
  418. my ($linenr, $remain, $off) = @_;
  419. my $line = $linenr - 1;
  420. my $blk = '';
  421. my $soff = $off;
  422. my $coff = $off - 1;
  423. my $coff_set = 0;
  424. my $loff = 0;
  425. my $type = '';
  426. my $level = 0;
  427. my @stack = ();
  428. my $p;
  429. my $c;
  430. my $len = 0;
  431. my $remainder;
  432. while (1) {
  433. @stack = (['', 0]) if ($#stack == -1);
  434. #warn "CSB: blk<$blk> remain<$remain>\n";
  435. # If we are about to drop off the end, pull in more
  436. # context.
  437. if ($off >= $len) {
  438. for (; $remain > 0; $line++) {
  439. last if (!defined $lines[$line]);
  440. next if ($lines[$line] =~ /^-/);
  441. $remain--;
  442. $loff = $len;
  443. $blk .= $lines[$line] . "\n";
  444. $len = length($blk);
  445. $line++;
  446. last;
  447. }
  448. # Bail if there is no further context.
  449. #warn "CSB: blk<$blk> off<$off> len<$len>\n";
  450. if ($off >= $len) {
  451. last;
  452. }
  453. }
  454. $p = $c;
  455. $c = substr($blk, $off, 1);
  456. $remainder = substr($blk, $off);
  457. #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
  458. # Handle nested #if/#else.
  459. if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
  460. push(@stack, [ $type, $level ]);
  461. } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
  462. ($type, $level) = @{$stack[$#stack - 1]};
  463. } elsif ($remainder =~ /^#\s*endif\b/) {
  464. ($type, $level) = @{pop(@stack)};
  465. }
  466. # Statement ends at the ';' or a close '}' at the
  467. # outermost level.
  468. if ($level == 0 && $c eq ';') {
  469. last;
  470. }
  471. # An else is really a conditional as long as its not else if
  472. if ($level == 0 && $coff_set == 0 &&
  473. (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
  474. $remainder =~ /^(else)(?:\s|{)/ &&
  475. $remainder !~ /^else\s+if\b/) {
  476. $coff = $off + length($1) - 1;
  477. $coff_set = 1;
  478. #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
  479. #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
  480. }
  481. if (($type eq '' || $type eq '(') && $c eq '(') {
  482. $level++;
  483. $type = '(';
  484. }
  485. if ($type eq '(' && $c eq ')') {
  486. $level--;
  487. $type = ($level != 0)? '(' : '';
  488. if ($level == 0 && $coff < $soff) {
  489. $coff = $off;
  490. $coff_set = 1;
  491. #warn "CSB: mark coff<$coff>\n";
  492. }
  493. }
  494. if (($type eq '' || $type eq '{') && $c eq '{') {
  495. $level++;
  496. $type = '{';
  497. }
  498. if ($type eq '{' && $c eq '}') {
  499. $level--;
  500. $type = ($level != 0)? '{' : '';
  501. if ($level == 0) {
  502. if (substr($blk, $off + 1, 1) eq ';') {
  503. $off++;
  504. }
  505. last;
  506. }
  507. }
  508. $off++;
  509. }
  510. # We are truly at the end, so shuffle to the next line.
  511. if ($off == $len) {
  512. $loff = $len + 1;
  513. $line++;
  514. $remain--;
  515. }
  516. my $statement = substr($blk, $soff, $off - $soff + 1);
  517. my $condition = substr($blk, $soff, $coff - $soff + 1);
  518. #warn "STATEMENT<$statement>\n";
  519. #warn "CONDITION<$condition>\n";
  520. #print "coff<$coff> soff<$off> loff<$loff>\n";
  521. return ($statement, $condition,
  522. $line, $remain + 1, $off - $loff + 1, $level);
  523. }
  524. sub statement_lines {
  525. my ($stmt) = @_;
  526. # Strip the diff line prefixes and rip blank lines at start and end.
  527. $stmt =~ s/(^|\n)./$1/g;
  528. $stmt =~ s/^\s*//;
  529. $stmt =~ s/\s*$//;
  530. my @stmt_lines = ($stmt =~ /\n/g);
  531. return $#stmt_lines + 2;
  532. }
  533. sub statement_rawlines {
  534. my ($stmt) = @_;
  535. my @stmt_lines = ($stmt =~ /\n/g);
  536. return $#stmt_lines + 2;
  537. }
  538. sub statement_block_size {
  539. my ($stmt) = @_;
  540. $stmt =~ s/(^|\n)./$1/g;
  541. $stmt =~ s/^\s*{//;
  542. $stmt =~ s/}\s*$//;
  543. $stmt =~ s/^\s*//;
  544. $stmt =~ s/\s*$//;
  545. my @stmt_lines = ($stmt =~ /\n/g);
  546. my @stmt_statements = ($stmt =~ /;/g);
  547. my $stmt_lines = $#stmt_lines + 2;
  548. my $stmt_statements = $#stmt_statements + 1;
  549. if ($stmt_lines > $stmt_statements) {
  550. return $stmt_lines;
  551. } else {
  552. return $stmt_statements;
  553. }
  554. }
  555. sub ctx_statement_full {
  556. my ($linenr, $remain, $off) = @_;
  557. my ($statement, $condition, $level);
  558. my (@chunks);
  559. # Grab the first conditional/block pair.
  560. ($statement, $condition, $linenr, $remain, $off, $level) =
  561. ctx_statement_block($linenr, $remain, $off);
  562. #print "F: c<$condition> s<$statement> remain<$remain>\n";
  563. push(@chunks, [ $condition, $statement ]);
  564. if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
  565. return ($level, $linenr, @chunks);
  566. }
  567. # Pull in the following conditional/block pairs and see if they
  568. # could continue the statement.
  569. for (;;) {
  570. ($statement, $condition, $linenr, $remain, $off, $level) =
  571. ctx_statement_block($linenr, $remain, $off);
  572. #print "C: c<$condition> s<$statement> remain<$remain>\n";
  573. last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
  574. #print "C: push\n";
  575. push(@chunks, [ $condition, $statement ]);
  576. }
  577. return ($level, $linenr, @chunks);
  578. }
  579. sub ctx_block_get {
  580. my ($linenr, $remain, $outer, $open, $close, $off) = @_;
  581. my $line;
  582. my $start = $linenr - 1;
  583. my $blk = '';
  584. my @o;
  585. my @c;
  586. my @res = ();
  587. my $level = 0;
  588. my @stack = ($level);
  589. for ($line = $start; $remain > 0; $line++) {
  590. next if ($rawlines[$line] =~ /^-/);
  591. $remain--;
  592. $blk .= $rawlines[$line];
  593. # Handle nested #if/#else.
  594. if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
  595. push(@stack, $level);
  596. } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
  597. $level = $stack[$#stack - 1];
  598. } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
  599. $level = pop(@stack);
  600. }
  601. foreach my $c (split(//, $lines[$line])) {
  602. ##print "C<$c>L<$level><$open$close>O<$off>\n";
  603. if ($off > 0) {
  604. $off--;
  605. next;
  606. }
  607. if ($c eq $close && $level > 0) {
  608. $level--;
  609. last if ($level == 0);
  610. } elsif ($c eq $open) {
  611. $level++;
  612. }
  613. }
  614. if (!$outer || $level <= 1) {
  615. push(@res, $rawlines[$line]);
  616. }
  617. last if ($level == 0);
  618. }
  619. return ($level, @res);
  620. }
  621. sub ctx_block_outer {
  622. my ($linenr, $remain) = @_;
  623. my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
  624. return @r;
  625. }
  626. sub ctx_block {
  627. my ($linenr, $remain) = @_;
  628. my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
  629. return @r;
  630. }
  631. sub ctx_statement {
  632. my ($linenr, $remain, $off) = @_;
  633. my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
  634. return @r;
  635. }
  636. sub ctx_block_level {
  637. my ($linenr, $remain) = @_;
  638. return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
  639. }
  640. sub ctx_statement_level {
  641. my ($linenr, $remain, $off) = @_;
  642. return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
  643. }
  644. sub ctx_locate_comment {
  645. my ($first_line, $end_line) = @_;
  646. # Catch a comment on the end of the line itself.
  647. my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
  648. return $current_comment if (defined $current_comment);
  649. # Look through the context and try and figure out if there is a
  650. # comment.
  651. my $in_comment = 0;
  652. $current_comment = '';
  653. for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
  654. my $line = $rawlines[$linenr - 1];
  655. #warn " $line\n";
  656. if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
  657. $in_comment = 1;
  658. }
  659. if ($line =~ m@/\*@) {
  660. $in_comment = 1;
  661. }
  662. if (!$in_comment && $current_comment ne '') {
  663. $current_comment = '';
  664. }
  665. $current_comment .= $line . "\n" if ($in_comment);
  666. if ($line =~ m@\*/@) {
  667. $in_comment = 0;
  668. }
  669. }
  670. chomp($current_comment);
  671. return($current_comment);
  672. }
  673. sub ctx_has_comment {
  674. my ($first_line, $end_line) = @_;
  675. my $cmt = ctx_locate_comment($first_line, $end_line);
  676. ##print "LINE: $rawlines[$end_line - 1 ]\n";
  677. ##print "CMMT: $cmt\n";
  678. return ($cmt ne '');
  679. }
  680. sub raw_line {
  681. my ($linenr, $cnt) = @_;
  682. my $offset = $linenr - 1;
  683. $cnt++;
  684. my $line;
  685. while ($cnt) {
  686. $line = $rawlines[$offset++];
  687. next if (defined($line) && $line =~ /^-/);
  688. $cnt--;
  689. }
  690. return $line;
  691. }
  692. sub cat_vet {
  693. my ($vet) = @_;
  694. my ($res, $coded);
  695. $res = '';
  696. while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
  697. $res .= $1;
  698. if ($2 ne '') {
  699. $coded = sprintf("^%c", unpack('C', $2) + 64);
  700. $res .= $coded;
  701. }
  702. }
  703. $res =~ s/$/\$/;
  704. return $res;
  705. }
  706. my $av_preprocessor = 0;
  707. my $av_pending;
  708. my @av_paren_type;
  709. my $av_pend_colon;
  710. sub annotate_reset {
  711. $av_preprocessor = 0;
  712. $av_pending = '_';
  713. @av_paren_type = ('E');
  714. $av_pend_colon = 'O';
  715. }
  716. sub annotate_values {
  717. my ($stream, $type) = @_;
  718. my $res;
  719. my $var = '_' x length($stream);
  720. my $cur = $stream;
  721. print "$stream\n" if ($dbg_values > 1);
  722. while (length($cur)) {
  723. @av_paren_type = ('E') if ($#av_paren_type < 0);
  724. print " <" . join('', @av_paren_type) .
  725. "> <$type> <$av_pending>" if ($dbg_values > 1);
  726. if ($cur =~ /^(\s+)/o) {
  727. print "WS($1)\n" if ($dbg_values > 1);
  728. if ($1 =~ /\n/ && $av_preprocessor) {
  729. $type = pop(@av_paren_type);
  730. $av_preprocessor = 0;
  731. }
  732. } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
  733. print "CAST($1)\n" if ($dbg_values > 1);
  734. push(@av_paren_type, $type);
  735. $type = 'C';
  736. } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
  737. print "DECLARE($1)\n" if ($dbg_values > 1);
  738. $type = 'T';
  739. } elsif ($cur =~ /^($Modifier)\s*/) {
  740. print "MODIFIER($1)\n" if ($dbg_values > 1);
  741. $type = 'T';
  742. } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
  743. print "DEFINE($1,$2)\n" if ($dbg_values > 1);
  744. $av_preprocessor = 1;
  745. push(@av_paren_type, $type);
  746. if ($2 ne '') {
  747. $av_pending = 'N';
  748. }
  749. $type = 'E';
  750. } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
  751. print "UNDEF($1)\n" if ($dbg_values > 1);
  752. $av_preprocessor = 1;
  753. push(@av_paren_type, $type);
  754. } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
  755. print "PRE_START($1)\n" if ($dbg_values > 1);
  756. $av_preprocessor = 1;
  757. push(@av_paren_type, $type);
  758. push(@av_paren_type, $type);
  759. $type = 'E';
  760. } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
  761. print "PRE_RESTART($1)\n" if ($dbg_values > 1);
  762. $av_preprocessor = 1;
  763. push(@av_paren_type, $av_paren_type[$#av_paren_type]);
  764. $type = 'E';
  765. } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
  766. print "PRE_END($1)\n" if ($dbg_values > 1);
  767. $av_preprocessor = 1;
  768. # Assume all arms of the conditional end as this
  769. # one does, and continue as if the #endif was not here.
  770. pop(@av_paren_type);
  771. push(@av_paren_type, $type);
  772. $type = 'E';
  773. } elsif ($cur =~ /^(\\\n)/o) {
  774. print "PRECONT($1)\n" if ($dbg_values > 1);
  775. } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
  776. print "ATTR($1)\n" if ($dbg_values > 1);
  777. $av_pending = $type;
  778. $type = 'N';
  779. } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
  780. print "SIZEOF($1)\n" if ($dbg_values > 1);
  781. if (defined $2) {
  782. $av_pending = 'V';
  783. }
  784. $type = 'N';
  785. } elsif ($cur =~ /^(if|while|for)\b/o) {
  786. print "COND($1)\n" if ($dbg_values > 1);
  787. $av_pending = 'E';
  788. $type = 'N';
  789. } elsif ($cur =~/^(case)/o) {
  790. print "CASE($1)\n" if ($dbg_values > 1);
  791. $av_pend_colon = 'C';
  792. $type = 'N';
  793. } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
  794. print "KEYWORD($1)\n" if ($dbg_values > 1);
  795. $type = 'N';
  796. } elsif ($cur =~ /^(\()/o) {
  797. print "PAREN('$1')\n" if ($dbg_values > 1);
  798. push(@av_paren_type, $av_pending);
  799. $av_pending = '_';
  800. $type = 'N';
  801. } elsif ($cur =~ /^(\))/o) {
  802. my $new_type = pop(@av_paren_type);
  803. if ($new_type ne '_') {
  804. $type = $new_type;
  805. print "PAREN('$1') -> $type\n"
  806. if ($dbg_values > 1);
  807. } else {
  808. print "PAREN('$1')\n" if ($dbg_values > 1);
  809. }
  810. } elsif ($cur =~ /^($Ident)\s*\(/o) {
  811. print "FUNC($1)\n" if ($dbg_values > 1);
  812. $type = 'V';
  813. $av_pending = 'V';
  814. } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
  815. if (defined $2 && $type eq 'C' || $type eq 'T') {
  816. $av_pend_colon = 'B';
  817. } elsif ($type eq 'E') {
  818. $av_pend_colon = 'L';
  819. }
  820. print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
  821. $type = 'V';
  822. } elsif ($cur =~ /^($Ident|$Constant)/o) {
  823. print "IDENT($1)\n" if ($dbg_values > 1);
  824. $type = 'V';
  825. } elsif ($cur =~ /^($Assignment)/o) {
  826. print "ASSIGN($1)\n" if ($dbg_values > 1);
  827. $type = 'N';
  828. } elsif ($cur =~/^(;|{|})/) {
  829. print "END($1)\n" if ($dbg_values > 1);
  830. $type = 'E';
  831. $av_pend_colon = 'O';
  832. } elsif ($cur =~/^(,)/) {
  833. print "COMMA($1)\n" if ($dbg_values > 1);
  834. $type = 'C';
  835. } elsif ($cur =~ /^(\?)/o) {
  836. print "QUESTION($1)\n" if ($dbg_values > 1);
  837. $type = 'N';
  838. } elsif ($cur =~ /^(:)/o) {
  839. print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
  840. substr($var, length($res), 1, $av_pend_colon);
  841. if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
  842. $type = 'E';
  843. } else {
  844. $type = 'N';
  845. }
  846. $av_pend_colon = 'O';
  847. } elsif ($cur =~ /^(\[)/o) {
  848. print "CLOSE($1)\n" if ($dbg_values > 1);
  849. $type = 'N';
  850. } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
  851. my $variant;
  852. print "OPV($1)\n" if ($dbg_values > 1);
  853. if ($type eq 'V') {
  854. $variant = 'B';
  855. } else {
  856. $variant = 'U';
  857. }
  858. substr($var, length($res), 1, $variant);
  859. $type = 'N';
  860. } elsif ($cur =~ /^($Operators)/o) {
  861. print "OP($1)\n" if ($dbg_values > 1);
  862. if ($1 ne '++' && $1 ne '--') {
  863. $type = 'N';
  864. }
  865. } elsif ($cur =~ /(^.)/o) {
  866. print "C($1)\n" if ($dbg_values > 1);
  867. }
  868. if (defined $1) {
  869. $cur = substr($cur, length($1));
  870. $res .= $type x length($1);
  871. }
  872. }
  873. return ($res, $var);
  874. }
  875. sub possible {
  876. my ($possible, $line) = @_;
  877. my $notPermitted = qr{(?:
  878. ^(?:
  879. $Modifier|
  880. $Storage|
  881. $Type|
  882. DEFINE_\S+
  883. )$|
  884. ^(?:
  885. goto|
  886. return|
  887. case|
  888. else|
  889. asm|__asm__|
  890. do
  891. )(?:\s|$)|
  892. ^(?:typedef|struct|enum)\b
  893. )}x;
  894. warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
  895. if ($possible !~ $notPermitted) {
  896. # Check for modifiers.
  897. $possible =~ s/\s*$Storage\s*//g;
  898. $possible =~ s/\s*$Sparse\s*//g;
  899. if ($possible =~ /^\s*$/) {
  900. } elsif ($possible =~ /\s/) {
  901. $possible =~ s/\s*$Type\s*//g;
  902. for my $modifier (split(' ', $possible)) {
  903. if ($modifier !~ $notPermitted) {
  904. warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
  905. push(@modifierList, $modifier);
  906. }
  907. }
  908. } else {
  909. warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
  910. push(@typeList, $possible);
  911. }
  912. build_types();
  913. } else {
  914. warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
  915. }
  916. }
  917. my $prefix = '';
  918. sub report {
  919. if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
  920. return 0;
  921. }
  922. my $line = $prefix . $_[0];
  923. $line = (split('\n', $line))[0] . "\n" if ($terse);
  924. push(our @report, $line);
  925. return 1;
  926. }
  927. sub report_dump {
  928. our @report;
  929. }
  930. sub ERROR {
  931. if (report("ERROR: $_[0]\n")) {
  932. our $clean = 0;
  933. our $cnt_error++;
  934. }
  935. }
  936. sub WARN {
  937. if (report("WARNING: $_[0]\n")) {
  938. our $clean = 0;
  939. our $cnt_warn++;
  940. }
  941. }
  942. sub CHK {
  943. if ($check && report("CHECK: $_[0]\n")) {
  944. our $clean = 0;
  945. our $cnt_chk++;
  946. }
  947. }
  948. sub check_absolute_file {
  949. my ($absolute, $herecurr) = @_;
  950. my $file = $absolute;
  951. ##print "absolute<$absolute>\n";
  952. # See if any suffix of this path is a path within the tree.
  953. while ($file =~ s@^[^/]*/@@) {
  954. if (-f "$root/$file") {
  955. ##print "file<$file>\n";
  956. last;
  957. }
  958. }
  959. if (! -f _) {
  960. return 0;
  961. }
  962. # It is, so see if the prefix is acceptable.
  963. my $prefix = $absolute;
  964. substr($prefix, -length($file)) = '';
  965. ##print "prefix<$prefix>\n";
  966. if ($prefix ne ".../") {
  967. WARN("use relative pathname instead of absolute in changelog text\n" . $herecurr);
  968. }
  969. }
  970. sub process {
  971. my $filename = shift;
  972. my $linenr=0;
  973. my $prevline="";
  974. my $prevrawline="";
  975. my $stashline="";
  976. my $stashrawline="";
  977. my $length;
  978. my $indent;
  979. my $previndent=0;
  980. my $stashindent=0;
  981. our $clean = 1;
  982. my $signoff = 0;
  983. my $is_patch = 0;
  984. our @report = ();
  985. our $cnt_lines = 0;
  986. our $cnt_error = 0;
  987. our $cnt_warn = 0;
  988. our $cnt_chk = 0;
  989. # Trace the real file/line as we go.
  990. my $realfile = '';
  991. my $realline = 0;
  992. my $realcnt = 0;
  993. my $here = '';
  994. my $in_comment = 0;
  995. my $comment_edge = 0;
  996. my $first_line = 0;
  997. my $p1_prefix = '';
  998. my $prev_values = 'E';
  999. # suppression flags
  1000. my %suppress_ifbraces;
  1001. my %suppress_whiletrailers;
  1002. my %suppress_export;
  1003. # Pre-scan the patch sanitizing the lines.
  1004. # Pre-scan the patch looking for any __setup documentation.
  1005. #
  1006. my @setup_docs = ();
  1007. my $setup_docs = 0;
  1008. sanitise_line_reset();
  1009. my $line;
  1010. foreach my $rawline (@rawlines) {
  1011. $linenr++;
  1012. $line = $rawline;
  1013. if ($rawline=~/^\+\+\+\s+(\S+)/) {
  1014. $setup_docs = 0;
  1015. if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
  1016. $setup_docs = 1;
  1017. }
  1018. #next;
  1019. }
  1020. if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
  1021. $realline=$1-1;
  1022. if (defined $2) {
  1023. $realcnt=$3+1;
  1024. } else {
  1025. $realcnt=1+1;
  1026. }
  1027. $in_comment = 0;
  1028. # Guestimate if this is a continuing comment. Run
  1029. # the context looking for a comment "edge". If this
  1030. # edge is a close comment then we must be in a comment
  1031. # at context start.
  1032. my $edge;
  1033. my $cnt = $realcnt;
  1034. for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
  1035. next if (defined $rawlines[$ln - 1] &&
  1036. $rawlines[$ln - 1] =~ /^-/);
  1037. $cnt--;
  1038. #print "RAW<$rawlines[$ln - 1]>\n";
  1039. last if (!defined $rawlines[$ln - 1]);
  1040. if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
  1041. $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
  1042. ($edge) = $1;
  1043. last;
  1044. }
  1045. }
  1046. if (defined $edge && $edge eq '*/') {
  1047. $in_comment = 1;
  1048. }
  1049. # Guestimate if this is a continuing comment. If this
  1050. # is the start of a diff block and this line starts
  1051. # ' *' then it is very likely a comment.
  1052. if (!defined $edge &&
  1053. $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
  1054. {
  1055. $in_comment = 1;
  1056. }
  1057. ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
  1058. sanitise_line_reset($in_comment);
  1059. } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
  1060. # Standardise the strings and chars within the input to
  1061. # simplify matching -- only bother with positive lines.
  1062. $line = sanitise_line($rawline);
  1063. }
  1064. push(@lines, $line);
  1065. if ($realcnt > 1) {
  1066. $realcnt-- if ($line =~ /^(?:\+| |$)/);
  1067. } else {
  1068. $realcnt = 0;
  1069. }
  1070. #print "==>$rawline\n";
  1071. #print "-->$line\n";
  1072. if ($setup_docs && $line =~ /^\+/) {
  1073. push(@setup_docs, $line);
  1074. }
  1075. }
  1076. $prefix = '';
  1077. $realcnt = 0;
  1078. $linenr = 0;
  1079. foreach my $line (@lines) {
  1080. $linenr++;
  1081. my $rawline = $rawlines[$linenr - 1];
  1082. #extract the line range in the file after the patch is applied
  1083. if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
  1084. $is_patch = 1;
  1085. $first_line = $linenr + 1;
  1086. $realline=$1-1;
  1087. if (defined $2) {
  1088. $realcnt=$3+1;
  1089. } else {
  1090. $realcnt=1+1;
  1091. }
  1092. annotate_reset();
  1093. $prev_values = 'E';
  1094. %suppress_ifbraces = ();
  1095. %suppress_whiletrailers = ();
  1096. %suppress_export = ();
  1097. next;
  1098. # track the line number as we move through the hunk, note that
  1099. # new versions of GNU diff omit the leading space on completely
  1100. # blank context lines so we need to count that too.
  1101. } elsif ($line =~ /^( |\+|$)/) {
  1102. $realline++;
  1103. $realcnt-- if ($realcnt != 0);
  1104. # Measure the line length and indent.
  1105. ($length, $indent) = line_stats($rawline);
  1106. # Track the previous line.
  1107. ($prevline, $stashline) = ($stashline, $line);
  1108. ($previndent, $stashindent) = ($stashindent, $indent);
  1109. ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
  1110. #warn "line<$line>\n";
  1111. } elsif ($realcnt == 1) {
  1112. $realcnt--;
  1113. }
  1114. my $hunk_line = ($realcnt != 0);
  1115. #make up the handle for any error we report on this line
  1116. $prefix = "$filename:$realline: " if ($emacs && $file);
  1117. $prefix = "$filename:$linenr: " if ($emacs && !$file);
  1118. $here = "#$linenr: " if (!$file);
  1119. $here = "#$realline: " if ($file);
  1120. # extract the filename as it passes
  1121. if ($line =~ /^diff --git.*?(\S+)$/) {
  1122. $realfile = $1;
  1123. $realfile =~ s@^([^/]*)/@@;
  1124. } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
  1125. $realfile = $1;
  1126. $realfile =~ s@^([^/]*)/@@;
  1127. $p1_prefix = $1;
  1128. if (!$file && $tree && $p1_prefix ne '' &&
  1129. -e "$root/$p1_prefix") {
  1130. WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
  1131. }
  1132. if ($realfile =~ m@^include/asm/@) {
  1133. ERROR("do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
  1134. }
  1135. next;
  1136. }
  1137. $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
  1138. my $hereline = "$here\n$rawline\n";
  1139. my $herecurr = "$here\n$rawline\n";
  1140. my $hereprev = "$here\n$prevrawline\n$rawline\n";
  1141. $cnt_lines++ if ($realcnt != 0);
  1142. # Check for incorrect file permissions
  1143. if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
  1144. my $permhere = $here . "FILE: $realfile\n";
  1145. if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
  1146. ERROR("do not set execute permissions for source files\n" . $permhere);
  1147. }
  1148. }
  1149. #check the patch for a signoff:
  1150. if ($line =~ /^\s*signed-off-by:/i) {
  1151. # This is a signoff, if ugly, so do not double report.
  1152. $signoff++;
  1153. if (!($line =~ /^\s*Signed-off-by:/)) {
  1154. WARN("Signed-off-by: is the preferred form\n" .
  1155. $herecurr);
  1156. }
  1157. if ($line =~ /^\s*signed-off-by:\S/i) {
  1158. WARN("space required after Signed-off-by:\n" .
  1159. $herecurr);
  1160. }
  1161. }
  1162. # Check for wrappage within a valid hunk of the file
  1163. if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
  1164. ERROR("patch seems to be corrupt (line wrapped?)\n" .
  1165. $herecurr) if (!$emitted_corrupt++);
  1166. }
  1167. # Check for absolute kernel paths.
  1168. if ($tree) {
  1169. while ($line =~ m{(?:^|\s)(/\S*)}g) {
  1170. my $file = $1;
  1171. if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
  1172. check_absolute_file($1, $herecurr)) {
  1173. #
  1174. } else {
  1175. check_absolute_file($file, $herecurr);
  1176. }
  1177. }
  1178. }
  1179. # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
  1180. if (($realfile =~ /^$/ || $line =~ /^\+/) &&
  1181. $rawline !~ m/^$UTF8*$/) {
  1182. my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
  1183. my $blank = copy_spacing($rawline);
  1184. my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
  1185. my $hereptr = "$hereline$ptr\n";
  1186. ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
  1187. }
  1188. # ignore non-hunk lines and lines being removed
  1189. next if (!$hunk_line || $line =~ /^-/);
  1190. #trailing whitespace
  1191. if ($line =~ /^\+.*\015/) {
  1192. my $herevet = "$here\n" . cat_vet($rawline) . "\n";
  1193. ERROR("DOS line endings\n" . $herevet);
  1194. } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
  1195. my $herevet = "$here\n" . cat_vet($rawline) . "\n";
  1196. ERROR("trailing whitespace\n" . $herevet);
  1197. $rpt_cleaners = 1;
  1198. }
  1199. # check for Kconfig help text having a real description
  1200. # Only applies when adding the entry originally, after that we do not have
  1201. # sufficient context to determine whether it is indeed long enough.
  1202. if ($realfile =~ /Kconfig/ &&
  1203. $line =~ /\+\s*(?:---)?help(?:---)?$/) {
  1204. my $length = 0;
  1205. my $cnt = $realcnt;
  1206. my $ln = $linenr + 1;
  1207. my $f;
  1208. my $is_end = 0;
  1209. while ($cnt > 0 && defined $lines[$ln - 1]) {
  1210. $f = $lines[$ln - 1];
  1211. $cnt-- if ($lines[$ln - 1] !~ /^-/);
  1212. $is_end = $lines[$ln - 1] =~ /^\+/;
  1213. $ln++;
  1214. next if ($f =~ /^-/);
  1215. $f =~ s/^.//;
  1216. $f =~ s/#.*//;
  1217. $f =~ s/^\s+//;
  1218. next if ($f =~ /^$/);
  1219. if ($f =~ /^\s*config\s/) {
  1220. $is_end = 1;
  1221. last;
  1222. }
  1223. $length++;
  1224. }
  1225. WARN("please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4);
  1226. #print "is_end<$is_end> length<$length>\n";
  1227. }
  1228. # check we are in a valid source file if not then ignore this hunk
  1229. next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
  1230. #80 column limit
  1231. if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
  1232. $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
  1233. !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:,|\)\s*;)\s*$/ ||
  1234. $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
  1235. $length > 80)
  1236. {
  1237. WARN("line over 80 characters\n" . $herecurr);
  1238. }
  1239. # check for spaces before a quoted newline
  1240. if ($rawline =~ /^.*\".*\s\\n/) {
  1241. WARN("unnecessary whitespace before a quoted newline\n" . $herecurr);
  1242. }
  1243. # check for adding lines without a newline.
  1244. if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
  1245. WARN("adding a line without newline at end of file\n" . $herecurr);
  1246. }
  1247. # Blackfin: use hi/lo macros
  1248. if ($realfile =~ m@arch/blackfin/.*\.S$@) {
  1249. if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
  1250. my $herevet = "$here\n" . cat_vet($line) . "\n";
  1251. ERROR("use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
  1252. }
  1253. if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
  1254. my $herevet = "$here\n" . cat_vet($line) . "\n";
  1255. ERROR("use the HI() macro, not (... >> 16)\n" . $herevet);
  1256. }
  1257. }
  1258. # check we are in a valid source file C or perl if not then ignore this hunk
  1259. next if ($realfile !~ /\.(h|c|pl)$/);
  1260. # in QEMU, no tabs are allowed
  1261. if ($rawline =~ /^\+.*\t/) {
  1262. my $herevet = "$here\n" . cat_vet($rawline) . "\n";
  1263. ERROR("code indent should never use tabs\n" . $herevet);
  1264. $rpt_cleaners = 1;
  1265. }
  1266. # check we are in a valid C source file if not then ignore this hunk
  1267. next if ($realfile !~ /\.(h|c)$/);
  1268. # check for RCS/CVS revision markers
  1269. if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
  1270. WARN("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
  1271. }
  1272. # Blackfin: don't use __builtin_bfin_[cs]sync
  1273. if ($line =~ /__builtin_bfin_csync/) {
  1274. my $herevet = "$here\n" . cat_vet($line) . "\n";
  1275. ERROR("use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
  1276. }
  1277. if ($line =~ /__builtin_bfin_ssync/) {
  1278. my $herevet = "$here\n" . cat_vet($line) . "\n";
  1279. ERROR("use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
  1280. }
  1281. # Check for potential 'bare' types
  1282. my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
  1283. $realline_next);
  1284. if ($realcnt && $line =~ /.\s*\S/) {
  1285. ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
  1286. ctx_statement_block($linenr, $realcnt, 0);
  1287. $stat =~ s/\n./\n /g;
  1288. $cond =~ s/\n./\n /g;
  1289. # Find the real next line.
  1290. $realline_next = $line_nr_next;
  1291. if (defined $realline_next &&
  1292. (!defined $lines[$realline_next - 1] ||
  1293. substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
  1294. $realline_next++;
  1295. }
  1296. my $s = $stat;
  1297. $s =~ s/{.*$//s;
  1298. # Ignore goto labels.
  1299. if ($s =~ /$Ident:\*$/s) {
  1300. # Ignore functions being called
  1301. } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
  1302. } elsif ($s =~ /^.\s*else\b/s) {
  1303. # declarations always start with types
  1304. } elsif ($prev_values eq 'E' && $s =~ /^.\s*(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?((?:\s*$Ident)+?)\b(?:\s+$Sparse)?\s*\**\s*(?:$Ident|\(\*[^\)]*\))(?:\s*$Modifier)?\s*(?:;|=|,|\()/s) {
  1305. my $type = $1;
  1306. $type =~ s/\s+/ /g;
  1307. possible($type, "A:" . $s);
  1308. # definitions in global scope can only start with types
  1309. } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
  1310. possible($1, "B:" . $s);
  1311. }
  1312. # any (foo ... *) is a pointer cast, and foo is a type
  1313. while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
  1314. possible($1, "C:" . $s);
  1315. }
  1316. # Check for any sort of function declaration.
  1317. # int foo(something bar, other baz);
  1318. # void (*store_gdt)(x86_descr_ptr *);
  1319. if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
  1320. my ($name_len) = length($1);
  1321. my $ctx = $s;
  1322. substr($ctx, 0, $name_len + 1, '');
  1323. $ctx =~ s/\)[^\)]*$//;
  1324. for my $arg (split(/\s*,\s*/, $ctx)) {
  1325. if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
  1326. possible($1, "D:" . $s);
  1327. }
  1328. }
  1329. }
  1330. }
  1331. #
  1332. # Checks which may be anchored in the context.
  1333. #
  1334. # Check for switch () and associated case and default
  1335. # statements should be at the same indent.
  1336. if ($line=~/\bswitch\s*\(.*\)/) {
  1337. my $err = '';
  1338. my $sep = '';
  1339. my @ctx = ctx_block_outer($linenr, $realcnt);
  1340. shift(@ctx);
  1341. for my $ctx (@ctx) {
  1342. my ($clen, $cindent) = line_stats($ctx);
  1343. if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
  1344. $indent != $cindent) {
  1345. $err .= "$sep$ctx\n";
  1346. $sep = '';
  1347. } else {
  1348. $sep = "[...]\n";
  1349. }
  1350. }
  1351. if ($err ne '') {
  1352. ERROR("switch and case should be at the same indent\n$hereline$err");
  1353. }
  1354. }
  1355. # if/while/etc brace do not go on next line, unless defining a do while loop,
  1356. # or if that brace on the next line is for something else
  1357. if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
  1358. my $pre_ctx = "$1$2";
  1359. my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
  1360. my $ctx_cnt = $realcnt - $#ctx - 1;
  1361. my $ctx = join("\n", @ctx);
  1362. my $ctx_ln = $linenr;
  1363. my $ctx_skip = $realcnt;
  1364. while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
  1365. defined $lines[$ctx_ln - 1] &&
  1366. $lines[$ctx_ln - 1] =~ /^-/)) {
  1367. ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
  1368. $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
  1369. $ctx_ln++;
  1370. }
  1371. #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
  1372. #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
  1373. if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
  1374. ERROR("that open brace { should be on the previous line\n" .
  1375. "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
  1376. }
  1377. if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
  1378. $ctx =~ /\)\s*\;\s*$/ &&
  1379. defined $lines[$ctx_ln - 1])
  1380. {
  1381. my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
  1382. if ($nindent > $indent) {
  1383. WARN("trailing semicolon indicates no statements, indent implies otherwise\n" .
  1384. "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
  1385. }
  1386. }
  1387. }
  1388. # Check relative indent for conditionals and blocks.
  1389. if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
  1390. my ($s, $c) = ($stat, $cond);
  1391. substr($s, 0, length($c), '');
  1392. # Make sure we remove the line prefixes as we have
  1393. # none on the first line, and are going to readd them
  1394. # where necessary.
  1395. $s =~ s/\n./\n/gs;
  1396. # Find out how long the conditional actually is.
  1397. my @newlines = ($c =~ /\n/gs);
  1398. my $cond_lines = 1 + $#newlines;
  1399. # We want to check the first line inside the block
  1400. # starting at the end of the conditional, so remove:
  1401. # 1) any blank line termination
  1402. # 2) any opening brace { on end of the line
  1403. # 3) any do (...) {
  1404. my $continuation = 0;
  1405. my $check = 0;
  1406. $s =~ s/^.*\bdo\b//;
  1407. $s =~ s/^\s*{//;
  1408. if ($s =~ s/^\s*\\//) {
  1409. $continuation = 1;
  1410. }
  1411. if ($s =~ s/^\s*?\n//) {
  1412. $check = 1;
  1413. $cond_lines++;
  1414. }
  1415. # Also ignore a loop construct at the end of a
  1416. # preprocessor statement.
  1417. if (($prevline =~ /^.\s*#\s*define\s/ ||
  1418. $prevline =~ /\\\s*$/) && $continuation == 0) {
  1419. $check = 0;
  1420. }
  1421. my $cond_ptr = -1;
  1422. $continuation = 0;
  1423. while ($cond_ptr != $cond_lines) {
  1424. $cond_ptr = $cond_lines;
  1425. # If we see an #else/#elif then the code
  1426. # is not linear.
  1427. if ($s =~ /^\s*\#\s*(?:else|elif)/) {
  1428. $check = 0;
  1429. }
  1430. # Ignore:
  1431. # 1) blank lines, they should be at 0,
  1432. # 2) preprocessor lines, and
  1433. # 3) labels.
  1434. if ($continuation ||
  1435. $s =~ /^\s*?\n/ ||
  1436. $s =~ /^\s*#\s*?/ ||
  1437. $s =~ /^\s*$Ident\s*:/) {
  1438. $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
  1439. if ($s =~ s/^.*?\n//) {
  1440. $cond_lines++;
  1441. }
  1442. }
  1443. }
  1444. my (undef, $sindent) = line_stats("+" . $s);
  1445. my $stat_real = raw_line($linenr, $cond_lines);
  1446. # Check if either of these lines are modified, else
  1447. # this is not this patch's fault.
  1448. if (!defined($stat_real) ||
  1449. $stat !~ /^\+/ && $stat_real !~ /^\+/) {
  1450. $check = 0;
  1451. }
  1452. if (defined($stat_real) && $cond_lines > 1) {
  1453. $stat_real = "[...]\n$stat_real";
  1454. }
  1455. #print "line<$line> prevline<$prevline> indent<$indent> sindent<$sindent> check<$check> continuation<$continuation> s<$s> cond_lines<$cond_lines> stat_real<$stat_real> stat<$stat>\n";
  1456. if ($check && (($sindent % 4) != 0 ||
  1457. ($sindent <= $indent && $s ne ''))) {
  1458. WARN("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
  1459. }
  1460. }
  1461. # Track the 'values' across context and added lines.
  1462. my $opline = $line; $opline =~ s/^./ /;
  1463. my ($curr_values, $curr_vars) =
  1464. annotate_values($opline . "\n", $prev_values);
  1465. $curr_values = $prev_values . $curr_values;
  1466. if ($dbg_values) {
  1467. my $outline = $opline; $outline =~ s/\t/ /g;
  1468. print "$linenr > .$outline\n";
  1469. print "$linenr > $curr_values\n";
  1470. print "$linenr > $curr_vars\n";
  1471. }
  1472. $prev_values = substr($curr_values, -1);
  1473. #ignore lines not being added
  1474. if ($line=~/^[^\+]/) {next;}
  1475. # TEST: allow direct testing of the type matcher.
  1476. if ($dbg_type) {
  1477. if ($line =~ /^.\s*$Declare\s*$/) {
  1478. ERROR("TEST: is type\n" . $herecurr);
  1479. } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
  1480. ERROR("TEST: is not type ($1 is)\n". $herecurr);
  1481. }
  1482. next;
  1483. }
  1484. # TEST: allow direct testing of the attribute matcher.
  1485. if ($dbg_attr) {
  1486. if ($line =~ /^.\s*$Modifier\s*$/) {
  1487. ERROR("TEST: is attr\n" . $herecurr);
  1488. } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
  1489. ERROR("TEST: is not attr ($1 is)\n". $herecurr);
  1490. }
  1491. next;
  1492. }
  1493. # check for initialisation to aggregates open brace on the next line
  1494. if ($line =~ /^.\s*{/ &&
  1495. $prevline =~ /(?:^|[^=])=\s*$/) {
  1496. ERROR("that open brace { should be on the previous line\n" . $hereprev);
  1497. }
  1498. #
  1499. # Checks which are anchored on the added line.
  1500. #
  1501. # check for malformed paths in #include statements (uses RAW line)
  1502. if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
  1503. my $path = $1;
  1504. if ($path =~ m{//}) {
  1505. ERROR("malformed #include filename\n" .
  1506. $herecurr);
  1507. }
  1508. }
  1509. # no C99 // comments
  1510. if ($line =~ m{//}) {
  1511. ERROR("do not use C99 // comments\n" . $herecurr);
  1512. }
  1513. # Remove C99 comments.
  1514. $line =~ s@//.*@@;
  1515. $opline =~ s@//.*@@;
  1516. # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
  1517. # the whole statement.
  1518. #print "APW <$lines[$realline_next - 1]>\n";
  1519. if (defined $realline_next &&
  1520. exists $lines[$realline_next - 1] &&
  1521. !defined $suppress_export{$realline_next} &&
  1522. ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
  1523. $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
  1524. # Handle definitions which produce identifiers with
  1525. # a prefix:
  1526. # XXX(foo);
  1527. # EXPORT_SYMBOL(something_foo);
  1528. my $name = $1;
  1529. if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ &&
  1530. $name =~ /^${Ident}_$2/) {
  1531. #print "FOO C name<$name>\n";
  1532. $suppress_export{$realline_next} = 1;
  1533. } elsif ($stat !~ /(?:
  1534. \n.}\s*$|
  1535. ^.DEFINE_$Ident\(\Q$name\E\)|
  1536. ^.DECLARE_$Ident\(\Q$name\E\)|
  1537. ^.LIST_HEAD\(\Q$name\E\)|
  1538. ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
  1539. \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
  1540. )/x) {
  1541. #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
  1542. $suppress_export{$realline_next} = 2;
  1543. } else {
  1544. $suppress_export{$realline_next} = 1;
  1545. }
  1546. }
  1547. if (!defined $suppress_export{$linenr} &&
  1548. $prevline =~ /^.\s*$/ &&
  1549. ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
  1550. $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
  1551. #print "FOO B <$lines[$linenr - 1]>\n";
  1552. $suppress_export{$linenr} = 2;
  1553. }
  1554. if (defined $suppress_export{$linenr} &&
  1555. $suppress_export{$linenr} == 2) {
  1556. WARN("EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
  1557. }
  1558. # check for global initialisers.
  1559. if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
  1560. ERROR("do not initialise globals to 0 or NULL\n" .
  1561. $herecurr);
  1562. }
  1563. # check for static initialisers.
  1564. if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
  1565. ERROR("do not initialise statics to 0 or NULL\n" .
  1566. $herecurr);
  1567. }
  1568. # * goes on variable not on type
  1569. # (char*[ const])
  1570. if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
  1571. my ($from, $to) = ($1, $1);
  1572. # Should start with a space.
  1573. $to =~ s/^(\S)/ $1/;
  1574. # Should not end with a space.
  1575. $to =~ s/\s+$//;
  1576. # '*'s should not have spaces between.
  1577. while ($to =~ s/\*\s+\*/\*\*/) {
  1578. }
  1579. #print "from<$from> to<$to>\n";
  1580. if ($from ne $to) {
  1581. ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
  1582. }
  1583. } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
  1584. my ($from, $to, $ident) = ($1, $1, $2);
  1585. # Should start with a space.
  1586. $to =~ s/^(\S)/ $1/;
  1587. # Should not end with a space.
  1588. $to =~ s/\s+$//;
  1589. # '*'s should not have spaces between.
  1590. while ($to =~ s/\*\s+\*/\*\*/) {
  1591. }
  1592. # Modifiers should have spaces.
  1593. $to =~ s/(\b$Modifier$)/$1 /;
  1594. #print "from<$from> to<$to> ident<$ident>\n";
  1595. if ($from ne $to && $ident !~ /^$Modifier$/) {
  1596. ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
  1597. }
  1598. }
  1599. # # no BUG() or BUG_ON()
  1600. # if ($line =~ /\b(BUG|BUG_ON)\b/) {
  1601. # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
  1602. # print "$herecurr";
  1603. # $clean = 0;
  1604. # }
  1605. if ($line =~ /\bLINUX_VERSION_CODE\b/) {
  1606. WARN("LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
  1607. }
  1608. # printk should use KERN_* levels. Note that follow on printk's on the
  1609. # same line do not need a level, so we use the current block context
  1610. # to try and find and validate the current printk. In summary the current
  1611. # printk includes all preceeding printk's which have no newline on the end.
  1612. # we assume the first bad printk is the one to report.
  1613. if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
  1614. my $ok = 0;
  1615. for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
  1616. #print "CHECK<$lines[$ln - 1]\n";
  1617. # we have a preceeding printk if it ends
  1618. # with "\n" ignore it, else it is to blame
  1619. if ($lines[$ln - 1] =~ m{\bprintk\(}) {
  1620. if ($rawlines[$ln - 1] !~ m{\\n"}) {
  1621. $ok = 1;
  1622. }
  1623. last;
  1624. }
  1625. }
  1626. if ($ok == 0) {
  1627. WARN("printk() should include KERN_ facility level\n" . $herecurr);
  1628. }
  1629. }
  1630. # function brace can't be on same line, except for #defines of do while,
  1631. # or if closed on same line
  1632. if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
  1633. !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
  1634. ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
  1635. }
  1636. # open braces for enum, union and struct go on the same line.
  1637. if ($line =~ /^.\s*{/ &&
  1638. $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
  1639. ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
  1640. }
  1641. # missing space after union, struct or enum definition
  1642. if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
  1643. WARN("missing space after $1 definition\n" . $herecurr);
  1644. }
  1645. # check for spacing round square brackets; allowed:
  1646. # 1. with a type on the left -- int [] a;
  1647. # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
  1648. # 3. inside a curly brace -- = { [0...10] = 5 }
  1649. while ($line =~ /(.*?\s)\[/g) {
  1650. my ($where, $prefix) = ($-[1], $1);
  1651. if ($prefix !~ /$Type\s+$/ &&
  1652. ($where != 0 || $prefix !~ /^.\s+$/) &&
  1653. $prefix !~ /{\s+$/) {
  1654. ERROR("space prohibited before open square bracket '['\n" . $herecurr);
  1655. }
  1656. }
  1657. # check for spaces between functions and their parentheses.
  1658. while ($line =~ /($Ident)\s+\(/g) {
  1659. my $name = $1;
  1660. my $ctx_before = substr($line, 0, $-[1]);
  1661. my $ctx = "$ctx_before$name";
  1662. # Ignore those directives where spaces _are_ permitted.
  1663. if ($name =~ /^(?:
  1664. if|for|while|switch|return|case|
  1665. volatile|__volatile__|
  1666. __attribute__|format|__extension__|
  1667. asm|__asm__)$/x)
  1668. {
  1669. # cpp #define statements have non-optional spaces, ie
  1670. # if there is a space between the name and the open
  1671. # parenthesis it is simply not a parameter group.
  1672. } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
  1673. # cpp #elif statement condition may start with a (
  1674. } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
  1675. # If this whole things ends with a type its most
  1676. # likely a typedef for a function.
  1677. } elsif ($ctx =~ /$Type$/) {
  1678. } else {
  1679. WARN("space prohibited between function name and open parenthesis '('\n" . $herecurr);
  1680. }
  1681. }
  1682. # Check operator spacing.
  1683. if (!($line=~/\#\s*include/)) {
  1684. my $ops = qr{
  1685. <<=|>>=|<=|>=|==|!=|
  1686. \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
  1687. =>|->|<<|>>|<|>|=|!|~|
  1688. &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
  1689. \?|:
  1690. }x;
  1691. my @elements = split(/($ops|;)/, $opline);
  1692. my $off = 0;
  1693. my $blank = copy_spacing($opline);
  1694. for (my $n = 0; $n < $#elements; $n += 2) {
  1695. $off += length($elements[$n]);
  1696. # Pick up the preceeding and succeeding characters.
  1697. my $ca = substr($opline, 0, $off);
  1698. my $cc = '';
  1699. if (length($opline) >= ($off + length($elements[$n + 1]))) {
  1700. $cc = substr($opline, $off + length($elements[$n + 1]));
  1701. }
  1702. my $cb = "$ca$;$cc";
  1703. my $a = '';
  1704. $a = 'V' if ($elements[$n] ne '');
  1705. $a = 'W' if ($elements[$n] =~ /\s$/);
  1706. $a = 'C' if ($elements[$n] =~ /$;$/);
  1707. $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
  1708. $a = 'O' if ($elements[$n] eq '');
  1709. $a = 'E' if ($ca =~ /^\s*$/);
  1710. my $op = $elements[$n + 1];
  1711. my $c = '';
  1712. if (defined $elements[$n + 2]) {
  1713. $c = 'V' if ($elements[$n + 2] ne '');
  1714. $c = 'W' if ($elements[$n + 2] =~ /^\s/);
  1715. $c = 'C' if ($elements[$n + 2] =~ /^$;/);
  1716. $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
  1717. $c = 'O' if ($elements[$n + 2] eq '');
  1718. $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
  1719. } else {
  1720. $c = 'E';
  1721. }
  1722. my $ctx = "${a}x${c}";
  1723. my $at = "(ctx:$ctx)";
  1724. my $ptr = substr($blank, 0, $off) . "^";
  1725. my $hereptr = "$hereline$ptr\n";
  1726. # Pull out the value of this operator.
  1727. my $op_type = substr($curr_values, $off + 1, 1);
  1728. # Get the full operator variant.
  1729. my $opv = $op . substr($curr_vars, $off, 1);
  1730. # Ignore operators passed as parameters.
  1731. if ($op_type ne 'V' &&
  1732. $ca =~ /\s$/ && $cc =~ /^\s*,/) {
  1733. # # Ignore comments
  1734. # } elsif ($op =~ /^$;+$/) {
  1735. # ; should have either the end of line or a space or \ after it
  1736. } elsif ($op eq ';') {
  1737. if ($ctx !~ /.x[WEBC]/ &&
  1738. $cc !~ /^\\/ && $cc !~ /^;/) {
  1739. ERROR("space required after that '$op' $at\n" . $hereptr);
  1740. }
  1741. # // is a comment
  1742. } elsif ($op eq '//') {
  1743. # No spaces for:
  1744. # ->
  1745. # : when part of a bitfield
  1746. } elsif ($op eq '->' || $opv eq ':B') {
  1747. if ($ctx =~ /Wx.|.xW/) {
  1748. ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
  1749. }
  1750. # , must have a space on the right.
  1751. # not required when having a single },{ on one line
  1752. } elsif ($op eq ',') {
  1753. if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
  1754. ($elements[$n] . $elements[$n + 2]) !~ " *}{") {
  1755. ERROR("space required after that '$op' $at\n" . $hereptr);
  1756. }
  1757. # '*' as part of a type definition -- reported already.
  1758. } elsif ($opv eq '*_') {
  1759. #warn "'*' is part of type\n";
  1760. # unary operators should have a space before and
  1761. # none after. May be left adjacent to another
  1762. # unary operator, or a cast
  1763. } elsif ($op eq '!' || $op eq '~' ||
  1764. $opv eq '*U' || $opv eq '-U' ||
  1765. $opv eq '&U' || $opv eq '&&U') {
  1766. if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
  1767. ERROR("space required before that '$op' $at\n" . $hereptr);
  1768. }
  1769. if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
  1770. # A unary '*' may be const
  1771. } elsif ($ctx =~ /.xW/) {
  1772. ERROR("space prohibited after that '$op' $at\n" . $hereptr);
  1773. }
  1774. # unary ++ and unary -- are allowed no space on one side.
  1775. } elsif ($op eq '++' or $op eq '--') {
  1776. if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
  1777. ERROR("space required one side of that '$op' $at\n" . $hereptr);
  1778. }
  1779. if ($ctx =~ /Wx[BE]/ ||
  1780. ($ctx =~ /Wx./ && $cc =~ /^;/)) {
  1781. ERROR("space prohibited before that '$op' $at\n" . $hereptr);
  1782. }
  1783. if ($ctx =~ /ExW/) {
  1784. ERROR("space prohibited after that '$op' $at\n" . $hereptr);
  1785. }
  1786. # << and >> may either have or not have spaces both sides
  1787. } elsif ($op eq '<<' or $op eq '>>' or
  1788. $op eq '&' or $op eq '^' or $op eq '|' or
  1789. $op eq '+' or $op eq '-' or
  1790. $op eq '*' or $op eq '/' or
  1791. $op eq '%')
  1792. {
  1793. if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
  1794. ERROR("need consistent spacing around '$op' $at\n" .
  1795. $hereptr);
  1796. }
  1797. # A colon needs no spaces before when it is
  1798. # terminating a case value or a label.
  1799. } elsif ($opv eq ':C' || $opv eq ':L') {
  1800. if ($ctx =~ /Wx./) {
  1801. ERROR("space prohibited before that '$op' $at\n" . $hereptr);
  1802. }
  1803. # All the others need spaces both sides.
  1804. } elsif ($ctx !~ /[EWC]x[CWE]/) {
  1805. my $ok = 0;
  1806. # Ignore email addresses <foo@bar>
  1807. if (($op eq '<' &&
  1808. $cc =~ /^\S+\@\S+>/) ||
  1809. ($op eq '>' &&
  1810. $ca =~ /<\S+\@\S+$/))
  1811. {
  1812. $ok = 1;
  1813. }
  1814. # Ignore ?:
  1815. if (($opv eq ':O' && $ca =~ /\?$/) ||
  1816. ($op eq '?' && $cc =~ /^:/)) {
  1817. $ok = 1;
  1818. }
  1819. if ($ok == 0) {
  1820. ERROR("spaces required around that '$op' $at\n" . $hereptr);
  1821. }
  1822. }
  1823. $off += length($elements[$n + 1]);
  1824. }
  1825. }
  1826. # check for multiple assignments
  1827. if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
  1828. CHK("multiple assignments should be avoided\n" . $herecurr);
  1829. }
  1830. ## # check for multiple declarations, allowing for a function declaration
  1831. ## # continuation.
  1832. ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
  1833. ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
  1834. ##
  1835. ## # Remove any bracketed sections to ensure we do not
  1836. ## # falsly report the parameters of functions.
  1837. ## my $ln = $line;
  1838. ## while ($ln =~ s/\([^\(\)]*\)//g) {
  1839. ## }
  1840. ## if ($ln =~ /,/) {
  1841. ## WARN("declaring multiple variables together should be avoided\n" . $herecurr);
  1842. ## }
  1843. ## }
  1844. #need space before brace following if, while, etc
  1845. if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
  1846. $line =~ /do{/) {
  1847. ERROR("space required before the open brace '{'\n" . $herecurr);
  1848. }
  1849. # closing brace should have a space following it when it has anything
  1850. # on the line
  1851. if ($line =~ /}(?!(?:,|;|\)))\S/) {
  1852. ERROR("space required after that close brace '}'\n" . $herecurr);
  1853. }
  1854. # check spacing on square brackets
  1855. if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
  1856. ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
  1857. }
  1858. if ($line =~ /\s\]/) {
  1859. ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
  1860. }
  1861. # check spacing on parentheses
  1862. if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
  1863. $line !~ /for\s*\(\s+;/) {
  1864. ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
  1865. }
  1866. if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
  1867. $line !~ /for\s*\(.*;\s+\)/ &&
  1868. $line !~ /:\s+\)/) {
  1869. ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
  1870. }
  1871. # Return is not a function.
  1872. if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
  1873. my $spacing = $1;
  1874. my $value = $2;
  1875. # Flatten any parentheses
  1876. $value =~ s/\(/ \(/g;
  1877. $value =~ s/\)/\) /g;
  1878. while ($value =~ s/\[[^\{\}]*\]/1/ ||
  1879. $value !~ /(?:$Ident|-?$Constant)\s*
  1880. $Compare\s*
  1881. (?:$Ident|-?$Constant)/x &&
  1882. $value =~ s/\([^\(\)]*\)/1/) {
  1883. }
  1884. #print "value<$value>\n";
  1885. if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
  1886. ERROR("return is not a function, parentheses are not required\n" . $herecurr);
  1887. } elsif ($spacing !~ /\s+/) {
  1888. ERROR("space required before the open parenthesis '('\n" . $herecurr);
  1889. }
  1890. }
  1891. # Return of what appears to be an errno should normally be -'ve
  1892. if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
  1893. my $name = $1;
  1894. if ($name ne 'EOF' && $name ne 'ERROR') {
  1895. CHK("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
  1896. }
  1897. }
  1898. # Need a space before open parenthesis after if, while etc
  1899. if ($line=~/\b(if|while|for|switch)\(/) {
  1900. ERROR("space required before the open parenthesis '('\n" . $herecurr);
  1901. }
  1902. # Check for illegal assignment in if conditional -- and check for trailing
  1903. # statements after the conditional.
  1904. if ($line =~ /do\s*(?!{)/) {
  1905. my ($stat_next) = ctx_statement_block($line_nr_next,
  1906. $remain_next, $off_next);
  1907. $stat_next =~ s/\n./\n /g;
  1908. ##print "stat<$stat> stat_next<$stat_next>\n";
  1909. if ($stat_next =~ /^\s*while\b/) {
  1910. # If the statement carries leading newlines,
  1911. # then count those as offsets.
  1912. my ($whitespace) =
  1913. ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
  1914. my $offset =
  1915. statement_rawlines($whitespace) - 1;
  1916. $suppress_whiletrailers{$line_nr_next +
  1917. $offset} = 1;
  1918. }
  1919. }
  1920. if (!defined $suppress_whiletrailers{$linenr} &&
  1921. $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
  1922. my ($s, $c) = ($stat, $cond);
  1923. if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
  1924. ERROR("do not use assignment in if condition\n" . $herecurr);
  1925. }
  1926. # Find out what is on the end of the line after the
  1927. # conditional.
  1928. substr($s, 0, length($c), '');
  1929. $s =~ s/\n.*//g;
  1930. $s =~ s/$;//g; # Remove any comments
  1931. if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
  1932. $c !~ /}\s*while\s*/)
  1933. {
  1934. # Find out how long the conditional actually is.
  1935. my @newlines = ($c =~ /\n/gs);
  1936. my $cond_lines = 1 + $#newlines;
  1937. my $stat_real = '';
  1938. $stat_real = raw_line($linenr, $cond_lines)
  1939. . "\n" if ($cond_lines);
  1940. if (defined($stat_real) && $cond_lines > 1) {
  1941. $stat_real = "[...]\n$stat_real";
  1942. }
  1943. ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
  1944. }
  1945. }
  1946. # Check for bitwise tests written as boolean
  1947. if ($line =~ /
  1948. (?:
  1949. (?:\[|\(|\&\&|\|\|)
  1950. \s*0[xX][0-9]+\s*
  1951. (?:\&\&|\|\|)
  1952. |
  1953. (?:\&\&|\|\|)
  1954. \s*0[xX][0-9]+\s*
  1955. (?:\&\&|\|\||\)|\])
  1956. )/x)
  1957. {
  1958. WARN("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
  1959. }
  1960. # if and else should not have general statements after it
  1961. if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
  1962. my $s = $1;
  1963. $s =~ s/$;//g; # Remove any comments
  1964. if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
  1965. ERROR("trailing statements should be on next line\n" . $herecurr);
  1966. }
  1967. }
  1968. # if should not continue a brace
  1969. if ($line =~ /}\s*if\b/) {
  1970. ERROR("trailing statements should be on next line\n" .
  1971. $herecurr);
  1972. }
  1973. # case and default should not have general statements after them
  1974. if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
  1975. $line !~ /\G(?:
  1976. (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
  1977. \s*return\s+
  1978. )/xg)
  1979. {
  1980. ERROR("trailing statements should be on next line\n" . $herecurr);
  1981. }
  1982. # Check for }<nl>else {, these must be at the same
  1983. # indent level to be relevant to each other.
  1984. if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
  1985. $previndent == $indent) {
  1986. ERROR("else should follow close brace '}'\n" . $hereprev);
  1987. }
  1988. if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
  1989. $previndent == $indent) {
  1990. my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
  1991. # Find out what is on the end of the line after the
  1992. # conditional.
  1993. substr($s, 0, length($c), '');
  1994. $s =~ s/\n.*//g;
  1995. if ($s =~ /^\s*;/) {
  1996. ERROR("while should follow close brace '}'\n" . $hereprev);
  1997. }
  1998. }
  1999. #studly caps, commented out until figure out how to distinguish between use of existing and adding new
  2000. # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
  2001. # print "No studly caps, use _\n";
  2002. # print "$herecurr";
  2003. # $clean = 0;
  2004. # }
  2005. #no spaces allowed after \ in define
  2006. if ($line=~/\#\s*define.*\\\s$/) {
  2007. WARN("Whitepspace after \\ makes next lines useless\n" . $herecurr);
  2008. }
  2009. #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
  2010. if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
  2011. my $file = "$1.h";
  2012. my $checkfile = "include/linux/$file";
  2013. if (-f "$root/$checkfile" &&
  2014. $realfile ne $checkfile &&
  2015. $1 !~ /$allowed_asm_includes/)
  2016. {
  2017. if ($realfile =~ m{^arch/}) {
  2018. CHK("Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
  2019. } else {
  2020. WARN("Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
  2021. }
  2022. }
  2023. }
  2024. # multi-statement macros should be enclosed in a do while loop, grab the
  2025. # first statement and ensure its the whole macro if its not enclosed
  2026. # in a known good container
  2027. if ($realfile !~ m@/vmlinux.lds.h$@ &&
  2028. $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
  2029. my $ln = $linenr;
  2030. my $cnt = $realcnt;
  2031. my ($off, $dstat, $dcond, $rest);
  2032. my $ctx = '';
  2033. my $args = defined($1);
  2034. # Find the end of the macro and limit our statement
  2035. # search to that.
  2036. while ($cnt > 0 && defined $lines[$ln - 1] &&
  2037. $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
  2038. {
  2039. $ctx .= $rawlines[$ln - 1] . "\n";
  2040. $cnt-- if ($lines[$ln - 1] !~ /^-/);
  2041. $ln++;
  2042. }
  2043. $ctx .= $rawlines[$ln - 1];
  2044. ($dstat, $dcond, $ln, $cnt, $off) =
  2045. ctx_statement_block($linenr, $ln - $linenr + 1, 0);
  2046. #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
  2047. #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
  2048. # Extract the remainder of the define (if any) and
  2049. # rip off surrounding spaces, and trailing \'s.
  2050. $rest = '';
  2051. while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
  2052. #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
  2053. if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
  2054. $rest .= substr($lines[$ln - 1], $off) . "\n";
  2055. $cnt--;
  2056. }
  2057. $ln++;
  2058. $off = 0;
  2059. }
  2060. $rest =~ s/\\\n.//g;
  2061. $rest =~ s/^\s*//s;
  2062. $rest =~ s/\s*$//s;
  2063. # Clean up the original statement.
  2064. if ($args) {
  2065. substr($dstat, 0, length($dcond), '');
  2066. } else {
  2067. $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
  2068. }
  2069. $dstat =~ s/$;//g;
  2070. $dstat =~ s/\\\n.//g;
  2071. $dstat =~ s/^\s*//s;
  2072. $dstat =~ s/\s*$//s;
  2073. # Flatten any parentheses and braces
  2074. while ($dstat =~ s/\([^\(\)]*\)/1/ ||
  2075. $dstat =~ s/\{[^\{\}]*\}/1/ ||
  2076. $dstat =~ s/\[[^\{\}]*\]/1/)
  2077. {
  2078. }
  2079. my $exceptions = qr{
  2080. $Declare|
  2081. module_param_named|
  2082. MODULE_PARAM_DESC|
  2083. DECLARE_PER_CPU|
  2084. DEFINE_PER_CPU|
  2085. __typeof__\(|
  2086. union|
  2087. struct|
  2088. \.$Ident\s*=\s*|
  2089. ^\"|\"$
  2090. }x;
  2091. #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
  2092. if ($rest ne '' && $rest ne ',') {
  2093. if ($rest !~ /while\s*\(/ &&
  2094. $dstat !~ /$exceptions/)
  2095. {
  2096. ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
  2097. }
  2098. } elsif ($ctx !~ /;/) {
  2099. if ($dstat ne '' &&
  2100. $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
  2101. $dstat !~ /$exceptions/ &&
  2102. $dstat !~ /^\.$Ident\s*=/ &&
  2103. $dstat =~ /$Operators/)
  2104. {
  2105. ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
  2106. }
  2107. }
  2108. }
  2109. # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
  2110. # all assignments may have only one of the following with an assignment:
  2111. # .
  2112. # ALIGN(...)
  2113. # VMLINUX_SYMBOL(...)
  2114. if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
  2115. WARN("vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
  2116. }
  2117. # check for missing bracing round if etc
  2118. if ($line =~ /(^.*)\bif\b/ && $line !~ /\#\s*if/) {
  2119. my ($level, $endln, @chunks) =
  2120. ctx_statement_full($linenr, $realcnt, 1);
  2121. #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
  2122. #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
  2123. if ($#chunks >= 0 && $level == 0) {
  2124. my $allowed = 0;
  2125. my $seen = 0;
  2126. my $herectx = $here . "\n";
  2127. my $ln = $linenr - 1;
  2128. for my $chunk (@chunks) {
  2129. my ($cond, $block) = @{$chunk};
  2130. # If the condition carries leading newlines, then count those as offsets.
  2131. my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
  2132. my $offset = statement_rawlines($whitespace) - 1;
  2133. #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
  2134. # We have looked at and allowed this specific line.
  2135. $suppress_ifbraces{$ln + $offset} = 1;
  2136. $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
  2137. $ln += statement_rawlines($block) - 1;
  2138. substr($block, 0, length($cond), '');
  2139. $seen++ if ($block =~ /^\s*{/);
  2140. #print "cond<$cond> block<$block> allowed<$allowed>\n";
  2141. if (statement_lines($cond) > 1) {
  2142. #print "APW: ALLOWED: cond<$cond>\n";
  2143. $allowed = 1;
  2144. }
  2145. if ($block =~/\b(?:if|for|while)\b/) {
  2146. #print "APW: ALLOWED: block<$block>\n";
  2147. $allowed = 1;
  2148. }
  2149. if (statement_block_size($block) > 1) {
  2150. #print "APW: ALLOWED: lines block<$block>\n";
  2151. $allowed = 1;
  2152. }
  2153. }
  2154. if ($seen != ($#chunks + 1)) {
  2155. WARN("braces {} are necessary for all arms of this statement\n" . $herectx);
  2156. }
  2157. }
  2158. }
  2159. if (!defined $suppress_ifbraces{$linenr - 1} &&
  2160. $line =~ /\b(if|while|for|else)\b/ &&
  2161. $line !~ /\#\s*if/ &&
  2162. $line !~ /\#\s*else/) {
  2163. my $allowed = 0;
  2164. # Check the pre-context.
  2165. if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
  2166. #print "APW: ALLOWED: pre<$1>\n";
  2167. $allowed = 1;
  2168. }
  2169. my ($level, $endln, @chunks) =
  2170. ctx_statement_full($linenr, $realcnt, $-[0]);
  2171. # Check the condition.
  2172. my ($cond, $block) = @{$chunks[0]};
  2173. #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
  2174. if (defined $cond) {
  2175. substr($block, 0, length($cond), '');
  2176. }
  2177. if (statement_lines($cond) > 1) {
  2178. #print "APW: ALLOWED: cond<$cond>\n";
  2179. $allowed = 1;
  2180. }
  2181. if ($block =~/\b(?:if|for|while)\b/) {
  2182. #print "APW: ALLOWED: block<$block>\n";
  2183. $allowed = 1;
  2184. }
  2185. if (statement_block_size($block) > 1) {
  2186. #print "APW: ALLOWED: lines block<$block>\n";
  2187. $allowed = 1;
  2188. }
  2189. # Check the post-context.
  2190. if (defined $chunks[1]) {
  2191. my ($cond, $block) = @{$chunks[1]};
  2192. if (defined $cond) {
  2193. substr($block, 0, length($cond), '');
  2194. }
  2195. if ($block =~ /^\s*\{/) {
  2196. #print "APW: ALLOWED: chunk-1 block<$block>\n";
  2197. $allowed = 1;
  2198. }
  2199. }
  2200. if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
  2201. my $herectx = $here . "\n";;
  2202. my $cnt = statement_rawlines($block);
  2203. for (my $n = 0; $n < $cnt; $n++) {
  2204. $herectx .= raw_line($linenr, $n) . "\n";;
  2205. }
  2206. WARN("braces {} are necessary even for single statement blocks\n" . $herectx);
  2207. }
  2208. }
  2209. # don't include deprecated include files (uses RAW line)
  2210. for my $inc (@dep_includes) {
  2211. if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
  2212. ERROR("Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
  2213. }
  2214. }
  2215. # don't use deprecated functions
  2216. for my $func (@dep_functions) {
  2217. if ($line =~ /\b$func\b/) {
  2218. ERROR("Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
  2219. }
  2220. }
  2221. # no volatiles please
  2222. my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
  2223. if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
  2224. WARN("Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
  2225. }
  2226. # SPIN_LOCK_UNLOCKED & RW_LOCK_UNLOCKED are deprecated
  2227. if ($line =~ /\b(SPIN_LOCK_UNLOCKED|RW_LOCK_UNLOCKED)/) {
  2228. ERROR("Use of $1 is deprecated: see Documentation/spinlocks.txt\n" . $herecurr);
  2229. }
  2230. # warn about #if 0
  2231. if ($line =~ /^.\s*\#\s*if\s+0\b/) {
  2232. CHK("if this code is redundant consider removing it\n" .
  2233. $herecurr);
  2234. }
  2235. # check for needless kfree() checks
  2236. if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
  2237. my $expr = $1;
  2238. if ($line =~ /\bkfree\(\Q$expr\E\);/) {
  2239. WARN("kfree(NULL) is safe this check is probably not required\n" . $hereprev);
  2240. }
  2241. }
  2242. # check for needless usb_free_urb() checks
  2243. if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
  2244. my $expr = $1;
  2245. if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
  2246. WARN("usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
  2247. }
  2248. }
  2249. # prefer usleep_range over udelay
  2250. if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
  2251. # ignore udelay's < 10, however
  2252. if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
  2253. CHK("usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
  2254. }
  2255. }
  2256. # warn about unexpectedly long msleep's
  2257. if ($line =~ /\bmsleep\s*\((\d+)\);/) {
  2258. if ($1 < 20) {
  2259. WARN("msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
  2260. }
  2261. }
  2262. # warn about #ifdefs in C files
  2263. # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
  2264. # print "#ifdef in C files should be avoided\n";
  2265. # print "$herecurr";
  2266. # $clean = 0;
  2267. # }
  2268. # warn about spacing in #ifdefs
  2269. if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
  2270. ERROR("exactly one space required after that #$1\n" . $herecurr);
  2271. }
  2272. # check for spinlock_t definitions without a comment.
  2273. if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
  2274. $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
  2275. my $which = $1;
  2276. if (!ctx_has_comment($first_line, $linenr)) {
  2277. CHK("$1 definition without comment\n" . $herecurr);
  2278. }
  2279. }
  2280. # check for memory barriers without a comment.
  2281. if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
  2282. if (!ctx_has_comment($first_line, $linenr)) {
  2283. CHK("memory barrier without comment\n" . $herecurr);
  2284. }
  2285. }
  2286. # check of hardware specific defines
  2287. if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
  2288. CHK("architecture specific defines should be avoided\n" . $herecurr);
  2289. }
  2290. # Check that the storage class is at the beginning of a declaration
  2291. if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
  2292. WARN("storage class should be at the beginning of the declaration\n" . $herecurr)
  2293. }
  2294. # check the location of the inline attribute, that it is between
  2295. # storage class and type.
  2296. if ($line =~ /\b$Type\s+$Inline\b/ ||
  2297. $line =~ /\b$Inline\s+$Storage\b/) {
  2298. ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
  2299. }
  2300. # Check for __inline__ and __inline, prefer inline
  2301. if ($line =~ /\b(__inline__|__inline)\b/) {
  2302. WARN("plain inline is preferred over $1\n" . $herecurr);
  2303. }
  2304. # check for sizeof(&)
  2305. if ($line =~ /\bsizeof\s*\(\s*\&/) {
  2306. WARN("sizeof(& should be avoided\n" . $herecurr);
  2307. }
  2308. # check for new externs in .c files.
  2309. if ($realfile =~ /\.c$/ && defined $stat &&
  2310. $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
  2311. {
  2312. my $function_name = $1;
  2313. my $paren_space = $2;
  2314. my $s = $stat;
  2315. if (defined $cond) {
  2316. substr($s, 0, length($cond), '');
  2317. }
  2318. if ($s =~ /^\s*;/ &&
  2319. $function_name ne 'uninitialized_var')
  2320. {
  2321. WARN("externs should be avoided in .c files\n" . $herecurr);
  2322. }
  2323. if ($paren_space =~ /\n/) {
  2324. WARN("arguments for function declarations should follow identifier\n" . $herecurr);
  2325. }
  2326. } elsif ($realfile =~ /\.c$/ && defined $stat &&
  2327. $stat =~ /^.\s*extern\s+/)
  2328. {
  2329. WARN("externs should be avoided in .c files\n" . $herecurr);
  2330. }
  2331. # checks for new __setup's
  2332. if ($rawline =~ /\b__setup\("([^"]*)"/) {
  2333. my $name = $1;
  2334. if (!grep(/$name/, @setup_docs)) {
  2335. CHK("__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
  2336. }
  2337. }
  2338. # check for pointless casting of kmalloc return
  2339. if ($line =~ /\*\s*\)\s*k[czm]alloc\b/) {
  2340. WARN("unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
  2341. }
  2342. # check for gcc specific __FUNCTION__
  2343. if ($line =~ /__FUNCTION__/) {
  2344. WARN("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
  2345. }
  2346. # check for semaphores used as mutexes
  2347. if ($line =~ /^.\s*(DECLARE_MUTEX|init_MUTEX)\s*\(/) {
  2348. WARN("mutexes are preferred for single holder semaphores\n" . $herecurr);
  2349. }
  2350. # check for semaphores used as mutexes
  2351. if ($line =~ /^.\s*init_MUTEX_LOCKED\s*\(/) {
  2352. WARN("consider using a completion\n" . $herecurr);
  2353. }
  2354. # recommend strict_strto* over simple_strto*
  2355. if ($line =~ /\bsimple_(strto.*?)\s*\(/) {
  2356. WARN("consider using strict_$1 in preference to simple_$1\n" . $herecurr);
  2357. }
  2358. # check for __initcall(), use device_initcall() explicitly please
  2359. if ($line =~ /^.\s*__initcall\s*\(/) {
  2360. WARN("please use device_initcall() instead of __initcall()\n" . $herecurr);
  2361. }
  2362. # check for various ops structs, ensure they are const.
  2363. my $struct_ops = qr{acpi_dock_ops|
  2364. address_space_operations|
  2365. backlight_ops|
  2366. block_device_operations|
  2367. dentry_operations|
  2368. dev_pm_ops|
  2369. dma_map_ops|
  2370. extent_io_ops|
  2371. file_lock_operations|
  2372. file_operations|
  2373. hv_ops|
  2374. ide_dma_ops|
  2375. intel_dvo_dev_ops|
  2376. item_operations|
  2377. iwl_ops|
  2378. kgdb_arch|
  2379. kgdb_io|
  2380. kset_uevent_ops|
  2381. lock_manager_operations|
  2382. microcode_ops|
  2383. mtrr_ops|
  2384. neigh_ops|
  2385. nlmsvc_binding|
  2386. pci_raw_ops|
  2387. pipe_buf_operations|
  2388. platform_hibernation_ops|
  2389. platform_suspend_ops|
  2390. proto_ops|
  2391. rpc_pipe_ops|
  2392. seq_operations|
  2393. snd_ac97_build_ops|
  2394. soc_pcmcia_socket_ops|
  2395. stacktrace_ops|
  2396. sysfs_ops|
  2397. tty_operations|
  2398. usb_mon_operations|
  2399. wd_ops}x;
  2400. if ($line !~ /\bconst\b/ &&
  2401. $line =~ /\bstruct\s+($struct_ops)\b/) {
  2402. WARN("struct $1 should normally be const\n" .
  2403. $herecurr);
  2404. }
  2405. # use of NR_CPUS is usually wrong
  2406. # ignore definitions of NR_CPUS and usage to define arrays as likely right
  2407. if ($line =~ /\bNR_CPUS\b/ &&
  2408. $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
  2409. $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
  2410. $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
  2411. $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
  2412. $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
  2413. {
  2414. WARN("usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
  2415. }
  2416. # check for %L{u,d,i} in strings
  2417. my $string;
  2418. while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
  2419. $string = substr($rawline, $-[1], $+[1] - $-[1]);
  2420. $string =~ s/%%/__/g;
  2421. if ($string =~ /(?<!%)%L[udi]/) {
  2422. WARN("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
  2423. last;
  2424. }
  2425. }
  2426. # whine mightly about in_atomic
  2427. if ($line =~ /\bin_atomic\s*\(/) {
  2428. if ($realfile =~ m@^drivers/@) {
  2429. ERROR("do not use in_atomic in drivers\n" . $herecurr);
  2430. } elsif ($realfile !~ m@^kernel/@) {
  2431. WARN("use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
  2432. }
  2433. }
  2434. # check for lockdep_set_novalidate_class
  2435. if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
  2436. $line =~ /__lockdep_no_validate__\s*\)/ ) {
  2437. if ($realfile !~ m@^kernel/lockdep@ &&
  2438. $realfile !~ m@^include/linux/lockdep@ &&
  2439. $realfile !~ m@^drivers/base/core@) {
  2440. ERROR("lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
  2441. }
  2442. }
  2443. }
  2444. # If we have no input at all, then there is nothing to report on
  2445. # so just keep quiet.
  2446. if ($#rawlines == -1) {
  2447. exit(0);
  2448. }
  2449. # In mailback mode only produce a report in the negative, for
  2450. # things that appear to be patches.
  2451. if ($mailback && ($clean == 1 || !$is_patch)) {
  2452. exit(0);
  2453. }
  2454. # This is not a patch, and we are are in 'no-patch' mode so
  2455. # just keep quiet.
  2456. if (!$chk_patch && !$is_patch) {
  2457. exit(0);
  2458. }
  2459. if (!$is_patch) {
  2460. ERROR("Does not appear to be a unified-diff format patch\n");
  2461. }
  2462. if ($is_patch && $chk_signoff && $signoff == 0) {
  2463. ERROR("Missing Signed-off-by: line(s)\n");
  2464. }
  2465. print report_dump();
  2466. if ($summary && !($clean == 1 && $quiet == 1)) {
  2467. print "$filename " if ($summary_file);
  2468. print "total: $cnt_error errors, $cnt_warn warnings, " .
  2469. (($check)? "$cnt_chk checks, " : "") .
  2470. "$cnt_lines lines checked\n";
  2471. print "\n" if ($quiet == 0);
  2472. }
  2473. if ($quiet == 0) {
  2474. # If there were whitespace errors which cleanpatch can fix
  2475. # then suggest that.
  2476. # if ($rpt_cleaners) {
  2477. # print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
  2478. # print " scripts/cleanfile\n\n";
  2479. # }
  2480. }
  2481. if ($clean == 1 && $quiet == 0) {
  2482. print "$vname has no obvious style problems and is ready for submission.\n"
  2483. }
  2484. if ($clean == 0 && $quiet == 0) {
  2485. print "$vname has style problems, please review. If any of these errors\n";
  2486. print "are false positives report them to the maintainer, see\n";
  2487. print "CHECKPATCH in MAINTAINERS.\n";
  2488. }
  2489. return $clean;
  2490. }