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