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