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 selection (mutually exclusive):
60 -export Only output documentation for symbols that have been
61 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
62 in any input FILE or -export-file FILE.
63 -internal Only output documentation for symbols that have NOT been
64 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
65 in any input FILE or -export-file FILE.
66 -function NAME Only output documentation for the given function(s)
67 or DOC: section title(s). All other functions and DOC:
68 sections are ignored. May be specified multiple times.
69 -nofunction NAME Do NOT output documentation for the given function(s);
70 only output documentation for the other functions and
71 DOC: sections. May be specified multiple times.
73 Output selection modifiers:
74 -no-doc-sections Do not output DOC: sections.
75 -enable-lineno Enable output of #define LINENO lines. Only works with
76 reStructuredText format.
77 -export-file FILE Specify an additional FILE in which to look for
78 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
79 -export or -internal. May be specified multiple times.
82 -v Verbose output, more warnings and other information.
84 -Werror Treat warnings as errors.
93 # In the following table, (...)? signifies optional structure.
94 # (...)* signifies 0 or more structure elements
96 # * function_name(:)? (- short description)?
97 # (* @parameterx: (description of parameter x)?)*
99 # * (Description:)? (Description of function)?
100 # * (section header: (section description)? )*
103 # So .. the trivial example would be:
109 # If the Description: header tag is omitted, then there must be a blank line
110 # after the last parameter specification.
113 # * my_function - does my stuff
114 # * @my_arg: its mine damnit
116 # * Does my stuff explained.
119 # or, could also use:
121 # * my_function - does my stuff
122 # * @my_arg: its mine damnit
123 # * Description: Does my stuff explained.
127 # Besides functions you can also write documentation for structs, unions,
128 # enums and typedefs. Instead of the function name you must write the name
129 # of the declaration; the struct/union/enum/typedef must always precede
130 # the name. Nesting of declarations is not supported.
131 # Use the argument mechanism to document members or constants.
134 # * struct my_struct - short description
136 # * @b: second member
138 # * Longer description
147 # All descriptions can be multiline, except the short function description.
149 # For really longs structs, you can also describe arguments inside the
150 # body of the struct.
153 # * struct my_struct - short description
155 # * @b: second member
157 # * Longer description
163 # * @c: This is longer description of C
165 # * You can use paragraphs to describe arguments
166 # * using this method.
171 # This should be use only for struct/enum members.
173 # You can also add additional sections. When documenting kernel functions you
174 # should document the "Context:" of the function, e.g. whether the functions
175 # can be called form interrupts. Unlike other sections you can end it with an
177 # A non-void function should have a "Return:" section describing the return
179 # Example-sections should contain the string EXAMPLE so that they are marked
180 # appropriately in DocBook.
184 # * user_function - function that can only be called in user context
185 # * @a: some argument
186 # * Context: !in_interrupt()
190 # * user_function(22);
195 # All descriptive text is further processed, scanning for the following special
196 # patterns, which are highlighted appropriately.
198 # 'funcname()' - function
199 # '$ENVVAR' - environmental variable
200 # '&struct_name' - name of a structure (up to two words including 'struct')
201 # '&struct_name.member' - name of a structure member
202 # '@parameter' - name of a parameter
203 # '%CONST' - name of a constant.
204 # '``LITERAL``' - literal string without any spaces on it.
210 my $anon_struct_union = 0;
212 # match expressions used to find embedded type information
213 my $type_constant = '\b``([^\`]+)``\b';
214 my $type_constant2 = '\%([-_\w]+)';
215 my $type_func = '(\w+)\(\)';
216 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
217 my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
218 my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
219 my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
220 my $type_env = '(\$\w+)';
221 my $type_enum = '\&(enum\s*([_\w]+))';
222 my $type_struct = '\&(struct\s*([_\w]+))';
223 my $type_typedef = '\&(typedef\s*([_\w]+))';
224 my $type_union = '\&(union\s*([_\w]+))';
225 my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
226 my $type_fallback = '\&([_\w]+)';
227 my $type_member_func = $type_member . '\(\)';
229 # Output conversion substitutions.
230 # One for each output format
232 # these are pretty rough
233 my @highlights_man = (
234 [$type_constant, "\$1"],
235 [$type_constant2, "\$1"],
236 [$type_func, "\\\\fB\$1\\\\fP"],
237 [$type_enum, "\\\\fI\$1\\\\fP"],
238 [$type_struct, "\\\\fI\$1\\\\fP"],
239 [$type_typedef, "\\\\fI\$1\\\\fP"],
240 [$type_union, "\\\\fI\$1\\\\fP"],
241 [$type_param, "\\\\fI\$1\\\\fP"],
242 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
243 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
244 [$type_fallback, "\\\\fI\$1\\\\fP"]
246 my $blankline_man = "";
249 my @highlights_rst = (
250 [$type_constant, "``\$1``"],
251 [$type_constant2, "``\$1``"],
252 # Note: need to escape () to avoid func matching later
253 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
254 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
255 [$type_fp_param, "**\$1\\\\(\\\\)**"],
256 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
257 [$type_func, "\$1()"],
258 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
259 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
260 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
261 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
262 # in rst this can refer to any type
263 [$type_fallback, "\\:c\\:type\\:`\$1`"],
264 [$type_param_ref, "**\$1\$2**"]
266 my $blankline_rst = "\n";
274 my $dohighlight = "";
278 my $output_mode = "rst";
279 my $output_preformatted = 0;
280 my $no_doc_sections = 0;
281 my $enable_lineno = 0;
282 my @highlights = @highlights_rst;
283 my $blankline = $blankline_rst;
284 my $modulename = "Kernel API";
287 OUTPUT_ALL => 0, # output all symbols and doc sections
288 OUTPUT_INCLUDE => 1, # output only specified symbols
289 OUTPUT_EXCLUDE => 2, # output everything except specified symbols
290 OUTPUT_EXPORTED => 3, # output exported symbols
291 OUTPUT_INTERNAL => 4, # output non-exported symbols
293 my $output_selection = OUTPUT_ALL;
294 my $show_not_found = 0; # No longer used
296 my @export_file_list;
299 if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
300 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
301 @build_time = gmtime($seconds);
303 @build_time = localtime;
306 my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
307 'July', 'August', 'September', 'October',
308 'November', 'December')[$build_time[4]] .
309 " " . ($build_time[5]+1900);
311 # Essentially these are globals.
312 # They probably want to be tidied up, made more localised or something.
313 # CAVEAT EMPTOR! Some of the others I localised may not want to be, which
314 # could cause "use of undefined value" or other bugs.
315 my ($function, %function_table, %parametertypes, $declaration_purpose);
316 my $declaration_start_line;
317 my ($type, $declaration_name, $return_type);
318 my ($newsection, $newcontents, $prototype, $brcount, %source_map);
320 if (defined($ENV{'KBUILD_VERBOSE'})) {
321 $verbose = "$ENV{'KBUILD_VERBOSE'}";
324 if (defined($ENV{'KDOC_WERROR'})) {
325 $Werror = "$ENV{'KDOC_WERROR'}";
328 if (defined($ENV{'KCFLAGS'})) {
329 my $kcflags = "$ENV{'KCFLAGS'}";
331 if ($kcflags =~ /Werror/) {
336 # Generated docbook code is inserted in a template at a point where
337 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
338 # https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
339 # We keep track of number of generated entries and generate a dummy
340 # if needs be to ensure the expanded template can be postprocessed
342 my $section_counter = 0;
348 STATE_NORMAL => 0, # normal code
349 STATE_NAME => 1, # looking for function name
350 STATE_BODY_MAYBE => 2, # body - or maybe more description
351 STATE_BODY => 3, # the body of the comment
352 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
353 STATE_PROTO => 5, # scanning prototype
354 STATE_DOCBLOCK => 6, # documentation block
355 STATE_INLINE => 7, # gathering doc outside main block
361 # Inline documentation state
363 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
364 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
365 STATE_INLINE_TEXT => 2, # looking for member documentation
366 STATE_INLINE_END => 3, # done
367 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
368 # Spit a warning as it's not
369 # proper kernel-doc and ignore the rest.
371 my $inline_doc_state;
373 #declaration types: can be
374 # 'function', 'struct', 'union', 'enum', 'typedef'
377 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
379 my $doc_com = '\s*\*\s*';
380 my $doc_com_body = '\s*\* ?';
381 my $doc_decl = $doc_com . '(\w+)';
382 # @params and a strictly limited set of supported section names
383 my $doc_sect = $doc_com .
384 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
385 my $doc_content = $doc_com_body . '(.*)';
386 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
387 my $doc_inline_start = '^\s*/\*\*\s*$';
388 my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
389 my $doc_inline_end = '^\s*\*/\s*$';
390 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
391 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
394 my %parameterdesc_start_lines;
398 my %section_start_lines;
403 my $new_start_line = 0;
405 # the canonical section names. see also $doc_sect above.
406 my $section_default = "Description"; # default section
407 my $section_intro = "Introduction";
408 my $section = $section_default;
409 my $section_context = "Context";
410 my $section_return = "Return";
412 my $undescribed = "-- undescribed --";
416 while ($ARGV[0] =~ m/^--?(.*)/) {
420 $output_mode = "man";
421 @highlights = @highlights_man;
422 $blankline = $blankline_man;
423 } elsif ($cmd eq "rst") {
424 $output_mode = "rst";
425 @highlights = @highlights_rst;
426 $blankline = $blankline_rst;
427 } elsif ($cmd eq "none") {
428 $output_mode = "none";
429 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
430 $modulename = shift @ARGV;
431 } elsif ($cmd eq "function") { # to only output specific functions
432 $output_selection = OUTPUT_INCLUDE;
433 $function = shift @ARGV;
434 $function_table{$function} = 1;
435 } elsif ($cmd eq "nofunction") { # output all except specific functions
436 $output_selection = OUTPUT_EXCLUDE;
437 $function = shift @ARGV;
438 $function_table{$function} = 1;
439 } elsif ($cmd eq "export") { # only exported symbols
440 $output_selection = OUTPUT_EXPORTED;
441 %function_table = ();
442 } elsif ($cmd eq "internal") { # only non-exported symbols
443 $output_selection = OUTPUT_INTERNAL;
444 %function_table = ();
445 } elsif ($cmd eq "export-file") {
446 my $file = shift @ARGV;
447 push(@export_file_list, $file);
448 } elsif ($cmd eq "v") {
450 } elsif ($cmd eq "Werror") {
452 } elsif (($cmd eq "h") || ($cmd eq "help")) {
454 } elsif ($cmd eq 'no-doc-sections') {
455 $no_doc_sections = 1;
456 } elsif ($cmd eq 'enable-lineno') {
458 } elsif ($cmd eq 'show-not-found') {
459 $show_not_found = 1; # A no-op but don't fail
466 # continue execution near EOF;
468 # get kernel version from env
469 sub get_kernel_version() {
470 my $version = 'unknown kernel version';
472 if (defined($ENV{'KERNELVERSION'})) {
473 $version = $ENV{'KERNELVERSION'};
481 if ($enable_lineno && defined($lineno)) {
482 print "#define LINENO " . $lineno . "\n";
486 # dumps section contents to arrays/hashes intended for that purpose.
491 my $contents = join "\n", @_;
493 if ($name =~ m/$type_param/) {
495 $parameterdescs{$name} = $contents;
496 $sectcheck = $sectcheck . $name . " ";
497 $parameterdesc_start_lines{$name} = $new_start_line;
499 } elsif ($name eq "@\.\.\.") {
501 $parameterdescs{$name} = $contents;
502 $sectcheck = $sectcheck . $name . " ";
503 $parameterdesc_start_lines{$name} = $new_start_line;
506 if (defined($sections{$name}) && ($sections{$name} ne "")) {
507 # Only warn on user specified duplicate section names.
508 if ($name ne $section_default) {
509 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
512 $sections{$name} .= $contents;
514 $sections{$name} = $contents;
515 push @sectionlist, $name;
516 $section_start_lines{$name} = $new_start_line;
523 # dump DOC: section after checking that it should go out
525 sub dump_doc_section {
528 my $contents = join "\n", @_;
530 if ($no_doc_sections) {
534 if (($output_selection == OUTPUT_ALL) ||
535 ($output_selection == OUTPUT_INCLUDE &&
536 defined($function_table{$name})) ||
537 ($output_selection == OUTPUT_EXCLUDE &&
538 !defined($function_table{$name})))
540 dump_section($file, $name, $contents);
541 output_blockhead({'sectionlist' => \@sectionlist,
542 'sections' => \%sections,
543 'module' => $modulename,
544 'content-only' => ($output_selection != OUTPUT_ALL), });
551 # parameterdescs, a hash.
552 # function => "function name"
553 # parameterlist => @list of parameters
554 # parameterdescs => %parameter descriptions
555 # sectionlist => @list of sections
556 # sections => %section descriptions
559 sub output_highlight {
560 my $contents = join "\n",@_;
564 # if (!defined $contents) {
566 # confess "output_highlight got called with no args?\n";
569 # print STDERR "contents b4:$contents\n";
572 # print STDERR "contents af:$contents\n";
574 foreach $line (split "\n", $contents) {
575 if (! $output_preformatted) {
579 if (! $output_preformatted) {
580 print $lineprefix, $blankline;
583 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
586 print $lineprefix, $line;
594 # output function in man
595 sub output_function_man(%) {
597 my ($parameter, $section);
600 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
603 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
605 print ".SH SYNOPSIS\n";
606 if ($args{'functiontype'} ne "") {
607 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
609 print ".B \"" . $args{'function'} . "\n";
614 foreach my $parameter (@{$args{'parameterlist'}}) {
615 if ($count == $#{$args{'parameterlist'}}) {
618 $type = $args{'parametertypes'}{$parameter};
619 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
620 # pointer-to-function
621 print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 . ")" . $post . "\"\n";
623 $type =~ s/([^\*])$/$1 /;
624 print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $post . "\"\n";
630 print ".SH ARGUMENTS\n";
631 foreach $parameter (@{$args{'parameterlist'}}) {
632 my $parameter_name = $parameter;
633 $parameter_name =~ s/\[.*//;
635 print ".IP \"" . $parameter . "\" 12\n";
636 output_highlight($args{'parameterdescs'}{$parameter_name});
638 foreach $section (@{$args{'sectionlist'}}) {
639 print ".SH \"", uc $section, "\"\n";
640 output_highlight($args{'sections'}{$section});
646 sub output_enum_man(%) {
648 my ($parameter, $section);
651 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
654 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
656 print ".SH SYNOPSIS\n";
657 print "enum " . $args{'enum'} . " {\n";
659 foreach my $parameter (@{$args{'parameterlist'}}) {
660 print ".br\n.BI \" $parameter\"\n";
661 if ($count == $#{$args{'parameterlist'}}) {
671 print ".SH Constants\n";
672 foreach $parameter (@{$args{'parameterlist'}}) {
673 my $parameter_name = $parameter;
674 $parameter_name =~ s/\[.*//;
676 print ".IP \"" . $parameter . "\" 12\n";
677 output_highlight($args{'parameterdescs'}{$parameter_name});
679 foreach $section (@{$args{'sectionlist'}}) {
680 print ".SH \"$section\"\n";
681 output_highlight($args{'sections'}{$section});
686 # output struct in man
687 sub output_struct_man(%) {
689 my ($parameter, $section);
691 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
694 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
696 my $declaration = $args{'definition'};
697 $declaration =~ s/\t/ /g;
698 $declaration =~ s/\n/"\n.br\n.BI \"/g;
699 print ".SH SYNOPSIS\n";
700 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
701 print ".BI \"$declaration\n};\n.br\n\n";
703 print ".SH Members\n";
704 foreach $parameter (@{$args{'parameterlist'}}) {
705 ($parameter =~ /^#/) && next;
707 my $parameter_name = $parameter;
708 $parameter_name =~ s/\[.*//;
710 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
711 print ".IP \"" . $parameter . "\" 12\n";
712 output_highlight($args{'parameterdescs'}{$parameter_name});
714 foreach $section (@{$args{'sectionlist'}}) {
715 print ".SH \"$section\"\n";
716 output_highlight($args{'sections'}{$section});
721 # output typedef in man
722 sub output_typedef_man(%) {
724 my ($parameter, $section);
726 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
729 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
731 foreach $section (@{$args{'sectionlist'}}) {
732 print ".SH \"$section\"\n";
733 output_highlight($args{'sections'}{$section});
737 sub output_blockhead_man(%) {
739 my ($parameter, $section);
742 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
744 foreach $section (@{$args{'sectionlist'}}) {
745 print ".SH \"$section\"\n";
746 output_highlight($args{'sections'}{$section});
751 # output in restructured text
755 # This could use some work; it's used to output the DOC: sections, and
756 # starts by putting out the name of the doc section itself, but that tends
757 # to duplicate a header already in the template file.
759 sub output_blockhead_rst(%) {
761 my ($parameter, $section);
763 foreach $section (@{$args{'sectionlist'}}) {
764 if ($output_selection != OUTPUT_INCLUDE) {
765 print "**$section**\n\n";
767 print_lineno($section_start_lines{$section});
768 output_highlight_rst($args{'sections'}{$section});
774 # Apply the RST highlights to a sub-block of text.
776 sub highlight_block($) {
777 # The dohighlight kludge requires the text be called $contents
778 my $contents = shift;
785 # Regexes used only here.
787 my $sphinx_literal = '^[^.].*::$';
788 my $sphinx_cblock = '^\.\.\ +code-block::';
790 sub output_highlight_rst {
791 my $input = join "\n",@_;
798 foreach $line (split "\n",$input) {
800 # If we're in a literal block, see if we should drop out
801 # of it. Otherwise pass the line straight through unmunged.
804 if (! ($line =~ /^\s*$/)) {
806 # If this is the first non-blank line in a literal
807 # block we need to figure out what the proper indent is.
809 if ($litprefix eq "") {
811 $litprefix = '^' . $1;
812 $output .= $line . "\n";
813 } elsif (! ($line =~ /$litprefix/)) {
816 $output .= $line . "\n";
819 $output .= $line . "\n";
823 # Not in a literal block (or just dropped out)
826 $block .= $line . "\n";
827 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
830 $output .= highlight_block($block);
837 $output .= highlight_block($block);
839 foreach $line (split "\n", $output) {
840 print $lineprefix . $line . "\n";
844 sub output_function_rst(%) {
846 my ($parameter, $section);
847 my $oldprefix = $lineprefix;
850 if ($args{'typedef'}) {
851 print ".. c:type:: ". $args{'function'} . "\n\n";
852 print_lineno($declaration_start_line);
853 print " **Typedef**: ";
855 output_highlight_rst($args{'purpose'});
856 $start = "\n\n**Syntax**\n\n ``";
858 print ".. c:function:: ";
860 if ($args{'functiontype'} ne "") {
861 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
863 $start .= $args{'function'} . " (";
868 foreach my $parameter (@{$args{'parameterlist'}}) {
873 $type = $args{'parametertypes'}{$parameter};
875 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
876 # pointer-to-function
877 print $1 . $parameter . ") (" . $2 . ")";
879 print $type . " " . $parameter;
882 if ($args{'typedef'}) {
886 print_lineno($declaration_start_line);
888 output_highlight_rst($args{'purpose'});
892 print "**Parameters**\n\n";
894 foreach $parameter (@{$args{'parameterlist'}}) {
895 my $parameter_name = $parameter;
896 $parameter_name =~ s/\[.*//;
897 $type = $args{'parametertypes'}{$parameter};
900 print "``$type $parameter``\n";
902 print "``$parameter``\n";
905 print_lineno($parameterdesc_start_lines{$parameter_name});
907 if (defined($args{'parameterdescs'}{$parameter_name}) &&
908 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
909 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
911 print " *undescribed*\n";
916 $lineprefix = $oldprefix;
917 output_section_rst(@_);
920 sub output_section_rst(%) {
923 my $oldprefix = $lineprefix;
926 foreach $section (@{$args{'sectionlist'}}) {
927 print "**$section**\n\n";
928 print_lineno($section_start_lines{$section});
929 output_highlight_rst($args{'sections'}{$section});
933 $lineprefix = $oldprefix;
936 sub output_enum_rst(%) {
939 my $oldprefix = $lineprefix;
941 my $name = "enum " . $args{'enum'};
943 print "\n\n.. c:type:: " . $name . "\n\n";
944 print_lineno($declaration_start_line);
946 output_highlight_rst($args{'purpose'});
949 print "**Constants**\n\n";
951 foreach $parameter (@{$args{'parameterlist'}}) {
952 print "``$parameter``\n";
953 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
954 output_highlight_rst($args{'parameterdescs'}{$parameter});
956 print " *undescribed*\n";
961 $lineprefix = $oldprefix;
962 output_section_rst(@_);
965 sub output_typedef_rst(%) {
968 my $oldprefix = $lineprefix;
969 my $name = "typedef " . $args{'typedef'};
971 print "\n\n.. c:type:: " . $name . "\n\n";
972 print_lineno($declaration_start_line);
974 output_highlight_rst($args{'purpose'});
977 $lineprefix = $oldprefix;
978 output_section_rst(@_);
981 sub output_struct_rst(%) {
984 my $oldprefix = $lineprefix;
985 my $name = $args{'type'} . " " . $args{'struct'};
987 print "\n\n.. c:type:: " . $name . "\n\n";
988 print_lineno($declaration_start_line);
990 output_highlight_rst($args{'purpose'});
993 print "**Definition**\n\n";
995 my $declaration = $args{'definition'};
996 $declaration =~ s/\t/ /g;
997 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n";
999 print "**Members**\n\n";
1001 foreach $parameter (@{$args{'parameterlist'}}) {
1002 ($parameter =~ /^#/) && next;
1004 my $parameter_name = $parameter;
1005 $parameter_name =~ s/\[.*//;
1007 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1008 $type = $args{'parametertypes'}{$parameter};
1009 print_lineno($parameterdesc_start_lines{$parameter_name});
1010 print "``" . $parameter . "``\n";
1011 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1016 $lineprefix = $oldprefix;
1017 output_section_rst(@_);
1020 ## none mode output functions
1022 sub output_function_none(%) {
1025 sub output_enum_none(%) {
1028 sub output_typedef_none(%) {
1031 sub output_struct_none(%) {
1034 sub output_blockhead_none(%) {
1038 # generic output function for all types (function, struct/union, typedef, enum);
1039 # calls the generated, variable output_ function name based on
1040 # functype and output_mode
1041 sub output_declaration {
1044 my $functype = shift;
1045 my $func = "output_${functype}_$output_mode";
1046 if (($output_selection == OUTPUT_ALL) ||
1047 (($output_selection == OUTPUT_INCLUDE ||
1048 $output_selection == OUTPUT_EXPORTED) &&
1049 defined($function_table{$name})) ||
1050 (($output_selection == OUTPUT_EXCLUDE ||
1051 $output_selection == OUTPUT_INTERNAL) &&
1052 !($functype eq "function" && defined($function_table{$name}))))
1060 # generic output function - calls the right one based on current output mode.
1061 sub output_blockhead {
1063 my $func = "output_blockhead_" . $output_mode;
1069 # takes a declaration (struct, union, enum, typedef) and
1070 # invokes the right handler. NOT called for functions.
1071 sub dump_declaration($$) {
1073 my ($prototype, $file) = @_;
1074 my $func = "dump_" . $decl_type;
1078 sub dump_union($$) {
1082 sub dump_struct($$) {
1086 if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
1088 $declaration_name = $2;
1091 # ignore members marked private:
1092 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1093 $members =~ s/\/\*\s*private:.*//gosi;
1095 $members =~ s/\/\*.*?\*\///gos;
1097 $members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi;
1098 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1099 $members =~ s/\s*__packed\s*/ /gos;
1100 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1101 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1102 $members =~ s/\s*____cacheline_aligned/ /gos;
1104 # replace DECLARE_BITMAP
1105 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1106 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1107 # replace DECLARE_HASHTABLE
1108 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1109 # replace DECLARE_KFIFO
1110 $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1111 # replace DECLARE_KFIFO_PTR
1112 $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1114 my $declaration = $members;
1116 # Split nested struct/union elements as newer ones
1117 while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
1122 foreach my $id(split /,/, $ids) {
1123 $newmember .= "$maintype $id; ";
1126 $id =~ s/^\s*\**(\S+)\s*/$1/;
1127 foreach my $arg (split /;/, $content) {
1128 next if ($arg =~ m/^\s*$/);
1129 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1130 # pointer-to-function
1135 if ($id =~ m/^\s*$/) {
1136 # anonymous struct/union
1137 $newmember .= "$type$name$extra; ";
1139 $newmember .= "$type$id.$name$extra; ";
1147 $arg =~ s/:\s*\d+\s*//g;
1149 $arg =~ s/\[.*\]//g;
1150 # The type may have multiple words,
1151 # and multiple IDs can be defined, like:
1152 # const struct foo, *bar, foobar
1153 # So, we remove spaces when parsing the
1154 # names, in order to match just names
1155 # and commas for the names
1156 $arg =~ s/\s*,\s*/,/g;
1157 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1161 $newmember .= "$arg; ";
1164 foreach my $name (split /,/, $names) {
1165 $name =~ s/^\s*\**(\S+)\s*/$1/;
1166 next if (($name =~ m/^\s*$/));
1167 if ($id =~ m/^\s*$/) {
1168 # anonymous struct/union
1169 $newmember .= "$type $name; ";
1171 $newmember .= "$type $id.$name; ";
1177 $members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
1180 # Ignore other nested elements, like enums
1181 $members =~ s/(\{[^\{\}]*\})//g;
1183 create_parameterlist($members, ';', $file, $declaration_name);
1184 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1186 # Adjust declaration for better display
1187 $declaration =~ s/([\{;])/$1\n/g;
1188 $declaration =~ s/\}\s+;/};/g;
1189 # Better handle inlined enums
1190 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1192 my @def_args = split /\n/, $declaration;
1195 foreach my $clause (@def_args) {
1196 $clause =~ s/^\s+//;
1197 $clause =~ s/\s+$//;
1198 $clause =~ s/\s+/ /;
1200 $level-- if ($clause =~ m/(\})/ && $level > 1);
1201 if (!($clause =~ m/^\s*#/)) {
1202 $declaration .= "\t" x $level;
1204 $declaration .= "\t" . $clause . "\n";
1205 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1207 output_declaration($declaration_name,
1209 {'struct' => $declaration_name,
1210 'module' => $modulename,
1211 'definition' => $declaration,
1212 'parameterlist' => \@parameterlist,
1213 'parameterdescs' => \%parameterdescs,
1214 'parametertypes' => \%parametertypes,
1215 'sectionlist' => \@sectionlist,
1216 'sections' => \%sections,
1217 'purpose' => $declaration_purpose,
1218 'type' => $decl_type
1222 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1228 sub show_warnings($$) {
1229 my $functype = shift;
1232 return 1 if ($output_selection == OUTPUT_ALL);
1234 if ($output_selection == OUTPUT_EXPORTED) {
1235 if (defined($function_table{$name})) {
1241 if ($output_selection == OUTPUT_INTERNAL) {
1242 if (!($functype eq "function" && defined($function_table{$name}))) {
1248 if ($output_selection == OUTPUT_INCLUDE) {
1249 if (defined($function_table{$name})) {
1255 if ($output_selection == OUTPUT_EXCLUDE) {
1256 if (!defined($function_table{$name})) {
1262 die("Please add the new output type at show_warnings()");
1269 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1270 # strip #define macros inside enums
1271 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1273 if ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1274 $declaration_name = $1;
1278 $members =~ s/\s+$//;
1280 foreach my $arg (split ',', $members) {
1281 $arg =~ s/^\s*(\w+).*/$1/;
1282 push @parameterlist, $arg;
1283 if (!$parameterdescs{$arg}) {
1284 $parameterdescs{$arg} = $undescribed;
1285 if (show_warnings("enum", $declaration_name)) {
1286 print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1289 $_members{$arg} = 1;
1292 while (my ($k, $v) = each %parameterdescs) {
1293 if (!exists($_members{$k})) {
1294 if (show_warnings("enum", $declaration_name)) {
1295 print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1300 output_declaration($declaration_name,
1302 {'enum' => $declaration_name,
1303 'module' => $modulename,
1304 'parameterlist' => \@parameterlist,
1305 'parameterdescs' => \%parameterdescs,
1306 'sectionlist' => \@sectionlist,
1307 'sections' => \%sections,
1308 'purpose' => $declaration_purpose
1312 print STDERR "${file}:$.: error: Cannot parse enum!\n";
1317 sub dump_typedef($$) {
1321 $x =~ s@/\*.*?\*/@@gos; # strip comments.
1323 # Parse function prototypes
1324 if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
1325 $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {
1329 $declaration_name = $2;
1332 create_parameterlist($args, ',', $file, $declaration_name);
1334 output_declaration($declaration_name,
1336 {'function' => $declaration_name,
1338 'module' => $modulename,
1339 'functiontype' => $return_type,
1340 'parameterlist' => \@parameterlist,
1341 'parameterdescs' => \%parameterdescs,
1342 'parametertypes' => \%parametertypes,
1343 'sectionlist' => \@sectionlist,
1344 'sections' => \%sections,
1345 'purpose' => $declaration_purpose
1350 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1351 $x =~ s/\(*.\)\s*;$/;/;
1352 $x =~ s/\[*.\]\s*;$/;/;
1355 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1356 $declaration_name = $1;
1358 output_declaration($declaration_name,
1360 {'typedef' => $declaration_name,
1361 'module' => $modulename,
1362 'sectionlist' => \@sectionlist,
1363 'sections' => \%sections,
1364 'purpose' => $declaration_purpose
1368 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1373 sub save_struct_actual($) {
1376 # strip all spaces from the actual param so that it looks like one string item
1377 $actual =~ s/\s*//g;
1378 $struct_actual = $struct_actual . $actual . " ";
1381 sub create_parameterlist($$$$) {
1383 my $splitter = shift;
1385 my $declaration_name = shift;
1389 # temporarily replace commas inside function pointer definition
1390 while ($args =~ /(\([^\),]+),/) {
1391 $args =~ s/(\([^\),]+),/$1#/g;
1394 foreach my $arg (split($splitter, $args)) {
1396 $arg =~ s/\/\*.*\*\///;
1397 # strip leading/trailing spaces
1403 # Treat preprocessor directive as a typeless variable just to fill
1404 # corresponding data structures "correctly". Catch it later in
1406 push_parameter($arg, "", $file);
1407 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1408 # pointer-to-function
1410 $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/;
1413 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1414 save_struct_actual($param);
1415 push_parameter($param, $type, $file, $declaration_name);
1417 $arg =~ s/\s*:\s*/:/g;
1418 $arg =~ s/\s*\[/\[/g;
1420 my @args = split('\s*,\s*', $arg);
1421 if ($args[0] =~ m/\*/) {
1422 $args[0] =~ s/(\*+)\s*/ $1/;
1426 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1428 push(@first_arg, split('\s+', $1));
1429 push(@first_arg, $2);
1431 @first_arg = split('\s+', shift @args);
1434 unshift(@args, pop @first_arg);
1435 $type = join " ", @first_arg;
1437 foreach $param (@args) {
1438 if ($param =~ m/^(\*+)\s*(.*)/) {
1439 save_struct_actual($2);
1440 push_parameter($2, "$type $1", $file, $declaration_name);
1442 elsif ($param =~ m/(.*?):(\d+)/) {
1443 if ($type ne "") { # skip unnamed bit-fields
1444 save_struct_actual($1);
1445 push_parameter($1, "$type:$2", $file, $declaration_name)
1449 save_struct_actual($param);
1450 push_parameter($param, $type, $file, $declaration_name);
1457 sub push_parameter($$$$) {
1461 my $declaration_name = shift;
1463 if (($anon_struct_union == 1) && ($type eq "") &&
1465 return; # ignore the ending }; from anon. struct/union
1468 $anon_struct_union = 0;
1469 $param =~ s/[\[\)].*//;
1471 if ($type eq "" && $param =~ /\.\.\.$/)
1473 if (!$param =~ /\w\.\.\.$/) {
1474 # handles unnamed variable parameters
1477 elsif ($param =~ /\w\.\.\.$/) {
1478 # for named variable parameters of the form `x...`, remove the dots
1479 $param =~ s/\.\.\.$//;
1481 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1482 $parameterdescs{$param} = "variable arguments";
1485 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1488 $parameterdescs{void} = "no arguments";
1490 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1491 # handle unnamed (anonymous) union or struct:
1494 $param = "{unnamed_" . $param . "}";
1495 $parameterdescs{$param} = "anonymous\n";
1496 $anon_struct_union = 1;
1499 # warn if parameter has no description
1500 # (but ignore ones starting with # as these are not parameters
1501 # but inline preprocessor statements);
1502 # Note: It will also ignore void params and unnamed structs/unions
1503 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1504 $parameterdescs{$param} = $undescribed;
1506 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1508 "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1513 # strip spaces from $param so that it is one continuous string
1514 # on @parameterlist;
1515 # this fixes a problem where check_sections() cannot find
1516 # a parameter like "addr[6 + 2]" because it actually appears
1517 # as "addr[6", "+", "2]" on the parameter list;
1518 # but it's better to maintain the param string unchanged for output,
1519 # so just weaken the string compare in check_sections() to ignore
1520 # "[blah" in a parameter string;
1521 ###$param =~ s/\s*//g;
1522 push @parameterlist, $param;
1523 $type =~ s/\s\s+/ /g;
1524 $parametertypes{$param} = $type;
1527 sub check_sections($$$$$) {
1528 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1529 my @sects = split ' ', $sectcheck;
1530 my @prms = split ' ', $prmscheck;
1533 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1535 foreach $sx (0 .. $#sects) {
1537 foreach $px (0 .. $#prms) {
1538 $prm_clean = $prms[$px];
1539 $prm_clean =~ s/\[.*\]//;
1540 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1541 # ignore array size in a parameter string;
1542 # however, the original param string may contain
1543 # spaces, e.g.: addr[6 + 2]
1544 # and this appears in @prms as "addr[6" since the
1545 # parameter list is split at spaces;
1546 # hence just ignore "[..." for the sections check;
1547 $prm_clean =~ s/\[.*//;
1549 ##$prm_clean =~ s/^\**//;
1550 if ($prm_clean eq $sects[$sx]) {
1556 if ($decl_type eq "function") {
1557 print STDERR "${file}:$.: warning: " .
1558 "Excess function parameter " .
1560 "description in '$decl_name'\n";
1568 # Checks the section describing the return value of a function.
1569 sub check_return_section {
1571 my $declaration_name = shift;
1572 my $return_type = shift;
1574 # Ignore an empty return type (It's a macro)
1575 # Ignore functions with a "void" return type. (But don't ignore "void *")
1576 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1580 if (!defined($sections{$section_return}) ||
1581 $sections{$section_return} eq "") {
1582 print STDERR "${file}:$.: warning: " .
1583 "No description found for return value of " .
1584 "'$declaration_name'\n";
1590 # takes a function prototype and the name of the current file being
1591 # processed and spits out all the details stored in the global
1593 sub dump_function($$) {
1594 my $prototype = shift;
1600 $prototype =~ s/^static +//;
1601 $prototype =~ s/^extern +//;
1602 $prototype =~ s/^asmlinkage +//;
1603 $prototype =~ s/^inline +//;
1604 $prototype =~ s/^__inline__ +//;
1605 $prototype =~ s/^__inline +//;
1606 $prototype =~ s/^__always_inline +//;
1607 $prototype =~ s/^noinline +//;
1608 $prototype =~ s/__init +//;
1609 $prototype =~ s/__init_or_module +//;
1610 $prototype =~ s/__meminit +//;
1611 $prototype =~ s/__must_check +//;
1612 $prototype =~ s/__weak +//;
1613 $prototype =~ s/__sched +//;
1614 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1615 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1616 $prototype =~ s/__attribute__\s*\(\(
1618 [\w\s]++ # attribute name
1619 (?:\([^)]*+\))? # attribute arguments
1620 \s*+,? # optional comma at the end
1624 # Yes, this truly is vile. We are looking for:
1625 # 1. Return type (may be nothing if we're looking at a macro)
1627 # 3. Function parameters.
1629 # All the while we have to watch out for function pointer parameters
1630 # (which IIRC is what the two sections are for), C types (these
1631 # regexps don't even start to express all the possibilities), and
1634 # If you mess with these regexps, it's a good idea to check that
1635 # the following functions' documentation still comes out right:
1636 # - parport_register_device (function pointer parameters)
1637 # - atomic_set (macro)
1638 # - pci_match_device, __copy_to_user (long return type)
1640 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
1641 # This is an object-like macro, it has no return type and no parameter
1643 # Function-like macros are not allowed to have spaces between
1644 # declaration_name and opening parenthesis (notice the \s+).
1646 $declaration_name = $2;
1648 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1649 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1650 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1651 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1652 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1653 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1654 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1655 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1656 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1657 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1658 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1659 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1660 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1661 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1662 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1663 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1664 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
1666 $declaration_name = $2;
1669 create_parameterlist($args, ',', $file, $declaration_name);
1671 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1675 my $prms = join " ", @parameterlist;
1676 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1678 # This check emits a lot of warnings at the moment, because many
1679 # functions don't have a 'Return' doc section. So until the number
1680 # of warnings goes sufficiently down, the check is only performed in
1682 # TODO: always perform the check.
1683 if ($verbose && !$noret) {
1684 check_return_section($file, $declaration_name, $return_type);
1687 output_declaration($declaration_name,
1689 {'function' => $declaration_name,
1690 'module' => $modulename,
1691 'functiontype' => $return_type,
1692 'parameterlist' => \@parameterlist,
1693 'parameterdescs' => \%parameterdescs,
1694 'parametertypes' => \%parametertypes,
1695 'sectionlist' => \@sectionlist,
1696 'sections' => \%sections,
1697 'purpose' => $declaration_purpose
1703 %parameterdescs = ();
1704 %parametertypes = ();
1705 @parameterlist = ();
1709 $struct_actual = "";
1712 $state = STATE_NORMAL;
1713 $inline_doc_state = STATE_INLINE_NA;
1716 sub tracepoint_munge($) {
1718 my $tracepointname = 0;
1719 my $tracepointargs = 0;
1721 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1722 $tracepointname = $1;
1724 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1725 $tracepointname = $1;
1727 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1728 $tracepointname = $2;
1730 $tracepointname =~ s/^\s+//; #strip leading whitespace
1731 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1732 $tracepointargs = $1;
1734 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1735 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1738 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1742 sub syscall_munge() {
1745 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1746 ## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1747 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1749 ## $prototype = "long sys_$1(void)";
1752 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1753 if ($prototype =~ m/long (sys_.*?),/) {
1754 $prototype =~ s/,/\(/;
1756 $prototype =~ s/\)/\(void\)/;
1759 # now delete all of the odd-number commas in $prototype
1760 # so that arg types & arg names don't have a comma between them
1762 my $len = length($prototype);
1764 $len = 0; # skip the for-loop
1766 for (my $ix = 0; $ix < $len; $ix++) {
1767 if (substr($prototype, $ix, 1) eq ',') {
1769 if ($count % 2 == 1) {
1770 substr($prototype, $ix, 1) = ' ';
1776 sub process_proto_function($$) {
1780 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1782 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1785 elsif ($x =~ /([^\{]*)/) {
1789 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1790 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1791 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1792 $prototype =~ s@^\s+@@gos; # strip leading spaces
1794 # Handle prototypes for function pointers like:
1795 # int (*pcs_config)(struct foo)
1796 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1798 if ($prototype =~ /SYSCALL_DEFINE/) {
1801 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1802 $prototype =~ /DEFINE_SINGLE_EVENT/)
1804 tracepoint_munge($file);
1806 dump_function($prototype, $file);
1811 sub process_proto_type($$) {
1815 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1816 $x =~ s@^\s+@@gos; # strip leading spaces
1817 $x =~ s@\s+$@@gos; # strip trailing spaces
1818 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1821 # To distinguish preprocessor directive from regular declaration later.
1826 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1827 if( length $prototype ) {
1830 $prototype .= $1 . $2;
1831 ($2 eq '{') && $brcount++;
1832 ($2 eq '}') && $brcount--;
1833 if (($2 eq ';') && ($brcount == 0)) {
1834 dump_declaration($prototype, $file);
1847 sub map_filename($) {
1849 my ($orig_file) = @_;
1851 if (defined($ENV{'SRCTREE'})) {
1852 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1857 if (defined($source_map{$file})) {
1858 $file = $source_map{$file};
1864 sub process_export_file($) {
1865 my ($orig_file) = @_;
1866 my $file = map_filename($orig_file);
1868 if (!open(IN,"<$file")) {
1869 print STDERR "Error: Cannot open file $file\n";
1875 if (/$export_symbol/) {
1876 $function_table{$2} = 1;
1884 # Parsers for the various processing states.
1886 # STATE_NORMAL: looking for the /** to begin everything.
1888 sub process_normal() {
1889 if (/$doc_start/o) {
1890 $state = STATE_NAME; # next line is always the function name
1892 $declaration_start_line = $. + 1;
1897 # STATE_NAME: Looking for the "name - description" line
1899 sub process_name($$) {
1904 if (/$doc_block/o) {
1905 $state = STATE_DOCBLOCK;
1907 $new_start_line = $. + 1;
1910 $section = $section_intro;
1915 elsif (/$doc_decl/o) {
1917 if (/\s*([\w\s]+?)(\(\))?\s*-/) {
1921 $state = STATE_BODY;
1922 # if there's no @param blocks need to set up default section
1925 $section = $section_default;
1926 $new_start_line = $. + 1;
1928 # strip leading/trailing/multiple spaces
1932 $descr =~ s/\s+/ /g;
1933 $declaration_purpose = $descr;
1934 $state = STATE_BODY_MAYBE;
1936 $declaration_purpose = "";
1939 if (($declaration_purpose eq "") && $verbose) {
1940 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
1945 if ($identifier =~ m/^struct\b/) {
1946 $decl_type = 'struct';
1947 } elsif ($identifier =~ m/^union\b/) {
1948 $decl_type = 'union';
1949 } elsif ($identifier =~ m/^enum\b/) {
1950 $decl_type = 'enum';
1951 } elsif ($identifier =~ m/^typedef\b/) {
1952 $decl_type = 'typedef';
1954 $decl_type = 'function';
1958 print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
1961 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
1962 " - I thought it was a doc line\n";
1964 $state = STATE_NORMAL;
1970 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
1972 sub process_body($$) {
1975 # Until all named variable macro parameters are
1976 # documented using the bare name (`x`) rather than with
1977 # dots (`x...`), strip the dots:
1978 if ($section =~ /\w\.\.\.$/) {
1979 $section =~ s/\.\.\.$//;
1982 print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
1987 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
1988 dump_section($file, $section, $contents);
1989 $section = $section_default;
1993 if (/$doc_sect/i) { # case insensitive for supported section names
1997 # map the supported section names to the canonical names
1998 if ($newsection =~ m/^description$/i) {
1999 $newsection = $section_default;
2000 } elsif ($newsection =~ m/^context$/i) {
2001 $newsection = $section_context;
2002 } elsif ($newsection =~ m/^returns?$/i) {
2003 $newsection = $section_return;
2004 } elsif ($newsection =~ m/^\@return$/) {
2005 # special: @return is a section, not a param description
2006 $newsection = $section_return;
2009 if (($contents ne "") && ($contents ne "\n")) {
2010 if (!$in_doc_sect && $verbose) {
2011 print STDERR "${file}:$.: warning: contents before sections\n";
2014 dump_section($file, $section, $contents);
2015 $section = $section_default;
2019 $state = STATE_BODY;
2020 $contents = $newcontents;
2021 $new_start_line = $.;
2022 while (substr($contents, 0, 1) eq " ") {
2023 $contents = substr($contents, 1);
2025 if ($contents ne "") {
2028 $section = $newsection;
2029 $leading_space = undef;
2030 } elsif (/$doc_end/) {
2031 if (($contents ne "") && ($contents ne "\n")) {
2032 dump_section($file, $section, $contents);
2033 $section = $section_default;
2036 # look for doc_com + <text> + doc_end:
2037 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2038 print STDERR "${file}:$.: warning: suspicious ending line: $_";
2043 $state = STATE_PROTO;
2045 } elsif (/$doc_content/) {
2047 if ($section eq $section_context) {
2048 dump_section($file, $section, $contents);
2049 $section = $section_default;
2051 $new_start_line = $.;
2052 $state = STATE_BODY;
2054 if ($section ne $section_default) {
2055 $state = STATE_BODY_WITH_BLANK_LINE;
2057 $state = STATE_BODY;
2061 } elsif ($state == STATE_BODY_MAYBE) {
2062 # Continued declaration purpose
2063 chomp($declaration_purpose);
2064 $declaration_purpose .= " " . $1;
2065 $declaration_purpose =~ s/\s+/ /g;
2068 if ($section =~ m/^@/ || $section eq $section_context) {
2069 if (!defined $leading_space) {
2070 if ($cont =~ m/^(\s+)/) {
2071 $leading_space = $1;
2073 $leading_space = "";
2076 $cont =~ s/^$leading_space//;
2078 $contents .= $cont . "\n";
2081 # i dont know - bad line? ignore.
2082 print STDERR "${file}:$.: warning: bad line: $_";
2089 # STATE_PROTO: reading a function/whatever prototype.
2091 sub process_proto($$) {
2094 if (/$doc_inline_oneline/) {
2097 if ($contents ne "") {
2099 dump_section($file, $section, $contents);
2100 $section = $section_default;
2103 } elsif (/$doc_inline_start/) {
2104 $state = STATE_INLINE;
2105 $inline_doc_state = STATE_INLINE_NAME;
2106 } elsif ($decl_type eq 'function') {
2107 process_proto_function($_, $file);
2109 process_proto_type($_, $file);
2114 # STATE_DOCBLOCK: within a DOC: block.
2116 sub process_docblock($$) {
2120 dump_doc_section($file, $section, $contents);
2121 $section = $section_default;
2124 %parameterdescs = ();
2125 %parametertypes = ();
2126 @parameterlist = ();
2130 $state = STATE_NORMAL;
2131 } elsif (/$doc_content/) {
2133 $contents .= $blankline;
2135 $contents .= $1 . "\n";
2141 # STATE_INLINE: docbook comments within a prototype.
2143 sub process_inline($$) {
2146 # First line (state 1) needs to be a @parameter
2147 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2150 $new_start_line = $.;
2151 if ($contents ne "") {
2152 while (substr($contents, 0, 1) eq " ") {
2153 $contents = substr($contents, 1);
2157 $inline_doc_state = STATE_INLINE_TEXT;
2158 # Documentation block end */
2159 } elsif (/$doc_inline_end/) {
2160 if (($contents ne "") && ($contents ne "\n")) {
2161 dump_section($file, $section, $contents);
2162 $section = $section_default;
2165 $state = STATE_PROTO;
2166 $inline_doc_state = STATE_INLINE_NA;
2168 } elsif (/$doc_content/) {
2169 if ($inline_doc_state == STATE_INLINE_TEXT) {
2170 $contents .= $1 . "\n";
2171 # nuke leading blank lines
2172 if ($contents =~ /^\s*$/) {
2175 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2176 $inline_doc_state = STATE_INLINE_ERROR;
2177 print STDERR "${file}:$.: warning: ";
2178 print STDERR "Incorrect use of kernel-doc format: $_";
2185 sub process_file($) {
2187 my $initial_section_counter = $section_counter;
2188 my ($orig_file) = @_;
2190 $file = map_filename($orig_file);
2192 if (!open(IN,"<$file")) {
2193 print STDERR "Error: Cannot open file $file\n";
2200 $section_counter = 0;
2202 while (s/\\\s*$//) {
2205 # Replace tabs by spaces
2206 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2207 # Hand this line to the appropriate state handler
2208 if ($state == STATE_NORMAL) {
2210 } elsif ($state == STATE_NAME) {
2211 process_name($file, $_);
2212 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2213 $state == STATE_BODY_WITH_BLANK_LINE) {
2214 process_body($file, $_);
2215 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2216 process_inline($file, $_);
2217 } elsif ($state == STATE_PROTO) {
2218 process_proto($file, $_);
2219 } elsif ($state == STATE_DOCBLOCK) {
2220 process_docblock($file, $_);
2224 # Make sure we got something interesting.
2225 if ($initial_section_counter == $section_counter && $
2226 output_mode ne "none") {
2227 if ($output_selection == OUTPUT_INCLUDE) {
2228 print STDERR "${file}:1: warning: '$_' not found\n"
2229 for keys %function_table;
2232 print STDERR "${file}:1: warning: no structured comments found\n";
2238 $kernelversion = get_kernel_version();
2240 # generate a sequence of code that will splice in highlighting information
2241 # using the s// operator.
2242 for (my $k = 0; $k < @highlights; $k++) {
2243 my $pattern = $highlights[$k][0];
2244 my $result = $highlights[$k][1];
2245 # print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2246 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
2249 # Read the file that maps relative names to absolute names for
2250 # separate source and object directories and for shadow trees.
2251 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2252 my ($relname, $absname);
2253 while(<SOURCE_MAP>) {
2255 ($relname, $absname) = (split())[0..1];
2256 $relname =~ s:^/+::;
2257 $source_map{$relname} = $absname;
2262 if ($output_selection == OUTPUT_EXPORTED ||
2263 $output_selection == OUTPUT_INTERNAL) {
2265 push(@export_file_list, @ARGV);
2267 foreach (@export_file_list) {
2269 process_export_file($_);
2277 if ($verbose && $errors) {
2278 print STDERR "$errors errors\n";
2280 if ($verbose && $warnings) {
2281 print STDERR "$warnings warnings\n";
2284 if ($Werror && $warnings) {
2285 print STDERR "$warnings warnings as Errors\n";
2288 exit($output_mode eq "none" ? 0 : $errors)