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