LXR linux/scripts/kernel-doc

   1#!/usr/bin/env perl
   2# SPDX-License-Identifier: GPL-2.0
   3
   4use warnings;
   5use 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
  44sub usage {
  45    my $message = <<"EOF";
  46Usage: $0 [OPTION ...] FILE ...
  47
  48Read C language source or header FILEs, extract embedded documentation comments,
  49and print formatted documentation to standard output.
  50
  51The documentation comments are identified by "/**" opening comment mark. See
  52Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
  53
  54Output 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
  59Output 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
  66Output 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
  79Output 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
  87Other parameters:
  88  -v                    Verbose output, more warnings and other information.
  89  -h                    Print this help.
  90  -Werror               Treat warnings as errors.
  91
  92EOF
  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
 214my $errors = 0;
 215my $warnings = 0;
 216my $anon_struct_union = 0;
 217
 218# match expressions used to find embedded type information
 219my $type_constant = '\b``([^\`]+)``\b';
 220my $type_constant2 = '\%([-_\w]+)';
 221my $type_func = '(\w+)\(\)';
 222my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
 223my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
 224my $type_fp_param = '\@(\w+)\(\)';  # Special RST handling for func ptr params
 225my $type_fp_param2 = '\@(\w+->\S+)\(\)';  # Special RST handling for structs with func ptr params
 226my $type_env = '(\$\w+)';
 227my $type_enum = '\&(enum\s*([_\w]+))';
 228my $type_struct = '\&(struct\s*([_\w]+))';
 229my $type_typedef = '\&(typedef\s*([_\w]+))';
 230my $type_union = '\&(union\s*([_\w]+))';
 231my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
 232my $type_fallback = '\&([_\w]+)';
 233my $type_member_func = $type_member . '\(\)';
 234
 235# Output conversion substitutions.
 236#  One for each output format
 237
 238# these are pretty rough
 239my @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                     );
 252my $blankline_man = "";
 253
 254# rst-mode
 255my @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                      );
 272my $blankline_rst = "\n";
 273
 274# read arguments
 275if ($#ARGV == -1) {
 276    usage();
 277}
 278
 279my $kernelversion;
 280my ($sphinx_major, $sphinx_minor, $sphinx_patch);
 281
 282my $dohighlight = "";
 283
 284my $verbose = 0;
 285my $Werror = 0;
 286my $output_mode = "rst";
 287my $output_preformatted = 0;
 288my $no_doc_sections = 0;
 289my $enable_lineno = 0;
 290my @highlights = @highlights_rst;
 291my $blankline = $blankline_rst;
 292my $modulename = "Kernel API";
 293
 294use 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};
 300my $output_selection = OUTPUT_ALL;
 301my $show_not_found = 0; # No longer used
 302
 303my @export_file_list;
 304
 305my @build_time;
 306if (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
 313my $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.
 322my ($function, %function_table, %parametertypes, $declaration_purpose);
 323my %nosymbol_table = ();
 324my $declaration_start_line;
 325my ($type, $declaration_name, $return_type);
 326my ($newsection, $newcontents, $prototype, $brcount, %source_map);
 327
 328if (defined($ENV{'KBUILD_VERBOSE'})) {
 329        $verbose = "$ENV{'KBUILD_VERBOSE'}";
 330}
 331
 332if (defined($ENV{'KDOC_WERROR'})) {
 333        $Werror = "$ENV{'KDOC_WERROR'}";
 334}
 335
 336if (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.
 350my $section_counter = 0;
 351
 352my $lineprefix="";
 353
 354# Parser states
 355use 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};
 365my $state;
 366my $in_doc_sect;
 367my $leading_space;
 368
 369# Inline documentation state
 370use 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};
 379my $inline_doc_state;
 380
 381#declaration types: can be
 382# 'function', 'struct', 'union', 'enum', 'typedef'
 383my $decl_type;
 384
 385# Name of the kernel-doc identifier for non-DOC markups
 386my $identifier;
 387
 388my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
 389my $doc_end = '\*/';
 390my $doc_com = '\s*\*\s*';
 391my $doc_com_body = '\s*\* ?';
 392my $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#
 400my $doc_sect = $doc_com .
 401    '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
 402my $doc_content = $doc_com_body . '(.*)';
 403my $doc_block = $doc_com . 'DOC:\s*(.*)?';
 404my $doc_inline_start = '^\s*/\*\*\s*$';
 405my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
 406my $doc_inline_end = '^\s*\*/\s*$';
 407my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
 408my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
 409my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
 410my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
 411
 412my %parameterdescs;
 413my %parameterdesc_start_lines;
 414my @parameterlist;
 415my %sections;
 416my @sectionlist;
 417my %section_start_lines;
 418my $sectcheck;
 419my $struct_actual;
 420
 421my $contents = "";
 422my $new_start_line = 0;
 423
 424# the canonical section names. see also $doc_sect above.
 425my $section_default = "Description";    # default section
 426my $section_intro = "Introduction";
 427my $section = $section_default;
 428my $section_context = "Context";
 429my $section_return = "Return";
 430
 431my $undescribed = "-- undescribed --";
 432
 433reset_state();
 434
 435while ($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.
 505sub findprog($)
 506{
 507        foreach(split(/:/, $ENV{PATH})) {
 508                return "$_/$_[0]" if(-x "$_/$_[0]");
 509        }
 510}
 511
 512sub 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
 549sub 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#
 559sub 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#
 568sub 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#
 605sub 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
 639sub 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
 675sub 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
 726sub 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
 767sub 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
 802sub 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
 817sub 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#
 839sub 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#
 859sub 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#
 870my $sphinx_literal = '^[^.].*::$';
 871my $sphinx_cblock = '^\.\.\ +code-block::';
 872
 873sub 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
 927sub 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
1026sub 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
1042sub 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
1076sub 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
1097sub 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
1147sub output_function_none(%) {
1148}
1149
1150sub output_enum_none(%) {
1151}
1152
1153sub output_typedef_none(%) {
1154}
1155
1156sub output_struct_none(%) {
1157}
1158
1159sub 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
1166sub 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.
1188sub 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.
1198sub dump_declaration($$) {
1199    no strict 'refs';
1200    my ($prototype, $file) = @_;
1201    my $func = "dump_" . $decl_type;
1202    &$func(@_);
1203}
1204
1205sub dump_union($$) {
1206    dump_struct(@_);
1207}
1208
1209sub 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
1249        my $args = qr{([^,)]+)};
1250        # replace DECLARE_BITMAP
1251        $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
1252        $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1253        # replace DECLARE_HASHTABLE
1254        $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1255        # replace DECLARE_KFIFO
1256        $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
1257        # replace DECLARE_KFIFO_PTR
1258        $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
1259        my $declaration = $members;
1260
1261        # Split nested struct/union elements as newer ones
1262        while ($members =~ m/$struct_members/) {
1263                my $newmember;
1264                my $maintype = $1;
1265                my $ids = $4;
1266                my $content = $3;
1267                foreach my $id(split /,/, $ids) {
1268                        $newmember .= "$maintype $id; ";
1269
1270                        $id =~ s/[:\[].*//;
1271                        $id =~ s/^\s*\**(\S+)\s*/$1/;
1272                        foreach my $arg (split /;/, $content) {
1273                                next if ($arg =~ m/^\s*$/);
1274                                if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1275                                        # pointer-to-function
1276                                        my $type = $1;
1277                                        my $name = $2;
1278                                        my $extra = $3;
1279                                        next if (!$name);
1280                                        if ($id =~ m/^\s*$/) {
1281                                                # anonymous struct/union
1282                                                $newmember .= "$type$name$extra; ";
1283                                        } else {
1284                                                $newmember .= "$type$id.$name$extra; ";
1285                                        }
1286                                } else {
1287                                        my $type;
1288                                        my $names;
1289                                        $arg =~ s/^\s+//;
1290                                        $arg =~ s/\s+$//;
1291                                        # Handle bitmaps
1292                                        $arg =~ s/:\s*\d+\s*//g;
1293                                        # Handle arrays
1294                                        $arg =~ s/\[.*\]//g;
1295                                        # The type may have multiple words,
1296                                        # and multiple IDs can be defined, like:
1297                                        #       const struct foo, *bar, foobar
1298                                        # So, we remove spaces when parsing the
1299                                        # names, in order to match just names
1300                                        # and commas for the names
1301                                        $arg =~ s/\s*,\s*/,/g;
1302                                        if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1303                                                $type = $1;
1304                                                $names = $2;
1305                                        } else {
1306                                                $newmember .= "$arg; ";
1307                                                next;
1308                                        }
1309                                        foreach my $name (split /,/, $names) {
1310                                                $name =~ s/^\s*\**(\S+)\s*/$1/;
1311                                                next if (($name =~ m/^\s*$/));
1312                                                if ($id =~ m/^\s*$/) {
1313                                                        # anonymous struct/union
1314                                                        $newmember .= "$type $name; ";
1315                                                } else {
1316                                                        $newmember .= "$type $id.$name; ";
1317                                                }
1318                                        }
1319                                }
1320                        }
1321                }
1322                $members =~ s/$struct_members/$newmember/;
1323        }
1324
1325        # Ignore other nested elements, like enums
1326        $members =~ s/(\{[^\{\}]*\})//g;
1327
1328        create_parameterlist($members, ';', $file, $declaration_name);
1329        check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1330
1331        # Adjust declaration for better display
1332        $declaration =~ s/([\{;])/$1\n/g;
1333        $declaration =~ s/\}\s+;/};/g;
1334        # Better handle inlined enums
1335        do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
1336
1337        my @def_args = split /\n/, $declaration;
1338        my $level = 1;
1339        $declaration = "";
1340        foreach my $clause (@def_args) {
1341                $clause =~ s/^\s+//;
1342                $clause =~ s/\s+$//;
1343                $clause =~ s/\s+/ /;
1344                next if (!$clause);
1345                $level-- if ($clause =~ m/(\})/ && $level > 1);
1346                if (!($clause =~ m/^\s*#/)) {
1347                        $declaration .= "\t" x $level;
1348                }
1349                $declaration .= "\t" . $clause . "\n";
1350                $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
1351        }
1352        output_declaration($declaration_name,
1353                           'struct',
1354                           {'struct' => $declaration_name,
1355                            'module' => $modulename,
1356                            'definition' => $declaration,
1357                            'parameterlist' => \@parameterlist,
1358                            'parameterdescs' => \%parameterdescs,
1359                            'parametertypes' => \%parametertypes,
1360                            'sectionlist' => \@sectionlist,
1361                            'sections' => \%sections,
1362                            'purpose' => $declaration_purpose,
1363                            'type' => $decl_type
1364                           });
1365    }
1366    else {
1367        print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
1368        ++$errors;
1369    }
1370}
1371
1372
1373sub show_warnings($$) {
1374        my $functype = shift;
1375        my $name = shift;
1376
1377        return 0 if (defined($nosymbol_table{$name}));
1378
1379        return 1 if ($output_selection == OUTPUT_ALL);
1380
1381        if ($output_selection == OUTPUT_EXPORTED) {
1382                if (defined($function_table{$name})) {
1383                        return 1;
1384                } else {
1385                        return 0;
1386                }
1387        }
1388        if ($output_selection == OUTPUT_INTERNAL) {
1389                if (!($functype eq "function" && defined($function_table{$name}))) {
1390                        return 1;
1391                } else {
1392                        return 0;
1393                }
1394        }
1395        if ($output_selection == OUTPUT_INCLUDE) {
1396                if (defined($function_table{$name})) {
1397                        return 1;
1398                } else {
1399                        return 0;
1400                }
1401        }
1402        die("Please add the new output type at show_warnings()");
1403}
1404
1405sub dump_enum($$) {
1406    my $x = shift;
1407    my $file = shift;
1408    my $members;
1409
1410
1411    $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1412    # strip #define macros inside enums
1413    $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
1414
1415    if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1416        $declaration_name = $2;
1417        $members = $1;
1418    } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
1419        $declaration_name = $1;
1420        $members = $2;
1421    }
1422
1423    if ($members) {
1424        if ($identifier ne $declaration_name) {
1425            if ($identifier eq "") {
1426                print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n";
1427            } else {
1428                print STDERR "${file}:$.: warning: expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n";
1429            }
1430            return;
1431        }
1432        $declaration_name = "(anonymous)" if ($declaration_name eq "");
1433
1434        my %_members;
1435
1436        $members =~ s/\s+$//;
1437
1438        foreach my $arg (split ',', $members) {
1439            $arg =~ s/^\s*(\w+).*/$1/;
1440            push @parameterlist, $arg;
1441            if (!$parameterdescs{$arg}) {
1442                $parameterdescs{$arg} = $undescribed;
1443                if (show_warnings("enum", $declaration_name)) {
1444                        print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1445                }
1446            }
1447            $_members{$arg} = 1;
1448        }
1449
1450        while (my ($k, $v) = each %parameterdescs) {
1451            if (!exists($_members{$k})) {
1452                if (show_warnings("enum", $declaration_name)) {
1453                     print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1454                }
1455            }
1456        }
1457
1458        output_declaration($declaration_name,
1459                           'enum',
1460                           {'enum' => $declaration_name,
1461                            'module' => $modulename,
1462                            'parameterlist' => \@parameterlist,
1463                            'parameterdescs' => \%parameterdescs,
1464                            'sectionlist' => \@sectionlist,
1465                            'sections' => \%sections,
1466                            'purpose' => $declaration_purpose
1467                           });
1468    } else {
1469        print STDERR "${file}:$.: error: Cannot parse enum!\n";
1470        ++$errors;
1471    }
1472}
1473
1474my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1475my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1476my $typedef_args = qr { \s*\((.*)\); }x;
1477
1478my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1479my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1480
1481sub dump_typedef($$) {
1482    my $x = shift;
1483    my $file = shift;
1484
1485    $x =~ s@/\*.*?\*/@@gos;     # strip comments.
1486
1487    # Parse function typedef prototypes
1488    if ($x =~ $typedef1 || $x =~ $typedef2) {
1489        $return_type = $1;
1490        $declaration_name = $2;
1491        my $args = $3;
1492        $return_type =~ s/^\s+//;
1493
1494        if ($identifier ne $declaration_name) {
1495            print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n";
1496            return;
1497        }
1498
1499        create_parameterlist($args, ',', $file, $declaration_name);
1500
1501        output_declaration($declaration_name,
1502                           'function',
1503                           {'function' => $declaration_name,
1504                            'typedef' => 1,
1505                            'module' => $modulename,
1506                            'functiontype' => $return_type,
1507                            'parameterlist' => \@parameterlist,
1508                            'parameterdescs' => \%parameterdescs,
1509                            'parametertypes' => \%parametertypes,
1510                            'sectionlist' => \@sectionlist,
1511                            'sections' => \%sections,
1512                            'purpose' => $declaration_purpose
1513                           });
1514        return;
1515    }
1516
1517    while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1518        $x =~ s/\(*.\)\s*;$/;/;
1519        $x =~ s/\[*.\]\s*;$/;/;
1520    }
1521
1522    if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1523        $declaration_name = $1;
1524
1525        if ($identifier ne $declaration_name) {
1526            print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n";
1527            return;
1528        }
1529
1530        output_declaration($declaration_name,
1531                           'typedef',
1532                           {'typedef' => $declaration_name,
1533                            'module' => $modulename,
1534                            'sectionlist' => \@sectionlist,
1535                            'sections' => \%sections,
1536                            'purpose' => $declaration_purpose
1537                           });
1538    }
1539    else {
1540        print STDERR "${file}:$.: error: Cannot parse typedef!\n";
1541        ++$errors;
1542    }
1543}
1544
1545sub save_struct_actual($) {
1546    my $actual = shift;
1547
1548    # strip all spaces from the actual param so that it looks like one string item
1549    $actual =~ s/\s*//g;
1550    $struct_actual = $struct_actual . $actual . " ";
1551}
1552
1553sub create_parameterlist($$$$) {
1554    my $args = shift;
1555    my $splitter = shift;
1556    my $file = shift;
1557    my $declaration_name = shift;
1558    my $type;
1559    my $param;
1560
1561    # temporarily replace commas inside function pointer definition
1562    my $arg_expr = qr{\([^\),]+};
1563    while ($args =~ /$arg_expr,/) {
1564        $args =~ s/($arg_expr),/$1#/g;
1565    }
1566
1567    foreach my $arg (split($splitter, $args)) {
1568        # strip comments
1569        $arg =~ s/\/\*.*\*\///;
1570        # strip leading/trailing spaces
1571        $arg =~ s/^\s*//;
1572        $arg =~ s/\s*$//;
1573        $arg =~ s/\s+/ /;
1574
1575        if ($arg =~ /^#/) {
1576            # Treat preprocessor directive as a typeless variable just to fill
1577            # corresponding data structures "correctly". Catch it later in
1578            # output_* subs.
1579            push_parameter($arg, "", "", $file);
1580        } elsif ($arg =~ m/\(.+\)\s*\(/) {
1581            # pointer-to-function
1582            $arg =~ tr/#/,/;
1583            $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
1584            $param = $1;
1585            $type = $arg;
1586            $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1587            save_struct_actual($param);
1588            push_parameter($param, $type, $arg, $file, $declaration_name);
1589        } elsif ($arg) {
1590            $arg =~ s/\s*:\s*/:/g;
1591            $arg =~ s/\s*\[/\[/g;
1592
1593            my @args = split('\s*,\s*', $arg);
1594            if ($args[0] =~ m/\*/) {
1595                $args[0] =~ s/(\*+)\s*/ $1/;
1596            }
1597
1598            my @first_arg;
1599            if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1600                    shift @args;
1601                    push(@first_arg, split('\s+', $1));
1602                    push(@first_arg, $2);
1603            } else {
1604                    @first_arg = split('\s+', shift @args);
1605            }
1606
1607            unshift(@args, pop @first_arg);
1608            $type = join " ", @first_arg;
1609
1610            foreach $param (@args) {
1611                if ($param =~ m/^(\*+)\s*(.*)/) {
1612                    save_struct_actual($2);
1613
1614                    push_parameter($2, "$type $1", $arg, $file, $declaration_name);
1615                }
1616                elsif ($param =~ m/(.*?):(\d+)/) {
1617                    if ($type ne "") { # skip unnamed bit-fields
1618                        save_struct_actual($1);
1619                        push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
1620                    }
1621                }
1622                else {
1623                    save_struct_actual($param);
1624                    push_parameter($param, $type, $arg, $file, $declaration_name);
1625                }
1626            }
1627        }
1628    }
1629}
1630
1631sub push_parameter($$$$$) {
1632        my $param = shift;
1633        my $type = shift;
1634        my $org_arg = shift;
1635        my $file = shift;
1636        my $declaration_name = shift;
1637
1638        if (($anon_struct_union == 1) && ($type eq "") &&
1639            ($param eq "}")) {
1640                return;         # ignore the ending }; from anon. struct/union
1641        }
1642
1643        $anon_struct_union = 0;
1644        $param =~ s/[\[\)].*//;
1645
1646        if ($type eq "" && $param =~ /\.\.\.$/)
1647        {
1648            if (!$param =~ /\w\.\.\.$/) {
1649              # handles unnamed variable parameters
1650              $param = "...";
1651            }
1652            elsif ($param =~ /\w\.\.\.$/) {
1653              # for named variable parameters of the form `x...`, remove the dots
1654              $param =~ s/\.\.\.$//;
1655            }
1656            if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1657                $parameterdescs{$param} = "variable arguments";
1658            }
1659        }
1660        elsif ($type eq "" && ($param eq "" or $param eq "void"))
1661        {
1662            $param="void";
1663            $parameterdescs{void} = "no arguments";
1664        }
1665        elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1666        # handle unnamed (anonymous) union or struct:
1667        {
1668                $type = $param;
1669                $param = "{unnamed_" . $param . "}";
1670                $parameterdescs{$param} = "anonymous\n";
1671                $anon_struct_union = 1;
1672        }
1673
1674        # warn if parameter has no description
1675        # (but ignore ones starting with # as these are not parameters
1676        # but inline preprocessor statements);
1677        # Note: It will also ignore void params and unnamed structs/unions
1678        if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1679                $parameterdescs{$param} = $undescribed;
1680
1681                if (show_warnings($type, $declaration_name) && $param !~ /\./) {
1682                        print STDERR
1683                              "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1684                        ++$warnings;
1685                }
1686        }
1687
1688        # strip spaces from $param so that it is one continuous string
1689        # on @parameterlist;
1690        # this fixes a problem where check_sections() cannot find
1691        # a parameter like "addr[6 + 2]" because it actually appears
1692        # as "addr[6", "+", "2]" on the parameter list;
1693        # but it's better to maintain the param string unchanged for output,
1694        # so just weaken the string compare in check_sections() to ignore
1695        # "[blah" in a parameter string;
1696        ###$param =~ s/\s*//g;
1697        push @parameterlist, $param;
1698        $org_arg =~ s/\s\s+/ /g;
1699        $parametertypes{$param} = $org_arg;
1700}
1701
1702sub check_sections($$$$$) {
1703        my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
1704        my @sects = split ' ', $sectcheck;
1705        my @prms = split ' ', $prmscheck;
1706        my $err;
1707        my ($px, $sx);
1708        my $prm_clean;          # strip trailing "[array size]" and/or beginning "*"
1709
1710        foreach $sx (0 .. $#sects) {
1711                $err = 1;
1712                foreach $px (0 .. $#prms) {
1713                        $prm_clean = $prms[$px];
1714                        $prm_clean =~ s/\[.*\]//;
1715                        $prm_clean =~ s/$attribute//i;
1716                        # ignore array size in a parameter string;
1717                        # however, the original param string may contain
1718                        # spaces, e.g.:  addr[6 + 2]
1719                        # and this appears in @prms as "addr[6" since the
1720                        # parameter list is split at spaces;
1721                        # hence just ignore "[..." for the sections check;
1722                        $prm_clean =~ s/\[.*//;
1723
1724                        ##$prm_clean =~ s/^\**//;
1725                        if ($prm_clean eq $sects[$sx]) {
1726                                $err = 0;
1727                                last;
1728                        }
1729                }
1730                if ($err) {
1731                        if ($decl_type eq "function") {
1732                                print STDERR "${file}:$.: warning: " .
1733                                        "Excess function parameter " .
1734                                        "'$sects[$sx]' " .
1735                                        "description in '$decl_name'\n";
1736                                ++$warnings;
1737                        }
1738                }
1739        }
1740}
1741
1742##
1743# Checks the section describing the return value of a function.
1744sub check_return_section {
1745        my $file = shift;
1746        my $declaration_name = shift;
1747        my $return_type = shift;
1748
1749        # Ignore an empty return type (It's a macro)
1750        # Ignore functions with a "void" return type. (But don't ignore "void *")
1751        if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1752                return;
1753        }
1754
1755        if (!defined($sections{$section_return}) ||
1756            $sections{$section_return} eq "") {
1757                print STDERR "${file}:$.: warning: " .
1758                        "No description found for return value of " .
1759                        "'$declaration_name'\n";
1760                ++$warnings;
1761        }
1762}
1763
1764##
1765# takes a function prototype and the name of the current file being
1766# processed and spits out all the details stored in the global
1767# arrays/hashes.
1768sub dump_function($$) {
1769    my $prototype = shift;
1770    my $file = shift;
1771    my $noret = 0;
1772
1773    print_lineno($new_start_line);
1774
1775    $prototype =~ s/^static +//;
1776    $prototype =~ s/^extern +//;
1777    $prototype =~ s/^asmlinkage +//;
1778    $prototype =~ s/^inline +//;
1779    $prototype =~ s/^__inline__ +//;
1780    $prototype =~ s/^__inline +//;
1781    $prototype =~ s/^__always_inline +//;
1782    $prototype =~ s/^noinline +//;
1783    $prototype =~ s/__init +//;
1784    $prototype =~ s/__init_or_module +//;
1785    $prototype =~ s/__deprecated +//;
1786    $prototype =~ s/__flatten +//;
1787    $prototype =~ s/__meminit +//;
1788    $prototype =~ s/__must_check +//;
1789    $prototype =~ s/__weak +//;
1790    $prototype =~ s/__sched +//;
1791    $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
1792    my $define = $prototype =~ s/^#\s*define\s+//; #ak added
1793    $prototype =~ s/__attribute_const__ +//;
1794    $prototype =~ s/__attribute__\s*\(\(
1795            (?:
1796                 [\w\s]++          # attribute name
1797                 (?:\([^)]*+\))?   # attribute arguments
1798                 \s*+,?            # optional comma at the end
1799            )+
1800          \)\)\s+//x;
1801
1802    # Yes, this truly is vile.  We are looking for:
1803    # 1. Return type (may be nothing if we're looking at a macro)
1804    # 2. Function name
1805    # 3. Function parameters.
1806    #
1807    # All the while we have to watch out for function pointer parameters
1808    # (which IIRC is what the two sections are for), C types (these
1809    # regexps don't even start to express all the possibilities), and
1810    # so on.
1811    #
1812    # If you mess with these regexps, it's a good idea to check that
1813    # the following functions' documentation still comes out right:
1814    # - parport_register_device (function pointer parameters)
1815    # - atomic_set (macro)
1816    # - pci_match_device, __copy_to_user (long return type)
1817    my $name = qr{[a-zA-Z0-9_~:]+};
1818    my $prototype_end1 = qr{[^\(]*};
1819    my $prototype_end2 = qr{[^\{]*};
1820    my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1821    my $type1 = qr{[\w\s]+};
1822    my $type2 = qr{$type1\*+};
1823
1824    if ($define && $prototype =~ m/^()($name)\s+/) {
1825        # This is an object-like macro, it has no return type and no parameter
1826        # list.
1827        # Function-like macros are not allowed to have spaces between
1828        # declaration_name and opening parenthesis (notice the \s+).
1829        $return_type = $1;
1830        $declaration_name = $2;
1831        $noret = 1;
1832    } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1833        $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1834        $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/)  {
1835        $return_type = $1;
1836        $declaration_name = $2;
1837        my $args = $3;
1838
1839        create_parameterlist($args, ',', $file, $declaration_name);
1840    } else {
1841        print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
1842        return;
1843    }
1844
1845    if ($identifier ne $declaration_name) {
1846        print STDERR "${file}:$.: warning: expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n";
1847        return;
1848    }
1849
1850    my $prms = join " ", @parameterlist;
1851    check_sections($file, $declaration_name, "function", $sectcheck, $prms);
1852
1853    # This check emits a lot of warnings at the moment, because many
1854    # functions don't have a 'Return' doc section. So until the number
1855    # of warnings goes sufficiently down, the check is only performed in
1856    # verbose mode.
1857    # TODO: always perform the check.
1858    if ($verbose && !$noret) {
1859            check_return_section($file, $declaration_name, $return_type);
1860    }
1861
1862    # The function parser can be called with a typedef parameter.
1863    # Handle it.
1864    if ($return_type =~ /typedef/) {
1865        output_declaration($declaration_name,
1866                           'function',
1867                           {'function' => $declaration_name,
1868                            'typedef' => 1,
1869                            'module' => $modulename,
1870                            'functiontype' => $return_type,
1871                            'parameterlist' => \@parameterlist,
1872                            'parameterdescs' => \%parameterdescs,
1873                            'parametertypes' => \%parametertypes,
1874                            'sectionlist' => \@sectionlist,
1875                            'sections' => \%sections,
1876                            'purpose' => $declaration_purpose
1877                           });
1878    } else {
1879        output_declaration($declaration_name,
1880                           'function',
1881                           {'function' => $declaration_name,
1882                            'module' => $modulename,
1883                            'functiontype' => $return_type,
1884                            'parameterlist' => \@parameterlist,
1885                            'parameterdescs' => \%parameterdescs,
1886                            'parametertypes' => \%parametertypes,
1887                            'sectionlist' => \@sectionlist,
1888                            'sections' => \%sections,
1889                            'purpose' => $declaration_purpose
1890                           });
1891    }
1892}
1893
1894sub reset_state {
1895    $function = "";
1896    %parameterdescs = ();
1897    %parametertypes = ();
1898    @parameterlist = ();
1899    %sections = ();
1900    @sectionlist = ();
1901    $sectcheck = "";
1902    $struct_actual = "";
1903    $prototype = "";
1904
1905    $state = STATE_NORMAL;
1906    $inline_doc_state = STATE_INLINE_NA;
1907}
1908
1909sub tracepoint_munge($) {
1910        my $file = shift;
1911        my $tracepointname = 0;
1912        my $tracepointargs = 0;
1913
1914        if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1915                $tracepointname = $1;
1916        }
1917        if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1918                $tracepointname = $1;
1919        }
1920        if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1921                $tracepointname = $2;
1922        }
1923        $tracepointname =~ s/^\s+//; #strip leading whitespace
1924        if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1925                $tracepointargs = $1;
1926        }
1927        if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
1928                print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
1929                             "$prototype\n";
1930        } else {
1931                $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1932                $identifier = "trace_$identifier";
1933        }
1934}
1935
1936sub syscall_munge() {
1937        my $void = 0;
1938
1939        $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
1940##      if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1941        if ($prototype =~ m/SYSCALL_DEFINE0/) {
1942                $void = 1;
1943##              $prototype = "long sys_$1(void)";
1944        }
1945
1946        $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1947        if ($prototype =~ m/long (sys_.*?),/) {
1948                $prototype =~ s/,/\(/;
1949        } elsif ($void) {
1950                $prototype =~ s/\)/\(void\)/;
1951        }
1952
1953        # now delete all of the odd-number commas in $prototype
1954        # so that arg types & arg names don't have a comma between them
1955        my $count = 0;
1956        my $len = length($prototype);
1957        if ($void) {
1958                $len = 0;       # skip the for-loop
1959        }
1960        for (my $ix = 0; $ix < $len; $ix++) {
1961                if (substr($prototype, $ix, 1) eq ',') {
1962                        $count++;
1963                        if ($count % 2 == 1) {
1964                                substr($prototype, $ix, 1) = ' ';
1965                        }
1966                }
1967        }
1968}
1969
1970sub process_proto_function($$) {
1971    my $x = shift;
1972    my $file = shift;
1973
1974    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1975
1976    if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1977        # do nothing
1978    }
1979    elsif ($x =~ /([^\{]*)/) {
1980        $prototype .= $1;
1981    }
1982
1983    if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1984        $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1985        $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1986        $prototype =~ s@^\s+@@gos; # strip leading spaces
1987
1988         # Handle prototypes for function pointers like:
1989         # int (*pcs_config)(struct foo)
1990        $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1991
1992        if ($prototype =~ /SYSCALL_DEFINE/) {
1993                syscall_munge();
1994        }
1995        if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1996            $prototype =~ /DEFINE_SINGLE_EVENT/)
1997        {
1998                tracepoint_munge($file);
1999        }
2000        dump_function($prototype, $file);

2001        reset_state();
2002    }
2003}
2004
2005sub process_proto_type($$) {
2006    my $x = shift;
2007    my $file = shift;
2008
2009    $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
2010    $x =~ s@^\s+@@gos; # strip leading spaces
2011    $x =~ s@\s+$@@gos; # strip trailing spaces
2012    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
2013
2014    if ($x =~ /^#/) {
2015        # To distinguish preprocessor directive from regular declaration later.
2016        $x .= ";";
2017    }
2018
2019    while (1) {
2020        if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
2021            if( length $prototype ) {
2022                $prototype .= " "
2023            }
2024            $prototype .= $1 . $2;
2025            ($2 eq '{') && $brcount++;
2026            ($2 eq '}') && $brcount--;
2027            if (($2 eq ';') && ($brcount == 0)) {
2028                dump_declaration($prototype, $file);
2029                reset_state();
2030                last;
2031            }
2032            $x = $3;
2033        } else {
2034            $prototype .= $x;
2035            last;
2036        }
2037    }
2038}
2039
2040
2041sub map_filename($) {
2042    my $file;
2043    my ($orig_file) = @_;
2044
2045    if (defined($ENV{'SRCTREE'})) {
2046        $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
2047    } else {
2048        $file = $orig_file;
2049    }
2050
2051    if (defined($source_map{$file})) {
2052        $file = $source_map{$file};
2053    }
2054
2055    return $file;
2056}
2057
2058sub process_export_file($) {
2059    my ($orig_file) = @_;
2060    my $file = map_filename($orig_file);
2061
2062    if (!open(IN,"<$file")) {
2063        print STDERR "Error: Cannot open file $file\n";
2064        ++$errors;
2065        return;
2066    }
2067
2068    while (<IN>) {
2069        if (/$export_symbol/) {
2070            next if (defined($nosymbol_table{$2}));
2071            $function_table{$2} = 1;
2072        }
2073    }
2074
2075    close(IN);
2076}
2077
2078#
2079# Parsers for the various processing states.
2080#
2081# STATE_NORMAL: looking for the /** to begin everything.
2082#
2083sub process_normal() {
2084    if (/$doc_start/o) {
2085        $state = STATE_NAME;    # next line is always the function name
2086        $in_doc_sect = 0;
2087        $declaration_start_line = $. + 1;
2088    }
2089}
2090
2091#
2092# STATE_NAME: Looking for the "name - description" line
2093#
2094sub process_name($$) {
2095    my $file = shift;
2096    my $descr;
2097
2098    if (/$doc_block/o) {
2099        $state = STATE_DOCBLOCK;
2100        $contents = "";
2101        $new_start_line = $.;
2102
2103        if ( $1 eq "" ) {
2104            $section = $section_intro;
2105        } else {
2106            $section = $1;
2107        }
2108    } elsif (/$doc_decl/o) {
2109        $identifier = $1;
2110        my $is_kernel_comment = 0;
2111        my $decl_start = qr{$doc_com};
2112        # test for pointer declaration type, foo * bar() - desc
2113        my $fn_type = qr{\w+\s*\*\s*}; 
2114        my $parenthesis = qr{\(\w*\)};
2115        my $decl_end = qr{[-:].*};
2116        if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
2117            $identifier = $1;
2118        }
2119        if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
2120            $decl_type = $1;
2121            $identifier = $2;
2122            $is_kernel_comment = 1;
2123        }
2124        # Look for foo() or static void foo() - description; or misspelt
2125        # identifier
2126        elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2127            /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
2128            $identifier = $1;
2129            $decl_type = 'function';
2130            $identifier =~ s/^define\s+//;
2131            $is_kernel_comment = 1;
2132        }
2133        $identifier =~ s/\s+$//;
2134
2135        $state = STATE_BODY;
2136        # if there's no @param blocks need to set up default section
2137        # here
2138        $contents = "";
2139        $section = $section_default;
2140        $new_start_line = $. + 1;
2141        if (/[-:](.*)/) {
2142            # strip leading/trailing/multiple spaces
2143            $descr= $1;
2144            $descr =~ s/^\s*//;
2145            $descr =~ s/\s*$//;
2146            $descr =~ s/\s+/ /g;
2147            $declaration_purpose = $descr;
2148            $state = STATE_BODY_MAYBE;
2149        } else {
2150            $declaration_purpose = "";
2151        }
2152
2153        if (!$is_kernel_comment) {
2154            print STDERR "${file}:$.: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n";
2155            print STDERR $_;
2156            ++$warnings;
2157            $state = STATE_NORMAL;
2158        }
2159
2160        if (($declaration_purpose eq "") && $verbose) {
2161            print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2162            print STDERR $_;
2163            ++$warnings;
2164        }
2165
2166        if ($identifier eq "" && $decl_type ne "enum") {
2167            print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n";
2168            print STDERR $_;
2169            ++$warnings;
2170            $state = STATE_NORMAL;
2171        }
2172
2173        if ($verbose) {
2174            print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
2175        }
2176    } else {
2177        print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2178            " - I thought it was a doc line\n";
2179        ++$warnings;
2180        $state = STATE_NORMAL;
2181    }
2182}
2183
2184
2185#
2186# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2187#
2188sub process_body($$) {
2189    my $file = shift;
2190
2191    # Until all named variable macro parameters are
2192    # documented using the bare name (`x`) rather than with
2193    # dots (`x...`), strip the dots:
2194    if ($section =~ /\w\.\.\.$/) {
2195        $section =~ s/\.\.\.$//;
2196
2197        if ($verbose) {
2198            print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
2199            ++$warnings;
2200        }
2201    }
2202
2203    if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2204        dump_section($file, $section, $contents);
2205        $section = $section_default;
2206        $new_start_line = $.;
2207        $contents = "";
2208    }
2209
2210    if (/$doc_sect/i) { # case insensitive for supported section names
2211        $newsection = $1;
2212        $newcontents = $2;
2213
2214        # map the supported section names to the canonical names
2215        if ($newsection =~ m/^description$/i) {
2216            $newsection = $section_default;
2217        } elsif ($newsection =~ m/^context$/i) {
2218            $newsection = $section_context;
2219        } elsif ($newsection =~ m/^returns?$/i) {
2220            $newsection = $section_return;
2221        } elsif ($newsection =~ m/^\@return$/) {
2222            # special: @return is a section, not a param description
2223            $newsection = $section_return;
2224        }
2225
2226        if (($contents ne "") && ($contents ne "\n")) {
2227            if (!$in_doc_sect && $verbose) {
2228                print STDERR "${file}:$.: warning: contents before sections\n";
2229                ++$warnings;
2230            }
2231            dump_section($file, $section, $contents);
2232            $section = $section_default;
2233        }
2234
2235        $in_doc_sect = 1;
2236        $state = STATE_BODY;
2237        $contents = $newcontents;
2238        $new_start_line = $.;
2239        while (substr($contents, 0, 1) eq " ") {
2240            $contents = substr($contents, 1);
2241        }
2242        if ($contents ne "") {
2243            $contents .= "\n";
2244        }
2245        $section = $newsection;
2246        $leading_space = undef;
2247    } elsif (/$doc_end/) {
2248        if (($contents ne "") && ($contents ne "\n")) {
2249            dump_section($file, $section, $contents);
2250            $section = $section_default;
2251            $contents = "";
2252        }
2253        # look for doc_com + <text> + doc_end:
2254        if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2255            print STDERR "${file}:$.: warning: suspicious ending line: $_";
2256            ++$warnings;
2257        }
2258
2259        $prototype = "";
2260        $state = STATE_PROTO;
2261        $brcount = 0;
2262        $new_start_line = $. + 1;
2263    } elsif (/$doc_content/) {
2264        if ($1 eq "") {
2265            if ($section eq $section_context) {
2266                dump_section($file, $section, $contents);
2267                $section = $section_default;
2268                $contents = "";
2269                $new_start_line = $.;
2270                $state = STATE_BODY;
2271            } else {
2272                if ($section ne $section_default) {
2273                    $state = STATE_BODY_WITH_BLANK_LINE;
2274                } else {
2275                    $state = STATE_BODY;
2276                }
2277                $contents .= "\n";
2278            }
2279        } elsif ($state == STATE_BODY_MAYBE) {
2280            # Continued declaration purpose
2281            chomp($declaration_purpose);
2282            $declaration_purpose .= " " . $1;
2283            $declaration_purpose =~ s/\s+/ /g;
2284        } else {
2285            my $cont = $1;
2286            if ($section =~ m/^@/ || $section eq $section_context) {
2287                if (!defined $leading_space) {
2288                    if ($cont =~ m/^(\s+)/) {
2289                        $leading_space = $1;
2290                    } else {
2291                        $leading_space = "";
2292                    }
2293                }
2294                $cont =~ s/^$leading_space//;
2295            }
2296            $contents .= $cont . "\n";
2297        }
2298    } else {
2299        # i dont know - bad line?  ignore.
2300        print STDERR "${file}:$.: warning: bad line: $_";
2301        ++$warnings;
2302    }
2303}
2304
2305
2306#
2307# STATE_PROTO: reading a function/whatever prototype.
2308#
2309sub process_proto($$) {
2310    my $file = shift;
2311
2312    if (/$doc_inline_oneline/) {
2313        $section = $1;
2314        $contents = $2;
2315        if ($contents ne "") {
2316            $contents .= "\n";
2317            dump_section($file, $section, $contents);
2318            $section = $section_default;
2319            $contents = "";
2320        }
2321    } elsif (/$doc_inline_start/) {
2322        $state = STATE_INLINE;
2323        $inline_doc_state = STATE_INLINE_NAME;
2324    } elsif ($decl_type eq 'function') {
2325        process_proto_function($_, $file);
2326    } else {
2327        process_proto_type($_, $file);
2328    }
2329}
2330
2331#
2332# STATE_DOCBLOCK: within a DOC: block.
2333#
2334sub process_docblock($$) {
2335    my $file = shift;
2336
2337    if (/$doc_end/) {
2338        dump_doc_section($file, $section, $contents);
2339        $section = $section_default;
2340        $contents = "";
2341        $function = "";
2342        %parameterdescs = ();
2343        %parametertypes = ();
2344        @parameterlist = ();
2345        %sections = ();
2346        @sectionlist = ();
2347        $prototype = "";
2348        $state = STATE_NORMAL;
2349    } elsif (/$doc_content/) {
2350        if ( $1 eq "" ) {
2351            $contents .= $blankline;
2352        } else {
2353            $contents .= $1 . "\n";
2354        }
2355    }
2356}
2357
2358#
2359# STATE_INLINE: docbook comments within a prototype.
2360#
2361sub process_inline($$) {
2362    my $file = shift;
2363
2364    # First line (state 1) needs to be a @parameter
2365    if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2366        $section = $1;
2367        $contents = $2;
2368        $new_start_line = $.;
2369        if ($contents ne "") {
2370            while (substr($contents, 0, 1) eq " ") {
2371                $contents = substr($contents, 1);
2372            }
2373            $contents .= "\n";
2374        }
2375        $inline_doc_state = STATE_INLINE_TEXT;
2376        # Documentation block end */
2377    } elsif (/$doc_inline_end/) {
2378        if (($contents ne "") && ($contents ne "\n")) {
2379            dump_section($file, $section, $contents);
2380            $section = $section_default;
2381            $contents = "";
2382        }
2383        $state = STATE_PROTO;
2384        $inline_doc_state = STATE_INLINE_NA;
2385        # Regular text
2386    } elsif (/$doc_content/) {
2387        if ($inline_doc_state == STATE_INLINE_TEXT) {
2388            $contents .= $1 . "\n";
2389            # nuke leading blank lines
2390            if ($contents =~ /^\s*$/) {
2391                $contents = "";
2392            }
2393        } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2394            $inline_doc_state = STATE_INLINE_ERROR;
2395            print STDERR "${file}:$.: warning: ";
2396            print STDERR "Incorrect use of kernel-doc format: $_";
2397            ++$warnings;
2398        }
2399    }
2400}
2401
2402
2403sub process_file($) {
2404    my $file;
2405    my $initial_section_counter = $section_counter;
2406    my ($orig_file) = @_;
2407
2408    $file = map_filename($orig_file);
2409
2410    if (!open(IN_FILE,"<$file")) {
2411        print STDERR "Error: Cannot open file $file\n";
2412        ++$errors;
2413        return;
2414    }
2415
2416    $. = 1;
2417
2418    $section_counter = 0;
2419    while (<IN_FILE>) {
2420        while (s/\\\s*$//) {
2421            $_ .= <IN_FILE>;
2422        }
2423        # Replace tabs by spaces
2424        while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2425        # Hand this line to the appropriate state handler
2426        if ($state == STATE_NORMAL) {
2427            process_normal();
2428        } elsif ($state == STATE_NAME) {
2429            process_name($file, $_);
2430        } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2431                 $state == STATE_BODY_WITH_BLANK_LINE) {
2432            process_body($file, $_);
2433        } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2434            process_inline($file, $_);
2435        } elsif ($state == STATE_PROTO) {
2436            process_proto($file, $_);
2437        } elsif ($state == STATE_DOCBLOCK) {
2438            process_docblock($file, $_);
2439        }
2440    }
2441
2442    # Make sure we got something interesting.
2443    if ($initial_section_counter == $section_counter && $
2444        output_mode ne "none") {
2445        if ($output_selection == OUTPUT_INCLUDE) {
2446            print STDERR "${file}:1: warning: '$_' not found\n"
2447                for keys %function_table;
2448        }
2449        else {
2450            print STDERR "${file}:1: warning: no structured comments found\n";
2451        }
2452    }
2453    close IN_FILE;
2454}
2455
2456
2457if ($output_mode eq "rst") {
2458        get_sphinx_version() if (!$sphinx_major);
2459}
2460
2461$kernelversion = get_kernel_version();
2462
2463# generate a sequence of code that will splice in highlighting information
2464# using the s// operator.
2465for (my $k = 0; $k < @highlights; $k++) {
2466    my $pattern = $highlights[$k][0];
2467    my $result = $highlights[$k][1];
2468#   print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2469    $dohighlight .=  "\$contents =~ s:$pattern:$result:gs;\n";
2470}
2471
2472# Read the file that maps relative names to absolute names for
2473# separate source and object directories and for shadow trees.
2474if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2475        my ($relname, $absname);
2476        while(<SOURCE_MAP>) {
2477                chop();
2478                ($relname, $absname) = (split())[0..1];
2479                $relname =~ s:^/+::;
2480                $source_map{$relname} = $absname;
2481        }
2482        close(SOURCE_MAP);
2483}
2484
2485if ($output_selection == OUTPUT_EXPORTED ||
2486    $output_selection == OUTPUT_INTERNAL) {
2487
2488    push(@export_file_list, @ARGV);
2489
2490    foreach (@export_file_list) {
2491        chomp;
2492        process_export_file($_);
2493    }
2494}
2495
2496foreach (@ARGV) {
2497    chomp;
2498    process_file($_);
2499}
2500if ($verbose && $errors) {
2501  print STDERR "$errors errors\n";
2502}
2503if ($verbose && $warnings) {
2504  print STDERR "$warnings warnings\n";
2505}
2506
2507if ($Werror && $warnings) {
2508    print STDERR "$warnings warnings as Errors\n";
2509    exit($warnings);
2510} else {
2511    exit($output_mode eq "none" ? 0 : $errors)
2512}
2513