2 # SPDX-License-Identifier: GPL-2.0
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 ##
13 ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
14 ## Copyright (c) 2000 MontaVista Software, Inc. ##
16 ## This software falls under the GNU General Public License. ##
17 ## Please read the COPYING file for more information ##
19 # 18/01/2001 - Cleanups
20 # Functions prototyped as foo(void) same as foo()
21 # Stop eval'ing where we don't need to.
24 # 27/06/2001 - Allowed whitespace after initial "/**" and
25 # allowed comments before function declarations.
26 # -- Christian Kreibich <ck@whoop.org>
29 # - add perldoc documentation
30 # - Look more closely at some of the scarier bits :)
32 # 26/05/2001 - Support for separate source and object trees.
34 # Keith Owens <kaos@ocs.com.au>
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>
41 # 25/07/2012 - Added support for HTML5
42 # -- Dan Luedtke <mail@danrl.de>
45 my $message = <<"EOF";
46 Usage: $0 [OPTION ...] FILE ...
48 Read C language source or header FILEs, extract embedded documentation comments,
49 and print formatted documentation to standard output.
51 The documentation comments are identified by "/**" opening comment mark. See
52 Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
54 Output 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.
59 Output format selection modifier (affects only ReST output):
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.
66 Output 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.
79 Output 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.
88 -v Verbose output, more warnings and other information.
90 -Werror Treat warnings as errors.
99 # In the following table, (...)? signifies optional structure.
100 # (...)* signifies 0 or more structure elements
102 # * function_name(:)? (- short description)?
103 # (* @parameterx: (description of parameter x)?)*
105 # * (Description:)? (Description of function)?
106 # * (section header: (section description)? )*
109 # So .. the trivial example would be:
115 # If the Description: header tag is omitted, then there must be a blank line
116 # after the last parameter specification.
119 # * my_function - does my stuff
120 # * @my_arg: its mine damnit
122 # * Does my stuff explained.
125 # or, could also use:
127 # * my_function - does my stuff
128 # * @my_arg: its mine damnit
129 # * Description: Does my stuff explained.
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.
140 # * struct my_struct - short description
142 # * @b: second member
144 # * Longer description
153 # All descriptions can be multiline, except the short function description.
155 # For really longs structs, you can also describe arguments inside the
156 # body of the struct.
159 # * struct my_struct - short description
161 # * @b: second member
163 # * Longer description
169 # * @c: This is longer description of C
171 # * You can use paragraphs to describe arguments
172 # * using this method.
177 # This should be use only for struct/enum members.
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
183 # A non-void function should have a "Return:" section describing the return
185 # Example-sections should contain the string EXAMPLE so that they are marked
186 # appropriately in DocBook.
190 # * user_function - function that can only be called in user context
191 # * @a: some argument
192 # * Context: !in_interrupt()
196 # * user_function(22);
201 # All descriptive text is further processed, scanning for the following special
202 # patterns, which are highlighted appropriately.
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.
216 my $anon_struct_union = 0;
218 # match expressions used to find embedded type information
219 my $type_constant = '\b``([^\`]+)``\b';
220 my $type_constant2 = '\%([-_\w]+)';
221 my $type_func = '(\w+)\(\)';
222 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
223 my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
224 my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
225 my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
226 my $type_env = '(\$\w+)';
227 my $type_enum = '\&(enum\s*([_\w]+))';
228 my $type_struct = '\&(struct\s*([_\w]+))';
229 my $type_typedef = '\&(typedef\s*([_\w]+))';
230 my $type_union = '\&(union\s*([_\w]+))';
231 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
232 my $type_fallback = '\&([_\w]+)';
233 my $type_member_func = $type_member . '\(\)';
235 # Output conversion substitutions.
236 # One for each output format
238 # these are pretty rough
239 my @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"]
252 my $blankline_man = "";
255 my @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**"]
272 my $blankline_rst = "\n";
280 my ($sphinx_major, $sphinx_minor, $sphinx_patch);
282 my $dohighlight = "";
286 my $output_mode = "rst";
287 my $output_preformatted = 0;
288 my $no_doc_sections = 0;
289 my $enable_lineno = 0;
290 my @highlights = @highlights_rst;
291 my $blankline = $blankline_rst;
292 my $modulename = "Kernel API";
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
300 my $output_selection = OUTPUT_ALL;
301 my $show_not_found = 0; # No longer used
303 my @export_file_list;
306 if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
307 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
308 @build_time = gmtime($seconds);
310 @build_time = localtime;
313 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
314 'July', 'August', 'September', 'October',
315 'November', 'December')[$build_time[4]] .
316 " " . ($build_time[5]+1900);
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.
322 my ($function, %function_table, %parametertypes, $declaration_purpose);
323 my %nosymbol_table = ();
324 my $declaration_start_line;
325 my ($type, $declaration_name, $return_type);
326 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
328 if (defined($ENV{'KBUILD_VERBOSE'})) {
329 $verbose = "$ENV{'KBUILD_VERBOSE'}";
332 if (defined($ENV{'KDOC_WERROR'})) {
333 $Werror = "$ENV{'KDOC_WERROR'}";
336 if (defined($ENV{'KCFLAGS'})) {
337 my $kcflags = "$ENV{'KCFLAGS'}";
339 if ($kcflags =~ /Werror/) {
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
350 my $section_counter = 0;
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
369 # Inline documentation state
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.
379 my $inline_doc_state;
381 #declaration types: can be
382 # 'function', 'struct', 'union', 'enum', 'typedef'
385 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
387 my $doc_com = '\s*\*\s*';
388 my $doc_com_body = '\s*\* ?';
389 my $doc_decl = $doc_com . '(\w+)';
390 # @params and a strictly limited set of supported section names
391 my $doc_sect = $doc_com .
392 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
393 my $doc_content = $doc_com_body . '(.*)';
394 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
395 my $doc_inline_start = '^\s*/\*\*\s*$';
396 my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
397 my $doc_inline_end = '^\s*\*/\s*$';
398 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
399 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
402 my %parameterdesc_start_lines;
406 my %section_start_lines;
411 my $new_start_line = 0;
413 # the canonical section names. see also $doc_sect above.
414 my $section_default = "Description"; # default section
415 my $section_intro = "Introduction";
416 my $section = $section_default;
417 my $section_context = "Context";
418 my $section_return = "Return";
420 my $undescribed = "-- undescribed --";
424 while ($ARGV[0] =~ m/^--?(.*)/) {
428 $output_mode = "man";
429 @highlights = @highlights_man;
430 $blankline = $blankline_man;
431 } elsif ($cmd eq "rst") {
432 $output_mode = "rst";
433 @highlights = @highlights_rst;
434 $blankline = $blankline_rst;
435 } elsif ($cmd eq "none") {
436 $output_mode = "none";
437 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
438 $modulename = shift @ARGV;
439 } elsif ($cmd eq "function") { # to only output specific functions
440 $output_selection = OUTPUT_INCLUDE;
441 $function = shift @ARGV;
442 $function_table{$function} = 1;
443 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
444 my $symbol = shift @ARGV;
445 $nosymbol_table{$symbol} = 1;
446 } elsif ($cmd eq "export") { # only exported symbols
447 $output_selection = OUTPUT_EXPORTED;
448 %function_table = ();
449 } elsif ($cmd eq "internal") { # only non-exported symbols
450 $output_selection = OUTPUT_INTERNAL;
451 %function_table = ();
452 } elsif ($cmd eq "export-file") {
453 my $file = shift @ARGV;
454 push(@export_file_list, $file);
455 } elsif ($cmd eq "v") {
457 } elsif ($cmd eq "Werror") {
459 } elsif (($cmd eq "h") || ($cmd eq "help")) {
461 } elsif ($cmd eq 'no-doc-sections') {
462 $no_doc_sections = 1;
463 } elsif ($cmd eq 'enable-lineno') {
465 } elsif ($cmd eq 'show-not-found') {
466 $show_not_found = 1; # A no-op but don't fail
467 } elsif ($cmd eq "sphinx-version") {
468 my $ver_string = shift @ARGV;
469 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
472 $sphinx_minor = substr($2,1);
477 $sphinx_patch = substr($3,1)
482 die "Sphinx version should either major.minor or major.minor.patch format\n";
490 # continue execution near EOF;
492 # The C domain dialect changed on Sphinx 3. So, we need to check the
493 # version in order to produce the right tags.
496 foreach(split(/:/, $ENV{PATH})) {
497 return "$_/$_[0]" if(-x "$_/$_[0]");
501 sub get_sphinx_version()
505 my $cmd = "sphinx-build";
506 if (!findprog($cmd)) {
507 my $cmd = "sphinx-build3";
508 if (!findprog($cmd)) {
512 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
513 $sphinx_major, $sphinx_minor, $sphinx_patch;
518 open IN, "$cmd --version 2>&1 |";
520 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
526 # Sphinx 1.2.x uses a different format
527 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
537 # get kernel version from env
538 sub get_kernel_version() {
539 my $version = 'unknown kernel version';
541 if (defined($ENV{'KERNELVERSION'})) {
542 $version = $ENV{'KERNELVERSION'};
550 if ($enable_lineno && defined($lineno)) {
551 print "#define LINENO " . $lineno . "\n";
555 # dumps section contents to arrays/hashes intended for that purpose.
560 my $contents = join "\n", @_;
562 if ($name =~ m/$type_param/) {
564 $parameterdescs{$name} = $contents;
565 $sectcheck = $sectcheck . $name . " ";
566 $parameterdesc_start_lines{$name} = $new_start_line;
568 } elsif ($name eq "@\.\.\.") {
570 $parameterdescs{$name} = $contents;
571 $sectcheck = $sectcheck . $name . " ";
572 $parameterdesc_start_lines{$name} = $new_start_line;
575 if (defined($sections{$name}) && ($sections{$name} ne "")) {
576 # Only warn on user specified duplicate section names.
577 if ($name ne $section_default) {
578 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
581 $sections{$name} .= $contents;
583 $sections{$name} = $contents;
584 push @sectionlist, $name;
585 $section_start_lines{$name} = $new_start_line;
592 # dump DOC: section after checking that it should go out
594 sub dump_doc_section {
597 my $contents = join "\n", @_;
599 if ($no_doc_sections) {
603 return if (defined($nosymbol_table{$name}));
605 if (($output_selection == OUTPUT_ALL) ||
606 (($output_selection == OUTPUT_INCLUDE) &&
607 defined($function_table{$name})))
609 dump_section($file, $name, $contents);
610 output_blockhead({'sectionlist' => \@sectionlist,
611 'sections' => \%sections,
612 'module' => $modulename,
613 'content-only' => ($output_selection != OUTPUT_ALL), });
620 # parameterdescs, a hash.
621 # function => "function name"
622 # parameterlist => @list of parameters
623 # parameterdescs => %parameter descriptions
624 # sectionlist => @list of sections
625 # sections => %section descriptions
628 sub output_highlight {
629 my $contents = join "\n",@_;
633 # if (!defined $contents) {
635 # confess "output_highlight got called with no args?\n";
638 # print STDERR "contents b4:$contents\n";
641 # print STDERR "contents af:$contents\n";
643 foreach $line (split "\n", $contents) {
644 if (! $output_preformatted) {
648 if (! $output_preformatted) {
649 print $lineprefix, $blankline;
652 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
655 print $lineprefix, $line;
663 # output function in man
664 sub output_function_man(%) {
666 my ($parameter, $section);
669 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
672 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
674 print ".SH SYNOPSIS\n";
675 if ($args{'functiontype'} ne "") {
676 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
678 print ".B \"" . $args{'function'} . "\n";
683 foreach my $parameter (@{$args{'parameterlist'}}) {
684 if ($count == $#{$args{'parameterlist'}}) {
687 $type = $args{'parametertypes'}{$parameter};
688 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
689 # pointer-to-function
690 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
692 $type =~ s/([^\*])$/$1 /;
693 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
699 print ".SH ARGUMENTS\n";
700 foreach $parameter (@{$args{'parameterlist'}}) {
701 my $parameter_name = $parameter;
702 $parameter_name =~ s/\[.*//;
704 print ".IP \"" . $parameter . "\" 12\n";
705 output_highlight($args{'parameterdescs'}{$parameter_name});
707 foreach $section (@{$args{'sectionlist'}}) {
708 print ".SH \"", uc $section, "\"\n";
709 output_highlight($args{'sections'}{$section});
715 sub output_enum_man(%) {
717 my ($parameter, $section);
720 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
723 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
725 print ".SH SYNOPSIS\n";
726 print "enum " . $args{'enum'} . " {\n";
728 foreach my $parameter (@{$args{'parameterlist'}}) {
729 print ".br\n.BI \" $parameter\"\n";
730 if ($count == $#{$args{'parameterlist'}}) {
740 print ".SH Constants\n";
741 foreach $parameter (@{$args{'parameterlist'}}) {
742 my $parameter_name = $parameter;
743 $parameter_name =~ s/\[.*//;
745 print ".IP \"" . $parameter . "\" 12\n";
746 output_highlight($args{'parameterdescs'}{$parameter_name});
748 foreach $section (@{$args{'sectionlist'}}) {
749 print ".SH \"$section\"\n";
750 output_highlight($args{'sections'}{$section});
755 # output struct in man
756 sub output_struct_man(%) {
758 my ($parameter, $section);
760 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
763 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
765 my $declaration = $args{'definition'};
766 $declaration =~ s/\t/ /g;
767 $declaration =~ s/\n/"\n.br\n.BI \"/g;
768 print ".SH SYNOPSIS\n";
769 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
770 print ".BI \"$declaration\n};\n.br\n\n";
772 print ".SH Members\n";
773 foreach $parameter (@{$args{'parameterlist'}}) {
774 ($parameter =~ /^#/) && next;
776 my $parameter_name = $parameter;
777 $parameter_name =~ s/\[.*//;
779 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
780 print ".IP \"" . $parameter . "\" 12\n";
781 output_highlight($args{'parameterdescs'}{$parameter_name});
783 foreach $section (@{$args{'sectionlist'}}) {
784 print ".SH \"$section\"\n";
785 output_highlight($args{'sections'}{$section});
790 # output typedef in man
791 sub output_typedef_man(%) {
793 my ($parameter, $section);
795 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
798 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
800 foreach $section (@{$args{'sectionlist'}}) {
801 print ".SH \"$section\"\n";
802 output_highlight($args{'sections'}{$section});
806 sub output_blockhead_man(%) {
808 my ($parameter, $section);
811 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
813 foreach $section (@{$args{'sectionlist'}}) {
814 print ".SH \"$section\"\n";
815 output_highlight($args{'sections'}{$section});
820 # output in restructured text
824 # This could use some work; it's used to output the DOC: sections, and
825 # starts by putting out the name of the doc section itself, but that tends
826 # to duplicate a header already in the template file.
828 sub output_blockhead_rst(%) {
830 my ($parameter, $section);
832 foreach $section (@{$args{'sectionlist'}}) {
833 next if (defined($nosymbol_table{$section}));
835 if ($output_selection != OUTPUT_INCLUDE) {
836 print "**$section**\n\n";
838 print_lineno($section_start_lines{$section});
839 output_highlight_rst($args{'sections'}{$section});
845 # Apply the RST highlights to a sub-block of text.
847 sub highlight_block($) {
848 # The dohighlight kludge requires the text be called $contents
849 my $contents = shift;
856 # Regexes used only here.
858 my $sphinx_literal = '^[^.].*::$';
859 my $sphinx_cblock = '^\.\.\ +code-block::';
861 sub output_highlight_rst {
862 my $input = join "\n",@_;
869 foreach $line (split "\n",$input) {
871 # If we're in a literal block, see if we should drop out
872 # of it. Otherwise pass the line straight through unmunged.
875 if (! ($line =~ /^\s*$/)) {
877 # If this is the first non-blank line in a literal
878 # block we need to figure out what the proper indent is.
880 if ($litprefix eq "") {
882 $litprefix = '^' . $1;
883 $output .= $line . "\n";
884 } elsif (! ($line =~ /$litprefix/)) {
887 $output .= $line . "\n";
890 $output .= $line . "\n";
894 # Not in a literal block (or just dropped out)
897 $block .= $line . "\n";
898 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
901 $output .= highlight_block($block);
908 $output .= highlight_block($block);
910 foreach $line (split "\n", $output) {
911 print $lineprefix . $line . "\n";
915 sub output_function_rst(%) {
917 my ($parameter, $section);
918 my $oldprefix = $lineprefix;
922 if ($sphinx_major < 3) {
923 if ($args{'typedef'}) {
924 print ".. c:type:: ". $args{'function'} . "\n\n";
925 print_lineno($declaration_start_line);
926 print " **Typedef**: ";
928 output_highlight_rst($args{'purpose'});
929 $start = "\n\n**Syntax**\n\n ``";
932 print ".. c:function:: ";
935 if ($args{'typedef'} || $args{'functiontype'} eq "") {
937 print ".. c:macro:: ". $args{'function'} . "\n\n";
939 print ".. c:function:: ";
942 if ($args{'typedef'}) {
943 print_lineno($declaration_start_line);
944 print " **Typedef**: ";
946 output_highlight_rst($args{'purpose'});
947 $start = "\n\n**Syntax**\n\n ``";
949 print "``" if ($is_macro);
952 if ($args{'functiontype'} ne "") {
953 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
955 $start .= $args{'function'} . " (";
960 foreach my $parameter (@{$args{'parameterlist'}}) {
965 $type = $args{'parametertypes'}{$parameter};
967 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
968 # pointer-to-function
969 print $1 . $parameter . ") (" . $2 . ")";
979 if (!$args{'typedef'}) {
980 print_lineno($declaration_start_line);
982 output_highlight_rst($args{'purpose'});
986 print "**Parameters**\n\n";
988 foreach $parameter (@{$args{'parameterlist'}}) {
989 my $parameter_name = $parameter;
990 $parameter_name =~ s/\[.*//;
991 $type = $args{'parametertypes'}{$parameter};
996 print "``$parameter``\n";
999 print_lineno($parameterdesc_start_lines{$parameter_name});
1001 if (defined($args{'parameterdescs'}{$parameter_name}) &&
1002 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
1003 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1005 print " *undescribed*\n";
1010 $lineprefix = $oldprefix;
1011 output_section_rst(@_);
1014 sub output_section_rst(%) {
1015 my %args = %{$_[0]};
1017 my $oldprefix = $lineprefix;
1020 foreach $section (@{$args{'sectionlist'}}) {
1021 print "**$section**\n\n";
1022 print_lineno($section_start_lines{$section});
1023 output_highlight_rst($args{'sections'}{$section});
1027 $lineprefix = $oldprefix;
1030 sub output_enum_rst(%) {
1031 my %args = %{$_[0]};
1033 my $oldprefix = $lineprefix;
1036 if ($sphinx_major < 3) {
1037 my $name = "enum " . $args{'enum'};
1038 print "\n\n.. c:type:: " . $name . "\n\n";
1040 my $name = $args{'enum'};
1041 print "\n\n.. c:enum:: " . $name . "\n\n";
1043 print_lineno($declaration_start_line);
1045 output_highlight_rst($args{'purpose'});
1048 print "**Constants**\n\n";
1050 foreach $parameter (@{$args{'parameterlist'}}) {
1051 print "``$parameter``\n";
1052 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1053 output_highlight_rst($args{'parameterdescs'}{$parameter});
1055 print " *undescribed*\n";
1060 $lineprefix = $oldprefix;
1061 output_section_rst(@_);
1064 sub output_typedef_rst(%) {
1065 my %args = %{$_[0]};
1067 my $oldprefix = $lineprefix;
1070 if ($sphinx_major < 3) {
1071 $name = "typedef " . $args{'typedef'};
1073 $name = $args{'typedef'};
1075 print "\n\n.. c:type:: " . $name . "\n\n";
1076 print_lineno($declaration_start_line);
1078 output_highlight_rst($args{'purpose'});
1081 $lineprefix = $oldprefix;
1082 output_section_rst(@_);
1085 sub output_struct_rst(%) {
1086 my %args = %{$_[0]};
1088 my $oldprefix = $lineprefix;
1090 if ($sphinx_major < 3) {
1091 my $name = $args{'type'} . " " . $args{'struct'};
1092 print "\n\n.. c:type:: " . $name . "\n\n";
1094 my $name = $args{'struct'};
1095 if ($args{'type'} eq 'union') {
1096 print "\n\n.. c:union:: " . $name . "\n\n";
1098 print "\n\n.. c:struct:: " . $name . "\n\n";
1101 print_lineno($declaration_start_line);
1103 output_highlight_rst($args{'purpose'});
1106 print "**Definition**\n\n";
1108 my $declaration = $args{'definition'};
1109 $declaration =~ s/\t/ /g;
1110 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n";
1112 print "**Members**\n\n";
1114 foreach $parameter (@{$args{'parameterlist'}}) {
1115 ($parameter =~ /^#/) && next;
1117 my $parameter_name = $parameter;
1118 $parameter_name =~ s/\[.*//;
1120 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1121 $type = $args{'parametertypes'}{$parameter};
1122 print_lineno($parameterdesc_start_lines{$parameter_name});
1123 print "``" . $parameter . "``\n";
1124 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1129 $lineprefix = $oldprefix;
1130 output_section_rst(@_);
1133 ## none mode output functions
1135 sub output_function_none(%) {
1138 sub output_enum_none(%) {
1141 sub output_typedef_none(%) {
1144 sub output_struct_none(%) {
1147 sub output_blockhead_none(%) {
1151 # generic output function for all types (function, struct/union, typedef, enum);
1152 # calls the generated, variable output_ function name based on
1153 # functype and output_mode
1154 sub output_declaration {
1157 my $functype = shift;
1158 my $func = "output_${functype}_$output_mode";
1160 return if (defined($nosymbol_table{$name}));
1162 if (($output_selection == OUTPUT_ALL) ||
1163 (($output_selection == OUTPUT_INCLUDE ||
1164 $output_selection == OUTPUT_EXPORTED) &&
1165 defined($function_table{$name})) ||
1166 ($output_selection == OUTPUT_INTERNAL &&
1167 !($functype eq "function" && defined($function_table{$name}))))
1175 # generic output function - calls the right one based on current output mode.
1176 sub output_blockhead {
1178 my $func = "output_blockhead_" . $output_mode;
1184 # takes a declaration (struct, union, enum, typedef) and
1185 # invokes the right handler. NOT called for functions.
1186 sub dump_declaration($$) {
1188 my ($prototype, $file) = @_;
1189 my $func = "dump_" . $decl_type;
1193 sub dump_union($$) {
1197 sub dump_struct($$) {
1201 if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
1203 $declaration_name = $2;
1206 # ignore members marked private:
1207 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1208 $members =~ s/\/\*\s*private:.*//gosi;
1210 $members =~ s/\/\*.*?\*\///gos;
1212 $members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi;
1213 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1214 $members =~ s/\s*__packed\s*/ /gos;
1215 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1216 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1217 $members =~ s/\s*____cacheline_aligned/ /gos;
1219 # replace DECLARE_BITMAP
1220 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1221 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1222 # replace DECLARE_HASHTABLE
1223 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1224 # replace DECLARE_KFIFO
1225 $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1226 # replace DECLARE_KFIFO_PTR
1227 $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1229 my $declaration = $members;
1231 # Split nested struct/union elements as newer ones
1232 while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
1237 foreach my $id(split /,/, $ids) {
1238 $newmember .= "$maintype $id; ";
1241 $id =~ s/^\s*\**(\S+)\s*/$1/;
1242 foreach my $arg (split /;/, $content) {
1243 next if ($arg =~ m/^\s*$/);
1244 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1245 # pointer-to-function
1250 if ($id =~ m/^\s*$/) {
1251 # anonymous struct/union
1252 $newmember .= "$type$name$extra; ";
1254 $newmember .= "$type$id.$name$extra; ";
1262 $arg =~ s/:\s*\d+\s*//g;
1264 $arg =~ s/\[.*\]//g;
1265 # The type may have multiple words,
1266 # and multiple IDs can be defined, like:
1267 # const struct foo, *bar, foobar
1268 # So, we remove spaces when parsing the
1269 # names, in order to match just names
1270 # and commas for the names
1271 $arg =~ s/\s*,\s*/,/g;
1272 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1276 $newmember .= "$arg; ";
1279 foreach my $name (split /,/, $names) {
1280 $name =~ s/^\s*\**(\S+)\s*/$1/;
1281 next if (($name =~ m/^\s*$/));
1282 if ($id =~ m/^\s*$/) {
1283 # anonymous struct/union
1284 $newmember .= "$type $name; ";
1286 $newmember .= "$type $id.$name; ";
1292 $members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
1295 # Ignore other nested elements, like enums
1296 $members =~ s/(\{[^\{\}]*\})//g;
1298 create_parameterlist($members, ';', $file, $declaration_name);
1299 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1301 # Adjust declaration for better display
1302 $declaration =~ s/([\{;])/$1\n/g;
1303 $declaration =~ s/\}\s+;/};/g;
1304 # Better handle inlined enums
1305 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1307 my @def_args = split /\n/, $declaration;
1310 foreach my $clause (@def_args) {
1311 $clause =~ s/^\s+//;
1312 $clause =~ s/\s+$//;
1313 $clause =~ s/\s+/ /;
1315 $level-- if ($clause =~ m/(\})/ && $level > 1);
1316 if (!($clause =~ m/^\s*#/)) {
1317 $declaration .= "\t" x $level;
1319 $declaration .= "\t" . $clause . "\n";
1320 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1322 output_declaration($declaration_name,
1324 {'struct' => $declaration_name,
1325 'module' => $modulename,
1326 'definition' => $declaration,
1327 'parameterlist' => \@parameterlist,
1328 'parameterdescs' => \%parameterdescs,
1329 'parametertypes' => \%parametertypes,
1330 'sectionlist' => \@sectionlist,
1331 'sections' => \%sections,
1332 'purpose' => $declaration_purpose,
1333 'type' => $decl_type
1337 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1343 sub show_warnings($$) {
1344 my $functype = shift;
1347 return 0 if (defined($nosymbol_table{$name}));
1349 return 1 if ($output_selection == OUTPUT_ALL);
1351 if ($output_selection == OUTPUT_EXPORTED) {
1352 if (defined($function_table{$name})) {
1358 if ($output_selection == OUTPUT_INTERNAL) {
1359 if (!($functype eq "function" && defined($function_table{$name}))) {
1365 if ($output_selection == OUTPUT_INCLUDE) {
1366 if (defined($function_table{$name})) {
1372 die("Please add the new output type at show_warnings()");
1381 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1382 # strip #define macros inside enums
1383 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1385 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1386 $declaration_name = $2;
1388 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1389 $declaration_name = $1;
1393 if ($declaration_name) {
1396 $members =~ s/\s+$//;
1398 foreach my $arg (split ',', $members) {
1399 $arg =~ s/^\s*(\w+).*/$1/;
1400 push @parameterlist, $arg;
1401 if (!$parameterdescs{$arg}) {
1402 $parameterdescs{$arg} = $undescribed;
1403 if (show_warnings("enum", $declaration_name)) {
1404 print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1407 $_members{$arg} = 1;
1410 while (my ($k, $v) = each %parameterdescs) {
1411 if (!exists($_members{$k})) {
1412 if (show_warnings("enum", $declaration_name)) {
1413 print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1418 output_declaration($declaration_name,
1420 {'enum' => $declaration_name,
1421 'module' => $modulename,
1422 'parameterlist' => \@parameterlist,
1423 'parameterdescs' => \%parameterdescs,
1424 'sectionlist' => \@sectionlist,
1425 'sections' => \%sections,
1426 'purpose' => $declaration_purpose
1429 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1434 my $typedef_type = qr { ((?:\s+[\w\*]+){1,8})\s* }x;
1435 my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1436 my $typedef_args = qr { \s*\((.*)\); }x;
1438 my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1439 my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1441 sub dump_typedef($$) {
1445 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1447 # Parse function typedef prototypes
1448 if ($x =~ $typedef1 || $x =~ $typedef2) {
1450 $declaration_name = $2;
1452 $return_type =~ s/^\s+//;
1454 create_parameterlist($args, ',', $file, $declaration_name);
1456 output_declaration($declaration_name,
1458 {'function' => $declaration_name,
1460 'module' => $modulename,
1461 'functiontype' => $return_type,
1462 'parameterlist' => \@parameterlist,
1463 'parameterdescs' => \%parameterdescs,
1464 'parametertypes' => \%parametertypes,
1465 'sectionlist' => \@sectionlist,
1466 'sections' => \%sections,
1467 'purpose' => $declaration_purpose
1472 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1473 $x =~ s/\(*.\)\s*;$/;/;
1474 $x =~ s/\[*.\]\s*;$/;/;
1477 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1478 $declaration_name = $1;
1480 output_declaration($declaration_name,
1482 {'typedef' => $declaration_name,
1483 'module' => $modulename,
1484 'sectionlist' => \@sectionlist,
1485 'sections' => \%sections,
1486 'purpose' => $declaration_purpose
1490 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1495 sub save_struct_actual($) {
1498 # strip all spaces from the actual param so that it looks like one string item
1499 $actual =~ s/\s*//g;
1500 $struct_actual = $struct_actual . $actual . " ";
1503 sub create_parameterlist($$$$) {
1505 my $splitter = shift;
1507 my $declaration_name = shift;
1511 # temporarily replace commas inside function pointer definition
1512 while ($args =~ /(\([^\),]+),/) {
1513 $args =~ s/(\([^\),]+),/$1#/g;
1516 foreach my $arg (split($splitter, $args)) {
1518 $arg =~ s/\/\*.*\*\///;
1519 # strip leading/trailing spaces
1525 # Treat preprocessor directive as a typeless variable just to fill
1526 # corresponding data structures "correctly". Catch it later in
1528 push_parameter($arg, "", "", $file);
1529 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1530 # pointer-to-function
1532 $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/;
1535 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1536 save_struct_actual($param);
1537 push_parameter($param, $type, $arg, $file, $declaration_name);
1539 $arg =~ s/\s*:\s*/:/g;
1540 $arg =~ s/\s*\[/\[/g;
1542 my @args = split('\s*,\s*', $arg);
1543 if ($args[0] =~ m/\*/) {
1544 $args[0] =~ s/(\*+)\s*/ $1/;
1548 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1550 push(@first_arg, split('\s+', $1));
1551 push(@first_arg, $2);
1553 @first_arg = split('\s+', shift @args);
1556 unshift(@args, pop @first_arg);
1557 $type = join " ", @first_arg;
1559 foreach $param (@args) {
1560 if ($param =~ m/^(\*+)\s*(.*)/) {
1561 save_struct_actual($2);
1563 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1565 elsif ($param =~ m/(.*?):(\d+)/) {
1566 if ($type ne "") { # skip unnamed bit-fields
1567 save_struct_actual($1);
1568 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1572 save_struct_actual($param);
1573 push_parameter($param, $type, $arg, $file, $declaration_name);
1580 sub push_parameter($$$$$) {
1583 my $org_arg = shift;
1585 my $declaration_name = shift;
1587 if (($anon_struct_union == 1) && ($type eq "") &&
1589 return; # ignore the ending }; from anon. struct/union
1592 $anon_struct_union = 0;
1593 $param =~ s/[\[\)].*//;
1595 if ($type eq "" && $param =~ /\.\.\.$/)
1597 if (!$param =~ /\w\.\.\.$/) {
1598 # handles unnamed variable parameters
1601 elsif ($param =~ /\w\.\.\.$/) {
1602 # for named variable parameters of the form `x...`, remove the dots
1603 $param =~ s/\.\.\.$//;
1605 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1606 $parameterdescs{$param} = "variable arguments";
1609 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1612 $parameterdescs{void} = "no arguments";
1614 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1615 # handle unnamed (anonymous) union or struct:
1618 $param = "{unnamed_" . $param . "}";
1619 $parameterdescs{$param} = "anonymous\n";
1620 $anon_struct_union = 1;
1623 # warn if parameter has no description
1624 # (but ignore ones starting with # as these are not parameters
1625 # but inline preprocessor statements);
1626 # Note: It will also ignore void params and unnamed structs/unions
1627 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1628 $parameterdescs{$param} = $undescribed;
1630 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1632 "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1637 # strip spaces from $param so that it is one continuous string
1638 # on @parameterlist;
1639 # this fixes a problem where check_sections() cannot find
1640 # a parameter like "addr[6 + 2]" because it actually appears
1641 # as "addr[6", "+", "2]" on the parameter list;
1642 # but it's better to maintain the param string unchanged for output,
1643 # so just weaken the string compare in check_sections() to ignore
1644 # "[blah" in a parameter string;
1645 ###$param =~ s/\s*//g;
1646 push @parameterlist, $param;
1647 $org_arg =~ s/\s\s+/ /g;
1648 $parametertypes{$param} = $org_arg;
1651 sub check_sections($$$$$) {
1652 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1653 my @sects = split ' ', $sectcheck;
1654 my @prms = split ' ', $prmscheck;
1657 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1659 foreach $sx (0 .. $#sects) {
1661 foreach $px (0 .. $#prms) {
1662 $prm_clean = $prms[$px];
1663 $prm_clean =~ s/\[.*\]//;
1664 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1665 # ignore array size in a parameter string;
1666 # however, the original param string may contain
1667 # spaces, e.g.: addr[6 + 2]
1668 # and this appears in @prms as "addr[6" since the
1669 # parameter list is split at spaces;
1670 # hence just ignore "[..." for the sections check;
1671 $prm_clean =~ s/\[.*//;
1673 ##$prm_clean =~ s/^\**//;
1674 if ($prm_clean eq $sects[$sx]) {
1680 if ($decl_type eq "function") {
1681 print STDERR "${file}:$.: warning: " .
1682 "Excess function parameter " .
1684 "description in '$decl_name'\n";
1692 # Checks the section describing the return value of a function.
1693 sub check_return_section {
1695 my $declaration_name = shift;
1696 my $return_type = shift;
1698 # Ignore an empty return type (It's a macro)
1699 # Ignore functions with a "void" return type. (But don't ignore "void *")
1700 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1704 if (!defined($sections{$section_return}) ||
1705 $sections{$section_return} eq "") {
1706 print STDERR "${file}:$.: warning: " .
1707 "No description found for return value of " .
1708 "'$declaration_name'\n";
1714 # takes a function prototype and the name of the current file being
1715 # processed and spits out all the details stored in the global
1717 sub dump_function($$) {
1718 my $prototype = shift;
1722 print_lineno($new_start_line);
1724 $prototype =~ s/^static +//;
1725 $prototype =~ s/^extern +//;
1726 $prototype =~ s/^asmlinkage +//;
1727 $prototype =~ s/^inline +//;
1728 $prototype =~ s/^__inline__ +//;
1729 $prototype =~ s/^__inline +//;
1730 $prototype =~ s/^__always_inline +//;
1731 $prototype =~ s/^noinline +//;
1732 $prototype =~ s/__init +//;
1733 $prototype =~ s/__init_or_module +//;
1734 $prototype =~ s/__meminit +//;
1735 $prototype =~ s/__must_check +//;
1736 $prototype =~ s/__weak +//;
1737 $prototype =~ s/__sched +//;
1738 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1739 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1740 $prototype =~ s/__attribute__\s*\(\(
1742 [\w\s]++ # attribute name
1743 (?:\([^)]*+\))? # attribute arguments
1744 \s*+,? # optional comma at the end
1748 # Yes, this truly is vile. We are looking for:
1749 # 1. Return type (may be nothing if we're looking at a macro)
1751 # 3. Function parameters.
1753 # All the while we have to watch out for function pointer parameters
1754 # (which IIRC is what the two sections are for), C types (these
1755 # regexps don't even start to express all the possibilities), and
1758 # If you mess with these regexps, it's a good idea to check that
1759 # the following functions' documentation still comes out right:
1760 # - parport_register_device (function pointer parameters)
1761 # - atomic_set (macro)
1762 # - pci_match_device, __copy_to_user (long return type)
1764 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
1765 # This is an object-like macro, it has no return type and no parameter
1767 # Function-like macros are not allowed to have spaces between
1768 # declaration_name and opening parenthesis (notice the \s+).
1770 $declaration_name = $2;
1772 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1773 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1774 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1775 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1776 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1777 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1778 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1779 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1780 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1781 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1782 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1783 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1784 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1785 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1786 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1787 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1788 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1790 $declaration_name = $2;
1793 create_parameterlist($args, ',', $file, $declaration_name);
1795 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1799 my $prms = join " ", @parameterlist;
1800 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1802 # This check emits a lot of warnings at the moment, because many
1803 # functions don't have a 'Return' doc section. So until the number
1804 # of warnings goes sufficiently down, the check is only performed in
1806 # TODO: always perform the check.
1807 if ($verbose && !$noret) {
1808 check_return_section($file, $declaration_name, $return_type);
1811 # The function parser can be called with a typedef parameter.
1813 if ($return_type =~ /typedef/) {
1814 output_declaration($declaration_name,
1816 {'function' => $declaration_name,
1818 'module' => $modulename,
1819 'functiontype' => $return_type,
1820 'parameterlist' => \@parameterlist,
1821 'parameterdescs' => \%parameterdescs,
1822 'parametertypes' => \%parametertypes,
1823 'sectionlist' => \@sectionlist,
1824 'sections' => \%sections,
1825 'purpose' => $declaration_purpose
1828 output_declaration($declaration_name,
1830 {'function' => $declaration_name,
1831 'module' => $modulename,
1832 'functiontype' => $return_type,
1833 'parameterlist' => \@parameterlist,
1834 'parameterdescs' => \%parameterdescs,
1835 'parametertypes' => \%parametertypes,
1836 'sectionlist' => \@sectionlist,
1837 'sections' => \%sections,
1838 'purpose' => $declaration_purpose
1845 %parameterdescs = ();
1846 %parametertypes = ();
1847 @parameterlist = ();
1851 $struct_actual = "";
1854 $state = STATE_NORMAL;
1855 $inline_doc_state = STATE_INLINE_NA;
1858 sub tracepoint_munge($) {
1860 my $tracepointname = 0;
1861 my $tracepointargs = 0;
1863 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1864 $tracepointname = $1;
1866 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1867 $tracepointname = $1;
1869 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1870 $tracepointname = $2;
1872 $tracepointname =~ s/^\s+//; #strip leading whitespace
1873 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1874 $tracepointargs = $1;
1876 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1877 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1880 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1884 sub syscall_munge() {
1887 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1888 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1889 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1891 ## $prototype = "long sys_$1(void)";
1894 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1895 if ($prototype =~ m/long (sys_.*?),/) {
1896 $prototype =~ s/,/\(/;
1898 $prototype =~ s/\)/\(void\)/;
1901 # now delete all of the odd-number commas in $prototype
1902 # so that arg types & arg names don't have a comma between them
1904 my $len = length($prototype);
1906 $len = 0; # skip the for-loop
1908 for (my $ix = 0; $ix < $len; $ix++) {
1909 if (substr($prototype, $ix, 1) eq ',') {
1911 if ($count % 2 == 1) {
1912 substr($prototype, $ix, 1) = ' ';
1918 sub process_proto_function($$) {
1922 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1924 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1927 elsif ($x =~ /([^\{]*)/) {
1931 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1932 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1933 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1934 $prototype =~ s@^\s+@@gos; # strip leading spaces
1936 # Handle prototypes for function pointers like:
1937 # int (*pcs_config)(struct foo)
1938 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1940 if ($prototype =~ /SYSCALL_DEFINE/) {
1943 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1944 $prototype =~ /DEFINE_SINGLE_EVENT/)
1946 tracepoint_munge($file);
1948 dump_function($prototype, $file);
1953 sub process_proto_type($$) {
1957 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1958 $x =~ s@^\s+@@gos; # strip leading spaces
1959 $x =~ s@\s+$@@gos; # strip trailing spaces
1960 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1963 # To distinguish preprocessor directive from regular declaration later.
1968 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1969 if( length $prototype ) {
1972 $prototype .= $1 . $2;
1973 ($2 eq '{') && $brcount++;
1974 ($2 eq '}') && $brcount--;
1975 if (($2 eq ';') && ($brcount == 0)) {
1976 dump_declaration($prototype, $file);
1989 sub map_filename($) {
1991 my ($orig_file) = @_;
1993 if (defined($ENV{'SRCTREE'})) {
1994 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1999 if (defined($source_map{$file})) {
2000 $file = $source_map{$file};
2006 sub process_export_file($) {
2007 my ($orig_file) = @_;
2008 my $file = map_filename($orig_file);
2010 if (!open(IN,"<$file")) {
2011 print STDERR "Error: Cannot open file $file\n";
2017 if (/$export_symbol/) {
2018 next if (defined($nosymbol_table{$2}));
2019 $function_table{$2} = 1;
2027 # Parsers for the various processing states.
2029 # STATE_NORMAL: looking for the /** to begin everything.
2031 sub process_normal() {
2032 if (/$doc_start/o) {
2033 $state = STATE_NAME; # next line is always the function name
2035 $declaration_start_line = $. + 1;
2040 # STATE_NAME: Looking for the "name - description" line
2042 sub process_name($$) {
2047 if (/$doc_block/o) {
2048 $state = STATE_DOCBLOCK;
2050 $new_start_line = $.;
2053 $section = $section_intro;
2058 elsif (/$doc_decl/o) {
2060 if (/\s*([\w\s]+?)(\(\))?\s*-/) {
2064 $state = STATE_BODY;
2065 # if there's no @param blocks need to set up default section
2068 $section = $section_default;
2069 $new_start_line = $. + 1;
2071 # strip leading/trailing/multiple spaces
2075 $descr =~ s/\s+/ /g;
2076 $declaration_purpose = $descr;
2077 $state = STATE_BODY_MAYBE;
2079 $declaration_purpose = "";
2082 if (($declaration_purpose eq "") && $verbose) {
2083 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2088 if ($identifier =~ m/^struct\b/) {
2089 $decl_type = 'struct';
2090 } elsif ($identifier =~ m/^union\b/) {
2091 $decl_type = 'union';
2092 } elsif ($identifier =~ m/^enum\b/) {
2093 $decl_type = 'enum';
2094 } elsif ($identifier =~ m/^typedef\b/) {
2095 $decl_type = 'typedef';
2097 $decl_type = 'function';
2101 print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
2104 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2105 " - I thought it was a doc line\n";
2107 $state = STATE_NORMAL;
2113 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2115 sub process_body($$) {
2118 # Until all named variable macro parameters are
2119 # documented using the bare name (`x`) rather than with
2120 # dots (`x...`), strip the dots:
2121 if ($section =~ /\w\.\.\.$/) {
2122 $section =~ s/\.\.\.$//;
2125 print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
2130 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2131 dump_section($file, $section, $contents);
2132 $section = $section_default;
2133 $new_start_line = $.;
2137 if (/$doc_sect/i) { # case insensitive for supported section names
2141 # map the supported section names to the canonical names
2142 if ($newsection =~ m/^description$/i) {
2143 $newsection = $section_default;
2144 } elsif ($newsection =~ m/^context$/i) {
2145 $newsection = $section_context;
2146 } elsif ($newsection =~ m/^returns?$/i) {
2147 $newsection = $section_return;
2148 } elsif ($newsection =~ m/^\@return$/) {
2149 # special: @return is a section, not a param description
2150 $newsection = $section_return;
2153 if (($contents ne "") && ($contents ne "\n")) {
2154 if (!$in_doc_sect && $verbose) {
2155 print STDERR "${file}:$.: warning: contents before sections\n";
2158 dump_section($file, $section, $contents);
2159 $section = $section_default;
2163 $state = STATE_BODY;
2164 $contents = $newcontents;
2165 $new_start_line = $.;
2166 while (substr($contents, 0, 1) eq " ") {
2167 $contents = substr($contents, 1);
2169 if ($contents ne "") {
2172 $section = $newsection;
2173 $leading_space = undef;
2174 } elsif (/$doc_end/) {
2175 if (($contents ne "") && ($contents ne "\n")) {
2176 dump_section($file, $section, $contents);
2177 $section = $section_default;
2180 # look for doc_com + <text> + doc_end:
2181 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2182 print STDERR "${file}:$.: warning: suspicious ending line: $_";
2187 $state = STATE_PROTO;
2189 $new_start_line = $. + 1;
2190 } elsif (/$doc_content/) {
2192 if ($section eq $section_context) {
2193 dump_section($file, $section, $contents);
2194 $section = $section_default;
2196 $new_start_line = $.;
2197 $state = STATE_BODY;
2199 if ($section ne $section_default) {
2200 $state = STATE_BODY_WITH_BLANK_LINE;
2202 $state = STATE_BODY;
2206 } elsif ($state == STATE_BODY_MAYBE) {
2207 # Continued declaration purpose
2208 chomp($declaration_purpose);
2209 $declaration_purpose .= " " . $1;
2210 $declaration_purpose =~ s/\s+/ /g;
2213 if ($section =~ m/^@/ || $section eq $section_context) {
2214 if (!defined $leading_space) {
2215 if ($cont =~ m/^(\s+)/) {
2216 $leading_space = $1;
2218 $leading_space = "";
2221 $cont =~ s/^$leading_space//;
2223 $contents .= $cont . "\n";
2226 # i dont know - bad line? ignore.
2227 print STDERR "${file}:$.: warning: bad line: $_";
2234 # STATE_PROTO: reading a function/whatever prototype.
2236 sub process_proto($$) {
2239 if (/$doc_inline_oneline/) {
2242 if ($contents ne "") {
2244 dump_section($file, $section, $contents);
2245 $section = $section_default;
2248 } elsif (/$doc_inline_start/) {
2249 $state = STATE_INLINE;
2250 $inline_doc_state = STATE_INLINE_NAME;
2251 } elsif ($decl_type eq 'function') {
2252 process_proto_function($_, $file);
2254 process_proto_type($_, $file);
2259 # STATE_DOCBLOCK: within a DOC: block.
2261 sub process_docblock($$) {
2265 dump_doc_section($file, $section, $contents);
2266 $section = $section_default;
2269 %parameterdescs = ();
2270 %parametertypes = ();
2271 @parameterlist = ();
2275 $state = STATE_NORMAL;
2276 } elsif (/$doc_content/) {
2278 $contents .= $blankline;
2280 $contents .= $1 . "\n";
2286 # STATE_INLINE: docbook comments within a prototype.
2288 sub process_inline($$) {
2291 # First line (state 1) needs to be a @parameter
2292 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2295 $new_start_line = $.;
2296 if ($contents ne "") {
2297 while (substr($contents, 0, 1) eq " ") {
2298 $contents = substr($contents, 1);
2302 $inline_doc_state = STATE_INLINE_TEXT;
2303 # Documentation block end */
2304 } elsif (/$doc_inline_end/) {
2305 if (($contents ne "") && ($contents ne "\n")) {
2306 dump_section($file, $section, $contents);
2307 $section = $section_default;
2310 $state = STATE_PROTO;
2311 $inline_doc_state = STATE_INLINE_NA;
2313 } elsif (/$doc_content/) {
2314 if ($inline_doc_state == STATE_INLINE_TEXT) {
2315 $contents .= $1 . "\n";
2316 # nuke leading blank lines
2317 if ($contents =~ /^\s*$/) {
2320 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2321 $inline_doc_state = STATE_INLINE_ERROR;
2322 print STDERR "${file}:$.: warning: ";
2323 print STDERR "Incorrect use of kernel-doc format: $_";
2330 sub process_file($) {
2332 my $initial_section_counter = $section_counter;
2333 my ($orig_file) = @_;
2335 $file = map_filename($orig_file);
2337 if (!open(IN_FILE,"<$file")) {
2338 print STDERR "Error: Cannot open file $file\n";
2345 $section_counter = 0;
2347 while (s/\\\s*$//) {
2350 # Replace tabs by spaces
2351 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2352 # Hand this line to the appropriate state handler
2353 if ($state == STATE_NORMAL) {
2355 } elsif ($state == STATE_NAME) {
2356 process_name($file, $_);
2357 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2358 $state == STATE_BODY_WITH_BLANK_LINE) {
2359 process_body($file, $_);
2360 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2361 process_inline($file, $_);
2362 } elsif ($state == STATE_PROTO) {
2363 process_proto($file, $_);
2364 } elsif ($state == STATE_DOCBLOCK) {
2365 process_docblock($file, $_);
2369 # Make sure we got something interesting.
2370 if ($initial_section_counter == $section_counter && $
2371 output_mode ne "none") {
2372 if ($output_selection == OUTPUT_INCLUDE) {
2373 print STDERR "${file}:1: warning: '$_' not found\n"
2374 for keys %function_table;
2377 print STDERR "${file}:1: warning: no structured comments found\n";
2384 if ($output_mode eq "rst") {
2385 get_sphinx_version() if (!$sphinx_major);
2388 $kernelversion = get_kernel_version();
2390 # generate a sequence of code that will splice in highlighting information
2391 # using the s// operator.
2392 for (my $k = 0; $k < @highlights; $k++) {
2393 my $pattern = $highlights[$k][0];
2394 my $result = $highlights[$k][1];
2395 # print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2396 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2399 # Read the file that maps relative names to absolute names for
2400 # separate source and object directories and for shadow trees.
2401 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2402 my ($relname, $absname);
2403 while(<SOURCE_MAP>) {
2405 ($relname, $absname) = (split())[0..1];
2406 $relname =~ s:^/+::;
2407 $source_map{$relname} = $absname;
2412 if ($output_selection == OUTPUT_EXPORTED ||
2413 $output_selection == OUTPUT_INTERNAL) {
2415 push(@export_file_list, @ARGV);
2417 foreach (@export_file_list) {
2419 process_export_file($_);
2427 if ($verbose && $errors) {
2428 print STDERR "$errors errors\n";
2430 if ($verbose && $warnings) {
2431 print STDERR "$warnings warnings\n";
2434 if ($Werror && $warnings) {
2435 print STDERR "$warnings warnings as Errors\n";
2438 exit($output_mode eq "none" ? 0 : $errors)