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