scripts/kernel-doc

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