checkpatch.pl 69 KB

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