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