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