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