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