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