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