checkpatch.pl 66 KB

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