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