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