Loading...
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3
4use warnings;
5use strict;
6
7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
9## Copyright (C) 2001 Simon Huggins ##
10## Copyright (C) 2005-2012 Randy Dunlap ##
11## Copyright (C) 2012 Dan Luedtke ##
12## ##
13## #define enhancements by Armin Kuster <akuster@mvista.com> ##
14## Copyright (c) 2000 MontaVista Software, Inc. ##
15#
16# Copyright (C) 2022 Tomasz Warniełło (POD)
17
18use Pod::Usage qw/pod2usage/;
19
20=head1 NAME
21
22kernel-doc - Print formatted kernel documentation to stdout
23
24=head1 SYNOPSIS
25
26 kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections]
27 [ -man |
28 -rst [-sphinx-version VERSION] [-enable-lineno] |
29 -none
30 ]
31 [
32 -export |
33 -internal |
34 [-function NAME] ... |
35 [-nosymbol NAME] ...
36 ]
37 [-no-doc-sections]
38 [-export-file FILE] ...
39 FILE ...
40
41Run `kernel-doc -h` for details.
42
43=head1 DESCRIPTION
44
45Read C language source or header FILEs, extract embedded documentation comments,
46and print formatted documentation to standard output.
47
48The documentation comments are identified by the "/**" opening comment mark.
49
50See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
51
52=cut
53
54# more perldoc at the end of the file
55
56## init lots of data
57
58my $errors = 0;
59my $warnings = 0;
60my $anon_struct_union = 0;
61
62# match expressions used to find embedded type information
63my $type_constant = '\b``([^\`]+)``\b';
64my $type_constant2 = '\%([-_\w]+)';
65my $type_func = '(\w+)\(\)';
66my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
67my $type_param_ref = '([\!~]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
68my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
69my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
70my $type_env = '(\$\w+)';
71my $type_enum = '\&(enum\s*([_\w]+))';
72my $type_struct = '\&(struct\s*([_\w]+))';
73my $type_typedef = '\&(typedef\s*([_\w]+))';
74my $type_union = '\&(union\s*([_\w]+))';
75my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
76my $type_fallback = '\&([_\w]+)';
77my $type_member_func = $type_member . '\(\)';
78
79# Output conversion substitutions.
80# One for each output format
81
82# these are pretty rough
83my @highlights_man = (
84 [$type_constant, "\$1"],
85 [$type_constant2, "\$1"],
86 [$type_func, "\\\\fB\$1\\\\fP"],
87 [$type_enum, "\\\\fI\$1\\\\fP"],
88 [$type_struct, "\\\\fI\$1\\\\fP"],
89 [$type_typedef, "\\\\fI\$1\\\\fP"],
90 [$type_union, "\\\\fI\$1\\\\fP"],
91 [$type_param, "\\\\fI\$1\\\\fP"],
92 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
93 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
94 [$type_fallback, "\\\\fI\$1\\\\fP"]
95 );
96my $blankline_man = "";
97
98# rst-mode
99my @highlights_rst = (
100 [$type_constant, "``\$1``"],
101 [$type_constant2, "``\$1``"],
102 # Note: need to escape () to avoid func matching later
103 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
104 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
105 [$type_fp_param, "**\$1\\\\(\\\\)**"],
106 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
107 [$type_func, "\$1()"],
108 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
109 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
110 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
111 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
112 # in rst this can refer to any type
113 [$type_fallback, "\\:c\\:type\\:`\$1`"],
114 [$type_param_ref, "**\$1\$2**"]
115 );
116my $blankline_rst = "\n";
117
118# read arguments
119if ($#ARGV == -1) {
120 pod2usage(
121 -message => "No arguments!\n",
122 -exitval => 1,
123 -verbose => 99,
124 -sections => 'SYNOPSIS',
125 -output => \*STDERR,
126 );
127}
128
129my $kernelversion;
130my ($sphinx_major, $sphinx_minor, $sphinx_patch);
131
132my $dohighlight = "";
133
134my $verbose = 0;
135my $Werror = 0;
136my $Wreturn = 0;
137my $Wshort_desc = 0;
138my $Wcontents_before_sections = 0;
139my $output_mode = "rst";
140my $output_preformatted = 0;
141my $no_doc_sections = 0;
142my $enable_lineno = 0;
143my @highlights = @highlights_rst;
144my $blankline = $blankline_rst;
145my $modulename = "Kernel API";
146
147use constant {
148 OUTPUT_ALL => 0, # output all symbols and doc sections
149 OUTPUT_INCLUDE => 1, # output only specified symbols
150 OUTPUT_EXPORTED => 2, # output exported symbols
151 OUTPUT_INTERNAL => 3, # output non-exported symbols
152};
153my $output_selection = OUTPUT_ALL;
154my $show_not_found = 0; # No longer used
155
156my @export_file_list;
157
158my @build_time;
159if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
160 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
161 @build_time = gmtime($seconds);
162} else {
163 @build_time = localtime;
164}
165
166my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
167 'July', 'August', 'September', 'October',
168 'November', 'December')[$build_time[4]] .
169 " " . ($build_time[5]+1900);
170
171# Essentially these are globals.
172# They probably want to be tidied up, made more localised or something.
173# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
174# could cause "use of undefined value" or other bugs.
175my ($function, %function_table, %parametertypes, $declaration_purpose);
176my %nosymbol_table = ();
177my $declaration_start_line;
178my ($type, $declaration_name, $return_type);
179my ($newsection, $newcontents, $prototype, $brcount, %source_map);
180
181if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') {
182 $verbose = 1;
183}
184
185if (defined($ENV{'KCFLAGS'})) {
186 my $kcflags = "$ENV{'KCFLAGS'}";
187
188 if ($kcflags =~ /(\s|^)-Werror(\s|$)/) {
189 $Werror = 1;
190 }
191}
192
193# reading this variable is for backwards compat just in case
194# someone was calling it with the variable from outside the
195# kernel's build system
196if (defined($ENV{'KDOC_WERROR'})) {
197 $Werror = "$ENV{'KDOC_WERROR'}";
198}
199# other environment variables are converted to command-line
200# arguments in cmd_checkdoc in the build system
201
202# Generated docbook code is inserted in a template at a point where
203# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
204# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
205# We keep track of number of generated entries and generate a dummy
206# if needs be to ensure the expanded template can be postprocessed
207# into html.
208my $section_counter = 0;
209
210my $lineprefix="";
211
212# Parser states
213use constant {
214 STATE_NORMAL => 0, # normal code
215 STATE_NAME => 1, # looking for function name
216 STATE_BODY_MAYBE => 2, # body - or maybe more description
217 STATE_BODY => 3, # the body of the comment
218 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
219 STATE_PROTO => 5, # scanning prototype
220 STATE_DOCBLOCK => 6, # documentation block
221 STATE_INLINE => 7, # gathering doc outside main block
222};
223my $state;
224my $in_doc_sect;
225my $leading_space;
226
227# Inline documentation state
228use constant {
229 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
230 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
231 STATE_INLINE_TEXT => 2, # looking for member documentation
232 STATE_INLINE_END => 3, # done
233 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
234 # Spit a warning as it's not
235 # proper kernel-doc and ignore the rest.
236};
237my $inline_doc_state;
238
239#declaration types: can be
240# 'function', 'struct', 'union', 'enum', 'typedef'
241my $decl_type;
242
243# Name of the kernel-doc identifier for non-DOC markups
244my $identifier;
245
246my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
247my $doc_end = '\*/';
248my $doc_com = '\s*\*\s*';
249my $doc_com_body = '\s*\* ?';
250my $doc_decl = $doc_com . '(\w+)';
251# @params and a strictly limited set of supported section names
252# Specifically:
253# Match @word:
254# @...:
255# @{section-name}:
256# while trying to not match literal block starts like "example::"
257#
258my $doc_sect = $doc_com .
259 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
260my $doc_content = $doc_com_body . '(.*)';
261my $doc_block = $doc_com . 'DOC:\s*(.*)?';
262my $doc_inline_start = '^\s*/\*\*\s*$';
263my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
264my $doc_inline_end = '^\s*\*/\s*$';
265my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
266my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
267my $export_symbol_ns = '^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*\w+\)\s*;';
268my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
269my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
270
271my %parameterdescs;
272my %parameterdesc_start_lines;
273my @parameterlist;
274my %sections;
275my @sectionlist;
276my %section_start_lines;
277my $sectcheck;
278my $struct_actual;
279
280my $contents = "";
281my $new_start_line = 0;
282
283# the canonical section names. see also $doc_sect above.
284my $section_default = "Description"; # default section
285my $section_intro = "Introduction";
286my $section = $section_default;
287my $section_context = "Context";
288my $section_return = "Return";
289
290my $undescribed = "-- undescribed --";
291
292reset_state();
293
294while ($ARGV[0] =~ m/^--?(.*)/) {
295 my $cmd = $1;
296 shift @ARGV;
297 if ($cmd eq "man") {
298 $output_mode = "man";
299 @highlights = @highlights_man;
300 $blankline = $blankline_man;
301 } elsif ($cmd eq "rst") {
302 $output_mode = "rst";
303 @highlights = @highlights_rst;
304 $blankline = $blankline_rst;
305 } elsif ($cmd eq "none") {
306 $output_mode = "none";
307 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
308 $modulename = shift @ARGV;
309 } elsif ($cmd eq "function") { # to only output specific functions
310 $output_selection = OUTPUT_INCLUDE;
311 $function = shift @ARGV;
312 $function_table{$function} = 1;
313 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
314 my $symbol = shift @ARGV;
315 $nosymbol_table{$symbol} = 1;
316 } elsif ($cmd eq "export") { # only exported symbols
317 $output_selection = OUTPUT_EXPORTED;
318 %function_table = ();
319 } elsif ($cmd eq "internal") { # only non-exported symbols
320 $output_selection = OUTPUT_INTERNAL;
321 %function_table = ();
322 } elsif ($cmd eq "export-file") {
323 my $file = shift @ARGV;
324 push(@export_file_list, $file);
325 } elsif ($cmd eq "v") {
326 $verbose = 1;
327 } elsif ($cmd eq "Werror") {
328 $Werror = 1;
329 } elsif ($cmd eq "Wreturn") {
330 $Wreturn = 1;
331 } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") {
332 $Wshort_desc = 1;
333 } elsif ($cmd eq "Wcontents-before-sections") {
334 $Wcontents_before_sections = 1;
335 } elsif ($cmd eq "Wall") {
336 $Wreturn = 1;
337 $Wshort_desc = 1;
338 $Wcontents_before_sections = 1;
339 } elsif (($cmd eq "h") || ($cmd eq "help")) {
340 pod2usage(-exitval => 0, -verbose => 2);
341 } elsif ($cmd eq 'no-doc-sections') {
342 $no_doc_sections = 1;
343 } elsif ($cmd eq 'enable-lineno') {
344 $enable_lineno = 1;
345 } elsif ($cmd eq 'show-not-found') {
346 $show_not_found = 1; # A no-op but don't fail
347 } elsif ($cmd eq "sphinx-version") {
348 my $ver_string = shift @ARGV;
349 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
350 $sphinx_major = $1;
351 if (defined($2)) {
352 $sphinx_minor = substr($2,1);
353 } else {
354 $sphinx_minor = 0;
355 }
356 if (defined($3)) {
357 $sphinx_patch = substr($3,1)
358 } else {
359 $sphinx_patch = 0;
360 }
361 } else {
362 die "Sphinx version should either major.minor or major.minor.patch format\n";
363 }
364 } else {
365 # Unknown argument
366 pod2usage(
367 -message => "Argument unknown!\n",
368 -exitval => 1,
369 -verbose => 99,
370 -sections => 'SYNOPSIS',
371 -output => \*STDERR,
372 );
373 }
374 if ($#ARGV < 0){
375 pod2usage(
376 -message => "FILE argument missing\n",
377 -exitval => 1,
378 -verbose => 99,
379 -sections => 'SYNOPSIS',
380 -output => \*STDERR,
381 );
382 }
383}
384
385# continue execution near EOF;
386
387# The C domain dialect changed on Sphinx 3. So, we need to check the
388# version in order to produce the right tags.
389sub findprog($)
390{
391 foreach(split(/:/, $ENV{PATH})) {
392 return "$_/$_[0]" if(-x "$_/$_[0]");
393 }
394}
395
396sub get_sphinx_version()
397{
398 my $ver;
399
400 my $cmd = "sphinx-build";
401 if (!findprog($cmd)) {
402 my $cmd = "sphinx-build3";
403 if (!findprog($cmd)) {
404 $sphinx_major = 1;
405 $sphinx_minor = 2;
406 $sphinx_patch = 0;
407 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
408 $sphinx_major, $sphinx_minor, $sphinx_patch;
409 return;
410 }
411 }
412
413 open IN, "$cmd --version 2>&1 |";
414 while (<IN>) {
415 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
416 $sphinx_major = $1;
417 $sphinx_minor = $2;
418 $sphinx_patch = $3;
419 last;
420 }
421 # Sphinx 1.2.x uses a different format
422 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
423 $sphinx_major = $1;
424 $sphinx_minor = $2;
425 $sphinx_patch = $3;
426 last;
427 }
428 }
429 close IN;
430}
431
432# get kernel version from env
433sub get_kernel_version() {
434 my $version = 'unknown kernel version';
435
436 if (defined($ENV{'KERNELVERSION'})) {
437 $version = $ENV{'KERNELVERSION'};
438 }
439 return $version;
440}
441
442#
443sub print_lineno {
444 my $lineno = shift;
445 if ($enable_lineno && defined($lineno)) {
446 print ".. LINENO " . $lineno . "\n";
447 }
448}
449
450sub emit_warning {
451 my $location = shift;
452 my $msg = shift;
453 print STDERR "$location: warning: $msg";
454 ++$warnings;
455}
456##
457# dumps section contents to arrays/hashes intended for that purpose.
458#
459sub dump_section {
460 my $file = shift;
461 my $name = shift;
462 my $contents = join "\n", @_;
463
464 if ($name =~ m/$type_param/) {
465 $name = $1;
466 $parameterdescs{$name} = $contents;
467 $sectcheck = $sectcheck . $name . " ";
468 $parameterdesc_start_lines{$name} = $new_start_line;
469 $new_start_line = 0;
470 } elsif ($name eq "@\.\.\.") {
471 $name = "...";
472 $parameterdescs{$name} = $contents;
473 $sectcheck = $sectcheck . $name . " ";
474 $parameterdesc_start_lines{$name} = $new_start_line;
475 $new_start_line = 0;
476 } else {
477 if (defined($sections{$name}) && ($sections{$name} ne "")) {
478 # Only warn on user specified duplicate section names.
479 if ($name ne $section_default) {
480 emit_warning("${file}:$.", "duplicate section name '$name'\n");
481 }
482 $sections{$name} .= $contents;
483 } else {
484 $sections{$name} = $contents;
485 push @sectionlist, $name;
486 $section_start_lines{$name} = $new_start_line;
487 $new_start_line = 0;
488 }
489 }
490}
491
492##
493# dump DOC: section after checking that it should go out
494#
495sub dump_doc_section {
496 my $file = shift;
497 my $name = shift;
498 my $contents = join "\n", @_;
499
500 if ($no_doc_sections) {
501 return;
502 }
503
504 return if (defined($nosymbol_table{$name}));
505
506 if (($output_selection == OUTPUT_ALL) ||
507 (($output_selection == OUTPUT_INCLUDE) &&
508 defined($function_table{$name})))
509 {
510 dump_section($file, $name, $contents);
511 output_blockhead({'sectionlist' => \@sectionlist,
512 'sections' => \%sections,
513 'module' => $modulename,
514 'content-only' => ($output_selection != OUTPUT_ALL), });
515 }
516}
517
518##
519# output function
520#
521# parameterdescs, a hash.
522# function => "function name"
523# parameterlist => @list of parameters
524# parameterdescs => %parameter descriptions
525# sectionlist => @list of sections
526# sections => %section descriptions
527#
528
529sub output_highlight {
530 my $contents = join "\n",@_;
531 my $line;
532
533# DEBUG
534# if (!defined $contents) {
535# use Carp;
536# confess "output_highlight got called with no args?\n";
537# }
538
539# print STDERR "contents b4:$contents\n";
540 eval $dohighlight;
541 die $@ if $@;
542# print STDERR "contents af:$contents\n";
543
544 foreach $line (split "\n", $contents) {
545 if (! $output_preformatted) {
546 $line =~ s/^\s*//;
547 }
548 if ($line eq ""){
549 if (! $output_preformatted) {
550 print $lineprefix, $blankline;
551 }
552 } else {
553 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
554 print "\\&$line";
555 } else {
556 print $lineprefix, $line;
557 }
558 }
559 print "\n";
560 }
561}
562
563##
564# output function in man
565sub output_function_man(%) {
566 my %args = %{$_[0]};
567 my ($parameter, $section);
568 my $count;
569
570 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
571
572 print ".SH NAME\n";
573 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
574
575 print ".SH SYNOPSIS\n";
576 if ($args{'functiontype'} ne "") {
577 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
578 } else {
579 print ".B \"" . $args{'function'} . "\n";
580 }
581 $count = 0;
582 my $parenth = "(";
583 my $post = ",";
584 foreach my $parameter (@{$args{'parameterlist'}}) {
585 if ($count == $#{$args{'parameterlist'}}) {
586 $post = ");";
587 }
588 $type = $args{'parametertypes'}{$parameter};
589 if ($type =~ m/$function_pointer/) {
590 # pointer-to-function
591 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
592 } else {
593 $type =~ s/([^\*])$/$1 /;
594 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
595 }
596 $count++;
597 $parenth = "";
598 }
599
600 print ".SH ARGUMENTS\n";
601 foreach $parameter (@{$args{'parameterlist'}}) {
602 my $parameter_name = $parameter;
603 $parameter_name =~ s/\[.*//;
604
605 print ".IP \"" . $parameter . "\" 12\n";
606 output_highlight($args{'parameterdescs'}{$parameter_name});
607 }
608 foreach $section (@{$args{'sectionlist'}}) {
609 print ".SH \"", uc $section, "\"\n";
610 output_highlight($args{'sections'}{$section});
611 }
612}
613
614##
615# output enum in man
616sub output_enum_man(%) {
617 my %args = %{$_[0]};
618 my ($parameter, $section);
619 my $count;
620
621 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
622
623 print ".SH NAME\n";
624 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
625
626 print ".SH SYNOPSIS\n";
627 print "enum " . $args{'enum'} . " {\n";
628 $count = 0;
629 foreach my $parameter (@{$args{'parameterlist'}}) {
630 print ".br\n.BI \" $parameter\"\n";
631 if ($count == $#{$args{'parameterlist'}}) {
632 print "\n};\n";
633 last;
634 }
635 else {
636 print ", \n.br\n";
637 }
638 $count++;
639 }
640
641 print ".SH Constants\n";
642 foreach $parameter (@{$args{'parameterlist'}}) {
643 my $parameter_name = $parameter;
644 $parameter_name =~ s/\[.*//;
645
646 print ".IP \"" . $parameter . "\" 12\n";
647 output_highlight($args{'parameterdescs'}{$parameter_name});
648 }
649 foreach $section (@{$args{'sectionlist'}}) {
650 print ".SH \"$section\"\n";
651 output_highlight($args{'sections'}{$section});
652 }
653}
654
655##
656# output struct in man
657sub output_struct_man(%) {
658 my %args = %{$_[0]};
659 my ($parameter, $section);
660
661 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
662
663 print ".SH NAME\n";
664 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
665
666 my $declaration = $args{'definition'};
667 $declaration =~ s/\t/ /g;
668 $declaration =~ s/\n/"\n.br\n.BI \"/g;
669 print ".SH SYNOPSIS\n";
670 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
671 print ".BI \"$declaration\n};\n.br\n\n";
672
673 print ".SH Members\n";
674 foreach $parameter (@{$args{'parameterlist'}}) {
675 ($parameter =~ /^#/) && next;
676
677 my $parameter_name = $parameter;
678 $parameter_name =~ s/\[.*//;
679
680 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
681 print ".IP \"" . $parameter . "\" 12\n";
682 output_highlight($args{'parameterdescs'}{$parameter_name});
683 }
684 foreach $section (@{$args{'sectionlist'}}) {
685 print ".SH \"$section\"\n";
686 output_highlight($args{'sections'}{$section});
687 }
688}
689
690##
691# output typedef in man
692sub output_typedef_man(%) {
693 my %args = %{$_[0]};
694 my ($parameter, $section);
695
696 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
697
698 print ".SH NAME\n";
699 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
700
701 foreach $section (@{$args{'sectionlist'}}) {
702 print ".SH \"$section\"\n";
703 output_highlight($args{'sections'}{$section});
704 }
705}
706
707sub output_blockhead_man(%) {
708 my %args = %{$_[0]};
709 my ($parameter, $section);
710 my $count;
711
712 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
713
714 foreach $section (@{$args{'sectionlist'}}) {
715 print ".SH \"$section\"\n";
716 output_highlight($args{'sections'}{$section});
717 }
718}
719
720##
721# output in restructured text
722#
723
724#
725# This could use some work; it's used to output the DOC: sections, and
726# starts by putting out the name of the doc section itself, but that tends
727# to duplicate a header already in the template file.
728#
729sub output_blockhead_rst(%) {
730 my %args = %{$_[0]};
731 my ($parameter, $section);
732
733 foreach $section (@{$args{'sectionlist'}}) {
734 next if (defined($nosymbol_table{$section}));
735
736 if ($output_selection != OUTPUT_INCLUDE) {
737 print ".. _$section:\n\n";
738 print "**$section**\n\n";
739 }
740 print_lineno($section_start_lines{$section});
741 output_highlight_rst($args{'sections'}{$section});
742 print "\n";
743 }
744}
745
746#
747# Apply the RST highlights to a sub-block of text.
748#
749sub highlight_block($) {
750 # The dohighlight kludge requires the text be called $contents
751 my $contents = shift;
752 eval $dohighlight;
753 die $@ if $@;
754 return $contents;
755}
756
757#
758# Regexes used only here.
759#
760my $sphinx_literal = '^[^.].*::$';
761my $sphinx_cblock = '^\.\.\ +code-block::';
762
763sub output_highlight_rst {
764 my $input = join "\n",@_;
765 my $output = "";
766 my $line;
767 my $in_literal = 0;
768 my $litprefix;
769 my $block = "";
770
771 foreach $line (split "\n",$input) {
772 #
773 # If we're in a literal block, see if we should drop out
774 # of it. Otherwise pass the line straight through unmunged.
775 #
776 if ($in_literal) {
777 if (! ($line =~ /^\s*$/)) {
778 #
779 # If this is the first non-blank line in a literal
780 # block we need to figure out what the proper indent is.
781 #
782 if ($litprefix eq "") {
783 $line =~ /^(\s*)/;
784 $litprefix = '^' . $1;
785 $output .= $line . "\n";
786 } elsif (! ($line =~ /$litprefix/)) {
787 $in_literal = 0;
788 } else {
789 $output .= $line . "\n";
790 }
791 } else {
792 $output .= $line . "\n";
793 }
794 }
795 #
796 # Not in a literal block (or just dropped out)
797 #
798 if (! $in_literal) {
799 $block .= $line . "\n";
800 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
801 $in_literal = 1;
802 $litprefix = "";
803 $output .= highlight_block($block);
804 $block = ""
805 }
806 }
807 }
808
809 if ($block) {
810 $output .= highlight_block($block);
811 }
812 foreach $line (split "\n", $output) {
813 print $lineprefix . $line . "\n";
814 }
815}
816
817sub output_function_rst(%) {
818 my %args = %{$_[0]};
819 my ($parameter, $section);
820 my $oldprefix = $lineprefix;
821 my $start = "";
822 my $is_macro = 0;
823
824 if ($sphinx_major < 3) {
825 if ($args{'typedef'}) {
826 print ".. c:type:: ". $args{'function'} . "\n\n";
827 print_lineno($declaration_start_line);
828 print " **Typedef**: ";
829 $lineprefix = "";
830 output_highlight_rst($args{'purpose'});
831 $start = "\n\n**Syntax**\n\n ``";
832 $is_macro = 1;
833 } else {
834 print ".. c:function:: ";
835 }
836 } else {
837 if ($args{'typedef'} || $args{'functiontype'} eq "") {
838 $is_macro = 1;
839 print ".. c:macro:: ". $args{'function'} . "\n\n";
840 } else {
841 print ".. c:function:: ";
842 }
843
844 if ($args{'typedef'}) {
845 print_lineno($declaration_start_line);
846 print " **Typedef**: ";
847 $lineprefix = "";
848 output_highlight_rst($args{'purpose'});
849 $start = "\n\n**Syntax**\n\n ``";
850 } else {
851 print "``" if ($is_macro);
852 }
853 }
854 if ($args{'functiontype'} ne "") {
855 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
856 } else {
857 $start .= $args{'function'} . " (";
858 }
859 print $start;
860
861 my $count = 0;
862 foreach my $parameter (@{$args{'parameterlist'}}) {
863 if ($count ne 0) {
864 print ", ";
865 }
866 $count++;
867 $type = $args{'parametertypes'}{$parameter};
868
869 if ($type =~ m/$function_pointer/) {
870 # pointer-to-function
871 print $1 . $parameter . ") (" . $2 . ")";
872 } else {
873 print $type;
874 }
875 }
876 if ($is_macro) {
877 print ")``\n\n";
878 } else {
879 print ")\n\n";
880 }
881 if (!$args{'typedef'}) {
882 print_lineno($declaration_start_line);
883 $lineprefix = " ";
884 output_highlight_rst($args{'purpose'});
885 print "\n";
886 }
887
888 #
889 # Put our descriptive text into a container (thus an HTML <div>) to help
890 # set the function prototypes apart.
891 #
892 print ".. container:: kernelindent\n\n";
893 $lineprefix = " ";
894 print $lineprefix . "**Parameters**\n\n";
895 foreach $parameter (@{$args{'parameterlist'}}) {
896 my $parameter_name = $parameter;
897 $parameter_name =~ s/\[.*//;
898 $type = $args{'parametertypes'}{$parameter};
899
900 if ($type ne "") {
901 print $lineprefix . "``$type``\n";
902 } else {
903 print $lineprefix . "``$parameter``\n";
904 }
905
906 print_lineno($parameterdesc_start_lines{$parameter_name});
907
908 $lineprefix = " ";
909 if (defined($args{'parameterdescs'}{$parameter_name}) &&
910 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
911 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
912 } else {
913 print $lineprefix . "*undescribed*\n";
914 }
915 $lineprefix = " ";
916 print "\n";
917 }
918
919 output_section_rst(@_);
920 $lineprefix = $oldprefix;
921}
922
923sub output_section_rst(%) {
924 my %args = %{$_[0]};
925 my $section;
926 my $oldprefix = $lineprefix;
927
928 foreach $section (@{$args{'sectionlist'}}) {
929 print $lineprefix . "**$section**\n\n";
930 print_lineno($section_start_lines{$section});
931 output_highlight_rst($args{'sections'}{$section});
932 print "\n";
933 }
934 print "\n";
935}
936
937sub output_enum_rst(%) {
938 my %args = %{$_[0]};
939 my ($parameter);
940 my $oldprefix = $lineprefix;
941 my $count;
942 my $outer;
943
944 if ($sphinx_major < 3) {
945 my $name = "enum " . $args{'enum'};
946 print "\n\n.. c:type:: " . $name . "\n\n";
947 } else {
948 my $name = $args{'enum'};
949 print "\n\n.. c:enum:: " . $name . "\n\n";
950 }
951 print_lineno($declaration_start_line);
952 $lineprefix = " ";
953 output_highlight_rst($args{'purpose'});
954 print "\n";
955
956 print ".. container:: kernelindent\n\n";
957 $outer = $lineprefix . " ";
958 $lineprefix = $outer . " ";
959 print $outer . "**Constants**\n\n";
960 foreach $parameter (@{$args{'parameterlist'}}) {
961 print $outer . "``$parameter``\n";
962
963 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
964 output_highlight_rst($args{'parameterdescs'}{$parameter});
965 } else {
966 print $lineprefix . "*undescribed*\n";
967 }
968 print "\n";
969 }
970 print "\n";
971 $lineprefix = $oldprefix;
972 output_section_rst(@_);
973}
974
975sub output_typedef_rst(%) {
976 my %args = %{$_[0]};
977 my ($parameter);
978 my $oldprefix = $lineprefix;
979 my $name;
980
981 if ($sphinx_major < 3) {
982 $name = "typedef " . $args{'typedef'};
983 } else {
984 $name = $args{'typedef'};
985 }
986 print "\n\n.. c:type:: " . $name . "\n\n";
987 print_lineno($declaration_start_line);
988 $lineprefix = " ";
989 output_highlight_rst($args{'purpose'});
990 print "\n";
991
992 $lineprefix = $oldprefix;
993 output_section_rst(@_);
994}
995
996sub output_struct_rst(%) {
997 my %args = %{$_[0]};
998 my ($parameter);
999 my $oldprefix = $lineprefix;
1000
1001 if ($sphinx_major < 3) {
1002 my $name = $args{'type'} . " " . $args{'struct'};
1003 print "\n\n.. c:type:: " . $name . "\n\n";
1004 } else {
1005 my $name = $args{'struct'};
1006 if ($args{'type'} eq 'union') {
1007 print "\n\n.. c:union:: " . $name . "\n\n";
1008 } else {
1009 print "\n\n.. c:struct:: " . $name . "\n\n";
1010 }
1011 }
1012 print_lineno($declaration_start_line);
1013 $lineprefix = " ";
1014 output_highlight_rst($args{'purpose'});
1015 print "\n";
1016
1017 print ".. container:: kernelindent\n\n";
1018 print $lineprefix . "**Definition**::\n\n";
1019 my $declaration = $args{'definition'};
1020 $lineprefix = $lineprefix . " ";
1021 $declaration =~ s/\t/$lineprefix/g;
1022 print $lineprefix . $args{'type'} . " " . $args{'struct'} . " {\n$declaration" . $lineprefix . "};\n\n";
1023
1024 $lineprefix = " ";
1025 print $lineprefix . "**Members**\n\n";
1026 foreach $parameter (@{$args{'parameterlist'}}) {
1027 ($parameter =~ /^#/) && next;
1028
1029 my $parameter_name = $parameter;
1030 $parameter_name =~ s/\[.*//;
1031
1032 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1033 $type = $args{'parametertypes'}{$parameter};
1034 print_lineno($parameterdesc_start_lines{$parameter_name});
1035 print $lineprefix . "``" . $parameter . "``\n";
1036 $lineprefix = " ";
1037 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1038 $lineprefix = " ";
1039 print "\n";
1040 }
1041 print "\n";
1042
1043 $lineprefix = $oldprefix;
1044 output_section_rst(@_);
1045}
1046
1047## none mode output functions
1048
1049sub output_function_none(%) {
1050}
1051
1052sub output_enum_none(%) {
1053}
1054
1055sub output_typedef_none(%) {
1056}
1057
1058sub output_struct_none(%) {
1059}
1060
1061sub output_blockhead_none(%) {
1062}
1063
1064##
1065# generic output function for all types (function, struct/union, typedef, enum);
1066# calls the generated, variable output_ function name based on
1067# functype and output_mode
1068sub output_declaration {
1069 no strict 'refs';
1070 my $name = shift;
1071 my $functype = shift;
1072 my $func = "output_${functype}_$output_mode";
1073
1074 return if (defined($nosymbol_table{$name}));
1075
1076 if (($output_selection == OUTPUT_ALL) ||
1077 (($output_selection == OUTPUT_INCLUDE ||
1078 $output_selection == OUTPUT_EXPORTED) &&
1079 defined($function_table{$name})) ||
1080 ($output_selection == OUTPUT_INTERNAL &&
1081 !($functype eq "function" && defined($function_table{$name}))))
1082 {
1083 &$func(@_);
1084 $section_counter++;
1085 }
1086}
1087
1088##
1089# generic output function - calls the right one based on current output mode.
1090sub output_blockhead {
1091 no strict 'refs';
1092 my $func = "output_blockhead_" . $output_mode;
1093 &$func(@_);
1094 $section_counter++;
1095}
1096
1097##
1098# takes a declaration (struct, union, enum, typedef) and
1099# invokes the right handler. NOT called for functions.
1100sub dump_declaration($$) {
1101 no strict 'refs';
1102 my ($prototype, $file) = @_;
1103 my $func = "dump_" . $decl_type;
1104 &$func(@_);
1105}
1106
1107sub dump_union($$) {
1108 dump_struct(@_);
1109}
1110
1111sub dump_struct($$) {
1112 my $x = shift;
1113 my $file = shift;
1114 my $decl_type;
1115 my $members;
1116 my $type = qr{struct|union};
1117 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
1118 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1119 my $definition_body = qr{\{(.*)\}\s*$qualifiers*};
1120 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1121
1122 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1123 $decl_type = $1;
1124 $declaration_name = $2;
1125 $members = $3;
1126 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1127 $decl_type = $1;
1128 $declaration_name = $3;
1129 $members = $2;
1130 }
1131
1132 if ($members) {
1133 if ($identifier ne $declaration_name) {
1134 emit_warning("${file}:$.", "expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n");
1135 return;
1136 }
1137
1138 # ignore members marked private:
1139 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1140 $members =~ s/\/\*\s*private:.*//gosi;
1141 # strip comments:
1142 $members =~ s/\/\*.*?\*\///gos;
1143 # strip attributes
1144 $members =~ s/\s*$attribute/ /gi;
1145 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1146 $members =~ s/\s*__counted_by\s*\([^;]*\)/ /gos;
1147 $members =~ s/\s*__packed\s*/ /gos;
1148 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1149 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1150 $members =~ s/\s*____cacheline_aligned/ /gos;
1151 # unwrap struct_group():
1152 # - first eat non-declaration parameters and rewrite for final match
1153 # - then remove macro, outer parens, and trailing semicolon
1154 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1155 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1156 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1157 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1158
1159 my $args = qr{([^,)]+)};
1160 # replace DECLARE_BITMAP
1161 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1162 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
1163 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1164 # replace DECLARE_HASHTABLE
1165 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1166 # replace DECLARE_KFIFO
1167 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1168 # replace DECLARE_KFIFO_PTR
1169 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1170 # replace DECLARE_FLEX_ARRAY
1171 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1172 #replace DEFINE_DMA_UNMAP_ADDR
1173 $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
1174 #replace DEFINE_DMA_UNMAP_LEN
1175 $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
1176 my $declaration = $members;
1177
1178 # Split nested struct/union elements as newer ones
1179 while ($members =~ m/$struct_members/) {
1180 my $newmember;
1181 my $maintype = $1;
1182 my $ids = $4;
1183 my $content = $3;
1184 foreach my $id(split /,/, $ids) {
1185 $newmember .= "$maintype $id; ";
1186
1187 $id =~ s/[:\[].*//;
1188 $id =~ s/^\s*\**(\S+)\s*/$1/;
1189 foreach my $arg (split /;/, $content) {
1190 next if ($arg =~ m/^\s*$/);
1191 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1192 # pointer-to-function
1193 my $type = $1;
1194 my $name = $2;
1195 my $extra = $3;
1196 next if (!$name);
1197 if ($id =~ m/^\s*$/) {
1198 # anonymous struct/union
1199 $newmember .= "$type$name$extra; ";
1200 } else {
1201 $newmember .= "$type$id.$name$extra; ";
1202 }
1203 } else {
1204 my $type;
1205 my $names;
1206 $arg =~ s/^\s+//;
1207 $arg =~ s/\s+$//;
1208 # Handle bitmaps
1209 $arg =~ s/:\s*\d+\s*//g;
1210 # Handle arrays
1211 $arg =~ s/\[.*\]//g;
1212 # The type may have multiple words,
1213 # and multiple IDs can be defined, like:
1214 # const struct foo, *bar, foobar
1215 # So, we remove spaces when parsing the
1216 # names, in order to match just names
1217 # and commas for the names
1218 $arg =~ s/\s*,\s*/,/g;
1219 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1220 $type = $1;
1221 $names = $2;
1222 } else {
1223 $newmember .= "$arg; ";
1224 next;
1225 }
1226 foreach my $name (split /,/, $names) {
1227 $name =~ s/^\s*\**(\S+)\s*/$1/;
1228 next if (($name =~ m/^\s*$/));
1229 if ($id =~ m/^\s*$/) {
1230 # anonymous struct/union
1231 $newmember .= "$type $name; ";
1232 } else {
1233 $newmember .= "$type $id.$name; ";
1234 }
1235 }
1236 }
1237 }
1238 }
1239 $members =~ s/$struct_members/$newmember/;
1240 }
1241
1242 # Ignore other nested elements, like enums
1243 $members =~ s/(\{[^\{\}]*\})//g;
1244
1245 create_parameterlist($members, ';', $file, $declaration_name);
1246 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1247
1248 # Adjust declaration for better display
1249 $declaration =~ s/([\{;])/$1\n/g;
1250 $declaration =~ s/\}\s+;/};/g;
1251 # Better handle inlined enums
1252 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1253
1254 my @def_args = split /\n/, $declaration;
1255 my $level = 1;
1256 $declaration = "";
1257 foreach my $clause (@def_args) {
1258 $clause =~ s/^\s+//;
1259 $clause =~ s/\s+$//;
1260 $clause =~ s/\s+/ /;
1261 next if (!$clause);
1262 $level-- if ($clause =~ m/(\})/ && $level > 1);
1263 if (!($clause =~ m/^\s*#/)) {
1264 $declaration .= "\t" x $level;
1265 }
1266 $declaration .= "\t" . $clause . "\n";
1267 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1268 }
1269 output_declaration($declaration_name,
1270 'struct',
1271 {'struct' => $declaration_name,
1272 'module' => $modulename,
1273 'definition' => $declaration,
1274 'parameterlist' => \@parameterlist,
1275 'parameterdescs' => \%parameterdescs,
1276 'parametertypes' => \%parametertypes,
1277 'sectionlist' => \@sectionlist,
1278 'sections' => \%sections,
1279 'purpose' => $declaration_purpose,
1280 'type' => $decl_type
1281 });
1282 }
1283 else {
1284 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1285 ++$errors;
1286 }
1287}
1288
1289
1290sub show_warnings($$) {
1291 my $functype = shift;
1292 my $name = shift;
1293
1294 return 0 if (defined($nosymbol_table{$name}));
1295
1296 return 1 if ($output_selection == OUTPUT_ALL);
1297
1298 if ($output_selection == OUTPUT_EXPORTED) {
1299 if (defined($function_table{$name})) {
1300 return 1;
1301 } else {
1302 return 0;
1303 }
1304 }
1305 if ($output_selection == OUTPUT_INTERNAL) {
1306 if (!($functype eq "function" && defined($function_table{$name}))) {
1307 return 1;
1308 } else {
1309 return 0;
1310 }
1311 }
1312 if ($output_selection == OUTPUT_INCLUDE) {
1313 if (defined($function_table{$name})) {
1314 return 1;
1315 } else {
1316 return 0;
1317 }
1318 }
1319 die("Please add the new output type at show_warnings()");
1320}
1321
1322sub dump_enum($$) {
1323 my $x = shift;
1324 my $file = shift;
1325 my $members;
1326
1327 # ignore members marked private:
1328 $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1329 $x =~ s/\/\*\s*private:.*}/}/gosi;
1330
1331 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1332 # strip #define macros inside enums
1333 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1334
1335 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1336 $declaration_name = $2;
1337 $members = $1;
1338 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1339 $declaration_name = $1;
1340 $members = $2;
1341 }
1342
1343 if ($members) {
1344 if ($identifier ne $declaration_name) {
1345 if ($identifier eq "") {
1346 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
1347 } else {
1348 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
1349 }
1350 return;
1351 }
1352 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1353
1354 my %_members;
1355
1356 $members =~ s/\s+$//;
1357 $members =~ s/\([^;]*?[\)]//g;
1358
1359 foreach my $arg (split ',', $members) {
1360 $arg =~ s/^\s*(\w+).*/$1/;
1361 push @parameterlist, $arg;
1362 if (!$parameterdescs{$arg}) {
1363 $parameterdescs{$arg} = $undescribed;
1364 if (show_warnings("enum", $declaration_name)) {
1365 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
1366 }
1367 }
1368 $_members{$arg} = 1;
1369 }
1370
1371 while (my ($k, $v) = each %parameterdescs) {
1372 if (!exists($_members{$k})) {
1373 if (show_warnings("enum", $declaration_name)) {
1374 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
1375 }
1376 }
1377 }
1378
1379 output_declaration($declaration_name,
1380 'enum',
1381 {'enum' => $declaration_name,
1382 'module' => $modulename,
1383 'parameterlist' => \@parameterlist,
1384 'parameterdescs' => \%parameterdescs,
1385 'sectionlist' => \@sectionlist,
1386 'sections' => \%sections,
1387 'purpose' => $declaration_purpose
1388 });
1389 } else {
1390 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1391 ++$errors;
1392 }
1393}
1394
1395my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1396my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1397my $typedef_args = qr { \s*\((.*)\); }x;
1398
1399my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1400my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1401
1402sub dump_typedef($$) {
1403 my $x = shift;
1404 my $file = shift;
1405
1406 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1407
1408 # Parse function typedef prototypes
1409 if ($x =~ $typedef1 || $x =~ $typedef2) {
1410 $return_type = $1;
1411 $declaration_name = $2;
1412 my $args = $3;
1413 $return_type =~ s/^\s+//;
1414
1415 if ($identifier ne $declaration_name) {
1416 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1417 return;
1418 }
1419
1420 create_parameterlist($args, ',', $file, $declaration_name);
1421
1422 output_declaration($declaration_name,
1423 'function',
1424 {'function' => $declaration_name,
1425 'typedef' => 1,
1426 'module' => $modulename,
1427 'functiontype' => $return_type,
1428 'parameterlist' => \@parameterlist,
1429 'parameterdescs' => \%parameterdescs,
1430 'parametertypes' => \%parametertypes,
1431 'sectionlist' => \@sectionlist,
1432 'sections' => \%sections,
1433 'purpose' => $declaration_purpose
1434 });
1435 return;
1436 }
1437
1438 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1439 $x =~ s/\(*.\)\s*;$/;/;
1440 $x =~ s/\[*.\]\s*;$/;/;
1441 }
1442
1443 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1444 $declaration_name = $1;
1445
1446 if ($identifier ne $declaration_name) {
1447 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1448 return;
1449 }
1450
1451 output_declaration($declaration_name,
1452 'typedef',
1453 {'typedef' => $declaration_name,
1454 'module' => $modulename,
1455 'sectionlist' => \@sectionlist,
1456 'sections' => \%sections,
1457 'purpose' => $declaration_purpose
1458 });
1459 }
1460 else {
1461 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1462 ++$errors;
1463 }
1464}
1465
1466sub save_struct_actual($) {
1467 my $actual = shift;
1468
1469 # strip all spaces from the actual param so that it looks like one string item
1470 $actual =~ s/\s*//g;
1471 $struct_actual = $struct_actual . $actual . " ";
1472}
1473
1474sub create_parameterlist($$$$) {
1475 my $args = shift;
1476 my $splitter = shift;
1477 my $file = shift;
1478 my $declaration_name = shift;
1479 my $type;
1480 my $param;
1481
1482 # temporarily replace commas inside function pointer definition
1483 my $arg_expr = qr{\([^\),]+};
1484 while ($args =~ /$arg_expr,/) {
1485 $args =~ s/($arg_expr),/$1#/g;
1486 }
1487
1488 foreach my $arg (split($splitter, $args)) {
1489 # strip comments
1490 $arg =~ s/\/\*.*\*\///;
1491 # ignore argument attributes
1492 $arg =~ s/\sPOS0?\s/ /;
1493 # strip leading/trailing spaces
1494 $arg =~ s/^\s*//;
1495 $arg =~ s/\s*$//;
1496 $arg =~ s/\s+/ /;
1497
1498 if ($arg =~ /^#/) {
1499 # Treat preprocessor directive as a typeless variable just to fill
1500 # corresponding data structures "correctly". Catch it later in
1501 # output_* subs.
1502 push_parameter($arg, "", "", $file);
1503 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1504 # pointer-to-function
1505 $arg =~ tr/#/,/;
1506 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1507 $param = $1;
1508 $type = $arg;
1509 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1510 save_struct_actual($param);
1511 push_parameter($param, $type, $arg, $file, $declaration_name);
1512 } elsif ($arg) {
1513 $arg =~ s/\s*:\s*/:/g;
1514 $arg =~ s/\s*\[/\[/g;
1515
1516 my @args = split('\s*,\s*', $arg);
1517 if ($args[0] =~ m/\*/) {
1518 $args[0] =~ s/(\*+)\s*/ $1/;
1519 }
1520
1521 my @first_arg;
1522 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1523 shift @args;
1524 push(@first_arg, split('\s+', $1));
1525 push(@first_arg, $2);
1526 } else {
1527 @first_arg = split('\s+', shift @args);
1528 }
1529
1530 unshift(@args, pop @first_arg);
1531 $type = join " ", @first_arg;
1532
1533 foreach $param (@args) {
1534 if ($param =~ m/^(\*+)\s*(.*)/) {
1535 save_struct_actual($2);
1536
1537 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1538 }
1539 elsif ($param =~ m/(.*?):(\d+)/) {
1540 if ($type ne "") { # skip unnamed bit-fields
1541 save_struct_actual($1);
1542 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1543 }
1544 }
1545 else {
1546 save_struct_actual($param);
1547 push_parameter($param, $type, $arg, $file, $declaration_name);
1548 }
1549 }
1550 }
1551 }
1552}
1553
1554sub push_parameter($$$$$) {
1555 my $param = shift;
1556 my $type = shift;
1557 my $org_arg = shift;
1558 my $file = shift;
1559 my $declaration_name = shift;
1560
1561 if (($anon_struct_union == 1) && ($type eq "") &&
1562 ($param eq "}")) {
1563 return; # ignore the ending }; from anon. struct/union
1564 }
1565
1566 $anon_struct_union = 0;
1567 $param =~ s/[\[\)].*//;
1568
1569 if ($type eq "" && $param =~ /\.\.\.$/)
1570 {
1571 if (!$param =~ /\w\.\.\.$/) {
1572 # handles unnamed variable parameters
1573 $param = "...";
1574 }
1575 elsif ($param =~ /\w\.\.\.$/) {
1576 # for named variable parameters of the form `x...`, remove the dots
1577 $param =~ s/\.\.\.$//;
1578 }
1579 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1580 $parameterdescs{$param} = "variable arguments";
1581 }
1582 }
1583 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1584 {
1585 $param="void";
1586 $parameterdescs{void} = "no arguments";
1587 }
1588 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1589 # handle unnamed (anonymous) union or struct:
1590 {
1591 $type = $param;
1592 $param = "{unnamed_" . $param . "}";
1593 $parameterdescs{$param} = "anonymous\n";
1594 $anon_struct_union = 1;
1595 }
1596 elsif ($param =~ "__cacheline_group" )
1597 # handle cache group enforcing variables: they do not need be described in header files
1598 {
1599 return; # ignore __cacheline_group_begin and __cacheline_group_end
1600 }
1601
1602 # warn if parameter has no description
1603 # (but ignore ones starting with # as these are not parameters
1604 # but inline preprocessor statements);
1605 # Note: It will also ignore void params and unnamed structs/unions
1606 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1607 $parameterdescs{$param} = $undescribed;
1608
1609 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1610 emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
1611 }
1612 }
1613
1614 # strip spaces from $param so that it is one continuous string
1615 # on @parameterlist;
1616 # this fixes a problem where check_sections() cannot find
1617 # a parameter like "addr[6 + 2]" because it actually appears
1618 # as "addr[6", "+", "2]" on the parameter list;
1619 # but it's better to maintain the param string unchanged for output,
1620 # so just weaken the string compare in check_sections() to ignore
1621 # "[blah" in a parameter string;
1622 ###$param =~ s/\s*//g;
1623 push @parameterlist, $param;
1624 $org_arg =~ s/\s\s+/ /g;
1625 $parametertypes{$param} = $org_arg;
1626}
1627
1628sub check_sections($$$$$) {
1629 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1630 my @sects = split ' ', $sectcheck;
1631 my @prms = split ' ', $prmscheck;
1632 my $err;
1633 my ($px, $sx);
1634 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1635
1636 foreach $sx (0 .. $#sects) {
1637 $err = 1;
1638 foreach $px (0 .. $#prms) {
1639 $prm_clean = $prms[$px];
1640 $prm_clean =~ s/\[.*\]//;
1641 $prm_clean =~ s/$attribute//i;
1642 # ignore array size in a parameter string;
1643 # however, the original param string may contain
1644 # spaces, e.g.: addr[6 + 2]
1645 # and this appears in @prms as "addr[6" since the
1646 # parameter list is split at spaces;
1647 # hence just ignore "[..." for the sections check;
1648 $prm_clean =~ s/\[.*//;
1649
1650 ##$prm_clean =~ s/^\**//;
1651 if ($prm_clean eq $sects[$sx]) {
1652 $err = 0;
1653 last;
1654 }
1655 }
1656 if ($err) {
1657 if ($decl_type eq "function") {
1658 emit_warning("${file}:$.",
1659 "Excess function parameter " .
1660 "'$sects[$sx]' " .
1661 "description in '$decl_name'\n");
1662 }
1663 elsif (($decl_type eq "struct") or
1664 ($decl_type eq "union")) {
1665 emit_warning("${file}:$.",
1666 "Excess $decl_type member " .
1667 "'$sects[$sx]' " .
1668 "description in '$decl_name'\n");
1669 }
1670 }
1671 }
1672}
1673
1674##
1675# Checks the section describing the return value of a function.
1676sub check_return_section {
1677 my $file = shift;
1678 my $declaration_name = shift;
1679 my $return_type = shift;
1680
1681 # Ignore an empty return type (It's a macro)
1682 # Ignore functions with a "void" return type. (But don't ignore "void *")
1683 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1684 return;
1685 }
1686
1687 if (!defined($sections{$section_return}) ||
1688 $sections{$section_return} eq "") {
1689 emit_warning("${file}:$.",
1690 "No description found for return value of " .
1691 "'$declaration_name'\n");
1692 }
1693}
1694
1695##
1696# takes a function prototype and the name of the current file being
1697# processed and spits out all the details stored in the global
1698# arrays/hashes.
1699sub dump_function($$) {
1700 my $prototype = shift;
1701 my $file = shift;
1702 my $noret = 0;
1703
1704 print_lineno($new_start_line);
1705
1706 $prototype =~ s/^static +//;
1707 $prototype =~ s/^extern +//;
1708 $prototype =~ s/^asmlinkage +//;
1709 $prototype =~ s/^inline +//;
1710 $prototype =~ s/^__inline__ +//;
1711 $prototype =~ s/^__inline +//;
1712 $prototype =~ s/^__always_inline +//;
1713 $prototype =~ s/^noinline +//;
1714 $prototype =~ s/^__FORTIFY_INLINE +//;
1715 $prototype =~ s/__init +//;
1716 $prototype =~ s/__init_or_module +//;
1717 $prototype =~ s/__deprecated +//;
1718 $prototype =~ s/__flatten +//;
1719 $prototype =~ s/__meminit +//;
1720 $prototype =~ s/__must_check +//;
1721 $prototype =~ s/__weak +//;
1722 $prototype =~ s/__sched +//;
1723 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1724 $prototype =~ s/__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//;
1725 $prototype =~ s/__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +//;
1726 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1727 $prototype =~ s/__attribute_const__ +//;
1728 $prototype =~ s/__attribute__\s*\(\(
1729 (?:
1730 [\w\s]++ # attribute name
1731 (?:\([^)]*+\))? # attribute arguments
1732 \s*+,? # optional comma at the end
1733 )+
1734 \)\)\s+//x;
1735
1736 # Yes, this truly is vile. We are looking for:
1737 # 1. Return type (may be nothing if we're looking at a macro)
1738 # 2. Function name
1739 # 3. Function parameters.
1740 #
1741 # All the while we have to watch out for function pointer parameters
1742 # (which IIRC is what the two sections are for), C types (these
1743 # regexps don't even start to express all the possibilities), and
1744 # so on.
1745 #
1746 # If you mess with these regexps, it's a good idea to check that
1747 # the following functions' documentation still comes out right:
1748 # - parport_register_device (function pointer parameters)
1749 # - atomic_set (macro)
1750 # - pci_match_device, __copy_to_user (long return type)
1751 my $name = qr{[a-zA-Z0-9_~:]+};
1752 my $prototype_end1 = qr{[^\(]*};
1753 my $prototype_end2 = qr{[^\{]*};
1754 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1755 my $type1 = qr{[\w\s]+};
1756 my $type2 = qr{$type1\*+};
1757
1758 if ($define && $prototype =~ m/^()($name)\s+/) {
1759 # This is an object-like macro, it has no return type and no parameter
1760 # list.
1761 # Function-like macros are not allowed to have spaces between
1762 # declaration_name and opening parenthesis (notice the \s+).
1763 $return_type = $1;
1764 $declaration_name = $2;
1765 $noret = 1;
1766 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1767 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1768 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1769 $return_type = $1;
1770 $declaration_name = $2;
1771 my $args = $3;
1772
1773 create_parameterlist($args, ',', $file, $declaration_name);
1774 } else {
1775 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
1776 return;
1777 }
1778
1779 if ($identifier ne $declaration_name) {
1780 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
1781 return;
1782 }
1783
1784 my $prms = join " ", @parameterlist;
1785 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1786
1787 # This check emits a lot of warnings at the moment, because many
1788 # functions don't have a 'Return' doc section. So until the number
1789 # of warnings goes sufficiently down, the check is only performed in
1790 # -Wreturn mode.
1791 # TODO: always perform the check.
1792 if ($Wreturn && !$noret) {
1793 check_return_section($file, $declaration_name, $return_type);
1794 }
1795
1796 # The function parser can be called with a typedef parameter.
1797 # Handle it.
1798 if ($return_type =~ /typedef/) {
1799 output_declaration($declaration_name,
1800 'function',
1801 {'function' => $declaration_name,
1802 'typedef' => 1,
1803 'module' => $modulename,
1804 'functiontype' => $return_type,
1805 'parameterlist' => \@parameterlist,
1806 'parameterdescs' => \%parameterdescs,
1807 'parametertypes' => \%parametertypes,
1808 'sectionlist' => \@sectionlist,
1809 'sections' => \%sections,
1810 'purpose' => $declaration_purpose
1811 });
1812 } else {
1813 output_declaration($declaration_name,
1814 'function',
1815 {'function' => $declaration_name,
1816 'module' => $modulename,
1817 'functiontype' => $return_type,
1818 'parameterlist' => \@parameterlist,
1819 'parameterdescs' => \%parameterdescs,
1820 'parametertypes' => \%parametertypes,
1821 'sectionlist' => \@sectionlist,
1822 'sections' => \%sections,
1823 'purpose' => $declaration_purpose
1824 });
1825 }
1826}
1827
1828sub reset_state {
1829 $function = "";
1830 %parameterdescs = ();
1831 %parametertypes = ();
1832 @parameterlist = ();
1833 %sections = ();
1834 @sectionlist = ();
1835 $sectcheck = "";
1836 $struct_actual = "";
1837 $prototype = "";
1838
1839 $state = STATE_NORMAL;
1840 $inline_doc_state = STATE_INLINE_NA;
1841}
1842
1843sub tracepoint_munge($) {
1844 my $file = shift;
1845 my $tracepointname = 0;
1846 my $tracepointargs = 0;
1847
1848 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1849 $tracepointname = $1;
1850 }
1851 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1852 $tracepointname = $1;
1853 }
1854 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1855 $tracepointname = $2;
1856 }
1857 $tracepointname =~ s/^\s+//; #strip leading whitespace
1858 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1859 $tracepointargs = $1;
1860 }
1861 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1862 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1863 "$prototype\n");
1864 } else {
1865 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1866 $identifier = "trace_$identifier";
1867 }
1868}
1869
1870sub syscall_munge() {
1871 my $void = 0;
1872
1873 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1874## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1875 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1876 $void = 1;
1877## $prototype = "long sys_$1(void)";
1878 }
1879
1880 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1881 if ($prototype =~ m/long (sys_.*?),/) {
1882 $prototype =~ s/,/\(/;
1883 } elsif ($void) {
1884 $prototype =~ s/\)/\(void\)/;
1885 }
1886
1887 # now delete all of the odd-number commas in $prototype
1888 # so that arg types & arg names don't have a comma between them
1889 my $count = 0;
1890 my $len = length($prototype);
1891 if ($void) {
1892 $len = 0; # skip the for-loop
1893 }
1894 for (my $ix = 0; $ix < $len; $ix++) {
1895 if (substr($prototype, $ix, 1) eq ',') {
1896 $count++;
1897 if ($count % 2 == 1) {
1898 substr($prototype, $ix, 1) = ' ';
1899 }
1900 }
1901 }
1902}
1903
1904sub process_proto_function($$) {
1905 my $x = shift;
1906 my $file = shift;
1907
1908 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1909
1910 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1911 # do nothing
1912 }
1913 elsif ($x =~ /([^\{]*)/) {
1914 $prototype .= $1;
1915 }
1916
1917 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1918 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1919 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1920 $prototype =~ s@^\s+@@gos; # strip leading spaces
1921
1922 # Handle prototypes for function pointers like:
1923 # int (*pcs_config)(struct foo)
1924 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1925
1926 if ($prototype =~ /SYSCALL_DEFINE/) {
1927 syscall_munge();
1928 }
1929 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1930 $prototype =~ /DEFINE_SINGLE_EVENT/)
1931 {
1932 tracepoint_munge($file);
1933 }
1934 dump_function($prototype, $file);
1935 reset_state();
1936 }
1937}
1938
1939sub process_proto_type($$) {
1940 my $x = shift;
1941 my $file = shift;
1942
1943 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1944 $x =~ s@^\s+@@gos; # strip leading spaces
1945 $x =~ s@\s+$@@gos; # strip trailing spaces
1946 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1947
1948 if ($x =~ /^#/) {
1949 # To distinguish preprocessor directive from regular declaration later.
1950 $x .= ";";
1951 }
1952
1953 while (1) {
1954 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1955 if( length $prototype ) {
1956 $prototype .= " "
1957 }
1958 $prototype .= $1 . $2;
1959 ($2 eq '{') && $brcount++;
1960 ($2 eq '}') && $brcount--;
1961 if (($2 eq ';') && ($brcount == 0)) {
1962 dump_declaration($prototype, $file);
1963 reset_state();
1964 last;
1965 }
1966 $x = $3;
1967 } else {
1968 $prototype .= $x;
1969 last;
1970 }
1971 }
1972}
1973
1974
1975sub map_filename($) {
1976 my $file;
1977 my ($orig_file) = @_;
1978
1979 if (defined($ENV{'SRCTREE'})) {
1980 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1981 } else {
1982 $file = $orig_file;
1983 }
1984
1985 if (defined($source_map{$file})) {
1986 $file = $source_map{$file};
1987 }
1988
1989 return $file;
1990}
1991
1992sub process_export_file($) {
1993 my ($orig_file) = @_;
1994 my $file = map_filename($orig_file);
1995
1996 if (!open(IN,"<$file")) {
1997 print STDERR "Error: Cannot open file $file\n";
1998 ++$errors;
1999 return;
2000 }
2001
2002 while (<IN>) {
2003 if (/$export_symbol/) {
2004 next if (defined($nosymbol_table{$2}));
2005 $function_table{$2} = 1;
2006 }
2007 if (/$export_symbol_ns/) {
2008 next if (defined($nosymbol_table{$2}));
2009 $function_table{$2} = 1;
2010 }
2011 }
2012
2013 close(IN);
2014}
2015
2016#
2017# Parsers for the various processing states.
2018#
2019# STATE_NORMAL: looking for the /** to begin everything.
2020#
2021sub process_normal() {
2022 if (/$doc_start/o) {
2023 $state = STATE_NAME; # next line is always the function name
2024 $in_doc_sect = 0;
2025 $declaration_start_line = $. + 1;
2026 }
2027}
2028
2029#
2030# STATE_NAME: Looking for the "name - description" line
2031#
2032sub process_name($$) {
2033 my $file = shift;
2034 my $descr;
2035
2036 if (/$doc_block/o) {
2037 $state = STATE_DOCBLOCK;
2038 $contents = "";
2039 $new_start_line = $.;
2040
2041 if ( $1 eq "" ) {
2042 $section = $section_intro;
2043 } else {
2044 $section = $1;
2045 }
2046 } elsif (/$doc_decl/o) {
2047 $identifier = $1;
2048 my $is_kernel_comment = 0;
2049 my $decl_start = qr{$doc_com};
2050 # test for pointer declaration type, foo * bar() - desc
2051 my $fn_type = qr{\w+\s*\*\s*};
2052 my $parenthesis = qr{\(\w*\)};
2053 my $decl_end = qr{[-:].*};
2054 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2055 $identifier = $1;
2056 }
2057 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2058 $decl_type = $1;
2059 $identifier = $2;
2060 $is_kernel_comment = 1;
2061 }
2062 # Look for foo() or static void foo() - description; or misspelt
2063 # identifier
2064 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2065 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2066 $identifier = $1;
2067 $decl_type = 'function';
2068 $identifier =~ s/^define\s+//;
2069 $is_kernel_comment = 1;
2070 }
2071 $identifier =~ s/\s+$//;
2072
2073 $state = STATE_BODY;
2074 # if there's no @param blocks need to set up default section
2075 # here
2076 $contents = "";
2077 $section = $section_default;
2078 $new_start_line = $. + 1;
2079 if (/[-:](.*)/) {
2080 # strip leading/trailing/multiple spaces
2081 $descr= $1;
2082 $descr =~ s/^\s*//;
2083 $descr =~ s/\s*$//;
2084 $descr =~ s/\s+/ /g;
2085 $declaration_purpose = $descr;
2086 $state = STATE_BODY_MAYBE;
2087 } else {
2088 $declaration_purpose = "";
2089 }
2090
2091 if (!$is_kernel_comment) {
2092 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
2093 $state = STATE_NORMAL;
2094 }
2095
2096 if (($declaration_purpose eq "") && $Wshort_desc) {
2097 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
2098 }
2099
2100 if ($identifier eq "" && $decl_type ne "enum") {
2101 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
2102 $state = STATE_NORMAL;
2103 }
2104
2105 if ($verbose) {
2106 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2107 }
2108 } else {
2109 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
2110 $state = STATE_NORMAL;
2111 }
2112}
2113
2114
2115#
2116# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2117#
2118sub process_body($$) {
2119 my $file = shift;
2120
2121 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2122 dump_section($file, $section, $contents);
2123 $section = $section_default;
2124 $new_start_line = $.;
2125 $contents = "";
2126 }
2127
2128 if (/$doc_sect/i) { # case insensitive for supported section names
2129 $in_doc_sect = 1;
2130 $newsection = $1;
2131 $newcontents = $2;
2132
2133 # map the supported section names to the canonical names
2134 if ($newsection =~ m/^description$/i) {
2135 $newsection = $section_default;
2136 } elsif ($newsection =~ m/^context$/i) {
2137 $newsection = $section_context;
2138 } elsif ($newsection =~ m/^returns?$/i) {
2139 $newsection = $section_return;
2140 } elsif ($newsection =~ m/^\@return$/) {
2141 # special: @return is a section, not a param description
2142 $newsection = $section_return;
2143 }
2144
2145 if (($contents ne "") && ($contents ne "\n")) {
2146 if (!$in_doc_sect && $Wcontents_before_sections) {
2147 emit_warning("${file}:$.", "contents before sections\n");
2148 }
2149 dump_section($file, $section, $contents);
2150 $section = $section_default;
2151 }
2152
2153 $in_doc_sect = 1;
2154 $state = STATE_BODY;
2155 $contents = $newcontents;
2156 $new_start_line = $.;
2157 while (substr($contents, 0, 1) eq " ") {
2158 $contents = substr($contents, 1);
2159 }
2160 if ($contents ne "") {
2161 $contents .= "\n";
2162 }
2163 $section = $newsection;
2164 $leading_space = undef;
2165 } elsif (/$doc_end/) {
2166 if (($contents ne "") && ($contents ne "\n")) {
2167 dump_section($file, $section, $contents);
2168 $section = $section_default;
2169 $contents = "";
2170 }
2171 # look for doc_com + <text> + doc_end:
2172 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2173 emit_warning("${file}:$.", "suspicious ending line: $_");
2174 }
2175
2176 $prototype = "";
2177 $state = STATE_PROTO;
2178 $brcount = 0;
2179 $new_start_line = $. + 1;
2180 } elsif (/$doc_content/) {
2181 if ($1 eq "") {
2182 if ($section eq $section_context) {
2183 dump_section($file, $section, $contents);
2184 $section = $section_default;
2185 $contents = "";
2186 $new_start_line = $.;
2187 $state = STATE_BODY;
2188 } else {
2189 if ($section ne $section_default) {
2190 $state = STATE_BODY_WITH_BLANK_LINE;
2191 } else {
2192 $state = STATE_BODY;
2193 }
2194 $contents .= "\n";
2195 }
2196 } elsif ($state == STATE_BODY_MAYBE) {
2197 # Continued declaration purpose
2198 chomp($declaration_purpose);
2199 $declaration_purpose .= " " . $1;
2200 $declaration_purpose =~ s/\s+/ /g;
2201 } else {
2202 my $cont = $1;
2203 if ($section =~ m/^@/ || $section eq $section_context) {
2204 if (!defined $leading_space) {
2205 if ($cont =~ m/^(\s+)/) {
2206 $leading_space = $1;
2207 } else {
2208 $leading_space = "";
2209 }
2210 }
2211 $cont =~ s/^$leading_space//;
2212 }
2213 $contents .= $cont . "\n";
2214 }
2215 } else {
2216 # i dont know - bad line? ignore.
2217 emit_warning("${file}:$.", "bad line: $_");
2218 }
2219}
2220
2221
2222#
2223# STATE_PROTO: reading a function/whatever prototype.
2224#
2225sub process_proto($$) {
2226 my $file = shift;
2227
2228 if (/$doc_inline_oneline/) {
2229 $section = $1;
2230 $contents = $2;
2231 if ($contents ne "") {
2232 $contents .= "\n";
2233 dump_section($file, $section, $contents);
2234 $section = $section_default;
2235 $contents = "";
2236 }
2237 } elsif (/$doc_inline_start/) {
2238 $state = STATE_INLINE;
2239 $inline_doc_state = STATE_INLINE_NAME;
2240 } elsif ($decl_type eq 'function') {
2241 process_proto_function($_, $file);
2242 } else {
2243 process_proto_type($_, $file);
2244 }
2245}
2246
2247#
2248# STATE_DOCBLOCK: within a DOC: block.
2249#
2250sub process_docblock($$) {
2251 my $file = shift;
2252
2253 if (/$doc_end/) {
2254 dump_doc_section($file, $section, $contents);
2255 $section = $section_default;
2256 $contents = "";
2257 $function = "";
2258 %parameterdescs = ();
2259 %parametertypes = ();
2260 @parameterlist = ();
2261 %sections = ();
2262 @sectionlist = ();
2263 $prototype = "";
2264 $state = STATE_NORMAL;
2265 } elsif (/$doc_content/) {
2266 if ( $1 eq "" ) {
2267 $contents .= $blankline;
2268 } else {
2269 $contents .= $1 . "\n";
2270 }
2271 }
2272}
2273
2274#
2275# STATE_INLINE: docbook comments within a prototype.
2276#
2277sub process_inline($$) {
2278 my $file = shift;
2279
2280 # First line (state 1) needs to be a @parameter
2281 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2282 $section = $1;
2283 $contents = $2;
2284 $new_start_line = $.;
2285 if ($contents ne "") {
2286 while (substr($contents, 0, 1) eq " ") {
2287 $contents = substr($contents, 1);
2288 }
2289 $contents .= "\n";
2290 }
2291 $inline_doc_state = STATE_INLINE_TEXT;
2292 # Documentation block end */
2293 } elsif (/$doc_inline_end/) {
2294 if (($contents ne "") && ($contents ne "\n")) {
2295 dump_section($file, $section, $contents);
2296 $section = $section_default;
2297 $contents = "";
2298 }
2299 $state = STATE_PROTO;
2300 $inline_doc_state = STATE_INLINE_NA;
2301 # Regular text
2302 } elsif (/$doc_content/) {
2303 if ($inline_doc_state == STATE_INLINE_TEXT) {
2304 $contents .= $1 . "\n";
2305 # nuke leading blank lines
2306 if ($contents =~ /^\s*$/) {
2307 $contents = "";
2308 }
2309 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2310 $inline_doc_state = STATE_INLINE_ERROR;
2311 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
2312 }
2313 }
2314}
2315
2316
2317sub process_file($) {
2318 my $file;
2319 my $initial_section_counter = $section_counter;
2320 my ($orig_file) = @_;
2321
2322 $file = map_filename($orig_file);
2323
2324 if (!open(IN_FILE,"<$file")) {
2325 print STDERR "Error: Cannot open file $file\n";
2326 ++$errors;
2327 return;
2328 }
2329
2330 $. = 1;
2331
2332 $section_counter = 0;
2333 while (<IN_FILE>) {
2334 while (s/\\\s*$//) {
2335 $_ .= <IN_FILE>;
2336 }
2337 # Replace tabs by spaces
2338 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2339 # Hand this line to the appropriate state handler
2340 if ($state == STATE_NORMAL) {
2341 process_normal();
2342 } elsif ($state == STATE_NAME) {
2343 process_name($file, $_);
2344 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2345 $state == STATE_BODY_WITH_BLANK_LINE) {
2346 process_body($file, $_);
2347 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2348 process_inline($file, $_);
2349 } elsif ($state == STATE_PROTO) {
2350 process_proto($file, $_);
2351 } elsif ($state == STATE_DOCBLOCK) {
2352 process_docblock($file, $_);
2353 }
2354 }
2355
2356 # Make sure we got something interesting.
2357 if ($initial_section_counter == $section_counter && $
2358 output_mode ne "none") {
2359 if ($output_selection == OUTPUT_INCLUDE) {
2360 emit_warning("${file}:1", "'$_' not found\n")
2361 for keys %function_table;
2362 }
2363 else {
2364 emit_warning("${file}:1", "no structured comments found\n");
2365 }
2366 }
2367 close IN_FILE;
2368}
2369
2370
2371if ($output_mode eq "rst") {
2372 get_sphinx_version() if (!$sphinx_major);
2373}
2374
2375$kernelversion = get_kernel_version();
2376
2377# generate a sequence of code that will splice in highlighting information
2378# using the s// operator.
2379for (my $k = 0; $k < @highlights; $k++) {
2380 my $pattern = $highlights[$k][0];
2381 my $result = $highlights[$k][1];
2382# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2383 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2384}
2385
2386# Read the file that maps relative names to absolute names for
2387# separate source and object directories and for shadow trees.
2388if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2389 my ($relname, $absname);
2390 while(<SOURCE_MAP>) {
2391 chop();
2392 ($relname, $absname) = (split())[0..1];
2393 $relname =~ s:^/+::;
2394 $source_map{$relname} = $absname;
2395 }
2396 close(SOURCE_MAP);
2397}
2398
2399if ($output_selection == OUTPUT_EXPORTED ||
2400 $output_selection == OUTPUT_INTERNAL) {
2401
2402 push(@export_file_list, @ARGV);
2403
2404 foreach (@export_file_list) {
2405 chomp;
2406 process_export_file($_);
2407 }
2408}
2409
2410foreach (@ARGV) {
2411 chomp;
2412 process_file($_);
2413}
2414if ($verbose && $errors) {
2415 print STDERR "$errors errors\n";
2416}
2417if ($verbose && $warnings) {
2418 print STDERR "$warnings warnings\n";
2419}
2420
2421if ($Werror && $warnings) {
2422 print STDERR "$warnings warnings as Errors\n";
2423 exit($warnings);
2424} else {
2425 exit($output_mode eq "none" ? 0 : $errors)
2426}
2427
2428__END__
2429
2430=head1 OPTIONS
2431
2432=head2 Output format selection (mutually exclusive):
2433
2434=over 8
2435
2436=item -man
2437
2438Output troff manual page format.
2439
2440=item -rst
2441
2442Output reStructuredText format. This is the default.
2443
2444=item -none
2445
2446Do not output documentation, only warnings.
2447
2448=back
2449
2450=head2 Output format modifiers
2451
2452=head3 reStructuredText only
2453
2454=over 8
2455
2456=item -sphinx-version VERSION
2457
2458Use the ReST C domain dialect compatible with a specific Sphinx Version.
2459
2460If not specified, kernel-doc will auto-detect using the sphinx-build version
2461found on PATH.
2462
2463=back
2464
2465=head2 Output selection (mutually exclusive):
2466
2467=over 8
2468
2469=item -export
2470
2471Only output documentation for the symbols that have been exported using
2472EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2473
2474=item -internal
2475
2476Only output documentation for the symbols that have NOT been exported using
2477EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2478
2479=item -function NAME
2480
2481Only output documentation for the given function or DOC: section title.
2482All other functions and DOC: sections are ignored.
2483
2484May be specified multiple times.
2485
2486=item -nosymbol NAME
2487
2488Exclude the specified symbol from the output documentation.
2489
2490May be specified multiple times.
2491
2492=back
2493
2494=head2 Output selection modifiers:
2495
2496=over 8
2497
2498=item -no-doc-sections
2499
2500Do not output DOC: sections.
2501
2502=item -export-file FILE
2503
2504Specify an additional FILE in which to look for EXPORT_SYMBOL information.
2505
2506To be used with -export or -internal.
2507
2508May be specified multiple times.
2509
2510=back
2511
2512=head3 reStructuredText only
2513
2514=over 8
2515
2516=item -enable-lineno
2517
2518Enable output of .. LINENO lines.
2519
2520=back
2521
2522=head2 Other parameters:
2523
2524=over 8
2525
2526=item -h, -help
2527
2528Print this help.
2529
2530=item -v
2531
2532Verbose output, more warnings and other information.
2533
2534=item -Werror
2535
2536Treat warnings as errors.
2537
2538=back
2539
2540=cut
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3
4use warnings;
5use strict;
6
7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
9## Copyright (C) 2001 Simon Huggins ##
10## Copyright (C) 2005-2012 Randy Dunlap ##
11## Copyright (C) 2012 Dan Luedtke ##
12## ##
13## #define enhancements by Armin Kuster <akuster@mvista.com> ##
14## Copyright (c) 2000 MontaVista Software, Inc. ##
15## ##
16## This software falls under the GNU General Public License. ##
17## Please read the COPYING file for more information ##
18
19# 18/01/2001 - Cleanups
20# Functions prototyped as foo(void) same as foo()
21# Stop eval'ing where we don't need to.
22# -- huggie@earth.li
23
24# 27/06/2001 - Allowed whitespace after initial "/**" and
25# allowed comments before function declarations.
26# -- Christian Kreibich <ck@whoop.org>
27
28# Still to do:
29# - add perldoc documentation
30# - Look more closely at some of the scarier bits :)
31
32# 26/05/2001 - Support for separate source and object trees.
33# Return error code.
34# Keith Owens <kaos@ocs.com.au>
35
36# 23/09/2001 - Added support for typedefs, structs, enums and unions
37# Support for Context section; can be terminated using empty line
38# Small fixes (like spaces vs. \s in regex)
39# -- Tim Jansen <tim@tjansen.de>
40
41# 25/07/2012 - Added support for HTML5
42# -- Dan Luedtke <mail@danrl.de>
43
44sub usage {
45 my $message = <<"EOF";
46Usage: $0 [OPTION ...] FILE ...
47
48Read C language source or header FILEs, extract embedded documentation comments,
49and print formatted documentation to standard output.
50
51The documentation comments are identified by "/**" opening comment mark. See
52Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
53
54Output format selection (mutually exclusive):
55 -man Output troff manual page format. This is the default.
56 -rst Output reStructuredText format.
57 -none Do not output documentation, only warnings.
58
59Output format selection modifier (affects only ReST output):
60
61 -sphinx-version Use the ReST C domain dialect compatible with an
62 specific Sphinx Version.
63 If not specified, kernel-doc will auto-detect using
64 the sphinx-build version found on PATH.
65
66Output selection (mutually exclusive):
67 -export Only output documentation for symbols that have been
68 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
69 in any input FILE or -export-file FILE.
70 -internal Only output documentation for symbols that have NOT been
71 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
72 in any input FILE or -export-file FILE.
73 -function NAME Only output documentation for the given function(s)
74 or DOC: section title(s). All other functions and DOC:
75 sections are ignored. May be specified multiple times.
76 -nosymbol NAME Exclude the specified symbols from the output
77 documentation. May be specified multiple times.
78
79Output selection modifiers:
80 -no-doc-sections Do not output DOC: sections.
81 -enable-lineno Enable output of #define LINENO lines. Only works with
82 reStructuredText format.
83 -export-file FILE Specify an additional FILE in which to look for
84 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
85 -export or -internal. May be specified multiple times.
86
87Other parameters:
88 -v Verbose output, more warnings and other information.
89 -h Print this help.
90 -Werror Treat warnings as errors.
91
92EOF
93 print $message;
94 exit 1;
95}
96
97#
98# format of comments.
99# In the following table, (...)? signifies optional structure.
100# (...)* signifies 0 or more structure elements
101# /**
102# * function_name(:)? (- short description)?
103# (* @parameterx: (description of parameter x)?)*
104# (* a blank line)?
105# * (Description:)? (Description of function)?
106# * (section header: (section description)? )*
107# (*)?*/
108#
109# So .. the trivial example would be:
110#
111# /**
112# * my_function
113# */
114#
115# If the Description: header tag is omitted, then there must be a blank line
116# after the last parameter specification.
117# e.g.
118# /**
119# * my_function - does my stuff
120# * @my_arg: its mine damnit
121# *
122# * Does my stuff explained.
123# */
124#
125# or, could also use:
126# /**
127# * my_function - does my stuff
128# * @my_arg: its mine damnit
129# * Description: Does my stuff explained.
130# */
131# etc.
132#
133# Besides functions you can also write documentation for structs, unions,
134# enums and typedefs. Instead of the function name you must write the name
135# of the declaration; the struct/union/enum/typedef must always precede
136# the name. Nesting of declarations is not supported.
137# Use the argument mechanism to document members or constants.
138# e.g.
139# /**
140# * struct my_struct - short description
141# * @a: first member
142# * @b: second member
143# *
144# * Longer description
145# */
146# struct my_struct {
147# int a;
148# int b;
149# /* private: */
150# int c;
151# };
152#
153# All descriptions can be multiline, except the short function description.
154#
155# For really longs structs, you can also describe arguments inside the
156# body of the struct.
157# eg.
158# /**
159# * struct my_struct - short description
160# * @a: first member
161# * @b: second member
162# *
163# * Longer description
164# */
165# struct my_struct {
166# int a;
167# int b;
168# /**
169# * @c: This is longer description of C
170# *
171# * You can use paragraphs to describe arguments
172# * using this method.
173# */
174# int c;
175# };
176#
177# This should be use only for struct/enum members.
178#
179# You can also add additional sections. When documenting kernel functions you
180# should document the "Context:" of the function, e.g. whether the functions
181# can be called form interrupts. Unlike other sections you can end it with an
182# empty line.
183# A non-void function should have a "Return:" section describing the return
184# value(s).
185# Example-sections should contain the string EXAMPLE so that they are marked
186# appropriately in DocBook.
187#
188# Example:
189# /**
190# * user_function - function that can only be called in user context
191# * @a: some argument
192# * Context: !in_interrupt()
193# *
194# * Some description
195# * Example:
196# * user_function(22);
197# */
198# ...
199#
200#
201# All descriptive text is further processed, scanning for the following special
202# patterns, which are highlighted appropriately.
203#
204# 'funcname()' - function
205# '$ENVVAR' - environmental variable
206# '&struct_name' - name of a structure (up to two words including 'struct')
207# '&struct_name.member' - name of a structure member
208# '@parameter' - name of a parameter
209# '%CONST' - name of a constant.
210# '``LITERAL``' - literal string without any spaces on it.
211
212## init lots of data
213
214my $errors = 0;
215my $warnings = 0;
216my $anon_struct_union = 0;
217
218# match expressions used to find embedded type information
219my $type_constant = '\b``([^\`]+)``\b';
220my $type_constant2 = '\%([-_\w]+)';
221my $type_func = '(\w+)\(\)';
222my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
223my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
224my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
225my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
226my $type_env = '(\$\w+)';
227my $type_enum = '\&(enum\s*([_\w]+))';
228my $type_struct = '\&(struct\s*([_\w]+))';
229my $type_typedef = '\&(typedef\s*([_\w]+))';
230my $type_union = '\&(union\s*([_\w]+))';
231my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
232my $type_fallback = '\&([_\w]+)';
233my $type_member_func = $type_member . '\(\)';
234
235# Output conversion substitutions.
236# One for each output format
237
238# these are pretty rough
239my @highlights_man = (
240 [$type_constant, "\$1"],
241 [$type_constant2, "\$1"],
242 [$type_func, "\\\\fB\$1\\\\fP"],
243 [$type_enum, "\\\\fI\$1\\\\fP"],
244 [$type_struct, "\\\\fI\$1\\\\fP"],
245 [$type_typedef, "\\\\fI\$1\\\\fP"],
246 [$type_union, "\\\\fI\$1\\\\fP"],
247 [$type_param, "\\\\fI\$1\\\\fP"],
248 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
249 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
250 [$type_fallback, "\\\\fI\$1\\\\fP"]
251 );
252my $blankline_man = "";
253
254# rst-mode
255my @highlights_rst = (
256 [$type_constant, "``\$1``"],
257 [$type_constant2, "``\$1``"],
258 # Note: need to escape () to avoid func matching later
259 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
260 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
261 [$type_fp_param, "**\$1\\\\(\\\\)**"],
262 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
263 [$type_func, "\$1()"],
264 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
265 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
266 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
267 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
268 # in rst this can refer to any type
269 [$type_fallback, "\\:c\\:type\\:`\$1`"],
270 [$type_param_ref, "**\$1\$2**"]
271 );
272my $blankline_rst = "\n";
273
274# read arguments
275if ($#ARGV == -1) {
276 usage();
277}
278
279my $kernelversion;
280my ($sphinx_major, $sphinx_minor, $sphinx_patch);
281
282my $dohighlight = "";
283
284my $verbose = 0;
285my $Werror = 0;
286my $output_mode = "rst";
287my $output_preformatted = 0;
288my $no_doc_sections = 0;
289my $enable_lineno = 0;
290my @highlights = @highlights_rst;
291my $blankline = $blankline_rst;
292my $modulename = "Kernel API";
293
294use constant {
295 OUTPUT_ALL => 0, # output all symbols and doc sections
296 OUTPUT_INCLUDE => 1, # output only specified symbols
297 OUTPUT_EXPORTED => 2, # output exported symbols
298 OUTPUT_INTERNAL => 3, # output non-exported symbols
299};
300my $output_selection = OUTPUT_ALL;
301my $show_not_found = 0; # No longer used
302
303my @export_file_list;
304
305my @build_time;
306if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
307 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
308 @build_time = gmtime($seconds);
309} else {
310 @build_time = localtime;
311}
312
313my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
314 'July', 'August', 'September', 'October',
315 'November', 'December')[$build_time[4]] .
316 " " . ($build_time[5]+1900);
317
318# Essentially these are globals.
319# They probably want to be tidied up, made more localised or something.
320# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
321# could cause "use of undefined value" or other bugs.
322my ($function, %function_table, %parametertypes, $declaration_purpose);
323my %nosymbol_table = ();
324my $declaration_start_line;
325my ($type, $declaration_name, $return_type);
326my ($newsection, $newcontents, $prototype, $brcount, %source_map);
327
328if (defined($ENV{'KBUILD_VERBOSE'})) {
329 $verbose = "$ENV{'KBUILD_VERBOSE'}";
330}
331
332if (defined($ENV{'KDOC_WERROR'})) {
333 $Werror = "$ENV{'KDOC_WERROR'}";
334}
335
336if (defined($ENV{'KCFLAGS'})) {
337 my $kcflags = "$ENV{'KCFLAGS'}";
338
339 if ($kcflags =~ /Werror/) {
340 $Werror = 1;
341 }
342}
343
344# Generated docbook code is inserted in a template at a point where
345# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
346# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
347# We keep track of number of generated entries and generate a dummy
348# if needs be to ensure the expanded template can be postprocessed
349# into html.
350my $section_counter = 0;
351
352my $lineprefix="";
353
354# Parser states
355use constant {
356 STATE_NORMAL => 0, # normal code
357 STATE_NAME => 1, # looking for function name
358 STATE_BODY_MAYBE => 2, # body - or maybe more description
359 STATE_BODY => 3, # the body of the comment
360 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
361 STATE_PROTO => 5, # scanning prototype
362 STATE_DOCBLOCK => 6, # documentation block
363 STATE_INLINE => 7, # gathering doc outside main block
364};
365my $state;
366my $in_doc_sect;
367my $leading_space;
368
369# Inline documentation state
370use constant {
371 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
372 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
373 STATE_INLINE_TEXT => 2, # looking for member documentation
374 STATE_INLINE_END => 3, # done
375 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
376 # Spit a warning as it's not
377 # proper kernel-doc and ignore the rest.
378};
379my $inline_doc_state;
380
381#declaration types: can be
382# 'function', 'struct', 'union', 'enum', 'typedef'
383my $decl_type;
384
385# Name of the kernel-doc identifier for non-DOC markups
386my $identifier;
387
388my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
389my $doc_end = '\*/';
390my $doc_com = '\s*\*\s*';
391my $doc_com_body = '\s*\* ?';
392my $doc_decl = $doc_com . '(\w+)';
393# @params and a strictly limited set of supported section names
394# Specifically:
395# Match @word:
396# @...:
397# @{section-name}:
398# while trying to not match literal block starts like "example::"
399#
400my $doc_sect = $doc_com .
401 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
402my $doc_content = $doc_com_body . '(.*)';
403my $doc_block = $doc_com . 'DOC:\s*(.*)?';
404my $doc_inline_start = '^\s*/\*\*\s*$';
405my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
406my $doc_inline_end = '^\s*\*/\s*$';
407my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
408my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
409my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
410my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
411
412my %parameterdescs;
413my %parameterdesc_start_lines;
414my @parameterlist;
415my %sections;
416my @sectionlist;
417my %section_start_lines;
418my $sectcheck;
419my $struct_actual;
420
421my $contents = "";
422my $new_start_line = 0;
423
424# the canonical section names. see also $doc_sect above.
425my $section_default = "Description"; # default section
426my $section_intro = "Introduction";
427my $section = $section_default;
428my $section_context = "Context";
429my $section_return = "Return";
430
431my $undescribed = "-- undescribed --";
432
433reset_state();
434
435while ($ARGV[0] =~ m/^--?(.*)/) {
436 my $cmd = $1;
437 shift @ARGV;
438 if ($cmd eq "man") {
439 $output_mode = "man";
440 @highlights = @highlights_man;
441 $blankline = $blankline_man;
442 } elsif ($cmd eq "rst") {
443 $output_mode = "rst";
444 @highlights = @highlights_rst;
445 $blankline = $blankline_rst;
446 } elsif ($cmd eq "none") {
447 $output_mode = "none";
448 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
449 $modulename = shift @ARGV;
450 } elsif ($cmd eq "function") { # to only output specific functions
451 $output_selection = OUTPUT_INCLUDE;
452 $function = shift @ARGV;
453 $function_table{$function} = 1;
454 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
455 my $symbol = shift @ARGV;
456 $nosymbol_table{$symbol} = 1;
457 } elsif ($cmd eq "export") { # only exported symbols
458 $output_selection = OUTPUT_EXPORTED;
459 %function_table = ();
460 } elsif ($cmd eq "internal") { # only non-exported symbols
461 $output_selection = OUTPUT_INTERNAL;
462 %function_table = ();
463 } elsif ($cmd eq "export-file") {
464 my $file = shift @ARGV;
465 push(@export_file_list, $file);
466 } elsif ($cmd eq "v") {
467 $verbose = 1;
468 } elsif ($cmd eq "Werror") {
469 $Werror = 1;
470 } elsif (($cmd eq "h") || ($cmd eq "help")) {
471 usage();
472 } elsif ($cmd eq 'no-doc-sections') {
473 $no_doc_sections = 1;
474 } elsif ($cmd eq 'enable-lineno') {
475 $enable_lineno = 1;
476 } elsif ($cmd eq 'show-not-found') {
477 $show_not_found = 1; # A no-op but don't fail
478 } elsif ($cmd eq "sphinx-version") {
479 my $ver_string = shift @ARGV;
480 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
481 $sphinx_major = $1;
482 if (defined($2)) {
483 $sphinx_minor = substr($2,1);
484 } else {
485 $sphinx_minor = 0;
486 }
487 if (defined($3)) {
488 $sphinx_patch = substr($3,1)
489 } else {
490 $sphinx_patch = 0;
491 }
492 } else {
493 die "Sphinx version should either major.minor or major.minor.patch format\n";
494 }
495 } else {
496 # Unknown argument
497 usage();
498 }
499}
500
501# continue execution near EOF;
502
503# The C domain dialect changed on Sphinx 3. So, we need to check the
504# version in order to produce the right tags.
505sub findprog($)
506{
507 foreach(split(/:/, $ENV{PATH})) {
508 return "$_/$_[0]" if(-x "$_/$_[0]");
509 }
510}
511
512sub get_sphinx_version()
513{
514 my $ver;
515
516 my $cmd = "sphinx-build";
517 if (!findprog($cmd)) {
518 my $cmd = "sphinx-build3";
519 if (!findprog($cmd)) {
520 $sphinx_major = 1;
521 $sphinx_minor = 2;
522 $sphinx_patch = 0;
523 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
524 $sphinx_major, $sphinx_minor, $sphinx_patch;
525 return;
526 }
527 }
528
529 open IN, "$cmd --version 2>&1 |";
530 while (<IN>) {
531 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
532 $sphinx_major = $1;
533 $sphinx_minor = $2;
534 $sphinx_patch = $3;
535 last;
536 }
537 # Sphinx 1.2.x uses a different format
538 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
539 $sphinx_major = $1;
540 $sphinx_minor = $2;
541 $sphinx_patch = $3;
542 last;
543 }
544 }
545 close IN;
546}
547
548# get kernel version from env
549sub get_kernel_version() {
550 my $version = 'unknown kernel version';
551
552 if (defined($ENV{'KERNELVERSION'})) {
553 $version = $ENV{'KERNELVERSION'};
554 }
555 return $version;
556}
557
558#
559sub print_lineno {
560 my $lineno = shift;
561 if ($enable_lineno && defined($lineno)) {
562 print "#define LINENO " . $lineno . "\n";
563 }
564}
565##
566# dumps section contents to arrays/hashes intended for that purpose.
567#
568sub dump_section {
569 my $file = shift;
570 my $name = shift;
571 my $contents = join "\n", @_;
572
573 if ($name =~ m/$type_param/) {
574 $name = $1;
575 $parameterdescs{$name} = $contents;
576 $sectcheck = $sectcheck . $name . " ";
577 $parameterdesc_start_lines{$name} = $new_start_line;
578 $new_start_line = 0;
579 } elsif ($name eq "@\.\.\.") {
580 $name = "...";
581 $parameterdescs{$name} = $contents;
582 $sectcheck = $sectcheck . $name . " ";
583 $parameterdesc_start_lines{$name} = $new_start_line;
584 $new_start_line = 0;
585 } else {
586 if (defined($sections{$name}) && ($sections{$name} ne "")) {
587 # Only warn on user specified duplicate section names.
588 if ($name ne $section_default) {
589 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
590 ++$warnings;
591 }
592 $sections{$name} .= $contents;
593 } else {
594 $sections{$name} = $contents;
595 push @sectionlist, $name;
596 $section_start_lines{$name} = $new_start_line;
597 $new_start_line = 0;
598 }
599 }
600}
601
602##
603# dump DOC: section after checking that it should go out
604#
605sub dump_doc_section {
606 my $file = shift;
607 my $name = shift;
608 my $contents = join "\n", @_;
609
610 if ($no_doc_sections) {
611 return;
612 }
613
614 return if (defined($nosymbol_table{$name}));
615
616 if (($output_selection == OUTPUT_ALL) ||
617 (($output_selection == OUTPUT_INCLUDE) &&
618 defined($function_table{$name})))
619 {
620 dump_section($file, $name, $contents);
621 output_blockhead({'sectionlist' => \@sectionlist,
622 'sections' => \%sections,
623 'module' => $modulename,
624 'content-only' => ($output_selection != OUTPUT_ALL), });
625 }
626}
627
628##
629# output function
630#
631# parameterdescs, a hash.
632# function => "function name"
633# parameterlist => @list of parameters
634# parameterdescs => %parameter descriptions
635# sectionlist => @list of sections
636# sections => %section descriptions
637#
638
639sub output_highlight {
640 my $contents = join "\n",@_;
641 my $line;
642
643# DEBUG
644# if (!defined $contents) {
645# use Carp;
646# confess "output_highlight got called with no args?\n";
647# }
648
649# print STDERR "contents b4:$contents\n";
650 eval $dohighlight;
651 die $@ if $@;
652# print STDERR "contents af:$contents\n";
653
654 foreach $line (split "\n", $contents) {
655 if (! $output_preformatted) {
656 $line =~ s/^\s*//;
657 }
658 if ($line eq ""){
659 if (! $output_preformatted) {
660 print $lineprefix, $blankline;
661 }
662 } else {
663 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
664 print "\\&$line";
665 } else {
666 print $lineprefix, $line;
667 }
668 }
669 print "\n";
670 }
671}
672
673##
674# output function in man
675sub output_function_man(%) {
676 my %args = %{$_[0]};
677 my ($parameter, $section);
678 my $count;
679
680 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
681
682 print ".SH NAME\n";
683 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
684
685 print ".SH SYNOPSIS\n";
686 if ($args{'functiontype'} ne "") {
687 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
688 } else {
689 print ".B \"" . $args{'function'} . "\n";
690 }
691 $count = 0;
692 my $parenth = "(";
693 my $post = ",";
694 foreach my $parameter (@{$args{'parameterlist'}}) {
695 if ($count == $#{$args{'parameterlist'}}) {
696 $post = ");";
697 }
698 $type = $args{'parametertypes'}{$parameter};
699 if ($type =~ m/$function_pointer/) {
700 # pointer-to-function
701 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
702 } else {
703 $type =~ s/([^\*])$/$1 /;
704 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
705 }
706 $count++;
707 $parenth = "";
708 }
709
710 print ".SH ARGUMENTS\n";
711 foreach $parameter (@{$args{'parameterlist'}}) {
712 my $parameter_name = $parameter;
713 $parameter_name =~ s/\[.*//;
714
715 print ".IP \"" . $parameter . "\" 12\n";
716 output_highlight($args{'parameterdescs'}{$parameter_name});
717 }
718 foreach $section (@{$args{'sectionlist'}}) {
719 print ".SH \"", uc $section, "\"\n";
720 output_highlight($args{'sections'}{$section});
721 }
722}
723
724##
725# output enum in man
726sub output_enum_man(%) {
727 my %args = %{$_[0]};
728 my ($parameter, $section);
729 my $count;
730
731 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
732
733 print ".SH NAME\n";
734 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
735
736 print ".SH SYNOPSIS\n";
737 print "enum " . $args{'enum'} . " {\n";
738 $count = 0;
739 foreach my $parameter (@{$args{'parameterlist'}}) {
740 print ".br\n.BI \" $parameter\"\n";
741 if ($count == $#{$args{'parameterlist'}}) {
742 print "\n};\n";
743 last;
744 }
745 else {
746 print ", \n.br\n";
747 }
748 $count++;
749 }
750
751 print ".SH Constants\n";
752 foreach $parameter (@{$args{'parameterlist'}}) {
753 my $parameter_name = $parameter;
754 $parameter_name =~ s/\[.*//;
755
756 print ".IP \"" . $parameter . "\" 12\n";
757 output_highlight($args{'parameterdescs'}{$parameter_name});
758 }
759 foreach $section (@{$args{'sectionlist'}}) {
760 print ".SH \"$section\"\n";
761 output_highlight($args{'sections'}{$section});
762 }
763}
764
765##
766# output struct in man
767sub output_struct_man(%) {
768 my %args = %{$_[0]};
769 my ($parameter, $section);
770
771 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
772
773 print ".SH NAME\n";
774 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
775
776 my $declaration = $args{'definition'};
777 $declaration =~ s/\t/ /g;
778 $declaration =~ s/\n/"\n.br\n.BI \"/g;
779 print ".SH SYNOPSIS\n";
780 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
781 print ".BI \"$declaration\n};\n.br\n\n";
782
783 print ".SH Members\n";
784 foreach $parameter (@{$args{'parameterlist'}}) {
785 ($parameter =~ /^#/) && next;
786
787 my $parameter_name = $parameter;
788 $parameter_name =~ s/\[.*//;
789
790 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
791 print ".IP \"" . $parameter . "\" 12\n";
792 output_highlight($args{'parameterdescs'}{$parameter_name});
793 }
794 foreach $section (@{$args{'sectionlist'}}) {
795 print ".SH \"$section\"\n";
796 output_highlight($args{'sections'}{$section});
797 }
798}
799
800##
801# output typedef in man
802sub output_typedef_man(%) {
803 my %args = %{$_[0]};
804 my ($parameter, $section);
805
806 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
807
808 print ".SH NAME\n";
809 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
810
811 foreach $section (@{$args{'sectionlist'}}) {
812 print ".SH \"$section\"\n";
813 output_highlight($args{'sections'}{$section});
814 }
815}
816
817sub output_blockhead_man(%) {
818 my %args = %{$_[0]};
819 my ($parameter, $section);
820 my $count;
821
822 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
823
824 foreach $section (@{$args{'sectionlist'}}) {
825 print ".SH \"$section\"\n";
826 output_highlight($args{'sections'}{$section});
827 }
828}
829
830##
831# output in restructured text
832#
833
834#
835# This could use some work; it's used to output the DOC: sections, and
836# starts by putting out the name of the doc section itself, but that tends
837# to duplicate a header already in the template file.
838#
839sub output_blockhead_rst(%) {
840 my %args = %{$_[0]};
841 my ($parameter, $section);
842
843 foreach $section (@{$args{'sectionlist'}}) {
844 next if (defined($nosymbol_table{$section}));
845
846 if ($output_selection != OUTPUT_INCLUDE) {
847 print ".. _$section:\n\n";
848 print "**$section**\n\n";
849 }
850 print_lineno($section_start_lines{$section});
851 output_highlight_rst($args{'sections'}{$section});
852 print "\n";
853 }
854}
855
856#
857# Apply the RST highlights to a sub-block of text.
858#
859sub highlight_block($) {
860 # The dohighlight kludge requires the text be called $contents
861 my $contents = shift;
862 eval $dohighlight;
863 die $@ if $@;
864 return $contents;
865}
866
867#
868# Regexes used only here.
869#
870my $sphinx_literal = '^[^.].*::$';
871my $sphinx_cblock = '^\.\.\ +code-block::';
872
873sub output_highlight_rst {
874 my $input = join "\n",@_;
875 my $output = "";
876 my $line;
877 my $in_literal = 0;
878 my $litprefix;
879 my $block = "";
880
881 foreach $line (split "\n",$input) {
882 #
883 # If we're in a literal block, see if we should drop out
884 # of it. Otherwise pass the line straight through unmunged.
885 #
886 if ($in_literal) {
887 if (! ($line =~ /^\s*$/)) {
888 #
889 # If this is the first non-blank line in a literal
890 # block we need to figure out what the proper indent is.
891 #
892 if ($litprefix eq "") {
893 $line =~ /^(\s*)/;
894 $litprefix = '^' . $1;
895 $output .= $line . "\n";
896 } elsif (! ($line =~ /$litprefix/)) {
897 $in_literal = 0;
898 } else {
899 $output .= $line . "\n";
900 }
901 } else {
902 $output .= $line . "\n";
903 }
904 }
905 #
906 # Not in a literal block (or just dropped out)
907 #
908 if (! $in_literal) {
909 $block .= $line . "\n";
910 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
911 $in_literal = 1;
912 $litprefix = "";
913 $output .= highlight_block($block);
914 $block = ""
915 }
916 }
917 }
918
919 if ($block) {
920 $output .= highlight_block($block);
921 }
922 foreach $line (split "\n", $output) {
923 print $lineprefix . $line . "\n";
924 }
925}
926
927sub output_function_rst(%) {
928 my %args = %{$_[0]};
929 my ($parameter, $section);
930 my $oldprefix = $lineprefix;
931 my $start = "";
932 my $is_macro = 0;
933
934 if ($sphinx_major < 3) {
935 if ($args{'typedef'}) {
936 print ".. c:type:: ". $args{'function'} . "\n\n";
937 print_lineno($declaration_start_line);
938 print " **Typedef**: ";
939 $lineprefix = "";
940 output_highlight_rst($args{'purpose'});
941 $start = "\n\n**Syntax**\n\n ``";
942 $is_macro = 1;
943 } else {
944 print ".. c:function:: ";
945 }
946 } else {
947 if ($args{'typedef'} || $args{'functiontype'} eq "") {
948 $is_macro = 1;
949 print ".. c:macro:: ". $args{'function'} . "\n\n";
950 } else {
951 print ".. c:function:: ";
952 }
953
954 if ($args{'typedef'}) {
955 print_lineno($declaration_start_line);
956 print " **Typedef**: ";
957 $lineprefix = "";
958 output_highlight_rst($args{'purpose'});
959 $start = "\n\n**Syntax**\n\n ``";
960 } else {
961 print "``" if ($is_macro);
962 }
963 }
964 if ($args{'functiontype'} ne "") {
965 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
966 } else {
967 $start .= $args{'function'} . " (";
968 }
969 print $start;
970
971 my $count = 0;
972 foreach my $parameter (@{$args{'parameterlist'}}) {
973 if ($count ne 0) {
974 print ", ";
975 }
976 $count++;
977 $type = $args{'parametertypes'}{$parameter};
978
979 if ($type =~ m/$function_pointer/) {
980 # pointer-to-function
981 print $1 . $parameter . ") (" . $2 . ")";
982 } else {
983 print $type;
984 }
985 }
986 if ($is_macro) {
987 print ")``\n\n";
988 } else {
989 print ")\n\n";
990 }
991 if (!$args{'typedef'}) {
992 print_lineno($declaration_start_line);
993 $lineprefix = " ";
994 output_highlight_rst($args{'purpose'});
995 print "\n";
996 }
997
998 print "**Parameters**\n\n";
999 $lineprefix = " ";
1000 foreach $parameter (@{$args{'parameterlist'}}) {
1001 my $parameter_name = $parameter;
1002 $parameter_name =~ s/\[.*//;
1003 $type = $args{'parametertypes'}{$parameter};
1004
1005 if ($type ne "") {
1006 print "``$type``\n";
1007 } else {
1008 print "``$parameter``\n";
1009 }
1010
1011 print_lineno($parameterdesc_start_lines{$parameter_name});
1012
1013 if (defined($args{'parameterdescs'}{$parameter_name}) &&
1014 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
1015 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1016 } else {
1017 print " *undescribed*\n";
1018 }
1019 print "\n";
1020 }
1021
1022 $lineprefix = $oldprefix;
1023 output_section_rst(@_);
1024}
1025
1026sub output_section_rst(%) {
1027 my %args = %{$_[0]};
1028 my $section;
1029 my $oldprefix = $lineprefix;
1030 $lineprefix = "";
1031
1032 foreach $section (@{$args{'sectionlist'}}) {
1033 print "**$section**\n\n";
1034 print_lineno($section_start_lines{$section});
1035 output_highlight_rst($args{'sections'}{$section});
1036 print "\n";
1037 }
1038 print "\n";
1039 $lineprefix = $oldprefix;
1040}
1041
1042sub output_enum_rst(%) {
1043 my %args = %{$_[0]};
1044 my ($parameter);
1045 my $oldprefix = $lineprefix;
1046 my $count;
1047
1048 if ($sphinx_major < 3) {
1049 my $name = "enum " . $args{'enum'};
1050 print "\n\n.. c:type:: " . $name . "\n\n";
1051 } else {
1052 my $name = $args{'enum'};
1053 print "\n\n.. c:enum:: " . $name . "\n\n";
1054 }
1055 print_lineno($declaration_start_line);
1056 $lineprefix = " ";
1057 output_highlight_rst($args{'purpose'});
1058 print "\n";
1059
1060 print "**Constants**\n\n";
1061 $lineprefix = " ";
1062 foreach $parameter (@{$args{'parameterlist'}}) {
1063 print "``$parameter``\n";
1064 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1065 output_highlight_rst($args{'parameterdescs'}{$parameter});
1066 } else {
1067 print " *undescribed*\n";
1068 }
1069 print "\n";
1070 }
1071
1072 $lineprefix = $oldprefix;
1073 output_section_rst(@_);
1074}
1075
1076sub output_typedef_rst(%) {
1077 my %args = %{$_[0]};
1078 my ($parameter);
1079 my $oldprefix = $lineprefix;
1080 my $name;
1081
1082 if ($sphinx_major < 3) {
1083 $name = "typedef " . $args{'typedef'};
1084 } else {
1085 $name = $args{'typedef'};
1086 }
1087 print "\n\n.. c:type:: " . $name . "\n\n";
1088 print_lineno($declaration_start_line);
1089 $lineprefix = " ";
1090 output_highlight_rst($args{'purpose'});
1091 print "\n";
1092
1093 $lineprefix = $oldprefix;
1094 output_section_rst(@_);
1095}
1096
1097sub output_struct_rst(%) {
1098 my %args = %{$_[0]};
1099 my ($parameter);
1100 my $oldprefix = $lineprefix;
1101
1102 if ($sphinx_major < 3) {
1103 my $name = $args{'type'} . " " . $args{'struct'};
1104 print "\n\n.. c:type:: " . $name . "\n\n";
1105 } else {
1106 my $name = $args{'struct'};
1107 if ($args{'type'} eq 'union') {
1108 print "\n\n.. c:union:: " . $name . "\n\n";
1109 } else {
1110 print "\n\n.. c:struct:: " . $name . "\n\n";
1111 }
1112 }
1113 print_lineno($declaration_start_line);
1114 $lineprefix = " ";
1115 output_highlight_rst($args{'purpose'});
1116 print "\n";
1117
1118 print "**Definition**\n\n";
1119 print "::\n\n";
1120 my $declaration = $args{'definition'};
1121 $declaration =~ s/\t/ /g;
1122 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n";
1123
1124 print "**Members**\n\n";
1125 $lineprefix = " ";
1126 foreach $parameter (@{$args{'parameterlist'}}) {
1127 ($parameter =~ /^#/) && next;
1128
1129 my $parameter_name = $parameter;
1130 $parameter_name =~ s/\[.*//;
1131
1132 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1133 $type = $args{'parametertypes'}{$parameter};
1134 print_lineno($parameterdesc_start_lines{$parameter_name});
1135 print "``" . $parameter . "``\n";
1136 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1137 print "\n";
1138 }
1139 print "\n";
1140
1141 $lineprefix = $oldprefix;
1142 output_section_rst(@_);
1143}
1144
1145## none mode output functions
1146
1147sub output_function_none(%) {
1148}
1149
1150sub output_enum_none(%) {
1151}
1152
1153sub output_typedef_none(%) {
1154}
1155
1156sub output_struct_none(%) {
1157}
1158
1159sub output_blockhead_none(%) {
1160}
1161
1162##
1163# generic output function for all types (function, struct/union, typedef, enum);
1164# calls the generated, variable output_ function name based on
1165# functype and output_mode
1166sub output_declaration {
1167 no strict 'refs';
1168 my $name = shift;
1169 my $functype = shift;
1170 my $func = "output_${functype}_$output_mode";
1171
1172 return if (defined($nosymbol_table{$name}));
1173
1174 if (($output_selection == OUTPUT_ALL) ||
1175 (($output_selection == OUTPUT_INCLUDE ||
1176 $output_selection == OUTPUT_EXPORTED) &&
1177 defined($function_table{$name})) ||
1178 ($output_selection == OUTPUT_INTERNAL &&
1179 !($functype eq "function" && defined($function_table{$name}))))
1180 {
1181 &$func(@_);
1182 $section_counter++;
1183 }
1184}
1185
1186##
1187# generic output function - calls the right one based on current output mode.
1188sub output_blockhead {
1189 no strict 'refs';
1190 my $func = "output_blockhead_" . $output_mode;
1191 &$func(@_);
1192 $section_counter++;
1193}
1194
1195##
1196# takes a declaration (struct, union, enum, typedef) and
1197# invokes the right handler. NOT called for functions.
1198sub dump_declaration($$) {
1199 no strict 'refs';
1200 my ($prototype, $file) = @_;
1201 my $func = "dump_" . $decl_type;
1202 &$func(@_);
1203}
1204
1205sub dump_union($$) {
1206 dump_struct(@_);
1207}
1208
1209sub dump_struct($$) {
1210 my $x = shift;
1211 my $file = shift;
1212 my $decl_type;
1213 my $members;
1214 my $type = qr{struct|union};
1215 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
1216 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1217 my $definition_body = qr{\{(.*)\}\s*$qualifiers*};
1218 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1219
1220 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1221 $decl_type = $1;
1222 $declaration_name = $2;
1223 $members = $3;
1224 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1225 $decl_type = $1;
1226 $declaration_name = $3;
1227 $members = $2;
1228 }
1229
1230 if ($members) {
1231 if ($identifier ne $declaration_name) {
1232 print STDERR "${file}:$.: warning: expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n";
1233 return;
1234 }
1235
1236 # ignore members marked private:
1237 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1238 $members =~ s/\/\*\s*private:.*//gosi;
1239 # strip comments:
1240 $members =~ s/\/\*.*?\*\///gos;
1241 # strip attributes
1242 $members =~ s/\s*$attribute/ /gi;
1243 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1244 $members =~ s/\s*__packed\s*/ /gos;
1245 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1246 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1247 $members =~ s/\s*____cacheline_aligned/ /gos;
1248
1249 my $args = qr{([^,)]+)};
1250 # replace DECLARE_BITMAP
1251 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1252 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1253 # replace DECLARE_HASHTABLE
1254 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1255 # replace DECLARE_KFIFO
1256 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1257 # replace DECLARE_KFIFO_PTR
1258 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1259 my $declaration = $members;
1260
1261 # Split nested struct/union elements as newer ones
1262 while ($members =~ m/$struct_members/) {
1263 my $newmember;
1264 my $maintype = $1;
1265 my $ids = $4;
1266 my $content = $3;
1267 foreach my $id(split /,/, $ids) {
1268 $newmember .= "$maintype $id; ";
1269
1270 $id =~ s/[:\[].*//;
1271 $id =~ s/^\s*\**(\S+)\s*/$1/;
1272 foreach my $arg (split /;/, $content) {
1273 next if ($arg =~ m/^\s*$/);
1274 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1275 # pointer-to-function
1276 my $type = $1;
1277 my $name = $2;
1278 my $extra = $3;
1279 next if (!$name);
1280 if ($id =~ m/^\s*$/) {
1281 # anonymous struct/union
1282 $newmember .= "$type$name$extra; ";
1283 } else {
1284 $newmember .= "$type$id.$name$extra; ";
1285 }
1286 } else {
1287 my $type;
1288 my $names;
1289 $arg =~ s/^\s+//;
1290 $arg =~ s/\s+$//;
1291 # Handle bitmaps
1292 $arg =~ s/:\s*\d+\s*//g;
1293 # Handle arrays
1294 $arg =~ s/\[.*\]//g;
1295 # The type may have multiple words,
1296 # and multiple IDs can be defined, like:
1297 # const struct foo, *bar, foobar
1298 # So, we remove spaces when parsing the
1299 # names, in order to match just names
1300 # and commas for the names
1301 $arg =~ s/\s*,\s*/,/g;
1302 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1303 $type = $1;
1304 $names = $2;
1305 } else {
1306 $newmember .= "$arg; ";
1307 next;
1308 }
1309 foreach my $name (split /,/, $names) {
1310 $name =~ s/^\s*\**(\S+)\s*/$1/;
1311 next if (($name =~ m/^\s*$/));
1312 if ($id =~ m/^\s*$/) {
1313 # anonymous struct/union
1314 $newmember .= "$type $name; ";
1315 } else {
1316 $newmember .= "$type $id.$name; ";
1317 }
1318 }
1319 }
1320 }
1321 }
1322 $members =~ s/$struct_members/$newmember/;
1323 }
1324
1325 # Ignore other nested elements, like enums
1326 $members =~ s/(\{[^\{\}]*\})//g;
1327
1328 create_parameterlist($members, ';', $file, $declaration_name);
1329 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1330
1331 # Adjust declaration for better display
1332 $declaration =~ s/([\{;])/$1\n/g;
1333 $declaration =~ s/\}\s+;/};/g;
1334 # Better handle inlined enums
1335 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1336
1337 my @def_args = split /\n/, $declaration;
1338 my $level = 1;
1339 $declaration = "";
1340 foreach my $clause (@def_args) {
1341 $clause =~ s/^\s+//;
1342 $clause =~ s/\s+$//;
1343 $clause =~ s/\s+/ /;
1344 next if (!$clause);
1345 $level-- if ($clause =~ m/(\})/ && $level > 1);
1346 if (!($clause =~ m/^\s*#/)) {
1347 $declaration .= "\t" x $level;
1348 }
1349 $declaration .= "\t" . $clause . "\n";
1350 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1351 }
1352 output_declaration($declaration_name,
1353 'struct',
1354 {'struct' => $declaration_name,
1355 'module' => $modulename,
1356 'definition' => $declaration,
1357 'parameterlist' => \@parameterlist,
1358 'parameterdescs' => \%parameterdescs,
1359 'parametertypes' => \%parametertypes,
1360 'sectionlist' => \@sectionlist,
1361 'sections' => \%sections,
1362 'purpose' => $declaration_purpose,
1363 'type' => $decl_type
1364 });
1365 }
1366 else {
1367 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1368 ++$errors;
1369 }
1370}
1371
1372
1373sub show_warnings($$) {
1374 my $functype = shift;
1375 my $name = shift;
1376
1377 return 0 if (defined($nosymbol_table{$name}));
1378
1379 return 1 if ($output_selection == OUTPUT_ALL);
1380
1381 if ($output_selection == OUTPUT_EXPORTED) {
1382 if (defined($function_table{$name})) {
1383 return 1;
1384 } else {
1385 return 0;
1386 }
1387 }
1388 if ($output_selection == OUTPUT_INTERNAL) {
1389 if (!($functype eq "function" && defined($function_table{$name}))) {
1390 return 1;
1391 } else {
1392 return 0;
1393 }
1394 }
1395 if ($output_selection == OUTPUT_INCLUDE) {
1396 if (defined($function_table{$name})) {
1397 return 1;
1398 } else {
1399 return 0;
1400 }
1401 }
1402 die("Please add the new output type at show_warnings()");
1403}
1404
1405sub dump_enum($$) {
1406 my $x = shift;
1407 my $file = shift;
1408 my $members;
1409
1410
1411 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1412 # strip #define macros inside enums
1413 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1414
1415 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1416 $declaration_name = $2;
1417 $members = $1;
1418 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1419 $declaration_name = $1;
1420 $members = $2;
1421 }
1422
1423 if ($members) {
1424 if ($identifier ne $declaration_name) {
1425 if ($identifier eq "") {
1426 print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n";
1427 } else {
1428 print STDERR "${file}:$.: warning: expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n";
1429 }
1430 return;
1431 }
1432 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1433
1434 my %_members;
1435
1436 $members =~ s/\s+$//;
1437
1438 foreach my $arg (split ',', $members) {
1439 $arg =~ s/^\s*(\w+).*/$1/;
1440 push @parameterlist, $arg;
1441 if (!$parameterdescs{$arg}) {
1442 $parameterdescs{$arg} = $undescribed;
1443 if (show_warnings("enum", $declaration_name)) {
1444 print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1445 }
1446 }
1447 $_members{$arg} = 1;
1448 }
1449
1450 while (my ($k, $v) = each %parameterdescs) {
1451 if (!exists($_members{$k})) {
1452 if (show_warnings("enum", $declaration_name)) {
1453 print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1454 }
1455 }
1456 }
1457
1458 output_declaration($declaration_name,
1459 'enum',
1460 {'enum' => $declaration_name,
1461 'module' => $modulename,
1462 'parameterlist' => \@parameterlist,
1463 'parameterdescs' => \%parameterdescs,
1464 'sectionlist' => \@sectionlist,
1465 'sections' => \%sections,
1466 'purpose' => $declaration_purpose
1467 });
1468 } else {
1469 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1470 ++$errors;
1471 }
1472}
1473
1474my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1475my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1476my $typedef_args = qr { \s*\((.*)\); }x;
1477
1478my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1479my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1480
1481sub dump_typedef($$) {
1482 my $x = shift;
1483 my $file = shift;
1484
1485 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1486
1487 # Parse function typedef prototypes
1488 if ($x =~ $typedef1 || $x =~ $typedef2) {
1489 $return_type = $1;
1490 $declaration_name = $2;
1491 my $args = $3;
1492 $return_type =~ s/^\s+//;
1493
1494 if ($identifier ne $declaration_name) {
1495 print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n";
1496 return;
1497 }
1498
1499 create_parameterlist($args, ',', $file, $declaration_name);
1500
1501 output_declaration($declaration_name,
1502 'function',
1503 {'function' => $declaration_name,
1504 'typedef' => 1,
1505 'module' => $modulename,
1506 'functiontype' => $return_type,
1507 'parameterlist' => \@parameterlist,
1508 'parameterdescs' => \%parameterdescs,
1509 'parametertypes' => \%parametertypes,
1510 'sectionlist' => \@sectionlist,
1511 'sections' => \%sections,
1512 'purpose' => $declaration_purpose
1513 });
1514 return;
1515 }
1516
1517 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1518 $x =~ s/\(*.\)\s*;$/;/;
1519 $x =~ s/\[*.\]\s*;$/;/;
1520 }
1521
1522 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1523 $declaration_name = $1;
1524
1525 if ($identifier ne $declaration_name) {
1526 print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n";
1527 return;
1528 }
1529
1530 output_declaration($declaration_name,
1531 'typedef',
1532 {'typedef' => $declaration_name,
1533 'module' => $modulename,
1534 'sectionlist' => \@sectionlist,
1535 'sections' => \%sections,
1536 'purpose' => $declaration_purpose
1537 });
1538 }
1539 else {
1540 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1541 ++$errors;
1542 }
1543}
1544
1545sub save_struct_actual($) {
1546 my $actual = shift;
1547
1548 # strip all spaces from the actual param so that it looks like one string item
1549 $actual =~ s/\s*//g;
1550 $struct_actual = $struct_actual . $actual . " ";
1551}
1552
1553sub create_parameterlist($$$$) {
1554 my $args = shift;
1555 my $splitter = shift;
1556 my $file = shift;
1557 my $declaration_name = shift;
1558 my $type;
1559 my $param;
1560
1561 # temporarily replace commas inside function pointer definition
1562 my $arg_expr = qr{\([^\),]+};
1563 while ($args =~ /$arg_expr,/) {
1564 $args =~ s/($arg_expr),/$1#/g;
1565 }
1566
1567 foreach my $arg (split($splitter, $args)) {
1568 # strip comments
1569 $arg =~ s/\/\*.*\*\///;
1570 # strip leading/trailing spaces
1571 $arg =~ s/^\s*//;
1572 $arg =~ s/\s*$//;
1573 $arg =~ s/\s+/ /;
1574
1575 if ($arg =~ /^#/) {
1576 # Treat preprocessor directive as a typeless variable just to fill
1577 # corresponding data structures "correctly". Catch it later in
1578 # output_* subs.
1579 push_parameter($arg, "", "", $file);
1580 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1581 # pointer-to-function
1582 $arg =~ tr/#/,/;
1583 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1584 $param = $1;
1585 $type = $arg;
1586 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1587 save_struct_actual($param);
1588 push_parameter($param, $type, $arg, $file, $declaration_name);
1589 } elsif ($arg) {
1590 $arg =~ s/\s*:\s*/:/g;
1591 $arg =~ s/\s*\[/\[/g;
1592
1593 my @args = split('\s*,\s*', $arg);
1594 if ($args[0] =~ m/\*/) {
1595 $args[0] =~ s/(\*+)\s*/ $1/;
1596 }
1597
1598 my @first_arg;
1599 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1600 shift @args;
1601 push(@first_arg, split('\s+', $1));
1602 push(@first_arg, $2);
1603 } else {
1604 @first_arg = split('\s+', shift @args);
1605 }
1606
1607 unshift(@args, pop @first_arg);
1608 $type = join " ", @first_arg;
1609
1610 foreach $param (@args) {
1611 if ($param =~ m/^(\*+)\s*(.*)/) {
1612 save_struct_actual($2);
1613
1614 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1615 }
1616 elsif ($param =~ m/(.*?):(\d+)/) {
1617 if ($type ne "") { # skip unnamed bit-fields
1618 save_struct_actual($1);
1619 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1620 }
1621 }
1622 else {
1623 save_struct_actual($param);
1624 push_parameter($param, $type, $arg, $file, $declaration_name);
1625 }
1626 }
1627 }
1628 }
1629}
1630
1631sub push_parameter($$$$$) {
1632 my $param = shift;
1633 my $type = shift;
1634 my $org_arg = shift;
1635 my $file = shift;
1636 my $declaration_name = shift;
1637
1638 if (($anon_struct_union == 1) && ($type eq "") &&
1639 ($param eq "}")) {
1640 return; # ignore the ending }; from anon. struct/union
1641 }
1642
1643 $anon_struct_union = 0;
1644 $param =~ s/[\[\)].*//;
1645
1646 if ($type eq "" && $param =~ /\.\.\.$/)
1647 {
1648 if (!$param =~ /\w\.\.\.$/) {
1649 # handles unnamed variable parameters
1650 $param = "...";
1651 }
1652 elsif ($param =~ /\w\.\.\.$/) {
1653 # for named variable parameters of the form `x...`, remove the dots
1654 $param =~ s/\.\.\.$//;
1655 }
1656 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1657 $parameterdescs{$param} = "variable arguments";
1658 }
1659 }
1660 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1661 {
1662 $param="void";
1663 $parameterdescs{void} = "no arguments";
1664 }
1665 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1666 # handle unnamed (anonymous) union or struct:
1667 {
1668 $type = $param;
1669 $param = "{unnamed_" . $param . "}";
1670 $parameterdescs{$param} = "anonymous\n";
1671 $anon_struct_union = 1;
1672 }
1673
1674 # warn if parameter has no description
1675 # (but ignore ones starting with # as these are not parameters
1676 # but inline preprocessor statements);
1677 # Note: It will also ignore void params and unnamed structs/unions
1678 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1679 $parameterdescs{$param} = $undescribed;
1680
1681 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1682 print STDERR
1683 "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1684 ++$warnings;
1685 }
1686 }
1687
1688 # strip spaces from $param so that it is one continuous string
1689 # on @parameterlist;
1690 # this fixes a problem where check_sections() cannot find
1691 # a parameter like "addr[6 + 2]" because it actually appears
1692 # as "addr[6", "+", "2]" on the parameter list;
1693 # but it's better to maintain the param string unchanged for output,
1694 # so just weaken the string compare in check_sections() to ignore
1695 # "[blah" in a parameter string;
1696 ###$param =~ s/\s*//g;
1697 push @parameterlist, $param;
1698 $org_arg =~ s/\s\s+/ /g;
1699 $parametertypes{$param} = $org_arg;
1700}
1701
1702sub check_sections($$$$$) {
1703 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1704 my @sects = split ' ', $sectcheck;
1705 my @prms = split ' ', $prmscheck;
1706 my $err;
1707 my ($px, $sx);
1708 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1709
1710 foreach $sx (0 .. $#sects) {
1711 $err = 1;
1712 foreach $px (0 .. $#prms) {
1713 $prm_clean = $prms[$px];
1714 $prm_clean =~ s/\[.*\]//;
1715 $prm_clean =~ s/$attribute//i;
1716 # ignore array size in a parameter string;
1717 # however, the original param string may contain
1718 # spaces, e.g.: addr[6 + 2]
1719 # and this appears in @prms as "addr[6" since the
1720 # parameter list is split at spaces;
1721 # hence just ignore "[..." for the sections check;
1722 $prm_clean =~ s/\[.*//;
1723
1724 ##$prm_clean =~ s/^\**//;
1725 if ($prm_clean eq $sects[$sx]) {
1726 $err = 0;
1727 last;
1728 }
1729 }
1730 if ($err) {
1731 if ($decl_type eq "function") {
1732 print STDERR "${file}:$.: warning: " .
1733 "Excess function parameter " .
1734 "'$sects[$sx]' " .
1735 "description in '$decl_name'\n";
1736 ++$warnings;
1737 }
1738 }
1739 }
1740}
1741
1742##
1743# Checks the section describing the return value of a function.
1744sub check_return_section {
1745 my $file = shift;
1746 my $declaration_name = shift;
1747 my $return_type = shift;
1748
1749 # Ignore an empty return type (It's a macro)
1750 # Ignore functions with a "void" return type. (But don't ignore "void *")
1751 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1752 return;
1753 }
1754
1755 if (!defined($sections{$section_return}) ||
1756 $sections{$section_return} eq "") {
1757 print STDERR "${file}:$.: warning: " .
1758 "No description found for return value of " .
1759 "'$declaration_name'\n";
1760 ++$warnings;
1761 }
1762}
1763
1764##
1765# takes a function prototype and the name of the current file being
1766# processed and spits out all the details stored in the global
1767# arrays/hashes.
1768sub dump_function($$) {
1769 my $prototype = shift;
1770 my $file = shift;
1771 my $noret = 0;
1772
1773 print_lineno($new_start_line);
1774
1775 $prototype =~ s/^static +//;
1776 $prototype =~ s/^extern +//;
1777 $prototype =~ s/^asmlinkage +//;
1778 $prototype =~ s/^inline +//;
1779 $prototype =~ s/^__inline__ +//;
1780 $prototype =~ s/^__inline +//;
1781 $prototype =~ s/^__always_inline +//;
1782 $prototype =~ s/^noinline +//;
1783 $prototype =~ s/__init +//;
1784 $prototype =~ s/__init_or_module +//;
1785 $prototype =~ s/__deprecated +//;
1786 $prototype =~ s/__flatten +//;
1787 $prototype =~ s/__meminit +//;
1788 $prototype =~ s/__must_check +//;
1789 $prototype =~ s/__weak +//;
1790 $prototype =~ s/__sched +//;
1791 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1792 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1793 $prototype =~ s/__attribute_const__ +//;
1794 $prototype =~ s/__attribute__\s*\(\(
1795 (?:
1796 [\w\s]++ # attribute name
1797 (?:\([^)]*+\))? # attribute arguments
1798 \s*+,? # optional comma at the end
1799 )+
1800 \)\)\s+//x;
1801
1802 # Yes, this truly is vile. We are looking for:
1803 # 1. Return type (may be nothing if we're looking at a macro)
1804 # 2. Function name
1805 # 3. Function parameters.
1806 #
1807 # All the while we have to watch out for function pointer parameters
1808 # (which IIRC is what the two sections are for), C types (these
1809 # regexps don't even start to express all the possibilities), and
1810 # so on.
1811 #
1812 # If you mess with these regexps, it's a good idea to check that
1813 # the following functions' documentation still comes out right:
1814 # - parport_register_device (function pointer parameters)
1815 # - atomic_set (macro)
1816 # - pci_match_device, __copy_to_user (long return type)
1817 my $name = qr{[a-zA-Z0-9_~:]+};
1818 my $prototype_end1 = qr{[^\(]*};
1819 my $prototype_end2 = qr{[^\{]*};
1820 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1821 my $type1 = qr{[\w\s]+};
1822 my $type2 = qr{$type1\*+};
1823
1824 if ($define && $prototype =~ m/^()($name)\s+/) {
1825 # This is an object-like macro, it has no return type and no parameter
1826 # list.
1827 # Function-like macros are not allowed to have spaces between
1828 # declaration_name and opening parenthesis (notice the \s+).
1829 $return_type = $1;
1830 $declaration_name = $2;
1831 $noret = 1;
1832 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1833 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1834 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1835 $return_type = $1;
1836 $declaration_name = $2;
1837 my $args = $3;
1838
1839 create_parameterlist($args, ',', $file, $declaration_name);
1840 } else {
1841 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1842 return;
1843 }
1844
1845 if ($identifier ne $declaration_name) {
1846 print STDERR "${file}:$.: warning: expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n";
1847 return;
1848 }
1849
1850 my $prms = join " ", @parameterlist;
1851 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1852
1853 # This check emits a lot of warnings at the moment, because many
1854 # functions don't have a 'Return' doc section. So until the number
1855 # of warnings goes sufficiently down, the check is only performed in
1856 # verbose mode.
1857 # TODO: always perform the check.
1858 if ($verbose && !$noret) {
1859 check_return_section($file, $declaration_name, $return_type);
1860 }
1861
1862 # The function parser can be called with a typedef parameter.
1863 # Handle it.
1864 if ($return_type =~ /typedef/) {
1865 output_declaration($declaration_name,
1866 'function',
1867 {'function' => $declaration_name,
1868 'typedef' => 1,
1869 'module' => $modulename,
1870 'functiontype' => $return_type,
1871 'parameterlist' => \@parameterlist,
1872 'parameterdescs' => \%parameterdescs,
1873 'parametertypes' => \%parametertypes,
1874 'sectionlist' => \@sectionlist,
1875 'sections' => \%sections,
1876 'purpose' => $declaration_purpose
1877 });
1878 } else {
1879 output_declaration($declaration_name,
1880 'function',
1881 {'function' => $declaration_name,
1882 'module' => $modulename,
1883 'functiontype' => $return_type,
1884 'parameterlist' => \@parameterlist,
1885 'parameterdescs' => \%parameterdescs,
1886 'parametertypes' => \%parametertypes,
1887 'sectionlist' => \@sectionlist,
1888 'sections' => \%sections,
1889 'purpose' => $declaration_purpose
1890 });
1891 }
1892}
1893
1894sub reset_state {
1895 $function = "";
1896 %parameterdescs = ();
1897 %parametertypes = ();
1898 @parameterlist = ();
1899 %sections = ();
1900 @sectionlist = ();
1901 $sectcheck = "";
1902 $struct_actual = "";
1903 $prototype = "";
1904
1905 $state = STATE_NORMAL;
1906 $inline_doc_state = STATE_INLINE_NA;
1907}
1908
1909sub tracepoint_munge($) {
1910 my $file = shift;
1911 my $tracepointname = 0;
1912 my $tracepointargs = 0;
1913
1914 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1915 $tracepointname = $1;
1916 }
1917 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1918 $tracepointname = $1;
1919 }
1920 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1921 $tracepointname = $2;
1922 }
1923 $tracepointname =~ s/^\s+//; #strip leading whitespace
1924 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1925 $tracepointargs = $1;
1926 }
1927 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1928 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1929 "$prototype\n";
1930 } else {
1931 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1932 $identifier = "trace_$identifier";
1933 }
1934}
1935
1936sub syscall_munge() {
1937 my $void = 0;
1938
1939 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1940## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1941 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1942 $void = 1;
1943## $prototype = "long sys_$1(void)";
1944 }
1945
1946 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1947 if ($prototype =~ m/long (sys_.*?),/) {
1948 $prototype =~ s/,/\(/;
1949 } elsif ($void) {
1950 $prototype =~ s/\)/\(void\)/;
1951 }
1952
1953 # now delete all of the odd-number commas in $prototype
1954 # so that arg types & arg names don't have a comma between them
1955 my $count = 0;
1956 my $len = length($prototype);
1957 if ($void) {
1958 $len = 0; # skip the for-loop
1959 }
1960 for (my $ix = 0; $ix < $len; $ix++) {
1961 if (substr($prototype, $ix, 1) eq ',') {
1962 $count++;
1963 if ($count % 2 == 1) {
1964 substr($prototype, $ix, 1) = ' ';
1965 }
1966 }
1967 }
1968}
1969
1970sub process_proto_function($$) {
1971 my $x = shift;
1972 my $file = shift;
1973
1974 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1975
1976 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1977 # do nothing
1978 }
1979 elsif ($x =~ /([^\{]*)/) {
1980 $prototype .= $1;
1981 }
1982
1983 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1984 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1985 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1986 $prototype =~ s@^\s+@@gos; # strip leading spaces
1987
1988 # Handle prototypes for function pointers like:
1989 # int (*pcs_config)(struct foo)
1990 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1991
1992 if ($prototype =~ /SYSCALL_DEFINE/) {
1993 syscall_munge();
1994 }
1995 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1996 $prototype =~ /DEFINE_SINGLE_EVENT/)
1997 {
1998 tracepoint_munge($file);
1999 }
2000 dump_function($prototype, $file);
2001 reset_state();
2002 }
2003}
2004
2005sub process_proto_type($$) {
2006 my $x = shift;
2007 my $file = shift;
2008
2009 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
2010 $x =~ s@^\s+@@gos; # strip leading spaces
2011 $x =~ s@\s+$@@gos; # strip trailing spaces
2012 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
2013
2014 if ($x =~ /^#/) {
2015 # To distinguish preprocessor directive from regular declaration later.
2016 $x .= ";";
2017 }
2018
2019 while (1) {
2020 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
2021 if( length $prototype ) {
2022 $prototype .= " "
2023 }
2024 $prototype .= $1 . $2;
2025 ($2 eq '{') && $brcount++;
2026 ($2 eq '}') && $brcount--;
2027 if (($2 eq ';') && ($brcount == 0)) {
2028 dump_declaration($prototype, $file);
2029 reset_state();
2030 last;
2031 }
2032 $x = $3;
2033 } else {
2034 $prototype .= $x;
2035 last;
2036 }
2037 }
2038}
2039
2040
2041sub map_filename($) {
2042 my $file;
2043 my ($orig_file) = @_;
2044
2045 if (defined($ENV{'SRCTREE'})) {
2046 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
2047 } else {
2048 $file = $orig_file;
2049 }
2050
2051 if (defined($source_map{$file})) {
2052 $file = $source_map{$file};
2053 }
2054
2055 return $file;
2056}
2057
2058sub process_export_file($) {
2059 my ($orig_file) = @_;
2060 my $file = map_filename($orig_file);
2061
2062 if (!open(IN,"<$file")) {
2063 print STDERR "Error: Cannot open file $file\n";
2064 ++$errors;
2065 return;
2066 }
2067
2068 while (<IN>) {
2069 if (/$export_symbol/) {
2070 next if (defined($nosymbol_table{$2}));
2071 $function_table{$2} = 1;
2072 }
2073 }
2074
2075 close(IN);
2076}
2077
2078#
2079# Parsers for the various processing states.
2080#
2081# STATE_NORMAL: looking for the /** to begin everything.
2082#
2083sub process_normal() {
2084 if (/$doc_start/o) {
2085 $state = STATE_NAME; # next line is always the function name
2086 $in_doc_sect = 0;
2087 $declaration_start_line = $. + 1;
2088 }
2089}
2090
2091#
2092# STATE_NAME: Looking for the "name - description" line
2093#
2094sub process_name($$) {
2095 my $file = shift;
2096 my $descr;
2097
2098 if (/$doc_block/o) {
2099 $state = STATE_DOCBLOCK;
2100 $contents = "";
2101 $new_start_line = $.;
2102
2103 if ( $1 eq "" ) {
2104 $section = $section_intro;
2105 } else {
2106 $section = $1;
2107 }
2108 } elsif (/$doc_decl/o) {
2109 $identifier = $1;
2110 my $is_kernel_comment = 0;
2111 my $decl_start = qr{$doc_com};
2112 # test for pointer declaration type, foo * bar() - desc
2113 my $fn_type = qr{\w+\s*\*\s*};
2114 my $parenthesis = qr{\(\w*\)};
2115 my $decl_end = qr{[-:].*};
2116 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2117 $identifier = $1;
2118 }
2119 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2120 $decl_type = $1;
2121 $identifier = $2;
2122 $is_kernel_comment = 1;
2123 }
2124 # Look for foo() or static void foo() - description; or misspelt
2125 # identifier
2126 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2127 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2128 $identifier = $1;
2129 $decl_type = 'function';
2130 $identifier =~ s/^define\s+//;
2131 $is_kernel_comment = 1;
2132 }
2133 $identifier =~ s/\s+$//;
2134
2135 $state = STATE_BODY;
2136 # if there's no @param blocks need to set up default section
2137 # here
2138 $contents = "";
2139 $section = $section_default;
2140 $new_start_line = $. + 1;
2141 if (/[-:](.*)/) {
2142 # strip leading/trailing/multiple spaces
2143 $descr= $1;
2144 $descr =~ s/^\s*//;
2145 $descr =~ s/\s*$//;
2146 $descr =~ s/\s+/ /g;
2147 $declaration_purpose = $descr;
2148 $state = STATE_BODY_MAYBE;
2149 } else {
2150 $declaration_purpose = "";
2151 }
2152
2153 if (!$is_kernel_comment) {
2154 print STDERR "${file}:$.: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n";
2155 print STDERR $_;
2156 ++$warnings;
2157 $state = STATE_NORMAL;
2158 }
2159
2160 if (($declaration_purpose eq "") && $verbose) {
2161 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2162 print STDERR $_;
2163 ++$warnings;
2164 }
2165
2166 if ($identifier eq "" && $decl_type ne "enum") {
2167 print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n";
2168 print STDERR $_;
2169 ++$warnings;
2170 $state = STATE_NORMAL;
2171 }
2172
2173 if ($verbose) {
2174 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2175 }
2176 } else {
2177 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2178 " - I thought it was a doc line\n";
2179 ++$warnings;
2180 $state = STATE_NORMAL;
2181 }
2182}
2183
2184
2185#
2186# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2187#
2188sub process_body($$) {
2189 my $file = shift;
2190
2191 # Until all named variable macro parameters are
2192 # documented using the bare name (`x`) rather than with
2193 # dots (`x...`), strip the dots:
2194 if ($section =~ /\w\.\.\.$/) {
2195 $section =~ s/\.\.\.$//;
2196
2197 if ($verbose) {
2198 print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
2199 ++$warnings;
2200 }
2201 }
2202
2203 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2204 dump_section($file, $section, $contents);
2205 $section = $section_default;
2206 $new_start_line = $.;
2207 $contents = "";
2208 }
2209
2210 if (/$doc_sect/i) { # case insensitive for supported section names
2211 $newsection = $1;
2212 $newcontents = $2;
2213
2214 # map the supported section names to the canonical names
2215 if ($newsection =~ m/^description$/i) {
2216 $newsection = $section_default;
2217 } elsif ($newsection =~ m/^context$/i) {
2218 $newsection = $section_context;
2219 } elsif ($newsection =~ m/^returns?$/i) {
2220 $newsection = $section_return;
2221 } elsif ($newsection =~ m/^\@return$/) {
2222 # special: @return is a section, not a param description
2223 $newsection = $section_return;
2224 }
2225
2226 if (($contents ne "") && ($contents ne "\n")) {
2227 if (!$in_doc_sect && $verbose) {
2228 print STDERR "${file}:$.: warning: contents before sections\n";
2229 ++$warnings;
2230 }
2231 dump_section($file, $section, $contents);
2232 $section = $section_default;
2233 }
2234
2235 $in_doc_sect = 1;
2236 $state = STATE_BODY;
2237 $contents = $newcontents;
2238 $new_start_line = $.;
2239 while (substr($contents, 0, 1) eq " ") {
2240 $contents = substr($contents, 1);
2241 }
2242 if ($contents ne "") {
2243 $contents .= "\n";
2244 }
2245 $section = $newsection;
2246 $leading_space = undef;
2247 } elsif (/$doc_end/) {
2248 if (($contents ne "") && ($contents ne "\n")) {
2249 dump_section($file, $section, $contents);
2250 $section = $section_default;
2251 $contents = "";
2252 }
2253 # look for doc_com + <text> + doc_end:
2254 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2255 print STDERR "${file}:$.: warning: suspicious ending line: $_";
2256 ++$warnings;
2257 }
2258
2259 $prototype = "";
2260 $state = STATE_PROTO;
2261 $brcount = 0;
2262 $new_start_line = $. + 1;
2263 } elsif (/$doc_content/) {
2264 if ($1 eq "") {
2265 if ($section eq $section_context) {
2266 dump_section($file, $section, $contents);
2267 $section = $section_default;
2268 $contents = "";
2269 $new_start_line = $.;
2270 $state = STATE_BODY;
2271 } else {
2272 if ($section ne $section_default) {
2273 $state = STATE_BODY_WITH_BLANK_LINE;
2274 } else {
2275 $state = STATE_BODY;
2276 }
2277 $contents .= "\n";
2278 }
2279 } elsif ($state == STATE_BODY_MAYBE) {
2280 # Continued declaration purpose
2281 chomp($declaration_purpose);
2282 $declaration_purpose .= " " . $1;
2283 $declaration_purpose =~ s/\s+/ /g;
2284 } else {
2285 my $cont = $1;
2286 if ($section =~ m/^@/ || $section eq $section_context) {
2287 if (!defined $leading_space) {
2288 if ($cont =~ m/^(\s+)/) {
2289 $leading_space = $1;
2290 } else {
2291 $leading_space = "";
2292 }
2293 }
2294 $cont =~ s/^$leading_space//;
2295 }
2296 $contents .= $cont . "\n";
2297 }
2298 } else {
2299 # i dont know - bad line? ignore.
2300 print STDERR "${file}:$.: warning: bad line: $_";
2301 ++$warnings;
2302 }
2303}
2304
2305
2306#
2307# STATE_PROTO: reading a function/whatever prototype.
2308#
2309sub process_proto($$) {
2310 my $file = shift;
2311
2312 if (/$doc_inline_oneline/) {
2313 $section = $1;
2314 $contents = $2;
2315 if ($contents ne "") {
2316 $contents .= "\n";
2317 dump_section($file, $section, $contents);
2318 $section = $section_default;
2319 $contents = "";
2320 }
2321 } elsif (/$doc_inline_start/) {
2322 $state = STATE_INLINE;
2323 $inline_doc_state = STATE_INLINE_NAME;
2324 } elsif ($decl_type eq 'function') {
2325 process_proto_function($_, $file);
2326 } else {
2327 process_proto_type($_, $file);
2328 }
2329}
2330
2331#
2332# STATE_DOCBLOCK: within a DOC: block.
2333#
2334sub process_docblock($$) {
2335 my $file = shift;
2336
2337 if (/$doc_end/) {
2338 dump_doc_section($file, $section, $contents);
2339 $section = $section_default;
2340 $contents = "";
2341 $function = "";
2342 %parameterdescs = ();
2343 %parametertypes = ();
2344 @parameterlist = ();
2345 %sections = ();
2346 @sectionlist = ();
2347 $prototype = "";
2348 $state = STATE_NORMAL;
2349 } elsif (/$doc_content/) {
2350 if ( $1 eq "" ) {
2351 $contents .= $blankline;
2352 } else {
2353 $contents .= $1 . "\n";
2354 }
2355 }
2356}
2357
2358#
2359# STATE_INLINE: docbook comments within a prototype.
2360#
2361sub process_inline($$) {
2362 my $file = shift;
2363
2364 # First line (state 1) needs to be a @parameter
2365 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2366 $section = $1;
2367 $contents = $2;
2368 $new_start_line = $.;
2369 if ($contents ne "") {
2370 while (substr($contents, 0, 1) eq " ") {
2371 $contents = substr($contents, 1);
2372 }
2373 $contents .= "\n";
2374 }
2375 $inline_doc_state = STATE_INLINE_TEXT;
2376 # Documentation block end */
2377 } elsif (/$doc_inline_end/) {
2378 if (($contents ne "") && ($contents ne "\n")) {
2379 dump_section($file, $section, $contents);
2380 $section = $section_default;
2381 $contents = "";
2382 }
2383 $state = STATE_PROTO;
2384 $inline_doc_state = STATE_INLINE_NA;
2385 # Regular text
2386 } elsif (/$doc_content/) {
2387 if ($inline_doc_state == STATE_INLINE_TEXT) {
2388 $contents .= $1 . "\n";
2389 # nuke leading blank lines
2390 if ($contents =~ /^\s*$/) {
2391 $contents = "";
2392 }
2393 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2394 $inline_doc_state = STATE_INLINE_ERROR;
2395 print STDERR "${file}:$.: warning: ";
2396 print STDERR "Incorrect use of kernel-doc format: $_";
2397 ++$warnings;
2398 }
2399 }
2400}
2401
2402
2403sub process_file($) {
2404 my $file;
2405 my $initial_section_counter = $section_counter;
2406 my ($orig_file) = @_;
2407
2408 $file = map_filename($orig_file);
2409
2410 if (!open(IN_FILE,"<$file")) {
2411 print STDERR "Error: Cannot open file $file\n";
2412 ++$errors;
2413 return;
2414 }
2415
2416 $. = 1;
2417
2418 $section_counter = 0;
2419 while (<IN_FILE>) {
2420 while (s/\\\s*$//) {
2421 $_ .= <IN_FILE>;
2422 }
2423 # Replace tabs by spaces
2424 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2425 # Hand this line to the appropriate state handler
2426 if ($state == STATE_NORMAL) {
2427 process_normal();
2428 } elsif ($state == STATE_NAME) {
2429 process_name($file, $_);
2430 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2431 $state == STATE_BODY_WITH_BLANK_LINE) {
2432 process_body($file, $_);
2433 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2434 process_inline($file, $_);
2435 } elsif ($state == STATE_PROTO) {
2436 process_proto($file, $_);
2437 } elsif ($state == STATE_DOCBLOCK) {
2438 process_docblock($file, $_);
2439 }
2440 }
2441
2442 # Make sure we got something interesting.
2443 if ($initial_section_counter == $section_counter && $
2444 output_mode ne "none") {
2445 if ($output_selection == OUTPUT_INCLUDE) {
2446 print STDERR "${file}:1: warning: '$_' not found\n"
2447 for keys %function_table;
2448 }
2449 else {
2450 print STDERR "${file}:1: warning: no structured comments found\n";
2451 }
2452 }
2453 close IN_FILE;
2454}
2455
2456
2457if ($output_mode eq "rst") {
2458 get_sphinx_version() if (!$sphinx_major);
2459}
2460
2461$kernelversion = get_kernel_version();
2462
2463# generate a sequence of code that will splice in highlighting information
2464# using the s// operator.
2465for (my $k = 0; $k < @highlights; $k++) {
2466 my $pattern = $highlights[$k][0];
2467 my $result = $highlights[$k][1];
2468# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2469 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2470}
2471
2472# Read the file that maps relative names to absolute names for
2473# separate source and object directories and for shadow trees.
2474if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2475 my ($relname, $absname);
2476 while(<SOURCE_MAP>) {
2477 chop();
2478 ($relname, $absname) = (split())[0..1];
2479 $relname =~ s:^/+::;
2480 $source_map{$relname} = $absname;
2481 }
2482 close(SOURCE_MAP);
2483}
2484
2485if ($output_selection == OUTPUT_EXPORTED ||
2486 $output_selection == OUTPUT_INTERNAL) {
2487
2488 push(@export_file_list, @ARGV);
2489
2490 foreach (@export_file_list) {
2491 chomp;
2492 process_export_file($_);
2493 }
2494}
2495
2496foreach (@ARGV) {
2497 chomp;
2498 process_file($_);
2499}
2500if ($verbose && $errors) {
2501 print STDERR "$errors errors\n";
2502}
2503if ($verbose && $warnings) {
2504 print STDERR "$warnings warnings\n";
2505}
2506
2507if ($Werror && $warnings) {
2508 print STDERR "$warnings warnings as Errors\n";
2509 exit($warnings);
2510} else {
2511 exit($output_mode eq "none" ? 0 : $errors)
2512}