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 # Copyright (C) 2022 Tomasz Warniełło (POD)
18 use Pod::Usage qw/pod2usage/;
22 kernel-doc - Print formatted kernel documentation to stdout
26 kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-description] [-Wcontents-before-sections]
28 -rst [-sphinx-version VERSION] [-enable-lineno] |
34 [-function NAME] ... |
38 [-export-file FILE] ...
41 Run `kernel-doc -h` for details.
45 Read C language source or header FILEs, extract embedded documentation comments,
46 and print formatted documentation to standard output.
48 The documentation comments are identified by the "/**" opening comment mark.
50 See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
54 # more perldoc at the end of the file
60 my $anon_struct_union = 0;
62 # match expressions used to find embedded type information
63 my $type_constant = '\b``([^\`]+)``\b';
64 my $type_constant2 = '\%([-_\w]+)';
65 my $type_func = '(\w+)\(\)';
66 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
67 my $type_param_ref = '([\!~]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
68 my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
69 my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
70 my $type_env = '(\$\w+)';
71 my $type_enum = '\&(enum\s*([_\w]+))';
72 my $type_struct = '\&(struct\s*([_\w]+))';
73 my $type_typedef = '\&(typedef\s*([_\w]+))';
74 my $type_union = '\&(union\s*([_\w]+))';
75 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
76 my $type_fallback = '\&([_\w]+)';
77 my $type_member_func = $type_member . '\(\)';
79 # Output conversion substitutions.
80 # One for each output format
82 # these are pretty rough
83 my @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"]
96 my $blankline_man = "";
99 my @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**"]
116 my $blankline_rst = "\n";
121 -message => "No arguments!\n",
124 -sections => 'SYNOPSIS',
130 my ($sphinx_major, $sphinx_minor, $sphinx_patch);
132 my $dohighlight = "";
138 my $Wcontents_before_sections = 0;
139 my $output_mode = "rst";
140 my $output_preformatted = 0;
141 my $no_doc_sections = 0;
142 my $enable_lineno = 0;
143 my @highlights = @highlights_rst;
144 my $blankline = $blankline_rst;
145 my $modulename = "Kernel API";
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
153 my $output_selection = OUTPUT_ALL;
154 my $show_not_found = 0; # No longer used
156 my @export_file_list;
159 if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
160 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
161 @build_time = gmtime($seconds);
163 @build_time = localtime;
166 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
167 'July', 'August', 'September', 'October',
168 'November', 'December')[$build_time[4]] .
169 " " . ($build_time[5]+1900);
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.
175 my ($function, %function_table, %parametertypes, $declaration_purpose);
176 my %nosymbol_table = ();
177 my $declaration_start_line;
178 my ($type, $declaration_name, $return_type);
179 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
181 if (defined($ENV{'KBUILD_VERBOSE'}) && $ENV{'KBUILD_VERBOSE'} =~ '1') {
185 if (defined($ENV{'KCFLAGS'})) {
186 my $kcflags = "$ENV{'KCFLAGS'}";
188 if ($kcflags =~ /Werror/) {
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
196 if (defined($ENV{'KDOC_WERROR'})) {
197 $Werror = "$ENV{'KDOC_WERROR'}";
199 # other environment variables are converted to command-line
200 # arguments in cmd_checkdoc in the build system
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
208 my $section_counter = 0;
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
227 # Inline documentation state
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.
237 my $inline_doc_state;
239 #declaration types: can be
240 # 'function', 'struct', 'union', 'enum', 'typedef'
243 # Name of the kernel-doc identifier for non-DOC markups
246 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
248 my $doc_com = '\s*\*\s*';
249 my $doc_com_body = '\s*\* ?';
250 my $doc_decl = $doc_com . '(\w+)';
251 # @params and a strictly limited set of supported section names
256 # while trying to not match literal block starts like "example::"
258 my $doc_sect = $doc_com .
259 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
260 my $doc_content = $doc_com_body . '(.*)';
261 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
262 my $doc_inline_start = '^\s*/\*\*\s*$';
263 my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
264 my $doc_inline_end = '^\s*\*/\s*$';
265 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
266 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
267 my $export_symbol_ns = '^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*\w+\)\s*;';
268 my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
269 my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
272 my %parameterdesc_start_lines;
276 my %section_start_lines;
281 my $new_start_line = 0;
283 # the canonical section names. see also $doc_sect above.
284 my $section_default = "Description"; # default section
285 my $section_intro = "Introduction";
286 my $section = $section_default;
287 my $section_context = "Context";
288 my $section_return = "Return";
290 my $undescribed = "-- undescribed --";
294 while ($ARGV[0] =~ m/^--?(.*)/) {
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") {
327 } elsif ($cmd eq "Werror") {
329 } elsif ($cmd eq "Wreturn") {
331 } elsif ($cmd eq "Wshort-desc") {
333 } elsif ($cmd eq "Wcontents-before-sections") {
334 $Wcontents_before_sections = 1;
335 } elsif ($cmd eq "Wall") {
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') {
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+)?/) {
352 $sphinx_minor = substr($2,1);
357 $sphinx_patch = substr($3,1)
362 die "Sphinx version should either major.minor or major.minor.patch format\n";
367 -message => "Argument unknown!\n",
370 -sections => 'SYNOPSIS',
376 -message => "FILE argument missing\n",
379 -sections => 'SYNOPSIS',
385 # continue execution near EOF;
387 # The C domain dialect changed on Sphinx 3. So, we need to check the
388 # version in order to produce the right tags.
391 foreach(split(/:/, $ENV{PATH})) {
392 return "$_/$_[0]" if(-x "$_/$_[0]");
396 sub get_sphinx_version()
400 my $cmd = "sphinx-build";
401 if (!findprog($cmd)) {
402 my $cmd = "sphinx-build3";
403 if (!findprog($cmd)) {
407 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
408 $sphinx_major, $sphinx_minor, $sphinx_patch;
413 open IN, "$cmd --version 2>&1 |";
415 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
421 # Sphinx 1.2.x uses a different format
422 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
432 # get kernel version from env
433 sub get_kernel_version() {
434 my $version = 'unknown kernel version';
436 if (defined($ENV{'KERNELVERSION'})) {
437 $version = $ENV{'KERNELVERSION'};
445 if ($enable_lineno && defined($lineno)) {
446 print ".. LINENO " . $lineno . "\n";
451 my $location = shift;
453 print STDERR "$location: warning: $msg";
457 # dumps section contents to arrays/hashes intended for that purpose.
462 my $contents = join "\n", @_;
464 if ($name =~ m/$type_param/) {
466 $parameterdescs{$name} = $contents;
467 $sectcheck = $sectcheck . $name . " ";
468 $parameterdesc_start_lines{$name} = $new_start_line;
470 } elsif ($name eq "@\.\.\.") {
472 $parameterdescs{$name} = $contents;
473 $sectcheck = $sectcheck . $name . " ";
474 $parameterdesc_start_lines{$name} = $new_start_line;
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");
482 $sections{$name} .= $contents;
484 $sections{$name} = $contents;
485 push @sectionlist, $name;
486 $section_start_lines{$name} = $new_start_line;
493 # dump DOC: section after checking that it should go out
495 sub dump_doc_section {
498 my $contents = join "\n", @_;
500 if ($no_doc_sections) {
504 return if (defined($nosymbol_table{$name}));
506 if (($output_selection == OUTPUT_ALL) ||
507 (($output_selection == OUTPUT_INCLUDE) &&
508 defined($function_table{$name})))
510 dump_section($file, $name, $contents);
511 output_blockhead({'sectionlist' => \@sectionlist,
512 'sections' => \%sections,
513 'module' => $modulename,
514 'content-only' => ($output_selection != OUTPUT_ALL), });
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
529 sub output_highlight {
530 my $contents = join "\n",@_;
534 # if (!defined $contents) {
536 # confess "output_highlight got called with no args?\n";
539 # print STDERR "contents b4:$contents\n";
542 # print STDERR "contents af:$contents\n";
544 foreach $line (split "\n", $contents) {
545 if (! $output_preformatted) {
549 if (! $output_preformatted) {
550 print $lineprefix, $blankline;
553 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
556 print $lineprefix, $line;
564 # output function in man
565 sub output_function_man(%) {
567 my ($parameter, $section);
570 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
573 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
575 print ".SH SYNOPSIS\n";
576 if ($args{'functiontype'} ne "") {
577 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
579 print ".B \"" . $args{'function'} . "\n";
584 foreach my $parameter (@{$args{'parameterlist'}}) {
585 if ($count == $#{$args{'parameterlist'}}) {
588 $type = $args{'parametertypes'}{$parameter};
589 if ($type =~ m/$function_pointer/) {
590 # pointer-to-function
591 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
593 $type =~ s/([^\*])$/$1 /;
594 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
600 print ".SH ARGUMENTS\n";
601 foreach $parameter (@{$args{'parameterlist'}}) {
602 my $parameter_name = $parameter;
603 $parameter_name =~ s/\[.*//;
605 print ".IP \"" . $parameter . "\" 12\n";
606 output_highlight($args{'parameterdescs'}{$parameter_name});
608 foreach $section (@{$args{'sectionlist'}}) {
609 print ".SH \"", uc $section, "\"\n";
610 output_highlight($args{'sections'}{$section});
616 sub output_enum_man(%) {
618 my ($parameter, $section);
621 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
624 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
626 print ".SH SYNOPSIS\n";
627 print "enum " . $args{'enum'} . " {\n";
629 foreach my $parameter (@{$args{'parameterlist'}}) {
630 print ".br\n.BI \" $parameter\"\n";
631 if ($count == $#{$args{'parameterlist'}}) {
641 print ".SH Constants\n";
642 foreach $parameter (@{$args{'parameterlist'}}) {
643 my $parameter_name = $parameter;
644 $parameter_name =~ s/\[.*//;
646 print ".IP \"" . $parameter . "\" 12\n";
647 output_highlight($args{'parameterdescs'}{$parameter_name});
649 foreach $section (@{$args{'sectionlist'}}) {
650 print ".SH \"$section\"\n";
651 output_highlight($args{'sections'}{$section});
656 # output struct in man
657 sub output_struct_man(%) {
659 my ($parameter, $section);
661 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
664 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
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";
673 print ".SH Members\n";
674 foreach $parameter (@{$args{'parameterlist'}}) {
675 ($parameter =~ /^#/) && next;
677 my $parameter_name = $parameter;
678 $parameter_name =~ s/\[.*//;
680 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
681 print ".IP \"" . $parameter . "\" 12\n";
682 output_highlight($args{'parameterdescs'}{$parameter_name});
684 foreach $section (@{$args{'sectionlist'}}) {
685 print ".SH \"$section\"\n";
686 output_highlight($args{'sections'}{$section});
691 # output typedef in man
692 sub output_typedef_man(%) {
694 my ($parameter, $section);
696 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
699 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
701 foreach $section (@{$args{'sectionlist'}}) {
702 print ".SH \"$section\"\n";
703 output_highlight($args{'sections'}{$section});
707 sub output_blockhead_man(%) {
709 my ($parameter, $section);
712 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
714 foreach $section (@{$args{'sectionlist'}}) {
715 print ".SH \"$section\"\n";
716 output_highlight($args{'sections'}{$section});
721 # output in restructured text
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.
729 sub output_blockhead_rst(%) {
731 my ($parameter, $section);
733 foreach $section (@{$args{'sectionlist'}}) {
734 next if (defined($nosymbol_table{$section}));
736 if ($output_selection != OUTPUT_INCLUDE) {
737 print ".. _$section:\n\n";
738 print "**$section**\n\n";
740 print_lineno($section_start_lines{$section});
741 output_highlight_rst($args{'sections'}{$section});
747 # Apply the RST highlights to a sub-block of text.
749 sub highlight_block($) {
750 # The dohighlight kludge requires the text be called $contents
751 my $contents = shift;
758 # Regexes used only here.
760 my $sphinx_literal = '^[^.].*::$';
761 my $sphinx_cblock = '^\.\.\ +code-block::';
763 sub output_highlight_rst {
764 my $input = join "\n",@_;
771 foreach $line (split "\n",$input) {
773 # If we're in a literal block, see if we should drop out
774 # of it. Otherwise pass the line straight through unmunged.
777 if (! ($line =~ /^\s*$/)) {
779 # If this is the first non-blank line in a literal
780 # block we need to figure out what the proper indent is.
782 if ($litprefix eq "") {
784 $litprefix = '^' . $1;
785 $output .= $line . "\n";
786 } elsif (! ($line =~ /$litprefix/)) {
789 $output .= $line . "\n";
792 $output .= $line . "\n";
796 # Not in a literal block (or just dropped out)
799 $block .= $line . "\n";
800 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
803 $output .= highlight_block($block);
810 $output .= highlight_block($block);
812 foreach $line (split "\n", $output) {
813 print $lineprefix . $line . "\n";
817 sub output_function_rst(%) {
819 my ($parameter, $section);
820 my $oldprefix = $lineprefix;
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**: ";
830 output_highlight_rst($args{'purpose'});
831 $start = "\n\n**Syntax**\n\n ``";
834 print ".. c:function:: ";
837 if ($args{'typedef'} || $args{'functiontype'} eq "") {
839 print ".. c:macro:: ". $args{'function'} . "\n\n";
841 print ".. c:function:: ";
844 if ($args{'typedef'}) {
845 print_lineno($declaration_start_line);
846 print " **Typedef**: ";
848 output_highlight_rst($args{'purpose'});
849 $start = "\n\n**Syntax**\n\n ``";
851 print "``" if ($is_macro);
854 if ($args{'functiontype'} ne "") {
855 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
857 $start .= $args{'function'} . " (";
862 foreach my $parameter (@{$args{'parameterlist'}}) {
867 $type = $args{'parametertypes'}{$parameter};
869 if ($type =~ m/$function_pointer/) {
870 # pointer-to-function
871 print $1 . $parameter . ") (" . $2 . ")";
881 if (!$args{'typedef'}) {
882 print_lineno($declaration_start_line);
884 output_highlight_rst($args{'purpose'});
889 # Put our descriptive text into a container (thus an HTML <div>) to help
890 # set the function prototypes apart.
892 print ".. container:: kernelindent\n\n";
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};
901 print $lineprefix . "``$type``\n";
903 print $lineprefix . "``$parameter``\n";
906 print_lineno($parameterdesc_start_lines{$parameter_name});
909 if (defined($args{'parameterdescs'}{$parameter_name}) &&
910 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
911 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
913 print $lineprefix . "*undescribed*\n";
919 output_section_rst(@_);
920 $lineprefix = $oldprefix;
923 sub output_section_rst(%) {
926 my $oldprefix = $lineprefix;
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});
937 sub output_enum_rst(%) {
940 my $oldprefix = $lineprefix;
944 if ($sphinx_major < 3) {
945 my $name = "enum " . $args{'enum'};
946 print "\n\n.. c:type:: " . $name . "\n\n";
948 my $name = $args{'enum'};
949 print "\n\n.. c:enum:: " . $name . "\n\n";
951 print_lineno($declaration_start_line);
953 output_highlight_rst($args{'purpose'});
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";
963 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
964 output_highlight_rst($args{'parameterdescs'}{$parameter});
966 print $lineprefix . "*undescribed*\n";
971 $lineprefix = $oldprefix;
972 output_section_rst(@_);
975 sub output_typedef_rst(%) {
978 my $oldprefix = $lineprefix;
981 if ($sphinx_major < 3) {
982 $name = "typedef " . $args{'typedef'};
984 $name = $args{'typedef'};
986 print "\n\n.. c:type:: " . $name . "\n\n";
987 print_lineno($declaration_start_line);
989 output_highlight_rst($args{'purpose'});
992 $lineprefix = $oldprefix;
993 output_section_rst(@_);
996 sub output_struct_rst(%) {
999 my $oldprefix = $lineprefix;
1001 if ($sphinx_major < 3) {
1002 my $name = $args{'type'} . " " . $args{'struct'};
1003 print "\n\n.. c:type:: " . $name . "\n\n";
1005 my $name = $args{'struct'};
1006 if ($args{'type'} eq 'union') {
1007 print "\n\n.. c:union:: " . $name . "\n\n";
1009 print "\n\n.. c:struct:: " . $name . "\n\n";
1012 print_lineno($declaration_start_line);
1014 output_highlight_rst($args{'purpose'});
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";
1025 print $lineprefix . "**Members**\n\n";
1026 foreach $parameter (@{$args{'parameterlist'}}) {
1027 ($parameter =~ /^#/) && next;
1029 my $parameter_name = $parameter;
1030 $parameter_name =~ s/\[.*//;
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";
1037 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1043 $lineprefix = $oldprefix;
1044 output_section_rst(@_);
1047 ## none mode output functions
1049 sub output_function_none(%) {
1052 sub output_enum_none(%) {
1055 sub output_typedef_none(%) {
1058 sub output_struct_none(%) {
1061 sub output_blockhead_none(%) {
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
1068 sub output_declaration {
1071 my $functype = shift;
1072 my $func = "output_${functype}_$output_mode";
1074 return if (defined($nosymbol_table{$name}));
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}))))
1089 # generic output function - calls the right one based on current output mode.
1090 sub output_blockhead {
1092 my $func = "output_blockhead_" . $output_mode;
1098 # takes a declaration (struct, union, enum, typedef) and
1099 # invokes the right handler. NOT called for functions.
1100 sub dump_declaration($$) {
1102 my ($prototype, $file) = @_;
1103 my $func = "dump_" . $decl_type;
1107 sub dump_union($$) {
1111 sub dump_struct($$) {
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)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
1122 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1124 $declaration_name = $2;
1126 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1128 $declaration_name = $3;
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");
1138 # ignore members marked private:
1139 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1140 $members =~ s/\/\*\s*private:.*//gosi;
1142 $members =~ s/\/\*.*?\*\///gos;
1144 $members =~ s/\s*$attribute/ /gi;
1145 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1146 $members =~ s/\s*__packed\s*/ /gos;
1147 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1148 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1149 $members =~ s/\s*____cacheline_aligned/ /gos;
1150 # unwrap struct_group():
1151 # - first eat non-declaration parameters and rewrite for final match
1152 # - then remove macro, outer parens, and trailing semicolon
1153 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1154 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1155 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1156 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
1158 my $args = qr{([^,)]+)};
1159 # replace DECLARE_BITMAP
1160 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1161 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
1162 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1163 # replace DECLARE_HASHTABLE
1164 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1165 # replace DECLARE_KFIFO
1166 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1167 # replace DECLARE_KFIFO_PTR
1168 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1169 # replace DECLARE_FLEX_ARRAY
1170 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
1171 #replace DEFINE_DMA_UNMAP_ADDR
1172 $members =~ s/DEFINE_DMA_UNMAP_ADDR\s*\($args\)/dma_addr_t $1/gos;
1173 #replace DEFINE_DMA_UNMAP_LEN
1174 $members =~ s/DEFINE_DMA_UNMAP_LEN\s*\($args\)/__u32 $1/gos;
1175 my $declaration = $members;
1177 # Split nested struct/union elements as newer ones
1178 while ($members =~ m/$struct_members/) {
1183 foreach my $id(split /,/, $ids) {
1184 $newmember .= "$maintype $id; ";
1187 $id =~ s/^\s*\**(\S+)\s*/$1/;
1188 foreach my $arg (split /;/, $content) {
1189 next if ($arg =~ m/^\s*$/);
1190 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1191 # pointer-to-function
1196 if ($id =~ m/^\s*$/) {
1197 # anonymous struct/union
1198 $newmember .= "$type$name$extra; ";
1200 $newmember .= "$type$id.$name$extra; ";
1208 $arg =~ s/:\s*\d+\s*//g;
1210 $arg =~ s/\[.*\]//g;
1211 # The type may have multiple words,
1212 # and multiple IDs can be defined, like:
1213 # const struct foo, *bar, foobar
1214 # So, we remove spaces when parsing the
1215 # names, in order to match just names
1216 # and commas for the names
1217 $arg =~ s/\s*,\s*/,/g;
1218 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1222 $newmember .= "$arg; ";
1225 foreach my $name (split /,/, $names) {
1226 $name =~ s/^\s*\**(\S+)\s*/$1/;
1227 next if (($name =~ m/^\s*$/));
1228 if ($id =~ m/^\s*$/) {
1229 # anonymous struct/union
1230 $newmember .= "$type $name; ";
1232 $newmember .= "$type $id.$name; ";
1238 $members =~ s/$struct_members/$newmember/;
1241 # Ignore other nested elements, like enums
1242 $members =~ s/(\{[^\{\}]*\})//g;
1244 create_parameterlist($members, ';', $file, $declaration_name);
1245 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1247 # Adjust declaration for better display
1248 $declaration =~ s/([\{;])/$1\n/g;
1249 $declaration =~ s/\}\s+;/};/g;
1250 # Better handle inlined enums
1251 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1253 my @def_args = split /\n/, $declaration;
1256 foreach my $clause (@def_args) {
1257 $clause =~ s/^\s+//;
1258 $clause =~ s/\s+$//;
1259 $clause =~ s/\s+/ /;
1261 $level-- if ($clause =~ m/(\})/ && $level > 1);
1262 if (!($clause =~ m/^\s*#/)) {
1263 $declaration .= "\t" x $level;
1265 $declaration .= "\t" . $clause . "\n";
1266 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1268 output_declaration($declaration_name,
1270 {'struct' => $declaration_name,
1271 'module' => $modulename,
1272 'definition' => $declaration,
1273 'parameterlist' => \@parameterlist,
1274 'parameterdescs' => \%parameterdescs,
1275 'parametertypes' => \%parametertypes,
1276 'sectionlist' => \@sectionlist,
1277 'sections' => \%sections,
1278 'purpose' => $declaration_purpose,
1279 'type' => $decl_type
1283 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1289 sub show_warnings($$) {
1290 my $functype = shift;
1293 return 0 if (defined($nosymbol_table{$name}));
1295 return 1 if ($output_selection == OUTPUT_ALL);
1297 if ($output_selection == OUTPUT_EXPORTED) {
1298 if (defined($function_table{$name})) {
1304 if ($output_selection == OUTPUT_INTERNAL) {
1305 if (!($functype eq "function" && defined($function_table{$name}))) {
1311 if ($output_selection == OUTPUT_INCLUDE) {
1312 if (defined($function_table{$name})) {
1318 die("Please add the new output type at show_warnings()");
1326 # ignore members marked private:
1327 $x =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1328 $x =~ s/\/\*\s*private:.*}/}/gosi;
1330 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1331 # strip #define macros inside enums
1332 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1334 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1335 $declaration_name = $2;
1337 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1338 $declaration_name = $1;
1343 if ($identifier ne $declaration_name) {
1344 if ($identifier eq "") {
1345 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
1347 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
1351 $declaration_name = "(anonymous)" if ($declaration_name eq "");
1355 $members =~ s/\s+$//;
1357 foreach my $arg (split ',', $members) {
1358 $arg =~ s/^\s*(\w+).*/$1/;
1359 push @parameterlist, $arg;
1360 if (!$parameterdescs{$arg}) {
1361 $parameterdescs{$arg} = $undescribed;
1362 if (show_warnings("enum", $declaration_name)) {
1363 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
1366 $_members{$arg} = 1;
1369 while (my ($k, $v) = each %parameterdescs) {
1370 if (!exists($_members{$k})) {
1371 if (show_warnings("enum", $declaration_name)) {
1372 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
1377 output_declaration($declaration_name,
1379 {'enum' => $declaration_name,
1380 'module' => $modulename,
1381 'parameterlist' => \@parameterlist,
1382 'parameterdescs' => \%parameterdescs,
1383 'sectionlist' => \@sectionlist,
1384 'sections' => \%sections,
1385 'purpose' => $declaration_purpose
1388 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1393 my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1394 my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1395 my $typedef_args = qr { \s*\((.*)\); }x;
1397 my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1398 my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1400 sub dump_typedef($$) {
1404 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1406 # Parse function typedef prototypes
1407 if ($x =~ $typedef1 || $x =~ $typedef2) {
1409 $declaration_name = $2;
1411 $return_type =~ s/^\s+//;
1413 if ($identifier ne $declaration_name) {
1414 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1418 create_parameterlist($args, ',', $file, $declaration_name);
1420 output_declaration($declaration_name,
1422 {'function' => $declaration_name,
1424 'module' => $modulename,
1425 'functiontype' => $return_type,
1426 'parameterlist' => \@parameterlist,
1427 'parameterdescs' => \%parameterdescs,
1428 'parametertypes' => \%parametertypes,
1429 'sectionlist' => \@sectionlist,
1430 'sections' => \%sections,
1431 'purpose' => $declaration_purpose
1436 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1437 $x =~ s/\(*.\)\s*;$/;/;
1438 $x =~ s/\[*.\]\s*;$/;/;
1441 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1442 $declaration_name = $1;
1444 if ($identifier ne $declaration_name) {
1445 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
1449 output_declaration($declaration_name,
1451 {'typedef' => $declaration_name,
1452 'module' => $modulename,
1453 'sectionlist' => \@sectionlist,
1454 'sections' => \%sections,
1455 'purpose' => $declaration_purpose
1459 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1464 sub save_struct_actual($) {
1467 # strip all spaces from the actual param so that it looks like one string item
1468 $actual =~ s/\s*//g;
1469 $struct_actual = $struct_actual . $actual . " ";
1472 sub create_parameterlist($$$$) {
1474 my $splitter = shift;
1476 my $declaration_name = shift;
1480 # temporarily replace commas inside function pointer definition
1481 my $arg_expr = qr{\([^\),]+};
1482 while ($args =~ /$arg_expr,/) {
1483 $args =~ s/($arg_expr),/$1#/g;
1486 foreach my $arg (split($splitter, $args)) {
1488 $arg =~ s/\/\*.*\*\///;
1489 # ignore argument attributes
1490 $arg =~ s/\sPOS0?\s/ /;
1491 # strip leading/trailing spaces
1497 # Treat preprocessor directive as a typeless variable just to fill
1498 # corresponding data structures "correctly". Catch it later in
1500 push_parameter($arg, "", "", $file);
1501 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1502 # pointer-to-function
1504 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1507 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1508 save_struct_actual($param);
1509 push_parameter($param, $type, $arg, $file, $declaration_name);
1511 $arg =~ s/\s*:\s*/:/g;
1512 $arg =~ s/\s*\[/\[/g;
1514 my @args = split('\s*,\s*', $arg);
1515 if ($args[0] =~ m/\*/) {
1516 $args[0] =~ s/(\*+)\s*/ $1/;
1520 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1522 push(@first_arg, split('\s+', $1));
1523 push(@first_arg, $2);
1525 @first_arg = split('\s+', shift @args);
1528 unshift(@args, pop @first_arg);
1529 $type = join " ", @first_arg;
1531 foreach $param (@args) {
1532 if ($param =~ m/^(\*+)\s*(.*)/) {
1533 save_struct_actual($2);
1535 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1537 elsif ($param =~ m/(.*?):(\d+)/) {
1538 if ($type ne "") { # skip unnamed bit-fields
1539 save_struct_actual($1);
1540 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1544 save_struct_actual($param);
1545 push_parameter($param, $type, $arg, $file, $declaration_name);
1552 sub push_parameter($$$$$) {
1555 my $org_arg = shift;
1557 my $declaration_name = shift;
1559 if (($anon_struct_union == 1) && ($type eq "") &&
1561 return; # ignore the ending }; from anon. struct/union
1564 $anon_struct_union = 0;
1565 $param =~ s/[\[\)].*//;
1567 if ($type eq "" && $param =~ /\.\.\.$/)
1569 if (!$param =~ /\w\.\.\.$/) {
1570 # handles unnamed variable parameters
1573 elsif ($param =~ /\w\.\.\.$/) {
1574 # for named variable parameters of the form `x...`, remove the dots
1575 $param =~ s/\.\.\.$//;
1577 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1578 $parameterdescs{$param} = "variable arguments";
1581 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1584 $parameterdescs{void} = "no arguments";
1586 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1587 # handle unnamed (anonymous) union or struct:
1590 $param = "{unnamed_" . $param . "}";
1591 $parameterdescs{$param} = "anonymous\n";
1592 $anon_struct_union = 1;
1595 # warn if parameter has no description
1596 # (but ignore ones starting with # as these are not parameters
1597 # but inline preprocessor statements);
1598 # Note: It will also ignore void params and unnamed structs/unions
1599 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1600 $parameterdescs{$param} = $undescribed;
1602 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1603 emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n");
1607 # strip spaces from $param so that it is one continuous string
1608 # on @parameterlist;
1609 # this fixes a problem where check_sections() cannot find
1610 # a parameter like "addr[6 + 2]" because it actually appears
1611 # as "addr[6", "+", "2]" on the parameter list;
1612 # but it's better to maintain the param string unchanged for output,
1613 # so just weaken the string compare in check_sections() to ignore
1614 # "[blah" in a parameter string;
1615 ###$param =~ s/\s*//g;
1616 push @parameterlist, $param;
1617 $org_arg =~ s/\s\s+/ /g;
1618 $parametertypes{$param} = $org_arg;
1621 sub check_sections($$$$$) {
1622 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1623 my @sects = split ' ', $sectcheck;
1624 my @prms = split ' ', $prmscheck;
1627 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1629 foreach $sx (0 .. $#sects) {
1631 foreach $px (0 .. $#prms) {
1632 $prm_clean = $prms[$px];
1633 $prm_clean =~ s/\[.*\]//;
1634 $prm_clean =~ s/$attribute//i;
1635 # ignore array size in a parameter string;
1636 # however, the original param string may contain
1637 # spaces, e.g.: addr[6 + 2]
1638 # and this appears in @prms as "addr[6" since the
1639 # parameter list is split at spaces;
1640 # hence just ignore "[..." for the sections check;
1641 $prm_clean =~ s/\[.*//;
1643 ##$prm_clean =~ s/^\**//;
1644 if ($prm_clean eq $sects[$sx]) {
1650 if ($decl_type eq "function") {
1651 emit_warning("${file}:$.",
1652 "Excess function parameter " .
1654 "description in '$decl_name'\n");
1661 # Checks the section describing the return value of a function.
1662 sub check_return_section {
1664 my $declaration_name = shift;
1665 my $return_type = shift;
1667 # Ignore an empty return type (It's a macro)
1668 # Ignore functions with a "void" return type. (But don't ignore "void *")
1669 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1673 if (!defined($sections{$section_return}) ||
1674 $sections{$section_return} eq "") {
1675 emit_warning("${file}:$.",
1676 "No description found for return value of " .
1677 "'$declaration_name'\n");
1682 # takes a function prototype and the name of the current file being
1683 # processed and spits out all the details stored in the global
1685 sub dump_function($$) {
1686 my $prototype = shift;
1690 print_lineno($new_start_line);
1692 $prototype =~ s/^static +//;
1693 $prototype =~ s/^extern +//;
1694 $prototype =~ s/^asmlinkage +//;
1695 $prototype =~ s/^inline +//;
1696 $prototype =~ s/^__inline__ +//;
1697 $prototype =~ s/^__inline +//;
1698 $prototype =~ s/^__always_inline +//;
1699 $prototype =~ s/^noinline +//;
1700 $prototype =~ s/^__FORTIFY_INLINE +//;
1701 $prototype =~ s/__init +//;
1702 $prototype =~ s/__init_or_module +//;
1703 $prototype =~ s/__deprecated +//;
1704 $prototype =~ s/__flatten +//;
1705 $prototype =~ s/__meminit +//;
1706 $prototype =~ s/__must_check +//;
1707 $prototype =~ s/__weak +//;
1708 $prototype =~ s/__sched +//;
1709 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1710 $prototype =~ s/__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//;
1711 $prototype =~ s/__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +//;
1712 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1713 $prototype =~ s/__attribute_const__ +//;
1714 $prototype =~ s/__attribute__\s*\(\(
1716 [\w\s]++ # attribute name
1717 (?:\([^)]*+\))? # attribute arguments
1718 \s*+,? # optional comma at the end
1722 # Yes, this truly is vile. We are looking for:
1723 # 1. Return type (may be nothing if we're looking at a macro)
1725 # 3. Function parameters.
1727 # All the while we have to watch out for function pointer parameters
1728 # (which IIRC is what the two sections are for), C types (these
1729 # regexps don't even start to express all the possibilities), and
1732 # If you mess with these regexps, it's a good idea to check that
1733 # the following functions' documentation still comes out right:
1734 # - parport_register_device (function pointer parameters)
1735 # - atomic_set (macro)
1736 # - pci_match_device, __copy_to_user (long return type)
1737 my $name = qr{[a-zA-Z0-9_~:]+};
1738 my $prototype_end1 = qr{[^\(]*};
1739 my $prototype_end2 = qr{[^\{]*};
1740 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1741 my $type1 = qr{[\w\s]+};
1742 my $type2 = qr{$type1\*+};
1744 if ($define && $prototype =~ m/^()($name)\s+/) {
1745 # This is an object-like macro, it has no return type and no parameter
1747 # Function-like macros are not allowed to have spaces between
1748 # declaration_name and opening parenthesis (notice the \s+).
1750 $declaration_name = $2;
1752 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1753 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1754 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
1756 $declaration_name = $2;
1759 create_parameterlist($args, ',', $file, $declaration_name);
1761 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
1765 if ($identifier ne $declaration_name) {
1766 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
1770 my $prms = join " ", @parameterlist;
1771 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1773 # This check emits a lot of warnings at the moment, because many
1774 # functions don't have a 'Return' doc section. So until the number
1775 # of warnings goes sufficiently down, the check is only performed in
1777 # TODO: always perform the check.
1778 if ($Wreturn && !$noret) {
1779 check_return_section($file, $declaration_name, $return_type);
1782 # The function parser can be called with a typedef parameter.
1784 if ($return_type =~ /typedef/) {
1785 output_declaration($declaration_name,
1787 {'function' => $declaration_name,
1789 'module' => $modulename,
1790 'functiontype' => $return_type,
1791 'parameterlist' => \@parameterlist,
1792 'parameterdescs' => \%parameterdescs,
1793 'parametertypes' => \%parametertypes,
1794 'sectionlist' => \@sectionlist,
1795 'sections' => \%sections,
1796 'purpose' => $declaration_purpose
1799 output_declaration($declaration_name,
1801 {'function' => $declaration_name,
1802 'module' => $modulename,
1803 'functiontype' => $return_type,
1804 'parameterlist' => \@parameterlist,
1805 'parameterdescs' => \%parameterdescs,
1806 'parametertypes' => \%parametertypes,
1807 'sectionlist' => \@sectionlist,
1808 'sections' => \%sections,
1809 'purpose' => $declaration_purpose
1816 %parameterdescs = ();
1817 %parametertypes = ();
1818 @parameterlist = ();
1822 $struct_actual = "";
1825 $state = STATE_NORMAL;
1826 $inline_doc_state = STATE_INLINE_NA;
1829 sub tracepoint_munge($) {
1831 my $tracepointname = 0;
1832 my $tracepointargs = 0;
1834 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1835 $tracepointname = $1;
1837 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1838 $tracepointname = $1;
1840 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1841 $tracepointname = $2;
1843 $tracepointname =~ s/^\s+//; #strip leading whitespace
1844 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1845 $tracepointargs = $1;
1847 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1848 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1851 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1852 $identifier = "trace_$identifier";
1856 sub syscall_munge() {
1859 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1860 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1861 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1863 ## $prototype = "long sys_$1(void)";
1866 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1867 if ($prototype =~ m/long (sys_.*?),/) {
1868 $prototype =~ s/,/\(/;
1870 $prototype =~ s/\)/\(void\)/;
1873 # now delete all of the odd-number commas in $prototype
1874 # so that arg types & arg names don't have a comma between them
1876 my $len = length($prototype);
1878 $len = 0; # skip the for-loop
1880 for (my $ix = 0; $ix < $len; $ix++) {
1881 if (substr($prototype, $ix, 1) eq ',') {
1883 if ($count % 2 == 1) {
1884 substr($prototype, $ix, 1) = ' ';
1890 sub process_proto_function($$) {
1894 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1896 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1899 elsif ($x =~ /([^\{]*)/) {
1903 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1904 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1905 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1906 $prototype =~ s@^\s+@@gos; # strip leading spaces
1908 # Handle prototypes for function pointers like:
1909 # int (*pcs_config)(struct foo)
1910 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1912 if ($prototype =~ /SYSCALL_DEFINE/) {
1915 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1916 $prototype =~ /DEFINE_SINGLE_EVENT/)
1918 tracepoint_munge($file);
1920 dump_function($prototype, $file);
1925 sub process_proto_type($$) {
1929 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1930 $x =~ s@^\s+@@gos; # strip leading spaces
1931 $x =~ s@\s+$@@gos; # strip trailing spaces
1932 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1935 # To distinguish preprocessor directive from regular declaration later.
1940 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1941 if( length $prototype ) {
1944 $prototype .= $1 . $2;
1945 ($2 eq '{') && $brcount++;
1946 ($2 eq '}') && $brcount--;
1947 if (($2 eq ';') && ($brcount == 0)) {
1948 dump_declaration($prototype, $file);
1961 sub map_filename($) {
1963 my ($orig_file) = @_;
1965 if (defined($ENV{'SRCTREE'})) {
1966 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1971 if (defined($source_map{$file})) {
1972 $file = $source_map{$file};
1978 sub process_export_file($) {
1979 my ($orig_file) = @_;
1980 my $file = map_filename($orig_file);
1982 if (!open(IN,"<$file")) {
1983 print STDERR "Error: Cannot open file $file\n";
1989 if (/$export_symbol/) {
1990 next if (defined($nosymbol_table{$2}));
1991 $function_table{$2} = 1;
1993 if (/$export_symbol_ns/) {
1994 next if (defined($nosymbol_table{$2}));
1995 $function_table{$2} = 1;
2003 # Parsers for the various processing states.
2005 # STATE_NORMAL: looking for the /** to begin everything.
2007 sub process_normal() {
2008 if (/$doc_start/o) {
2009 $state = STATE_NAME; # next line is always the function name
2011 $declaration_start_line = $. + 1;
2016 # STATE_NAME: Looking for the "name - description" line
2018 sub process_name($$) {
2022 if (/$doc_block/o) {
2023 $state = STATE_DOCBLOCK;
2025 $new_start_line = $.;
2028 $section = $section_intro;
2032 } elsif (/$doc_decl/o) {
2034 my $is_kernel_comment = 0;
2035 my $decl_start = qr{$doc_com};
2036 # test for pointer declaration type, foo * bar() - desc
2037 my $fn_type = qr{\w+\s*\*\s*};
2038 my $parenthesis = qr{\(\w*\)};
2039 my $decl_end = qr{[-:].*};
2040 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2043 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2046 $is_kernel_comment = 1;
2048 # Look for foo() or static void foo() - description; or misspelt
2050 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2051 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2053 $decl_type = 'function';
2054 $identifier =~ s/^define\s+//;
2055 $is_kernel_comment = 1;
2057 $identifier =~ s/\s+$//;
2059 $state = STATE_BODY;
2060 # if there's no @param blocks need to set up default section
2063 $section = $section_default;
2064 $new_start_line = $. + 1;
2066 # strip leading/trailing/multiple spaces
2070 $descr =~ s/\s+/ /g;
2071 $declaration_purpose = $descr;
2072 $state = STATE_BODY_MAYBE;
2074 $declaration_purpose = "";
2077 if (!$is_kernel_comment) {
2078 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
2079 $state = STATE_NORMAL;
2082 if (($declaration_purpose eq "") && $Wshort_desc) {
2083 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
2086 if ($identifier eq "" && $decl_type ne "enum") {
2087 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
2088 $state = STATE_NORMAL;
2092 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2095 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
2096 $state = STATE_NORMAL;
2102 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2104 sub process_body($$) {
2107 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2108 dump_section($file, $section, $contents);
2109 $section = $section_default;
2110 $new_start_line = $.;
2114 if (/$doc_sect/i) { # case insensitive for supported section names
2118 # map the supported section names to the canonical names
2119 if ($newsection =~ m/^description$/i) {
2120 $newsection = $section_default;
2121 } elsif ($newsection =~ m/^context$/i) {
2122 $newsection = $section_context;
2123 } elsif ($newsection =~ m/^returns?$/i) {
2124 $newsection = $section_return;
2125 } elsif ($newsection =~ m/^\@return$/) {
2126 # special: @return is a section, not a param description
2127 $newsection = $section_return;
2130 if (($contents ne "") && ($contents ne "\n")) {
2131 if (!$in_doc_sect && $Wcontents_before_sections) {
2132 emit_warning("${file}:$.", "contents before sections\n");
2134 dump_section($file, $section, $contents);
2135 $section = $section_default;
2139 $state = STATE_BODY;
2140 $contents = $newcontents;
2141 $new_start_line = $.;
2142 while (substr($contents, 0, 1) eq " ") {
2143 $contents = substr($contents, 1);
2145 if ($contents ne "") {
2148 $section = $newsection;
2149 $leading_space = undef;
2150 } elsif (/$doc_end/) {
2151 if (($contents ne "") && ($contents ne "\n")) {
2152 dump_section($file, $section, $contents);
2153 $section = $section_default;
2156 # look for doc_com + <text> + doc_end:
2157 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2158 emit_warning("${file}:$.", "suspicious ending line: $_");
2162 $state = STATE_PROTO;
2164 $new_start_line = $. + 1;
2165 } elsif (/$doc_content/) {
2167 if ($section eq $section_context) {
2168 dump_section($file, $section, $contents);
2169 $section = $section_default;
2171 $new_start_line = $.;
2172 $state = STATE_BODY;
2174 if ($section ne $section_default) {
2175 $state = STATE_BODY_WITH_BLANK_LINE;
2177 $state = STATE_BODY;
2181 } elsif ($state == STATE_BODY_MAYBE) {
2182 # Continued declaration purpose
2183 chomp($declaration_purpose);
2184 $declaration_purpose .= " " . $1;
2185 $declaration_purpose =~ s/\s+/ /g;
2188 if ($section =~ m/^@/ || $section eq $section_context) {
2189 if (!defined $leading_space) {
2190 if ($cont =~ m/^(\s+)/) {
2191 $leading_space = $1;
2193 $leading_space = "";
2196 $cont =~ s/^$leading_space//;
2198 $contents .= $cont . "\n";
2201 # i dont know - bad line? ignore.
2202 emit_warning("${file}:$.", "bad line: $_");
2208 # STATE_PROTO: reading a function/whatever prototype.
2210 sub process_proto($$) {
2213 if (/$doc_inline_oneline/) {
2216 if ($contents ne "") {
2218 dump_section($file, $section, $contents);
2219 $section = $section_default;
2222 } elsif (/$doc_inline_start/) {
2223 $state = STATE_INLINE;
2224 $inline_doc_state = STATE_INLINE_NAME;
2225 } elsif ($decl_type eq 'function') {
2226 process_proto_function($_, $file);
2228 process_proto_type($_, $file);
2233 # STATE_DOCBLOCK: within a DOC: block.
2235 sub process_docblock($$) {
2239 dump_doc_section($file, $section, $contents);
2240 $section = $section_default;
2243 %parameterdescs = ();
2244 %parametertypes = ();
2245 @parameterlist = ();
2249 $state = STATE_NORMAL;
2250 } elsif (/$doc_content/) {
2252 $contents .= $blankline;
2254 $contents .= $1 . "\n";
2260 # STATE_INLINE: docbook comments within a prototype.
2262 sub process_inline($$) {
2265 # First line (state 1) needs to be a @parameter
2266 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2269 $new_start_line = $.;
2270 if ($contents ne "") {
2271 while (substr($contents, 0, 1) eq " ") {
2272 $contents = substr($contents, 1);
2276 $inline_doc_state = STATE_INLINE_TEXT;
2277 # Documentation block end */
2278 } elsif (/$doc_inline_end/) {
2279 if (($contents ne "") && ($contents ne "\n")) {
2280 dump_section($file, $section, $contents);
2281 $section = $section_default;
2284 $state = STATE_PROTO;
2285 $inline_doc_state = STATE_INLINE_NA;
2287 } elsif (/$doc_content/) {
2288 if ($inline_doc_state == STATE_INLINE_TEXT) {
2289 $contents .= $1 . "\n";
2290 # nuke leading blank lines
2291 if ($contents =~ /^\s*$/) {
2294 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2295 $inline_doc_state = STATE_INLINE_ERROR;
2296 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
2302 sub process_file($) {
2304 my $initial_section_counter = $section_counter;
2305 my ($orig_file) = @_;
2307 $file = map_filename($orig_file);
2309 if (!open(IN_FILE,"<$file")) {
2310 print STDERR "Error: Cannot open file $file\n";
2317 $section_counter = 0;
2319 while (s/\\\s*$//) {
2322 # Replace tabs by spaces
2323 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2324 # Hand this line to the appropriate state handler
2325 if ($state == STATE_NORMAL) {
2327 } elsif ($state == STATE_NAME) {
2328 process_name($file, $_);
2329 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2330 $state == STATE_BODY_WITH_BLANK_LINE) {
2331 process_body($file, $_);
2332 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2333 process_inline($file, $_);
2334 } elsif ($state == STATE_PROTO) {
2335 process_proto($file, $_);
2336 } elsif ($state == STATE_DOCBLOCK) {
2337 process_docblock($file, $_);
2341 # Make sure we got something interesting.
2342 if ($initial_section_counter == $section_counter && $
2343 output_mode ne "none") {
2344 if ($output_selection == OUTPUT_INCLUDE) {
2345 emit_warning("${file}:1", "'$_' not found\n")
2346 for keys %function_table;
2349 emit_warning("${file}:1", "no structured comments found\n");
2356 if ($output_mode eq "rst") {
2357 get_sphinx_version() if (!$sphinx_major);
2360 $kernelversion = get_kernel_version();
2362 # generate a sequence of code that will splice in highlighting information
2363 # using the s// operator.
2364 for (my $k = 0; $k < @highlights; $k++) {
2365 my $pattern = $highlights[$k][0];
2366 my $result = $highlights[$k][1];
2367 # print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2368 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2371 # Read the file that maps relative names to absolute names for
2372 # separate source and object directories and for shadow trees.
2373 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2374 my ($relname, $absname);
2375 while(<SOURCE_MAP>) {
2377 ($relname, $absname) = (split())[0..1];
2378 $relname =~ s:^/+::;
2379 $source_map{$relname} = $absname;
2384 if ($output_selection == OUTPUT_EXPORTED ||
2385 $output_selection == OUTPUT_INTERNAL) {
2387 push(@export_file_list, @ARGV);
2389 foreach (@export_file_list) {
2391 process_export_file($_);
2399 if ($verbose && $errors) {
2400 print STDERR "$errors errors\n";
2402 if ($verbose && $warnings) {
2403 print STDERR "$warnings warnings\n";
2406 if ($Werror && $warnings) {
2407 print STDERR "$warnings warnings as Errors\n";
2410 exit($output_mode eq "none" ? 0 : $errors)
2417 =head2 Output format selection (mutually exclusive):
2423 Output troff manual page format.
2427 Output reStructuredText format. This is the default.
2431 Do not output documentation, only warnings.
2435 =head2 Output format modifiers
2437 =head3 reStructuredText only
2441 =item -sphinx-version VERSION
2443 Use the ReST C domain dialect compatible with a specific Sphinx Version.
2445 If not specified, kernel-doc will auto-detect using the sphinx-build version
2450 =head2 Output selection (mutually exclusive):
2456 Only output documentation for the symbols that have been exported using
2457 EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2461 Only output documentation for the symbols that have NOT been exported using
2462 EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE.
2464 =item -function NAME
2466 Only output documentation for the given function or DOC: section title.
2467 All other functions and DOC: sections are ignored.
2469 May be specified multiple times.
2471 =item -nosymbol NAME
2473 Exclude the specified symbol from the output documentation.
2475 May be specified multiple times.
2479 =head2 Output selection modifiers:
2483 =item -no-doc-sections
2485 Do not output DOC: sections.
2487 =item -export-file FILE
2489 Specify an additional FILE in which to look for EXPORT_SYMBOL information.
2491 To be used with -export or -internal.
2493 May be specified multiple times.
2497 =head3 reStructuredText only
2501 =item -enable-lineno
2503 Enable output of .. LINENO lines.
2507 =head2 Other parameters:
2517 Verbose output, more warnings and other information.
2521 Treat warnings as errors.