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 = '#(([A-Z][_\w]*))';
 230 my $type_union = '#(union\s*([_\w]+))';
 231 my $type_member = '#([_\w]+)(\.|->)([_\w]+)';
 232 my $type_fallback = '(?!)';    # this never matches
 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{'KDOC_WERROR'})) {
 333         $Werror = "$ENV{'KDOC_WERROR'}";
 334 }
 335
 336 if (defined($ENV{'KCFLAGS'})) {
 337         my $kcflags = "$ENV{'KCFLAGS'}";
 338
 339         if ($kcflags =~ /Werror/) {
 340                 $Werror = 1;
 341         }
 342 }
 343
 344 # Generated docbook code is inserted in a template at a point where
 345 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
 346 # https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
 347 # We keep track of number of generated entries and generate a dummy
 348 # if needs be to ensure the expanded template can be postprocessed
 349 # into html.
 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 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
 386 my $doc_end = '\*/';
 387 my $doc_com = '\s*\*\s*';
 388 my $doc_com_body = '\s*\* ?';
 389 my $doc_decl = $doc_com . '(\w+)';
 390 # @params and a strictly limited set of supported section names
 391 my $doc_sect = $doc_com .
 392     '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
 393 my $doc_content = $doc_com_body . '(.*)';
 394 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
 395 my $doc_inline_start = '^\s*/\*\*\s*$';
 396 my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
 397 my $doc_inline_end = '^\s*\*/\s*$';
 398 my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
 399 my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
 400
 401 my %parameterdescs;
 402 my %parameterdesc_start_lines;
 403 my @parameterlist;
 404 my %sections;
 405 my @sectionlist;
 406 my %section_start_lines;
 407 my $sectcheck;
 408 my $struct_actual;
 409
 410 my $contents = "";
 411 my $new_start_line = 0;
 412
 413 # the canonical section names. see also $doc_sect above.
 414 my $section_default = "Description";    # default section
 415 my $section_intro = "Introduction";
 416 my $section = $section_default;
 417 my $section_context = "Context";
 418 my $section_return = "Return";
 419
 420 my $undescribed = "-- undescribed --";
 421
 422 reset_state();
 423
 424 while ($ARGV[0] =~ m/^--?(.*)/) {
 425     my $cmd = $1;
 426     shift @ARGV;
 427     if ($cmd eq "man") {
 428         $output_mode = "man";
 429         @highlights = @highlights_man;
 430         $blankline = $blankline_man;
 431     } elsif ($cmd eq "rst") {
 432         $output_mode = "rst";
 433         @highlights = @highlights_rst;
 434         $blankline = $blankline_rst;
 435     } elsif ($cmd eq "none") {
 436         $output_mode = "none";
 437     } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
 438         $modulename = shift @ARGV;
 439     } elsif ($cmd eq "function") { # to only output specific functions
 440         $output_selection = OUTPUT_INCLUDE;
 441         $function = shift @ARGV;
 442         $function_table{$function} = 1;
 443     } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
 444         my $symbol = shift @ARGV;
 445         $nosymbol_table{$symbol} = 1;
 446     } elsif ($cmd eq "export") { # only exported symbols
 447         $output_selection = OUTPUT_EXPORTED;
 448         %function_table = ();
 449     } elsif ($cmd eq "internal") { # only non-exported symbols
 450         $output_selection = OUTPUT_INTERNAL;
 451         %function_table = ();
 452     } elsif ($cmd eq "export-file") {
 453         my $file = shift @ARGV;
 454         push(@export_file_list, $file);
 455     } elsif ($cmd eq "v") {
 456         $verbose = 1;
 457     } elsif ($cmd eq "Werror") {
 458         $Werror = 1;
 459     } elsif (($cmd eq "h") || ($cmd eq "help")) {
 460         usage();
 461     } elsif ($cmd eq 'no-doc-sections') {
 462             $no_doc_sections = 1;
 463     } elsif ($cmd eq 'enable-lineno') {
 464             $enable_lineno = 1;
 465     } elsif ($cmd eq 'show-not-found') {
 466         $show_not_found = 1;  # A no-op but don't fail
 467     } elsif ($cmd eq "sphinx-version") {
 468         my $ver_string = shift @ARGV;
 469         if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
 470             $sphinx_major = $1;
 471             if (defined($2)) {
 472                 $sphinx_minor = substr($2,1);
 473             } else {
 474                 $sphinx_minor = 0;
 475             }
 476             if (defined($3)) {
 477                 $sphinx_patch = substr($3,1)
 478             } else {
 479                 $sphinx_patch = 0;
 480             }
 481         } else {
 482             die "Sphinx version should either major.minor or major.minor.patch format\n";
 483         }
 484     } else {
 485         # Unknown argument
 486         usage();
 487     }
 488 }
 489
 490 # continue execution near EOF;
 491
 492 # The C domain dialect changed on Sphinx 3. So, we need to check the
 493 # version in order to produce the right tags.
 494 sub findprog($)
 495 {
 496         foreach(split(/:/, $ENV{PATH})) {
 497                 return "$_/$_[0]" if(-x "$_/$_[0]");
 498         }
 499 }
 500
 501 sub get_sphinx_version()
 502 {
 503         my $ver;
 504
 505         my $cmd = "sphinx-build";
 506         if (!findprog($cmd)) {
 507                 my $cmd = "sphinx-build3";
 508                 if (!findprog($cmd)) {
 509                         $sphinx_major = 1;
 510                         $sphinx_minor = 2;
 511                         $sphinx_patch = 0;
 512                         printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
 513                                $sphinx_major, $sphinx_minor, $sphinx_patch;
 514                         return;
 515                 }
 516         }
 517
 518         open IN, "$cmd --version 2>&1 |";
 519         while (<IN>) {
 520                 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
 521                         $sphinx_major = $1;
 522                         $sphinx_minor = $2;
 523                         $sphinx_patch = $3;
 524                         last;
 525                 }
 526                 # Sphinx 1.2.x uses a different format
 527                 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
 528                         $sphinx_major = $1;
 529                         $sphinx_minor = $2;
 530                         $sphinx_patch = $3;
 531                         last;
 532                 }
 533         }
 534         close IN;
 535 }
 536
 537 # get kernel version from env
 538 sub get_kernel_version() {
 539     my $version = 'unknown kernel version';
 540
 541     if (defined($ENV{'KERNELVERSION'})) {
 542         $version = $ENV{'KERNELVERSION'};
 543     }
 544     return $version;
 545 }
 546
 547 #
 548 sub print_lineno {
 549     my $lineno = shift;
 550     if ($enable_lineno && defined($lineno)) {
 551         print "#define LINENO " . $lineno . "\n";
 552     }
 553 }
 554 ##
 555 # dumps section contents to arrays/hashes intended for that purpose.
 556 #
 557 sub dump_section {
 558     my $file = shift;
 559     my $name = shift;
 560     my $contents = join "\n", @_;
 561
 562     if ($name =~ m/$type_param/) {
 563         $name = $1;
 564         $parameterdescs{$name} = $contents;
 565         $sectcheck = $sectcheck . $name . " ";
 566         $parameterdesc_start_lines{$name} = $new_start_line;
 567         $new_start_line = 0;
 568     } elsif ($name eq "@\.\.\.") {
 569         $name = "...";
 570         $parameterdescs{$name} = $contents;
 571         $sectcheck = $sectcheck . $name . " ";
 572         $parameterdesc_start_lines{$name} = $new_start_line;
 573         $new_start_line = 0;
 574     } else {
 575         if (defined($sections{$name}) && ($sections{$name} ne "")) {
 576             # Only warn on user specified duplicate section names.
 577             if ($name ne $section_default) {
 578                 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
 579                 ++$warnings;
 580             }
 581             $sections{$name} .= $contents;
 582         } else {
 583             $sections{$name} = $contents;
 584             push @sectionlist, $name;
 585             $section_start_lines{$name} = $new_start_line;
 586             $new_start_line = 0;
 587         }
 588     }
 589 }
 590
 591 ##
 592 # dump DOC: section after checking that it should go out
 593 #
 594 sub dump_doc_section {
 595     my $file = shift;
 596     my $name = shift;
 597     my $contents = join "\n", @_;
 598
 599     if ($no_doc_sections) {
 600         return;
 601     }
 602
 603     return if (defined($nosymbol_table{$name}));
 604
 605     if (($output_selection == OUTPUT_ALL) ||
 606         (($output_selection == OUTPUT_INCLUDE) &&
 607          defined($function_table{$name})))
 608     {
 609         dump_section($file, $name, $contents);
 610         output_blockhead({'sectionlist' => \@sectionlist,
 611                           'sections' => \%sections,
 612                           'module' => $modulename,
 613                           'content-only' => ($output_selection != OUTPUT_ALL), });
 614     }
 615 }
 616
 617 ##
 618 # output function
 619 #
 620 # parameterdescs, a hash.
 621 #  function => "function name"
 622 #  parameterlist => @list of parameters
 623 #  parameterdescs => %parameter descriptions
 624 #  sectionlist => @list of sections
 625 #  sections => %section descriptions
 626 #
 627
 628 sub output_highlight {
 629     my $contents = join "\n",@_;
 630     my $line;
 631
 632 #   DEBUG
 633 #   if (!defined $contents) {
 634 #       use Carp;
 635 #       confess "output_highlight got called with no args?\n";
 636 #   }
 637
 638 #   print STDERR "contents b4:$contents\n";
 639     eval $dohighlight;
 640     die $@ if $@;
 641 #   print STDERR "contents af:$contents\n";
 642
 643     foreach $line (split "\n", $contents) {
 644         if (! $output_preformatted) {
 645             $line =~ s/^\s*//;
 646         }
 647         if ($line eq ""){
 648             if (! $output_preformatted) {
 649                 print $lineprefix, $blankline;
 650             }
 651         } else {
 652             if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
 653                 print "\\&$line";
 654             } else {
 655                 print $lineprefix, $line;
 656             }
 657         }
 658         print "\n";
 659     }
 660 }
 661
 662 ##
 663 # output function in man
 664 sub output_function_man(%) {
 665     my %args = %{$_[0]};
 666     my ($parameter, $section);
 667     my $count;
 668
 669     print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
 670
 671     print ".SH NAME\n";
 672     print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
 673
 674     print ".SH SYNOPSIS\n";
 675     if ($args{'functiontype'} ne "") {
 676         print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
 677     } else {
 678         print ".B \"" . $args{'function'} . "\n";
 679     }
 680     $count = 0;
 681     my $parenth = "(";
 682     my $post = ",";
 683     foreach my $parameter (@{$args{'parameterlist'}}) {
 684         if ($count == $#{$args{'parameterlist'}}) {
 685             $post = ");";
 686         }
 687         $type = $args{'parametertypes'}{$parameter};
 688         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 689             # pointer-to-function
 690             print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
 691         } else {
 692             $type =~ s/([^\*])$/$1 /;
 693             print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
 694         }
 695         $count++;
 696         $parenth = "";
 697     }
 698
 699     print ".SH ARGUMENTS\n";
 700     foreach $parameter (@{$args{'parameterlist'}}) {
 701         my $parameter_name = $parameter;
 702         $parameter_name =~ s/\[.*//;
 703
 704         print ".IP \"" . $parameter . "\" 12\n";
 705         output_highlight($args{'parameterdescs'}{$parameter_name});
 706     }
 707     foreach $section (@{$args{'sectionlist'}}) {
 708         print ".SH \"", uc $section, "\"\n";
 709         output_highlight($args{'sections'}{$section});
 710     }
 711 }
 712
 713 ##
 714 # output enum in man
 715 sub output_enum_man(%) {
 716     my %args = %{$_[0]};
 717     my ($parameter, $section);
 718     my $count;
 719
 720     print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
 721
 722     print ".SH NAME\n";
 723     print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
 724
 725     print ".SH SYNOPSIS\n";
 726     print "enum " . $args{'enum'} . " {\n";
 727     $count = 0;
 728     foreach my $parameter (@{$args{'parameterlist'}}) {
 729         print ".br\n.BI \"    $parameter\"\n";
 730         if ($count == $#{$args{'parameterlist'}}) {
 731             print "\n};\n";
 732             last;
 733         }
 734         else {
 735             print ", \n.br\n";
 736         }
 737         $count++;
 738     }
 739
 740     print ".SH Constants\n";
 741     foreach $parameter (@{$args{'parameterlist'}}) {
 742         my $parameter_name = $parameter;
 743         $parameter_name =~ s/\[.*//;
 744
 745         print ".IP \"" . $parameter . "\" 12\n";
 746         output_highlight($args{'parameterdescs'}{$parameter_name});
 747     }
 748     foreach $section (@{$args{'sectionlist'}}) {
 749         print ".SH \"$section\"\n";
 750         output_highlight($args{'sections'}{$section});
 751     }
 752 }
 753
 754 ##
 755 # output struct in man
 756 sub output_struct_man(%) {
 757     my %args = %{$_[0]};
 758     my ($parameter, $section);
 759
 760     print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
 761
 762     print ".SH NAME\n";
 763     print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
 764
 765     my $declaration = $args{'definition'};
 766     $declaration =~ s/\t/  /g;
 767     $declaration =~ s/\n/"\n.br\n.BI \"/g;
 768     print ".SH SYNOPSIS\n";
 769     print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
 770     print ".BI \"$declaration\n};\n.br\n\n";
 771
 772     print ".SH Members\n";
 773     foreach $parameter (@{$args{'parameterlist'}}) {
 774         ($parameter =~ /^#/) && next;
 775
 776         my $parameter_name = $parameter;
 777         $parameter_name =~ s/\[.*//;
 778
 779         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
 780         print ".IP \"" . $parameter . "\" 12\n";
 781         output_highlight($args{'parameterdescs'}{$parameter_name});
 782     }
 783     foreach $section (@{$args{'sectionlist'}}) {
 784         print ".SH \"$section\"\n";
 785         output_highlight($args{'sections'}{$section});
 786     }
 787 }
 788
 789 ##
 790 # output typedef in man
 791 sub output_typedef_man(%) {
 792     my %args = %{$_[0]};
 793     my ($parameter, $section);
 794
 795     print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
 796
 797     print ".SH NAME\n";
 798     print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
 799
 800     foreach $section (@{$args{'sectionlist'}}) {
 801         print ".SH \"$section\"\n";
 802         output_highlight($args{'sections'}{$section});
 803     }
 804 }
 805
 806 sub output_blockhead_man(%) {
 807     my %args = %{$_[0]};
 808     my ($parameter, $section);
 809     my $count;
 810
 811     print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
 812
 813     foreach $section (@{$args{'sectionlist'}}) {
 814         print ".SH \"$section\"\n";
 815         output_highlight($args{'sections'}{$section});
 816     }
 817 }
 818
 819 ##
 820 # output in restructured text
 821 #
 822
 823 #
 824 # This could use some work; it's used to output the DOC: sections, and
 825 # starts by putting out the name of the doc section itself, but that tends
 826 # to duplicate a header already in the template file.
 827 #
 828 sub output_blockhead_rst(%) {
 829     my %args = %{$_[0]};
 830     my ($parameter, $section);
 831
 832     foreach $section (@{$args{'sectionlist'}}) {
 833         next if (defined($nosymbol_table{$section}));
 834
 835         if ($output_selection != OUTPUT_INCLUDE) {
 836             print "**$section**\n\n";
 837         }
 838         print_lineno($section_start_lines{$section});
 839         output_highlight_rst($args{'sections'}{$section});
 840         print "\n";
 841     }
 842 }
 843
 844 #
 845 # Apply the RST highlights to a sub-block of text.
 846 #
 847 sub highlight_block($) {
 848     # The dohighlight kludge requires the text be called $contents
 849     my $contents = shift;
 850     eval $dohighlight;
 851     die $@ if $@;
 852     return $contents;
 853 }
 854
 855 #
 856 # Regexes used only here.
 857 #
 858 my $sphinx_literal = '^[^.].*::$';
 859 my $sphinx_cblock = '^\.\.\ +code-block::';
 860
 861 sub output_highlight_rst {
 862     my $input = join "\n",@_;
 863     my $output = "";
 864     my $line;
 865     my $in_literal = 0;
 866     my $litprefix;
 867     my $block = "";
 868
 869     foreach $line (split "\n",$input) {
 870         #
 871         # If we're in a literal block, see if we should drop out
 872         # of it.  Otherwise pass the line straight through unmunged.
 873         #
 874         if ($in_literal) {
 875             if (! ($line =~ /^\s*$/)) {
 876                 #
 877                 # If this is the first non-blank line in a literal
 878                 # block we need to figure out what the proper indent is.
 879                 #
 880                 if ($litprefix eq "") {
 881                     $line =~ /^(\s*)/;
 882                     $litprefix = '^' . $1;
 883                     $output .= $line . "\n";
 884                 } elsif (! ($line =~ /$litprefix/)) {
 885                     $in_literal = 0;
 886                 } else {
 887                     $output .= $line . "\n";
 888                 }
 889             } else {
 890                 $output .= $line . "\n";
 891             }
 892         }
 893         #
 894         # Not in a literal block (or just dropped out)
 895         #
 896         if (! $in_literal) {
 897             $block .= $line . "\n";
 898             if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
 899                 $in_literal = 1;
 900                 $litprefix = "";
 901                 $output .= highlight_block($block);
 902                 $block = ""
 903             }
 904         }
 905     }
 906
 907     if ($block) {
 908         $output .= highlight_block($block);
 909     }
 910     foreach $line (split "\n", $output) {
 911         print $lineprefix . $line . "\n";
 912     }
 913 }
 914
 915 sub output_function_rst(%) {
 916     my %args = %{$_[0]};
 917     my ($parameter, $section);
 918     my $oldprefix = $lineprefix;
 919     my $start = "";
 920     my $is_macro = 0;
 921
 922     if ($sphinx_major < 3) {
 923         if ($args{'typedef'}) {
 924             print ".. c:type:: ". $args{'function'} . "\n\n";
 925             print_lineno($declaration_start_line);
 926             print "   **Typedef**: ";
 927             $lineprefix = "";
 928             output_highlight_rst($args{'purpose'});
 929             $start = "\n\n**Syntax**\n\n  ``";
 930             $is_macro = 1;
 931         } else {
 932             print ".. c:function:: ";
 933         }
 934     } else {
 935         if ($args{'typedef'} || $args{'functiontype'} eq "") {
 936             $is_macro = 1;
 937             print ".. c:macro:: ". $args{'function'} . "\n\n";
 938         } else {
 939             print ".. c:function:: ";
 940         }
 941
 942         if ($args{'typedef'}) {
 943             print_lineno($declaration_start_line);
 944             print "   **Typedef**: ";
 945             $lineprefix = "";
 946             output_highlight_rst($args{'purpose'});
 947             $start = "\n\n**Syntax**\n\n  ``";
 948         } else {
 949             print "``" if ($is_macro);
 950         }
 951     }
 952     if ($args{'functiontype'} ne "") {
 953         $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
 954     } else {
 955         $start .= $args{'function'} . " (";
 956     }
 957     print $start;
 958
 959     my $count = 0;
 960     foreach my $parameter (@{$args{'parameterlist'}}) {
 961         if ($count ne 0) {
 962             print ", ";
 963         }
 964         $count++;
 965         $type = $args{'parametertypes'}{$parameter};
 966
 967         if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
 968             # pointer-to-function
 969             print $1 . $parameter . ") (" . $2 . ")";
 970         } else {
 971             print $type;
 972         }
 973     }
 974     if ($is_macro) {
 975         print ")``\n\n";
 976     } else {
 977         print ")\n\n";
 978     }
 979     if (!$args{'typedef'}) {
 980         print_lineno($declaration_start_line);
 981         $lineprefix = "   ";
 982         output_highlight_rst($args{'purpose'});
 983         print "\n";
 984     }
 985
 986     print "**Parameters**\n\n";
 987     $lineprefix = "  ";
 988     foreach $parameter (@{$args{'parameterlist'}}) {
 989         my $parameter_name = $parameter;
 990         $parameter_name =~ s/\[.*//;
 991         $type = $args{'parametertypes'}{$parameter};
 992
 993         if ($type ne "") {
 994             print "``$type``\n";
 995         } else {
 996             print "``$parameter``\n";
 997         }
 998
 999         print_lineno($parameterdesc_start_lines{$parameter_name});
1000
1001         if (defined($args{'parameterdescs'}{$parameter_name}) &&
1002             $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
1003             output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1004         } else {
1005             print "  *undescribed*\n";
1006         }
1007         print "\n";
1008     }
1009
1010     $lineprefix = $oldprefix;
1011     output_section_rst(@_);
1012 }
1013
1014 sub output_section_rst(%) {
1015     my %args = %{$_[0]};
1016     my $section;
1017     my $oldprefix = $lineprefix;
1018     $lineprefix = "";
1019
1020     foreach $section (@{$args{'sectionlist'}}) {
1021         print "**$section**\n\n";
1022         print_lineno($section_start_lines{$section});
1023         output_highlight_rst($args{'sections'}{$section});
1024         print "\n";
1025     }
1026     print "\n";
1027     $lineprefix = $oldprefix;
1028 }
1029
1030 sub output_enum_rst(%) {
1031     my %args = %{$_[0]};
1032     my ($parameter);
1033     my $oldprefix = $lineprefix;
1034     my $count;
1035
1036     if ($sphinx_major < 3) {
1037         my $name = "enum " . $args{'enum'};
1038         print "\n\n.. c:type:: " . $name . "\n\n";
1039     } else {
1040         my $name = $args{'enum'};
1041         print "\n\n.. c:enum:: " . $name . "\n\n";
1042     }
1043     print_lineno($declaration_start_line);
1044     $lineprefix = "   ";
1045     output_highlight_rst($args{'purpose'});
1046     print "\n";
1047
1048     print "**Constants**\n\n";
1049     $lineprefix = "  ";
1050     foreach $parameter (@{$args{'parameterlist'}}) {
1051         print "``$parameter``\n";
1052         if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1053             output_highlight_rst($args{'parameterdescs'}{$parameter});
1054         } else {
1055             print "  *undescribed*\n";
1056         }
1057         print "\n";
1058     }
1059
1060     $lineprefix = $oldprefix;
1061     output_section_rst(@_);
1062 }
1063
1064 sub output_typedef_rst(%) {
1065     my %args = %{$_[0]};
1066     my ($parameter);
1067     my $oldprefix = $lineprefix;
1068     my $name;
1069
1070     if ($sphinx_major < 3) {
1071         $name = "typedef " . $args{'typedef'};
1072     } else {
1073         $name = $args{'typedef'};
1074     }
1075     print "\n\n.. c:type:: " . $name . "\n\n";
1076     print_lineno($declaration_start_line);
1077     $lineprefix = "   ";
1078     output_highlight_rst($args{'purpose'});
1079     print "\n";
1080
1081     $lineprefix = $oldprefix;
1082     output_section_rst(@_);
1083 }
1084
1085 sub output_struct_rst(%) {
1086     my %args = %{$_[0]};
1087     my ($parameter);
1088     my $oldprefix = $lineprefix;
1089
1090     if ($sphinx_major < 3) {
1091         my $name = $args{'type'} . " " . $args{'struct'};
1092         print "\n\n.. c:type:: " . $name . "\n\n";
1093     } else {
1094         my $name = $args{'struct'};
1095         print "\n\n.. c:struct:: " . $name . "\n\n";
1096     }
1097     print_lineno($declaration_start_line);
1098     $lineprefix = "   ";
1099     output_highlight_rst($args{'purpose'});
1100     print "\n";
1101
1102     print "**Definition**\n\n";
1103     print "::\n\n";
1104     my $declaration = $args{'definition'};
1105     $declaration =~ s/\t/  /g;
1106     print "  " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration  };\n\n";
1107
1108     print "**Members**\n\n";
1109     $lineprefix = "  ";
1110     foreach $parameter (@{$args{'parameterlist'}}) {
1111         ($parameter =~ /^#/) && next;
1112
1113         my $parameter_name = $parameter;
1114         $parameter_name =~ s/\[.*//;
1115
1116         ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1117         $type = $args{'parametertypes'}{$parameter};
1118         print_lineno($parameterdesc_start_lines{$parameter_name});
1119         print "``" . $parameter . "``\n";
1120         output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1121         print "\n";
1122     }
1123     print "\n";
1124
1125     $lineprefix = $oldprefix;
1126     output_section_rst(@_);
1127 }
1128
1129 ## none mode output functions
1130
1131 sub output_function_none(%) {
1132 }
1133
1134 sub output_enum_none(%) {
1135 }
1136
1137 sub output_typedef_none(%) {
1138 }
1139
1140 sub output_struct_none(%) {
1141 }
1142
1143 sub output_blockhead_none(%) {
1144 }
1145
1146 ##
1147 # generic output function for all types (function, struct/union, typedef, enum);
1148 # calls the generated, variable output_ function name based on
1149 # functype and output_mode
1150 sub output_declaration {
1151     no strict 'refs';
1152     my $name = shift;
1153     my $functype = shift;
1154     my $func = "output_${functype}_$output_mode";
1155
1156     return if (defined($nosymbol_table{$name}));
1157
1158     if (($output_selection == OUTPUT_ALL) ||
1159         (($output_selection == OUTPUT_INCLUDE ||
1160           $output_selection == OUTPUT_EXPORTED) &&
1161          defined($function_table{$name})) ||
1162         ($output_selection == OUTPUT_INTERNAL &&
1163          !($functype eq "function" && defined($function_table{$name}))))
1164     {
1165         &$func(@_);
1166         $section_counter++;
1167     }
1168 }
1169
1170 ##
1171 # generic output function - calls the right one based on current output mode.
1172 sub output_blockhead {
1173     no strict 'refs';
1174     my $func = "output_blockhead_" . $output_mode;
1175     &$func(@_);
1176     $section_counter++;
1177 }
1178
1179 ##
1180 # takes a declaration (struct, union, enum, typedef) and
1181 # invokes the right handler. NOT called for functions.
1182 sub dump_declaration($$) {
1183     no strict 'refs';
1184     my ($prototype, $file) = @_;
1185     my $func = "dump_" . $decl_type;
1186     &$func(@_);
1187 }
1188
1189 sub dump_union($$) {
1190     dump_struct(@_);
1191 }
1192
1193 sub dump_struct($$) {
1194     my $x = shift;
1195     my $file = shift;
1196
1197     if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
1198         my $decl_type = $1;
1199         $declaration_name = $2;
1200         my $members = $3;
1201
1202         # ignore members marked private:
1203         $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1204         $members =~ s/\/\*\s*private:.*//gosi;
1205         # strip comments:
1206         $members =~ s/\/\*.*?\*\///gos;
1207         # strip attributes
1208         $members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi;
1209         $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1210         $members =~ s/\s*__packed\s*/ /gos;
1211         $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1212         $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1213         $members =~ s/\s*____cacheline_aligned/ /gos;
1214
1215         # replace DECLARE_BITMAP
1216         $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1217         $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1218         # replace DECLARE_HASHTABLE
1219         $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1220         # replace DECLARE_KFIFO
1221         $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1222         # replace DECLARE_KFIFO_PTR
1223         $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1224
1225         my $declaration = $members;
1226
1227         # Split nested struct/union elements as newer ones
1228         while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
1229                 my $newmember;
1230                 my $maintype = $1;
1231                 my $ids = $4;
1232                 my $content = $3;
1233                 foreach my $id(split /,/, $ids) {
1234                         $newmember .= "$maintype $id; ";
1235
1236                         $id =~ s/[:\[].*//;
1237                         $id =~ s/^\s*\**(\S+)\s*/$1/;
1238                         foreach my $arg (split /;/, $content) {
1239                                 next if ($arg =~ m/^\s*$/);
1240                                 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1241                                         # pointer-to-function
1242                                         my $type = $1;
1243                                         my $name = $2;
1244                                         my $extra = $3;
1245                                         next if (!$name);
1246                                         if ($id =~ m/^\s*$/) {
1247                                                 # anonymous struct/union
1248                                                 $newmember .= "$type$name$extra; ";
1249                                         } else {
1250                                                 $newmember .= "$type$id.$name$extra; ";
1251                                         }
1252                                 } else {
1253                                         my $type;
1254                                         my $names;
1255                                         $arg =~ s/^\s+//;
1256                                         $arg =~ s/\s+$//;
1257                                         # Handle bitmaps
1258                                         $arg =~ s/:\s*\d+\s*//g;
1259                                         # Handle arrays
1260                                         $arg =~ s/\[.*\]//g;
1261                                         # The type may have multiple words,
1262                                         # and multiple IDs can be defined, like:
1263                                         #       const struct foo, *bar, foobar
1264                                         # So, we remove spaces when parsing the
1265                                         # names, in order to match just names
1266                                         # and commas for the names
1267                                         $arg =~ s/\s*,\s*/,/g;
1268                                         if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1269                                                 $type = $1;
1270                                                 $names = $2;
1271                                         } else {
1272                                                 $newmember .= "$arg; ";
1273                                                 next;
1274                                         }
1275                                         foreach my $name (split /,/, $names) {
1276                                                 $name =~ s/^\s*\**(\S+)\s*/$1/;
1277                                                 next if (($name =~ m/^\s*$/));
1278                                                 if ($id =~ m/^\s*$/) {
1279                                                         # anonymous struct/union
1280                                                         $newmember .= "$type $name; ";
1281                                                 } else {
1282                                                         $newmember .= "$type $id.$name; ";
1283                                                 }
1284                                         }
1285                                 }
1286                         }
1287                 }
1288                 $members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
1289         }
1290
1291         # Ignore other nested elements, like enums
1292         $members =~ s/(\{[^\{\}]*\})//g;
1293
1294         create_parameterlist($members, ';', $file, $declaration_name);
1295         check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1296
1297         # Adjust declaration for better display
1298         $declaration =~ s/([\{;])/$1\n/g;
1299         $declaration =~ s/\}\s+;/};/g;
1300         # Better handle inlined enums
1301         do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1302
1303         my @def_args = split /\n/, $declaration;
1304         my $level = 1;
1305         $declaration = "";
1306         foreach my $clause (@def_args) {
1307                 $clause =~ s/^\s+//;
1308                 $clause =~ s/\s+$//;
1309                 $clause =~ s/\s+/ /;
1310                 next if (!$clause);
1311                 $level-- if ($clause =~ m/(\})/ && $level > 1);
1312                 if (!($clause =~ m/^\s*#/)) {
1313                         $declaration .= "\t" x $level;
1314                 }
1315                 $declaration .= "\t" . $clause . "\n";
1316                 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1317         }
1318         output_declaration($declaration_name,
1319                            'struct',
1320                            {'struct' => $declaration_name,
1321                             'module' => $modulename,
1322                             'definition' => $declaration,
1323                             'parameterlist' => \@parameterlist,
1324                             'parameterdescs' => \%parameterdescs,
1325                             'parametertypes' => \%parametertypes,
1326                             'sectionlist' => \@sectionlist,
1327                             'sections' => \%sections,
1328                             'purpose' => $declaration_purpose,
1329                             'type' => $decl_type
1330                            });
1331     }
1332     else {
1333         print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1334         ++$errors;
1335     }
1336 }
1337
1338
1339 sub show_warnings($$) {
1340         my $functype = shift;
1341         my $name = shift;
1342
1343         return 0 if (defined($nosymbol_table{$name}));
1344
1345         return 1 if ($output_selection == OUTPUT_ALL);
1346
1347         if ($output_selection == OUTPUT_EXPORTED) {
1348                 if (defined($function_table{$name})) {
1349                         return 1;
1350                 } else {
1351                         return 0;
1352                 }
1353         }
1354         if ($output_selection == OUTPUT_INTERNAL) {
1355                 if (!($functype eq "function" && defined($function_table{$name}))) {
1356                         return 1;
1357                 } else {
1358                         return 0;
1359                 }
1360         }
1361         if ($output_selection == OUTPUT_INCLUDE) {
1362                 if (defined($function_table{$name})) {
1363                         return 1;
1364                 } else {
1365                         return 0;
1366                 }
1367         }
1368         die("Please add the new output type at show_warnings()");
1369 }
1370
1371 sub dump_enum($$) {
1372     my $x = shift;
1373     my $file = shift;
1374     my $members;
1375
1376
1377     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1378     # strip #define macros inside enums
1379     $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1380
1381     if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1382         $declaration_name = $2;
1383         $members = $1;
1384     } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1385         $declaration_name = $1;
1386         $members = $2;
1387     }
1388
1389     if ($declaration_name) {
1390         my %_members;
1391
1392         $members =~ s/\s+$//;
1393
1394         foreach my $arg (split ',', $members) {
1395             $arg =~ s/^\s*(\w+).*/$1/;
1396             push @parameterlist, $arg;
1397             if (!$parameterdescs{$arg}) {
1398                 $parameterdescs{$arg} = $undescribed;
1399                 if (show_warnings("enum", $declaration_name)) {
1400                         print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1401                 }
1402             }
1403             $_members{$arg} = 1;
1404         }
1405
1406         while (my ($k, $v) = each %parameterdescs) {
1407             if (!exists($_members{$k})) {
1408                 if (show_warnings("enum", $declaration_name)) {
1409                      print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1410                 }
1411             }
1412         }
1413
1414         output_declaration($declaration_name,
1415                            'enum',
1416                            {'enum' => $declaration_name,
1417                             'module' => $modulename,
1418                             'parameterlist' => \@parameterlist,
1419                             'parameterdescs' => \%parameterdescs,
1420                             'sectionlist' => \@sectionlist,
1421                             'sections' => \%sections,
1422                             'purpose' => $declaration_purpose
1423                            });
1424     } else {
1425         print STDERR "${file}:$.: error: Cannot parse enum!\n";
1426         ++$errors;
1427     }
1428 }
1429
1430 sub dump_typedef($$) {
1431     my $x = shift;
1432     my $file = shift;
1433
1434     $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1435
1436     # Parse function prototypes
1437     if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||
1438         $x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {
1439
1440         # Function typedefs
1441         $return_type = $1;
1442         $declaration_name = $2;
1443         my $args = $3;
1444
1445         create_parameterlist($args, ',', $file, $declaration_name);
1446
1447         output_declaration($declaration_name,
1448                            'function',
1449                            {'function' => $declaration_name,
1450                             'typedef' => 1,
1451                             'module' => $modulename,
1452                             'functiontype' => $return_type,
1453                             'parameterlist' => \@parameterlist,
1454                             'parameterdescs' => \%parameterdescs,
1455                             'parametertypes' => \%parametertypes,
1456                             'sectionlist' => \@sectionlist,
1457                             'sections' => \%sections,
1458                             'purpose' => $declaration_purpose
1459                            });
1460         return;
1461     }
1462
1463     while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1464         $x =~ s/\(*.\)\s*;$/;/;
1465         $x =~ s/\[*.\]\s*;$/;/;
1466     }
1467
1468     if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1469         $declaration_name = $1;
1470
1471         output_declaration($declaration_name,
1472                            'typedef',
1473                            {'typedef' => $declaration_name,
1474                             'module' => $modulename,
1475                             'sectionlist' => \@sectionlist,
1476                             'sections' => \%sections,
1477                             'purpose' => $declaration_purpose
1478                            });
1479     }
1480     else {
1481         print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1482         ++$errors;
1483     }
1484 }
1485
1486 sub save_struct_actual($) {
1487     my $actual = shift;
1488
1489     # strip all spaces from the actual param so that it looks like one string item
1490     $actual =~ s/\s*//g;
1491     $struct_actual = $struct_actual . $actual . " ";
1492 }
1493
1494 sub create_parameterlist($$$$) {
1495     my $args = shift;
1496     my $splitter = shift;
1497     my $file = shift;
1498     my $declaration_name = shift;
1499     my $type;
1500     my $param;
1501
1502     # temporarily replace commas inside function pointer definition
1503     while ($args =~ /(\([^\),]+),/) {
1504         $args =~ s/(\([^\),]+),/$1#/g;
1505     }
1506
1507     foreach my $arg (split($splitter, $args)) {
1508         # strip comments
1509         $arg =~ s/\/\*.*\*\///;
1510         # strip leading/trailing spaces
1511         $arg =~ s/^\s*//;
1512         $arg =~ s/\s*$//;
1513         $arg =~ s/\s+/ /;
1514
1515         if ($arg =~ /^#/) {
1516             # Treat preprocessor directive as a typeless variable just to fill
1517             # corresponding data structures "correctly". Catch it later in
1518             # output_* subs.
1519             push_parameter($arg, "", "", $file);
1520         } elsif ($arg =~ m/\(.+\)\s*\(/) {
1521             # pointer-to-function
1522             $arg =~ tr/#/,/;
1523             $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/;
1524             $param = $1;
1525             $type = $arg;
1526             $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1527             save_struct_actual($param);
1528             push_parameter($param, $type, $arg, $file, $declaration_name);
1529         } elsif ($arg) {
1530             $arg =~ s/\s*:\s*/:/g;
1531             $arg =~ s/\s*\[/\[/g;
1532
1533             my @args = split('\s*,\s*', $arg);
1534             if ($args[0] =~ m/\*/) {
1535                 $args[0] =~ s/(\*+)\s*/ $1/;
1536             }
1537
1538             my @first_arg;
1539             if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1540                     shift @args;
1541                     push(@first_arg, split('\s+', $1));
1542                     push(@first_arg, $2);
1543             } else {
1544                     @first_arg = split('\s+', shift @args);
1545             }
1546
1547             unshift(@args, pop @first_arg);
1548             $type = join " ", @first_arg;
1549
1550             foreach $param (@args) {
1551                 if ($param =~ m/^(\*+)\s*(.*)/) {
1552                     save_struct_actual($2);
1553
1554                     push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1555                 }
1556                 elsif ($param =~ m/(.*?):(\d+)/) {
1557                     if ($type ne "") { # skip unnamed bit-fields
1558                         save_struct_actual($1);
1559                         push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1560                     }
1561                 }
1562                 else {
1563                     save_struct_actual($param);
1564                     push_parameter($param, $type, $arg, $file, $declaration_name);
1565                 }
1566             }
1567         }
1568     }
1569 }
1570
1571 sub push_parameter($$$$$) {
1572         my $param = shift;
1573         my $type = shift;
1574         my $org_arg = shift;
1575         my $file = shift;
1576         my $declaration_name = shift;
1577
1578         if (($anon_struct_union == 1) && ($type eq "") &&
1579             ($param eq "}")) {
1580                 return;         # ignore the ending }; from anon. struct/union
1581         }
1582
1583         $anon_struct_union = 0;
1584         $param =~ s/[\[\)].*//;
1585
1586         if ($type eq "" && $param =~ /\.\.\.$/)
1587         {
1588             if (!$param =~ /\w\.\.\.$/) {
1589               # handles unnamed variable parameters
1590               $param = "...";
1591             }
1592             elsif ($param =~ /\w\.\.\.$/) {
1593               # for named variable parameters of the form `x...`, remove the dots
1594               $param =~ s/\.\.\.$//;
1595             }
1596             if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1597                 $parameterdescs{$param} = "variable arguments";
1598             }
1599         }
1600         elsif ($type eq "" && ($param eq "" or $param eq "void"))
1601         {
1602             $param="void";
1603             $parameterdescs{void} = "no arguments";
1604         }
1605         elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1606         # handle unnamed (anonymous) union or struct:
1607         {
1608                 $type = $param;
1609                 $param = "{unnamed_" . $param . "}";
1610                 $parameterdescs{$param} = "anonymous\n";
1611                 $anon_struct_union = 1;
1612         }
1613
1614         # warn if parameter has no description
1615         # (but ignore ones starting with # as these are not parameters
1616         # but inline preprocessor statements);
1617         # Note: It will also ignore void params and unnamed structs/unions
1618         if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1619                 $parameterdescs{$param} = $undescribed;
1620
1621                 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1622                         print STDERR
1623                               "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1624                         ++$warnings;
1625                 }
1626         }
1627
1628         # strip spaces from $param so that it is one continuous string
1629         # on @parameterlist;
1630         # this fixes a problem where check_sections() cannot find
1631         # a parameter like "addr[6 + 2]" because it actually appears
1632         # as "addr[6", "+", "2]" on the parameter list;
1633         # but it's better to maintain the param string unchanged for output,
1634         # so just weaken the string compare in check_sections() to ignore
1635         # "[blah" in a parameter string;
1636         ###$param =~ s/\s*//g;
1637         push @parameterlist, $param;
1638         $org_arg =~ s/\s\s+/ /g;
1639         $parametertypes{$param} = $org_arg;
1640 }
1641
1642 sub check_sections($$$$$) {
1643         my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1644         my @sects = split ' ', $sectcheck;
1645         my @prms = split ' ', $prmscheck;
1646         my $err;
1647         my ($px, $sx);
1648         my $prm_clean;          # strip trailing "[array size]" and/or beginning "*"
1649
1650         foreach $sx (0 .. $#sects) {
1651                 $err = 1;
1652                 foreach $px (0 .. $#prms) {
1653                         $prm_clean = $prms[$px];
1654                         $prm_clean =~ s/\[.*\]//;
1655                         $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1656                         # ignore array size in a parameter string;
1657                         # however, the original param string may contain
1658                         # spaces, e.g.:  addr[6 + 2]
1659                         # and this appears in @prms as "addr[6" since the
1660                         # parameter list is split at spaces;
1661                         # hence just ignore "[..." for the sections check;
1662                         $prm_clean =~ s/\[.*//;
1663
1664                         ##$prm_clean =~ s/^\**//;
1665                         if ($prm_clean eq $sects[$sx]) {
1666                                 $err = 0;
1667                                 last;
1668                         }
1669                 }
1670                 if ($err) {
1671                         if ($decl_type eq "function") {
1672                                 print STDERR "${file}:$.: warning: " .
1673                                         "Excess function parameter " .
1674                                         "'$sects[$sx]' " .
1675                                         "description in '$decl_name'\n";
1676                                 ++$warnings;
1677                         }
1678                 }
1679         }
1680 }
1681
1682 ##
1683 # Checks the section describing the return value of a function.
1684 sub check_return_section {
1685         my $file = shift;
1686         my $declaration_name = shift;
1687         my $return_type = shift;
1688
1689         # Ignore an empty return type (It's a macro)
1690         # Ignore functions with a "void" return type. (But don't ignore "void *")
1691         if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1692                 return;
1693         }
1694
1695         if (!defined($sections{$section_return}) ||
1696             $sections{$section_return} eq "") {
1697                 print STDERR "${file}:$.: warning: " .
1698                         "No description found for return value of " .
1699                         "'$declaration_name'\n";
1700                 ++$warnings;
1701         }
1702 }
1703
1704 ##
1705 # takes a function prototype and the name of the current file being
1706 # processed and spits out all the details stored in the global
1707 # arrays/hashes.
1708 sub dump_function($$) {
1709     my $prototype = shift;
1710     my $file = shift;
1711     my $noret = 0;
1712
1713     print_lineno($new_start_line);
1714
1715     $prototype =~ s/^static +//;
1716     $prototype =~ s/^extern +//;
1717     $prototype =~ s/^asmlinkage +//;
1718     $prototype =~ s/^inline +//;
1719     $prototype =~ s/^__inline__ +//;
1720     $prototype =~ s/^__inline +//;
1721     $prototype =~ s/^__always_inline +//;
1722     $prototype =~ s/^noinline +//;
1723     $prototype =~ s/__init +//;
1724     $prototype =~ s/__init_or_module +//;
1725     $prototype =~ s/__meminit +//;
1726     $prototype =~ s/__must_check +//;
1727     $prototype =~ s/__weak +//;
1728     $prototype =~ s/__sched +//;
1729     $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1730     my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1731     $prototype =~ s/__attribute__\s*\(\(
1732             (?:
1733                  [\w\s]++          # attribute name
1734                  (?:\([^)]*+\))?   # attribute arguments
1735                  \s*+,?            # optional comma at the end
1736             )+
1737           \)\)\s+//x;
1738
1739     # Yes, this truly is vile.  We are looking for:
1740     # 1. Return type (may be nothing if we're looking at a macro)
1741     # 2. Function name
1742     # 3. Function parameters.
1743     #
1744     # All the while we have to watch out for function pointer parameters
1745     # (which IIRC is what the two sections are for), C types (these
1746     # regexps don't even start to express all the possibilities), and
1747     # so on.
1748     #
1749     # If you mess with these regexps, it's a good idea to check that
1750     # the following functions' documentation still comes out right:
1751     # - parport_register_device (function pointer parameters)
1752     # - qatomic_set (macro)
1753     # - pci_match_device, __copy_to_user (long return type)
1754
1755     if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
1756         # This is an object-like macro, it has no return type and no parameter
1757         # list.
1758         # Function-like macros are not allowed to have spaces between
1759         # declaration_name and opening parenthesis (notice the \s+).
1760         $return_type = $1;
1761         $declaration_name = $2;
1762         $noret = 1;
1763     } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1764         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1765         $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1766         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1767         $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1768         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1769         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1770         $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1771         $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1772         $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1773         $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1774         $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1775         $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1776         $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1777         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1778         $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1779         $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/)  {
1780         $return_type = $1;
1781         $declaration_name = $2;
1782         my $args = $3;
1783
1784         create_parameterlist($args, ',', $file, $declaration_name);
1785     } else {
1786         print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1787         return;
1788     }
1789
1790     my $prms = join " ", @parameterlist;
1791     check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1792
1793     # This check emits a lot of warnings at the moment, because many
1794     # functions don't have a 'Return' doc section. So until the number
1795     # of warnings goes sufficiently down, the check is only performed in
1796     # verbose mode.
1797     # TODO: always perform the check.
1798     if ($verbose && !$noret) {
1799             check_return_section($file, $declaration_name, $return_type);
1800     }
1801
1802     # The function parser can be called with a typedef parameter.
1803     # Handle it.
1804     if ($return_type =~ /typedef/) {
1805         output_declaration($declaration_name,
1806                            'function',
1807                            {'function' => $declaration_name,
1808                             'typedef' => 1,
1809                             'module' => $modulename,
1810                             'functiontype' => $return_type,
1811                             'parameterlist' => \@parameterlist,
1812                             'parameterdescs' => \%parameterdescs,
1813                             'parametertypes' => \%parametertypes,
1814                             'sectionlist' => \@sectionlist,
1815                             'sections' => \%sections,
1816                             'purpose' => $declaration_purpose
1817                            });
1818     } else {
1819         output_declaration($declaration_name,
1820                            'function',
1821                            {'function' => $declaration_name,
1822                             'module' => $modulename,
1823                             'functiontype' => $return_type,
1824                             'parameterlist' => \@parameterlist,
1825                             'parameterdescs' => \%parameterdescs,
1826                             'parametertypes' => \%parametertypes,
1827                             'sectionlist' => \@sectionlist,
1828                             'sections' => \%sections,
1829                             'purpose' => $declaration_purpose
1830                            });
1831     }
1832 }
1833
1834 sub reset_state {
1835     $function = "";
1836     %parameterdescs = ();
1837     %parametertypes = ();
1838     @parameterlist = ();
1839     %sections = ();
1840     @sectionlist = ();
1841     $sectcheck = "";
1842     $struct_actual = "";
1843     $prototype = "";
1844
1845     $state = STATE_NORMAL;
1846     $inline_doc_state = STATE_INLINE_NA;
1847 }
1848
1849 sub tracepoint_munge($) {
1850         my $file = shift;
1851         my $tracepointname = 0;
1852         my $tracepointargs = 0;
1853
1854         if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1855                 $tracepointname = $1;
1856         }
1857         if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1858                 $tracepointname = $1;
1859         }
1860         if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1861                 $tracepointname = $2;
1862         }
1863         $tracepointname =~ s/^\s+//; #strip leading whitespace
1864         if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1865                 $tracepointargs = $1;
1866         }
1867         if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1868                 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1869                              "$prototype\n";
1870         } else {
1871                 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1872         }
1873 }
1874
1875 sub syscall_munge() {
1876         my $void = 0;
1877
1878         $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1879 ##      if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1880         if ($prototype =~ m/SYSCALL_DEFINE0/) {
1881                 $void = 1;
1882 ##              $prototype = "long sys_$1(void)";
1883         }
1884
1885         $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1886         if ($prototype =~ m/long (sys_.*?),/) {
1887                 $prototype =~ s/,/\(/;
1888         } elsif ($void) {
1889                 $prototype =~ s/\)/\(void\)/;
1890         }
1891
1892         # now delete all of the odd-number commas in $prototype
1893         # so that arg types & arg names don't have a comma between them
1894         my $count = 0;
1895         my $len = length($prototype);
1896         if ($void) {
1897                 $len = 0;       # skip the for-loop
1898         }
1899         for (my $ix = 0; $ix < $len; $ix++) {
1900                 if (substr($prototype, $ix, 1) eq ',') {
1901                         $count++;
1902                         if ($count % 2 == 1) {
1903                                 substr($prototype, $ix, 1) = ' ';
1904                         }
1905                 }
1906         }
1907 }
1908
1909 sub process_proto_function($$) {
1910     my $x = shift;
1911     my $file = shift;
1912
1913     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1914
1915     if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1916         # do nothing
1917     }
1918     elsif ($x =~ /([^\{]*)/) {
1919         $prototype .= $1;
1920     }
1921
1922     if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1923         $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1924         $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1925         $prototype =~ s@^\s+@@gos; # strip leading spaces
1926
1927          # Handle prototypes for function pointers like:
1928          # int (*pcs_config)(struct foo)
1929         $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1930
1931         if ($prototype =~ /SYSCALL_DEFINE/) {
1932                 syscall_munge();
1933         }
1934         if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1935             $prototype =~ /DEFINE_SINGLE_EVENT/)
1936         {
1937                 tracepoint_munge($file);
1938         }
1939         dump_function($prototype, $file);
1940         reset_state();
1941     }
1942 }
1943
1944 sub process_proto_type($$) {
1945     my $x = shift;
1946     my $file = shift;
1947
1948     $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1949     $x =~ s@^\s+@@gos; # strip leading spaces
1950     $x =~ s@\s+$@@gos; # strip trailing spaces
1951     $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1952
1953     if ($x =~ /^#/) {
1954         # To distinguish preprocessor directive from regular declaration later.
1955         $x .= ";";
1956     }
1957
1958     while (1) {
1959         if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
1960             if( length $prototype ) {
1961                 $prototype .= " "
1962             }
1963             $prototype .= $1 . $2;
1964             ($2 eq '{') && $brcount++;
1965             ($2 eq '}') && $brcount--;
1966             if (($2 eq ';') && ($brcount == 0)) {
1967                 dump_declaration($prototype, $file);
1968                 reset_state();
1969                 last;
1970             }
1971             $x = $3;
1972         } else {
1973             $prototype .= $x;
1974             last;
1975         }
1976     }
1977 }
1978
1979
1980 sub map_filename($) {
1981     my $file;
1982     my ($orig_file) = @_;
1983
1984     if (defined($ENV{'SRCTREE'})) {
1985         $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1986     } else {
1987         $file = $orig_file;
1988     }
1989
1990     if (defined($source_map{$file})) {
1991         $file = $source_map{$file};
1992     }
1993
1994     return $file;
1995 }
1996
1997 sub process_export_file($) {
1998     my ($orig_file) = @_;
1999     my $file = map_filename($orig_file);
2000
2001     if (!open(IN,"<$file")) {
2002         print STDERR "Error: Cannot open file $file\n";
2003         ++$errors;
2004         return;
2005     }
2006
2007     while (<IN>) {
2008         if (/$export_symbol/) {
2009             next if (defined($nosymbol_table{$2}));
2010             $function_table{$2} = 1;
2011         }
2012     }
2013
2014     close(IN);
2015 }
2016
2017 #
2018 # Parsers for the various processing states.
2019 #
2020 # STATE_NORMAL: looking for the /** to begin everything.
2021 #
2022 sub process_normal() {
2023     if (/$doc_start/o) {
2024         $state = STATE_NAME;    # next line is always the function name
2025         $in_doc_sect = 0;
2026         $declaration_start_line = $. + 1;
2027     }
2028 }
2029
2030 #
2031 # STATE_NAME: Looking for the "name - description" line
2032 #
2033 sub process_name($$) {
2034     my $file = shift;
2035     my $identifier;
2036     my $descr;
2037
2038     if (/$doc_block/o) {
2039         $state = STATE_DOCBLOCK;
2040         $contents = "";
2041         $new_start_line = $.;
2042
2043         if ( $1 eq "" ) {
2044             $section = $section_intro;
2045         } else {
2046             $section = $1;
2047         }
2048     }
2049     elsif (/$doc_decl/o) {
2050         $identifier = $1;
2051         if (/\s*([\w\s]+?)(\s*-|:)/) {
2052             $identifier = $1;
2053         }
2054
2055         $state = STATE_BODY;
2056         # if there's no @param blocks need to set up default section
2057         # here
2058         $contents = "";
2059         $section = $section_default;
2060         $new_start_line = $. + 1;
2061         if (/[-:](.*)/) {
2062             # strip leading/trailing/multiple spaces
2063             $descr= $1;
2064             $descr =~ s/^\s*//;
2065             $descr =~ s/\s*$//;
2066             $descr =~ s/\s+/ /g;
2067             $declaration_purpose = $descr;
2068             $state = STATE_BODY_MAYBE;
2069         } else {
2070             $declaration_purpose = "";
2071         }
2072
2073         if (($declaration_purpose eq "") && $verbose) {
2074             print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2075             print STDERR $_;
2076             ++$warnings;
2077         }
2078
2079         if ($identifier =~ m/^struct\b/) {
2080             $decl_type = 'struct';
2081         } elsif ($identifier =~ m/^union\b/) {
2082             $decl_type = 'union';
2083         } elsif ($identifier =~ m/^enum\b/) {
2084             $decl_type = 'enum';
2085         } elsif ($identifier =~ m/^typedef\b/) {
2086             $decl_type = 'typedef';
2087         } else {
2088             $decl_type = 'function';
2089         }
2090
2091         if ($verbose) {
2092             print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
2093         }
2094     } else {
2095         print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2096             " - I thought it was a doc line\n";
2097         ++$warnings;
2098         $state = STATE_NORMAL;
2099     }
2100 }
2101
2102
2103 #
2104 # STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2105 #
2106 sub process_body($$) {
2107     my $file = shift;
2108
2109     # Until all named variable macro parameters are
2110     # documented using the bare name (`x`) rather than with
2111     # dots (`x...`), strip the dots:
2112     if ($section =~ /\w\.\.\.$/) {
2113         $section =~ s/\.\.\.$//;
2114
2115         if ($verbose) {
2116             print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
2117             ++$warnings;
2118         }
2119     }
2120
2121     if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2122         dump_section($file, $section, $contents);
2123         $section = $section_default;
2124         $new_start_line = $.;
2125         $contents = "";
2126     }
2127
2128     if (/$doc_sect/i) { # case insensitive for supported section names
2129         $newsection = $1;
2130         $newcontents = $2;
2131
2132         # map the supported section names to the canonical names
2133         if ($newsection =~ m/^description$/i) {
2134             $newsection = $section_default;
2135         } elsif ($newsection =~ m/^context$/i) {
2136             $newsection = $section_context;
2137         } elsif ($newsection =~ m/^returns?$/i) {
2138             $newsection = $section_return;
2139         } elsif ($newsection =~ m/^\@return$/) {
2140             # special: @return is a section, not a param description
2141             $newsection = $section_return;
2142         }
2143
2144         if (($contents ne "") && ($contents ne "\n")) {
2145             if (!$in_doc_sect && $verbose) {
2146                 print STDERR "${file}:$.: warning: contents before sections\n";
2147                 ++$warnings;
2148             }
2149             dump_section($file, $section, $contents);
2150             $section = $section_default;
2151         }
2152
2153         $in_doc_sect = 1;
2154         $state = STATE_BODY;
2155         $contents = $newcontents;
2156         $new_start_line = $.;
2157         while (substr($contents, 0, 1) eq " ") {
2158             $contents = substr($contents, 1);
2159         }
2160         if ($contents ne "") {
2161             $contents .= "\n";
2162         }
2163         $section = $newsection;
2164         $leading_space = undef;
2165     } elsif (/$doc_end/) {
2166         if (($contents ne "") && ($contents ne "\n")) {
2167             dump_section($file, $section, $contents);
2168             $section = $section_default;
2169             $contents = "";
2170         }
2171         # look for doc_com + <text> + doc_end:
2172         if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2173             print STDERR "${file}:$.: warning: suspicious ending line: $_";
2174             ++$warnings;
2175         }
2176
2177         $prototype = "";
2178         $state = STATE_PROTO;
2179         $brcount = 0;
2180         $new_start_line = $. + 1;
2181     } elsif (/$doc_content/) {
2182         if ($1 eq "") {
2183             if ($section eq $section_context) {
2184                 dump_section($file, $section, $contents);
2185                 $section = $section_default;
2186                 $contents = "";
2187                 $new_start_line = $.;
2188                 $state = STATE_BODY;
2189             } else {
2190                 if ($section ne $section_default) {
2191                     $state = STATE_BODY_WITH_BLANK_LINE;
2192                 } else {
2193                     $state = STATE_BODY;
2194                 }
2195                 $contents .= "\n";
2196             }
2197         } elsif ($state == STATE_BODY_MAYBE) {
2198             # Continued declaration purpose
2199             chomp($declaration_purpose);
2200             $declaration_purpose .= " " . $1;
2201             $declaration_purpose =~ s/\s+/ /g;
2202         } else {
2203             my $cont = $1;
2204             if ($section =~ m/^@/ || $section eq $section_context) {
2205                 if (!defined $leading_space) {
2206                     if ($cont =~ m/^(\s+)/) {
2207                         $leading_space = $1;
2208                     } else {
2209                         $leading_space = "";
2210                     }
2211                 }
2212                 $cont =~ s/^$leading_space//;
2213             }
2214             $contents .= $cont . "\n";
2215         }
2216     } else {
2217         # i dont know - bad line?  ignore.
2218         print STDERR "${file}:$.: warning: bad line: $_";
2219         ++$warnings;
2220     }
2221 }
2222
2223
2224 #
2225 # STATE_PROTO: reading a function/whatever prototype.
2226 #
2227 sub process_proto($$) {
2228     my $file = shift;
2229
2230     if (/$doc_inline_oneline/) {
2231         $section = $1;
2232         $contents = $2;
2233         if ($contents ne "") {
2234             $contents .= "\n";
2235             dump_section($file, $section, $contents);
2236             $section = $section_default;
2237             $contents = "";
2238         }
2239     } elsif (/$doc_inline_start/) {
2240         $state = STATE_INLINE;
2241         $inline_doc_state = STATE_INLINE_NAME;
2242     } elsif ($decl_type eq 'function') {
2243         process_proto_function($_, $file);
2244     } else {
2245         process_proto_type($_, $file);
2246     }
2247 }
2248
2249 #
2250 # STATE_DOCBLOCK: within a DOC: block.
2251 #
2252 sub process_docblock($$) {
2253     my $file = shift;
2254
2255     if (/$doc_end/) {
2256         dump_doc_section($file, $section, $contents);
2257         $section = $section_default;
2258         $contents = "";
2259         $function = "";
2260         %parameterdescs = ();
2261         %parametertypes = ();
2262         @parameterlist = ();
2263         %sections = ();
2264         @sectionlist = ();
2265         $prototype = "";
2266         $state = STATE_NORMAL;
2267     } elsif (/$doc_content/) {
2268         if ( $1 eq "" ) {
2269             $contents .= $blankline;
2270         } else {
2271             $contents .= $1 . "\n";
2272         }
2273     }
2274 }
2275
2276 #
2277 # STATE_INLINE: docbook comments within a prototype.
2278 #
2279 sub process_inline($$) {
2280     my $file = shift;
2281
2282     # First line (state 1) needs to be a @parameter
2283     if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2284         $section = $1;
2285         $contents = $2;
2286         $new_start_line = $.;
2287         if ($contents ne "") {
2288             while (substr($contents, 0, 1) eq " ") {
2289                 $contents = substr($contents, 1);
2290             }
2291             $contents .= "\n";
2292         }
2293         $inline_doc_state = STATE_INLINE_TEXT;
2294         # Documentation block end */
2295     } elsif (/$doc_inline_end/) {
2296         if (($contents ne "") && ($contents ne "\n")) {
2297             dump_section($file, $section, $contents);
2298             $section = $section_default;
2299             $contents = "";
2300         }
2301         $state = STATE_PROTO;
2302         $inline_doc_state = STATE_INLINE_NA;
2303         # Regular text
2304     } elsif (/$doc_content/) {
2305         if ($inline_doc_state == STATE_INLINE_TEXT) {
2306             $contents .= $1 . "\n";
2307             # nuke leading blank lines
2308             if ($contents =~ /^\s*$/) {
2309                 $contents = "";
2310             }
2311         } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2312             $inline_doc_state = STATE_INLINE_ERROR;
2313             print STDERR "${file}:$.: warning: ";
2314             print STDERR "Incorrect use of kernel-doc format: $_";
2315             ++$warnings;
2316         }
2317     }
2318 }
2319
2320
2321 sub process_file($) {
2322     my $file;
2323     my $initial_section_counter = $section_counter;
2324     my ($orig_file) = @_;
2325
2326     $file = map_filename($orig_file);
2327
2328     if (!open(IN_FILE,"<$file")) {
2329         print STDERR "Error: Cannot open file $file\n";
2330         ++$errors;
2331         return;
2332     }
2333
2334     $. = 1;
2335
2336     $section_counter = 0;
2337     while (<IN_FILE>) {
2338         while (s/\\\s*$//) {
2339             $_ .= <IN_FILE>;
2340         }
2341         # Replace tabs by spaces
2342         while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2343         # Hand this line to the appropriate state handler
2344         if ($state == STATE_NORMAL) {
2345             process_normal();
2346         } elsif ($state == STATE_NAME) {
2347             process_name($file, $_);
2348         } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2349                  $state == STATE_BODY_WITH_BLANK_LINE) {
2350             process_body($file, $_);
2351         } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2352             process_inline($file, $_);
2353         } elsif ($state == STATE_PROTO) {
2354             process_proto($file, $_);
2355         } elsif ($state == STATE_DOCBLOCK) {
2356             process_docblock($file, $_);
2357         }
2358     }
2359
2360     # Make sure we got something interesting.
2361     if ($initial_section_counter == $section_counter && $
2362         output_mode ne "none") {
2363         if ($output_selection == OUTPUT_INCLUDE) {
2364             print STDERR "${file}:1: warning: '$_' not found\n"
2365                 for keys %function_table;
2366         }
2367         else {
2368             print STDERR "${file}:1: warning: no structured comments found\n";
2369         }
2370     }
2371     close IN_FILE;
2372 }
2373
2374
2375 if ($output_mode eq "rst") {
2376         get_sphinx_version() if (!$sphinx_major);
2377 }
2378
2379 $kernelversion = get_kernel_version();
2380
2381 # generate a sequence of code that will splice in highlighting information
2382 # using the s// operator.
2383 for (my $k = 0; $k < @highlights; $k++) {
2384     my $pattern = $highlights[$k][0];
2385     my $result = $highlights[$k][1];
2386 #   print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2387     $dohighlight .=  "\$contents =~ s:$pattern:$result:gs;\n";
2388 }
2389
2390 # Read the file that maps relative names to absolute names for
2391 # separate source and object directories and for shadow trees.
2392 if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2393         my ($relname, $absname);
2394         while(<SOURCE_MAP>) {
2395                 chop();
2396                 ($relname, $absname) = (split())[0..1];
2397                 $relname =~ s:^/+::;
2398                 $source_map{$relname} = $absname;
2399         }
2400         close(SOURCE_MAP);
2401 }
2402
2403 if ($output_selection == OUTPUT_EXPORTED ||
2404     $output_selection == OUTPUT_INTERNAL) {
2405
2406     push(@export_file_list, @ARGV);
2407
2408     foreach (@export_file_list) {
2409         chomp;
2410         process_export_file($_);
2411     }
2412 }
2413
2414 foreach (@ARGV) {
2415     chomp;
2416     process_file($_);
2417 }
2418 if ($verbose && $errors) {
2419   print STDERR "$errors errors\n";
2420 }
2421 if ($verbose && $warnings) {
2422   print STDERR "$warnings warnings\n";
2423 }
2424
2425 if ($Werror && $warnings) {
2426     print STDERR "$warnings warnings as Errors\n";
2427     exit($warnings);
2428 } else {
2429     exit($output_mode eq "none" ? 0 : $errors)
2430 }