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