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] 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 print "**Parameters**\n\n"; 871 $lineprefix = " "; 872 foreach $parameter (@{$args{'parameterlist'}}) { 873 my $parameter_name = $parameter; 874 $parameter_name =~ s/\[.*//; 875 $type = $args{'parametertypes'}{$parameter}; 876 877 if ($type ne "") { 878 print "``$type``\n"; 879 } else { 880 print "``$parameter``\n"; 881 } 882 883 print_lineno($parameterdesc_start_lines{$parameter_name}); 884 885 if (defined($args{'parameterdescs'}{$parameter_name}) && 886 $args{'parameterdescs'}{$parameter_name} ne $undescribed) { 887 output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 888 } else { 889 print " *undescribed*\n"; 890 } 891 print "\n"; 892 } 893 894 $lineprefix = $oldprefix; 895 output_section_rst(@_); 896} 897 898sub output_section_rst(%) { 899 my %args = %{$_[0]}; 900 my $section; 901 my $oldprefix = $lineprefix; 902 $lineprefix = ""; 903 904 foreach $section (@{$args{'sectionlist'}}) { 905 print "**$section**\n\n"; 906 print_lineno($section_start_lines{$section}); 907 output_highlight_rst($args{'sections'}{$section}); 908 print "\n"; 909 } 910 print "\n"; 911 $lineprefix = $oldprefix; 912} 913 914sub output_enum_rst(%) { 915 my %args = %{$_[0]}; 916 my ($parameter); 917 my $oldprefix = $lineprefix; 918 my $count; 919 920 if ($sphinx_major < 3) { 921 my $name = "enum " . $args{'enum'}; 922 print "\n\n.. c:type:: " . $name . "\n\n"; 923 } else { 924 my $name = $args{'enum'}; 925 print "\n\n.. c:enum:: " . $name . "\n\n"; 926 } 927 print_lineno($declaration_start_line); 928 $lineprefix = " "; 929 output_highlight_rst($args{'purpose'}); 930 print "\n"; 931 932 print "**Constants**\n\n"; 933 $lineprefix = " "; 934 foreach $parameter (@{$args{'parameterlist'}}) { 935 print "``$parameter``\n"; 936 if ($args{'parameterdescs'}{$parameter} ne $undescribed) { 937 output_highlight_rst($args{'parameterdescs'}{$parameter}); 938 } else { 939 print " *undescribed*\n"; 940 } 941 print "\n"; 942 } 943 944 $lineprefix = $oldprefix; 945 output_section_rst(@_); 946} 947 948sub output_typedef_rst(%) { 949 my %args = %{$_[0]}; 950 my ($parameter); 951 my $oldprefix = $lineprefix; 952 my $name; 953 954 if ($sphinx_major < 3) { 955 $name = "typedef " . $args{'typedef'}; 956 } else { 957 $name = $args{'typedef'}; 958 } 959 print "\n\n.. c:type:: " . $name . "\n\n"; 960 print_lineno($declaration_start_line); 961 $lineprefix = " "; 962 output_highlight_rst($args{'purpose'}); 963 print "\n"; 964 965 $lineprefix = $oldprefix; 966 output_section_rst(@_); 967} 968 969sub output_struct_rst(%) { 970 my %args = %{$_[0]}; 971 my ($parameter); 972 my $oldprefix = $lineprefix; 973 974 if ($sphinx_major < 3) { 975 my $name = $args{'type'} . " " . $args{'struct'}; 976 print "\n\n.. c:type:: " . $name . "\n\n"; 977 } else { 978 my $name = $args{'struct'}; 979 if ($args{'type'} eq 'union') { 980 print "\n\n.. c:union:: " . $name . "\n\n"; 981 } else { 982 print "\n\n.. c:struct:: " . $name . "\n\n"; 983 } 984 } 985 print_lineno($declaration_start_line); 986 $lineprefix = " "; 987 output_highlight_rst($args{'purpose'}); 988 print "\n"; 989 990 print "**Definition**\n\n"; 991 print "::\n\n"; 992 my $declaration = $args{'definition'}; 993 $declaration =~ s/\t/ /g; 994 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n"; 995 996 print "**Members**\n\n"; 997 $lineprefix = " "; 998 foreach $parameter (@{$args{'parameterlist'}}) { 999 ($parameter =~ /^#/) && next; 1000 1001 my $parameter_name = $parameter; 1002 $parameter_name =~ s/\[.*//; 1003 1004 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; 1005 $type = $args{'parametertypes'}{$parameter}; 1006 print_lineno($parameterdesc_start_lines{$parameter_name}); 1007 print "``" . $parameter . "``\n"; 1008 output_highlight_rst($args{'parameterdescs'}{$parameter_name}); 1009 print "\n"; 1010 } 1011 print "\n"; 1012 1013 $lineprefix = $oldprefix; 1014 output_section_rst(@_); 1015} 1016 1017## none mode output functions 1018 1019sub output_function_none(%) { 1020} 1021 1022sub output_enum_none(%) { 1023} 1024 1025sub output_typedef_none(%) { 1026} 1027 1028sub output_struct_none(%) { 1029} 1030 1031sub output_blockhead_none(%) { 1032} 1033 1034## 1035# generic output function for all types (function, struct/union, typedef, enum); 1036# calls the generated, variable output_ function name based on 1037# functype and output_mode 1038sub output_declaration { 1039 no strict 'refs'; 1040 my $name = shift; 1041 my $functype = shift; 1042 my $func = "output_${functype}_$output_mode"; 1043 1044 return if (defined($nosymbol_table{$name})); 1045 1046 if (($output_selection == OUTPUT_ALL) || 1047 (($output_selection == OUTPUT_INCLUDE || 1048 $output_selection == OUTPUT_EXPORTED) && 1049 defined($function_table{$name})) || 1050 ($output_selection == OUTPUT_INTERNAL && 1051 !($functype eq "function" && defined($function_table{$name})))) 1052 { 1053 &$func(@_); 1054 $section_counter++; 1055 } 1056} 1057 1058## 1059# generic output function - calls the right one based on current output mode. 1060sub output_blockhead { 1061 no strict 'refs'; 1062 my $func = "output_blockhead_" . $output_mode; 1063 &$func(@_); 1064 $section_counter++; 1065} 1066 1067## 1068# takes a declaration (struct, union, enum, typedef) and 1069# invokes the right handler. NOT called for functions. 1070sub dump_declaration($$) { 1071 no strict 'refs'; 1072 my ($prototype, $file) = @_; 1073 my $func = "dump_" . $decl_type; 1074 &$func(@_); 1075} 1076 1077sub dump_union($$) { 1078 dump_struct(@_); 1079} 1080 1081sub dump_struct($$) { 1082 my $x = shift; 1083 my $file = shift; 1084 my $decl_type; 1085 my $members; 1086 my $type = qr{struct|union}; 1087 # For capturing struct/union definition body, i.e. "{members*}qualifiers*" 1088 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned}; 1089 my $definition_body = qr{\{(.*)\}\s*$qualifiers*}; 1090 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;}; 1091 1092 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) { 1093 $decl_type = $1; 1094 $declaration_name = $2; 1095 $members = $3; 1096 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) { 1097 $decl_type = $1; 1098 $declaration_name = $3; 1099 $members = $2; 1100 } 1101 1102 if ($members) { 1103 if ($identifier ne $declaration_name) { 1104 emit_warning("${file}:$.", "expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n"); 1105 return; 1106 } 1107 1108 # ignore members marked private: 1109 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; 1110 $members =~ s/\/\*\s*private:.*//gosi; 1111 # strip comments: 1112 $members =~ s/\/\*.*?\*\///gos; 1113 # strip attributes 1114 $members =~ s/\s*$attribute/ /gi; 1115 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos; 1116 $members =~ s/\s*__packed\s*/ /gos; 1117 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos; 1118 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos; 1119 $members =~ s/\s*____cacheline_aligned/ /gos; 1120 # unwrap struct_group(): 1121 # - first eat non-declaration parameters and rewrite for final match 1122 # - then remove macro, outer parens, and trailing semicolon 1123 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos; 1124 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos; 1125 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos; 1126 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos; 1127 1128 my $args = qr{([^,)]+)}; 1129 # replace DECLARE_BITMAP 1130 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos; 1131 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos; 1132 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos; 1133 # replace DECLARE_HASHTABLE 1134 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos; 1135 # replace DECLARE_KFIFO 1136 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos; 1137 # replace DECLARE_KFIFO_PTR 1138 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos; 1139 # replace DECLARE_FLEX_ARRAY 1140 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos; 1141 my $declaration = $members; 1142 1143 # Split nested struct/union elements as newer ones 1144 while ($members =~ m/$struct_members/) { 1145 my $newmember; 1146 my $maintype = $1; 1147 my $ids = $4; 1148 my $content = $3; 1149 foreach my $id(split /,/, $ids) { 1150 $newmember .= "$maintype $id; "; 1151 1152 $id =~ s/[:\[].*//; 1153 $id =~ s/^\s*\**(\S+)\s*/$1/; 1154 foreach my $arg (split /;/, $content) { 1155 next if ($arg =~ m/^\s*$/); 1156 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { 1157 # pointer-to-function 1158 my $type = $1; 1159 my $name = $2; 1160 my $extra = $3; 1161 next if (!$name); 1162 if ($id =~ m/^\s*$/) { 1163 # anonymous struct/union 1164 $newmember .= "$type$name$extra; "; 1165 } else { 1166 $newmember .= "$type$id.$name$extra; "; 1167 } 1168 } else { 1169 my $type; 1170 my $names; 1171 $arg =~ s/^\s+//; 1172 $arg =~ s/\s+$//; 1173 # Handle bitmaps 1174 $arg =~ s/:\s*\d+\s*//g; 1175 # Handle arrays 1176 $arg =~ s/\[.*\]//g; 1177 # The type may have multiple words, 1178 # and multiple IDs can be defined, like: 1179 # const struct foo, *bar, foobar 1180 # So, we remove spaces when parsing the 1181 # names, in order to match just names 1182 # and commas for the names 1183 $arg =~ s/\s*,\s*/,/g; 1184 if ($arg =~ m/(.*)\s+([\S+,]+)/) { 1185 $type = $1; 1186 $names = $2; 1187 } else { 1188 $newmember .= "$arg; "; 1189 next; 1190 } 1191 foreach my $name (split /,/, $names) { 1192 $name =~ s/^\s*\**(\S+)\s*/$1/; 1193 next if (($name =~ m/^\s*$/)); 1194 if ($id =~ m/^\s*$/) { 1195 # anonymous struct/union 1196 $newmember .= "$type $name; "; 1197 } else { 1198 $newmember .= "$type $id.$name; "; 1199 } 1200 } 1201 } 1202 } 1203 } 1204 $members =~ s/$struct_members/$newmember/; 1205 } 1206 1207 # Ignore other nested elements, like enums 1208 $members =~ s/(\{[^\{\}]*\})//g; 1209 1210 create_parameterlist($members, ';', $file, $declaration_name); 1211 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual); 1212 1213 # Adjust declaration for better display 1214 $declaration =~ s/([\{;])/$1\n/g; 1215 $declaration =~ s/\}\s+;/};/g; 1216 # Better handle inlined enums 1217 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/); 1218 1219 my @def_args = split /\n/, $declaration; 1220 my $level = 1; 1221 $declaration = ""; 1222 foreach my $clause (@def_args) { 1223 $clause =~ s/^\s+//; 1224 $clause =~ s/\s+$//; 1225 $clause =~ s/\s+/ /; 1226 next if (!$clause); 1227 $level-- if ($clause =~ m/(\})/ && $level > 1); 1228 if (!($clause =~ m/^\s*#/)) { 1229 $declaration .= "\t" x $level; 1230 } 1231 $declaration .= "\t" . $clause . "\n"; 1232 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); 1233 } 1234 output_declaration($declaration_name, 1235 'struct', 1236 {'struct' => $declaration_name, 1237 'module' => $modulename, 1238 'definition' => $declaration, 1239 'parameterlist' => \@parameterlist, 1240 'parameterdescs' => \%parameterdescs, 1241 'parametertypes' => \%parametertypes, 1242 'sectionlist' => \@sectionlist, 1243 'sections' => \%sections, 1244 'purpose' => $declaration_purpose, 1245 'type' => $decl_type 1246 }); 1247 } 1248 else { 1249 print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; 1250 ++$errors; 1251 } 1252} 1253 1254 1255sub show_warnings($$) { 1256 my $functype = shift; 1257 my $name = shift; 1258 1259 return 0 if (defined($nosymbol_table{$name})); 1260 1261 return 1 if ($output_selection == OUTPUT_ALL); 1262 1263 if ($output_selection == OUTPUT_EXPORTED) { 1264 if (defined($function_table{$name})) { 1265 return 1; 1266 } else { 1267 return 0; 1268 } 1269 } 1270 if ($output_selection == OUTPUT_INTERNAL) { 1271 if (!($functype eq "function" && defined($function_table{$name}))) { 1272 return 1; 1273 } else { 1274 return 0; 1275 } 1276 } 1277 if ($output_selection == OUTPUT_INCLUDE) { 1278 if (defined($function_table{$name})) { 1279 return 1; 1280 } else { 1281 return 0; 1282 } 1283 } 1284 die("Please add the new output type at show_warnings()"); 1285} 1286 1287sub dump_enum($$) { 1288 my $x = shift; 1289 my $file = shift; 1290 my $members; 1291 1292 1293 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1294 # strip #define macros inside enums 1295 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; 1296 1297 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) { 1298 $declaration_name = $2; 1299 $members = $1; 1300 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) { 1301 $declaration_name = $1; 1302 $members = $2; 1303 } 1304 1305 if ($members) { 1306 if ($identifier ne $declaration_name) { 1307 if ($identifier eq "") { 1308 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n"); 1309 } else { 1310 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n"); 1311 } 1312 return; 1313 } 1314 $declaration_name = "(anonymous)" if ($declaration_name eq ""); 1315 1316 my %_members; 1317 1318 $members =~ s/\s+$//; 1319 1320 foreach my $arg (split ',', $members) { 1321 $arg =~ s/^\s*(\w+).*/$1/; 1322 push @parameterlist, $arg; 1323 if (!$parameterdescs{$arg}) { 1324 $parameterdescs{$arg} = $undescribed; 1325 if (show_warnings("enum", $declaration_name)) { 1326 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n"); 1327 } 1328 } 1329 $_members{$arg} = 1; 1330 } 1331 1332 while (my ($k, $v) = each %parameterdescs) { 1333 if (!exists($_members{$k})) { 1334 if (show_warnings("enum", $declaration_name)) { 1335 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n"); 1336 } 1337 } 1338 } 1339 1340 output_declaration($declaration_name, 1341 'enum', 1342 {'enum' => $declaration_name, 1343 'module' => $modulename, 1344 'parameterlist' => \@parameterlist, 1345 'parameterdescs' => \%parameterdescs, 1346 'sectionlist' => \@sectionlist, 1347 'sections' => \%sections, 1348 'purpose' => $declaration_purpose 1349 }); 1350 } else { 1351 print STDERR "${file}:$.: error: Cannot parse enum!\n"; 1352 ++$errors; 1353 } 1354} 1355 1356my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x; 1357my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x; 1358my $typedef_args = qr { \s*\((.*)\); }x; 1359 1360my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x; 1361my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x; 1362 1363sub dump_typedef($$) { 1364 my $x = shift; 1365 my $file = shift; 1366 1367 $x =~ s@/\*.*?\*/@@gos; # strip comments. 1368 1369 # Parse function typedef prototypes 1370 if ($x =~ $typedef1 || $x =~ $typedef2) { 1371 $return_type = $1; 1372 $declaration_name = $2; 1373 my $args = $3; 1374 $return_type =~ s/^\s+//; 1375 1376 if ($identifier ne $declaration_name) { 1377 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n"); 1378 return; 1379 } 1380 1381 create_parameterlist($args, ',', $file, $declaration_name); 1382 1383 output_declaration($declaration_name, 1384 'function', 1385 {'function' => $declaration_name, 1386 'typedef' => 1, 1387 'module' => $modulename, 1388 'functiontype' => $return_type, 1389 'parameterlist' => \@parameterlist, 1390 'parameterdescs' => \%parameterdescs, 1391 'parametertypes' => \%parametertypes, 1392 'sectionlist' => \@sectionlist, 1393 'sections' => \%sections, 1394 'purpose' => $declaration_purpose 1395 }); 1396 return; 1397 } 1398 1399 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) { 1400 $x =~ s/\(*.\)\s*;$/;/; 1401 $x =~ s/\[*.\]\s*;$/;/; 1402 } 1403 1404 if ($x =~ /typedef.*\s+(\w+)\s*;/) { 1405 $declaration_name = $1; 1406 1407 if ($identifier ne $declaration_name) { 1408 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n"); 1409 return; 1410 } 1411 1412 output_declaration($declaration_name, 1413 'typedef', 1414 {'typedef' => $declaration_name, 1415 'module' => $modulename, 1416 'sectionlist' => \@sectionlist, 1417 'sections' => \%sections, 1418 'purpose' => $declaration_purpose 1419 }); 1420 } 1421 else { 1422 print STDERR "${file}:$.: error: Cannot parse typedef!\n"; 1423 ++$errors; 1424 } 1425} 1426 1427sub save_struct_actual($) { 1428 my $actual = shift; 1429 1430 # strip all spaces from the actual param so that it looks like one string item 1431 $actual =~ s/\s*//g; 1432 $struct_actual = $struct_actual . $actual . " "; 1433} 1434 1435sub create_parameterlist($$$$) { 1436 my $args = shift; 1437 my $splitter = shift; 1438 my $file = shift; 1439 my $declaration_name = shift; 1440 my $type; 1441 my $param; 1442 1443 # temporarily replace commas inside function pointer definition 1444 my $arg_expr = qr{\([^\),]+}; 1445 while ($args =~ /$arg_expr,/) { 1446 $args =~ s/($arg_expr),/$1#/g; 1447 } 1448 1449 foreach my $arg (split($splitter, $args)) { 1450 # strip comments 1451 $arg =~ s/\/\*.*\*\///; 1452 # strip leading/trailing spaces 1453 $arg =~ s/^\s*//; 1454 $arg =~ s/\s*$//; 1455 $arg =~ s/\s+/ /; 1456 1457 if ($arg =~ /^#/) { 1458 # Treat preprocessor directive as a typeless variable just to fill 1459 # corresponding data structures "correctly". Catch it later in 1460 # output_* subs. 1461 push_parameter($arg, "", "", $file); 1462 } elsif ($arg =~ m/\(.+\)\s*\(/) { 1463 # pointer-to-function 1464 $arg =~ tr/#/,/; 1465 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/; 1466 $param = $1; 1467 $type = $arg; 1468 $type =~ s/([^\(]+\(\*?)\s*$param/$1/; 1469 save_struct_actual($param); 1470 push_parameter($param, $type, $arg, $file, $declaration_name); 1471 } elsif ($arg) { 1472 $arg =~ s/\s*:\s*/:/g; 1473 $arg =~ s/\s*\[/\[/g; 1474 1475 my @args = split('\s*,\s*', $arg); 1476 if ($args[0] =~ m/\*/) { 1477 $args[0] =~ s/(\*+)\s*/ $1/; 1478 } 1479 1480 my @first_arg; 1481 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) { 1482 shift @args; 1483 push(@first_arg, split('\s+', $1)); 1484 push(@first_arg, $2); 1485 } else { 1486 @first_arg = split('\s+', shift @args); 1487 } 1488 1489 unshift(@args, pop @first_arg); 1490 $type = join " ", @first_arg; 1491 1492 foreach $param (@args) { 1493 if ($param =~ m/^(\*+)\s*(.*)/) { 1494 save_struct_actual($2); 1495 1496 push_parameter($2, "$type $1", $arg, $file, $declaration_name); 1497 } 1498 elsif ($param =~ m/(.*?):(\d+)/) { 1499 if ($type ne "") { # skip unnamed bit-fields 1500 save_struct_actual($1); 1501 push_parameter($1, "$type:$2", $arg, $file, $declaration_name) 1502 } 1503 } 1504 else { 1505 save_struct_actual($param); 1506 push_parameter($param, $type, $arg, $file, $declaration_name); 1507 } 1508 } 1509 } 1510 } 1511} 1512 1513sub push_parameter($$$$$) { 1514 my $param = shift; 1515 my $type = shift; 1516 my $org_arg = shift; 1517 my $file = shift; 1518 my $declaration_name = shift; 1519 1520 if (($anon_struct_union == 1) && ($type eq "") && 1521 ($param eq "}")) { 1522 return; # ignore the ending }; from anon. struct/union 1523 } 1524 1525 $anon_struct_union = 0; 1526 $param =~ s/[\[\)].*//; 1527 1528 if ($type eq "" && $param =~ /\.\.\.$/) 1529 { 1530 if (!$param =~ /\w\.\.\.$/) { 1531 # handles unnamed variable parameters 1532 $param = "..."; 1533 } 1534 elsif ($param =~ /\w\.\.\.$/) { 1535 # for named variable parameters of the form `x...`, remove the dots 1536 $param =~ s/\.\.\.$//; 1537 } 1538 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") { 1539 $parameterdescs{$param} = "variable arguments"; 1540 } 1541 } 1542 elsif ($type eq "" && ($param eq "" or $param eq "void")) 1543 { 1544 $param="void"; 1545 $parameterdescs{void} = "no arguments"; 1546 } 1547 elsif ($type eq "" && ($param eq "struct" or $param eq "union")) 1548 # handle unnamed (anonymous) union or struct: 1549 { 1550 $type = $param; 1551 $param = "{unnamed_" . $param . "}"; 1552 $parameterdescs{$param} = "anonymous\n"; 1553 $anon_struct_union = 1; 1554 } 1555 1556 # warn if parameter has no description 1557 # (but ignore ones starting with # as these are not parameters 1558 # but inline preprocessor statements); 1559 # Note: It will also ignore void params and unnamed structs/unions 1560 if (!defined $parameterdescs{$param} && $param !~ /^#/) { 1561 $parameterdescs{$param} = $undescribed; 1562 1563 if (show_warnings($type, $declaration_name) && $param !~ /\./) { 1564 emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n"); 1565 } 1566 } 1567 1568 # strip spaces from $param so that it is one continuous string 1569 # on @parameterlist; 1570 # this fixes a problem where check_sections() cannot find 1571 # a parameter like "addr[6 + 2]" because it actually appears 1572 # as "addr[6", "+", "2]" on the parameter list; 1573 # but it's better to maintain the param string unchanged for output, 1574 # so just weaken the string compare in check_sections() to ignore 1575 # "[blah" in a parameter string; 1576 ###$param =~ s/\s*//g; 1577 push @parameterlist, $param; 1578 $org_arg =~ s/\s\s+/ /g; 1579 $parametertypes{$param} = $org_arg; 1580} 1581 1582sub check_sections($$$$$) { 1583 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_; 1584 my @sects = split ' ', $sectcheck; 1585 my @prms = split ' ', $prmscheck; 1586 my $err; 1587 my ($px, $sx); 1588 my $prm_clean; # strip trailing "[array size]" and/or beginning "*" 1589 1590 foreach $sx (0 .. $#sects) { 1591 $err = 1; 1592 foreach $px (0 .. $#prms) { 1593 $prm_clean = $prms[$px]; 1594 $prm_clean =~ s/\[.*\]//; 1595 $prm_clean =~ s/$attribute//i; 1596 # ignore array size in a parameter string; 1597 # however, the original param string may contain 1598 # spaces, e.g.: addr[6 + 2] 1599 # and this appears in @prms as "addr[6" since the 1600 # parameter list is split at spaces; 1601 # hence just ignore "[..." for the sections check; 1602 $prm_clean =~ s/\[.*//; 1603 1604 ##$prm_clean =~ s/^\**//; 1605 if ($prm_clean eq $sects[$sx]) { 1606 $err = 0; 1607 last; 1608 } 1609 } 1610 if ($err) { 1611 if ($decl_type eq "function") { 1612 emit_warning("${file}:$.", 1613 "Excess function parameter " . 1614 "'$sects[$sx]' " . 1615 "description in '$decl_name'\n"); 1616 } 1617 } 1618 } 1619} 1620 1621## 1622# Checks the section describing the return value of a function. 1623sub check_return_section { 1624 my $file = shift; 1625 my $declaration_name = shift; 1626 my $return_type = shift; 1627 1628 # Ignore an empty return type (It's a macro) 1629 # Ignore functions with a "void" return type. (But don't ignore "void *") 1630 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) { 1631 return; 1632 } 1633 1634 if (!defined($sections{$section_return}) || 1635 $sections{$section_return} eq "") { 1636 emit_warning("${file}:$.", 1637 "No description found for return value of " . 1638 "'$declaration_name'\n"); 1639 } 1640} 1641 1642## 1643# takes a function prototype and the name of the current file being 1644# processed and spits out all the details stored in the global 1645# arrays/hashes. 1646sub dump_function($$) { 1647 my $prototype = shift; 1648 my $file = shift; 1649 my $noret = 0; 1650 1651 print_lineno($new_start_line); 1652 1653 $prototype =~ s/^static +//; 1654 $prototype =~ s/^extern +//; 1655 $prototype =~ s/^asmlinkage +//; 1656 $prototype =~ s/^inline +//; 1657 $prototype =~ s/^__inline__ +//; 1658 $prototype =~ s/^__inline +//; 1659 $prototype =~ s/^__always_inline +//; 1660 $prototype =~ s/^noinline +//; 1661 $prototype =~ s/__init +//; 1662 $prototype =~ s/__init_or_module +//; 1663 $prototype =~ s/__deprecated +//; 1664 $prototype =~ s/__flatten +//; 1665 $prototype =~ s/__meminit +//; 1666 $prototype =~ s/__must_check +//; 1667 $prototype =~ s/__weak +//; 1668 $prototype =~ s/__sched +//; 1669 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; 1670 $prototype =~ s/__alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//; 1671 my $define = $prototype =~ s/^#\s*define\s+//; #ak added 1672 $prototype =~ s/__attribute_const__ +//; 1673 $prototype =~ s/__attribute__\s*\(\( 1674 (?: 1675 [\w\s]++ # attribute name 1676 (?:\([^)]*+\))? # attribute arguments 1677 \s*+,? # optional comma at the end 1678 )+ 1679 \)\)\s+//x; 1680 1681 # Yes, this truly is vile. We are looking for: 1682 # 1. Return type (may be nothing if we're looking at a macro) 1683 # 2. Function name 1684 # 3. Function parameters. 1685 # 1686 # All the while we have to watch out for function pointer parameters 1687 # (which IIRC is what the two sections are for), C types (these 1688 # regexps don't even start to express all the possibilities), and 1689 # so on. 1690 # 1691 # If you mess with these regexps, it's a good idea to check that 1692 # the following functions' documentation still comes out right: 1693 # - parport_register_device (function pointer parameters) 1694 # - atomic_set (macro) 1695 # - pci_match_device, __copy_to_user (long return type) 1696 my $name = qr{[a-zA-Z0-9_~:]+}; 1697 my $prototype_end1 = qr{[^\(]*}; 1698 my $prototype_end2 = qr{[^\{]*}; 1699 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)}; 1700 my $type1 = qr{[\w\s]+}; 1701 my $type2 = qr{$type1\*+}; 1702 1703 if ($define && $prototype =~ m/^()($name)\s+/) { 1704 # This is an object-like macro, it has no return type and no parameter 1705 # list. 1706 # Function-like macros are not allowed to have spaces between 1707 # declaration_name and opening parenthesis (notice the \s+). 1708 $return_type = $1; 1709 $declaration_name = $2; 1710 $noret = 1; 1711 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ || 1712 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ || 1713 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) { 1714 $return_type = $1; 1715 $declaration_name = $2; 1716 my $args = $3; 1717 1718 create_parameterlist($args, ',', $file, $declaration_name); 1719 } else { 1720 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n"); 1721 return; 1722 } 1723 1724 if ($identifier ne $declaration_name) { 1725 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n"); 1726 return; 1727 } 1728 1729 my $prms = join " ", @parameterlist; 1730 check_sections($file, $declaration_name, "function", $sectcheck, $prms); 1731 1732 # This check emits a lot of warnings at the moment, because many 1733 # functions don't have a 'Return' doc section. So until the number 1734 # of warnings goes sufficiently down, the check is only performed in 1735 # verbose mode. 1736 # TODO: always perform the check. 1737 if ($verbose && !$noret) { 1738 check_return_section($file, $declaration_name, $return_type); 1739 } 1740 1741 # The function parser can be called with a typedef parameter. 1742 # Handle it. 1743 if ($return_type =~ /typedef/) { 1744 output_declaration($declaration_name, 1745 'function', 1746 {'function' => $declaration_name, 1747 'typedef' => 1, 1748 'module' => $modulename, 1749 'functiontype' => $return_type, 1750 'parameterlist' => \@parameterlist, 1751 'parameterdescs' => \%parameterdescs, 1752 'parametertypes' => \%parametertypes, 1753 'sectionlist' => \@sectionlist, 1754 'sections' => \%sections, 1755 'purpose' => $declaration_purpose 1756 }); 1757 } else { 1758 output_declaration($declaration_name, 1759 'function', 1760 {'function' => $declaration_name, 1761 'module' => $modulename, 1762 'functiontype' => $return_type, 1763 'parameterlist' => \@parameterlist, 1764 'parameterdescs' => \%parameterdescs, 1765 'parametertypes' => \%parametertypes, 1766 'sectionlist' => \@sectionlist, 1767 'sections' => \%sections, 1768 'purpose' => $declaration_purpose 1769 }); 1770 } 1771} 1772 1773sub reset_state { 1774 $function = ""; 1775 %parameterdescs = (); 1776 %parametertypes = (); 1777 @parameterlist = (); 1778 %sections = (); 1779 @sectionlist = (); 1780 $sectcheck = ""; 1781 $struct_actual = ""; 1782 $prototype = ""; 1783 1784 $state = STATE_NORMAL; 1785 $inline_doc_state = STATE_INLINE_NA; 1786} 1787 1788sub tracepoint_munge($) { 1789 my $file = shift; 1790 my $tracepointname = 0; 1791 my $tracepointargs = 0; 1792 1793 if ($prototype =~ m/TRACE_EVENT\((.*?),/) { 1794 $tracepointname = $1; 1795 } 1796 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) { 1797 $tracepointname = $1; 1798 } 1799 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) { 1800 $tracepointname = $2; 1801 } 1802 $tracepointname =~ s/^\s+//; #strip leading whitespace 1803 if ($prototype =~ m/TP_PROTO\((.*?)\)/) { 1804 $tracepointargs = $1; 1805 } 1806 if (($tracepointname eq 0) || ($tracepointargs eq 0)) { 1807 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n". 1808 "$prototype\n"); 1809 } else { 1810 $prototype = "static inline void trace_$tracepointname($tracepointargs)"; 1811 $identifier = "trace_$identifier"; 1812 } 1813} 1814 1815sub syscall_munge() { 1816 my $void = 0; 1817 1818 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's 1819## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { 1820 if ($prototype =~ m/SYSCALL_DEFINE0/) { 1821 $void = 1; 1822## $prototype = "long sys_$1(void)"; 1823 } 1824 1825 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name 1826 if ($prototype =~ m/long (sys_.*?),/) { 1827 $prototype =~ s/,/\(/; 1828 } elsif ($void) { 1829 $prototype =~ s/\)/\(void\)/; 1830 } 1831 1832 # now delete all of the odd-number commas in $prototype 1833 # so that arg types & arg names don't have a comma between them 1834 my $count = 0; 1835 my $len = length($prototype); 1836 if ($void) { 1837 $len = 0; # skip the for-loop 1838 } 1839 for (my $ix = 0; $ix < $len; $ix++) { 1840 if (substr($prototype, $ix, 1) eq ',') { 1841 $count++; 1842 if ($count % 2 == 1) { 1843 substr($prototype, $ix, 1) = ' '; 1844 } 1845 } 1846 } 1847} 1848 1849sub process_proto_function($$) { 1850 my $x = shift; 1851 my $file = shift; 1852 1853 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1854 1855 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) { 1856 # do nothing 1857 } 1858 elsif ($x =~ /([^\{]*)/) { 1859 $prototype .= $1; 1860 } 1861 1862 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) { 1863 $prototype =~ s@/\*.*?\*/@@gos; # strip comments. 1864 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1865 $prototype =~ s@^\s+@@gos; # strip leading spaces 1866 1867 # Handle prototypes for function pointers like: 1868 # int (*pcs_config)(struct foo) 1869 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos; 1870 1871 if ($prototype =~ /SYSCALL_DEFINE/) { 1872 syscall_munge(); 1873 } 1874 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ || 1875 $prototype =~ /DEFINE_SINGLE_EVENT/) 1876 { 1877 tracepoint_munge($file); 1878 } 1879 dump_function($prototype, $file); 1880 reset_state(); 1881 } 1882} 1883 1884sub process_proto_type($$) { 1885 my $x = shift; 1886 my $file = shift; 1887 1888 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's. 1889 $x =~ s@^\s+@@gos; # strip leading spaces 1890 $x =~ s@\s+$@@gos; # strip trailing spaces 1891 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line 1892 1893 if ($x =~ /^#/) { 1894 # To distinguish preprocessor directive from regular declaration later. 1895 $x .= ";"; 1896 } 1897 1898 while (1) { 1899 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) { 1900 if( length $prototype ) { 1901 $prototype .= " " 1902 } 1903 $prototype .= $1 . $2; 1904 ($2 eq '{') && $brcount++; 1905 ($2 eq '}') && $brcount--; 1906 if (($2 eq ';') && ($brcount == 0)) { 1907 dump_declaration($prototype, $file); 1908 reset_state(); 1909 last; 1910 } 1911 $x = $3; 1912 } else { 1913 $prototype .= $x; 1914 last; 1915 } 1916 } 1917} 1918 1919 1920sub map_filename($) { 1921 my $file; 1922 my ($orig_file) = @_; 1923 1924 if (defined($ENV{'SRCTREE'})) { 1925 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file; 1926 } else { 1927 $file = $orig_file; 1928 } 1929 1930 if (defined($source_map{$file})) { 1931 $file = $source_map{$file}; 1932 } 1933 1934 return $file; 1935} 1936 1937sub process_export_file($) { 1938 my ($orig_file) = @_; 1939 my $file = map_filename($orig_file); 1940 1941 if (!open(IN,"<$file")) { 1942 print STDERR "Error: Cannot open file $file\n"; 1943 ++$errors; 1944 return; 1945 } 1946 1947 while (<IN>) { 1948 if (/$export_symbol/) { 1949 next if (defined($nosymbol_table{$2})); 1950 $function_table{$2} = 1; 1951 } 1952 if (/$export_symbol_ns/) { 1953 next if (defined($nosymbol_table{$2})); 1954 $function_table{$2} = 1; 1955 } 1956 } 1957 1958 close(IN); 1959} 1960 1961# 1962# Parsers for the various processing states. 1963# 1964# STATE_NORMAL: looking for the /** to begin everything. 1965# 1966sub process_normal() { 1967 if (/$doc_start/o) { 1968 $state = STATE_NAME; # next line is always the function name 1969 $in_doc_sect = 0; 1970 $declaration_start_line = $. + 1; 1971 } 1972} 1973 1974# 1975# STATE_NAME: Looking for the "name - description" line 1976# 1977sub process_name($$) { 1978 my $file = shift; 1979 my $descr; 1980 1981 if (/$doc_block/o) { 1982 $state = STATE_DOCBLOCK; 1983 $contents = ""; 1984 $new_start_line = $.; 1985 1986 if ( $1 eq "" ) { 1987 $section = $section_intro; 1988 } else { 1989 $section = $1; 1990 } 1991 } elsif (/$doc_decl/o) { 1992 $identifier = $1; 1993 my $is_kernel_comment = 0; 1994 my $decl_start = qr{$doc_com}; 1995 # test for pointer declaration type, foo * bar() - desc 1996 my $fn_type = qr{\w+\s*\*\s*}; 1997 my $parenthesis = qr{\(\w*\)}; 1998 my $decl_end = qr{[-:].*}; 1999 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) { 2000 $identifier = $1; 2001 } 2002 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) { 2003 $decl_type = $1; 2004 $identifier = $2; 2005 $is_kernel_comment = 1; 2006 } 2007 # Look for foo() or static void foo() - description; or misspelt 2008 # identifier 2009 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ || 2010 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) { 2011 $identifier = $1; 2012 $decl_type = 'function'; 2013 $identifier =~ s/^define\s+//; 2014 $is_kernel_comment = 1; 2015 } 2016 $identifier =~ s/\s+$//; 2017 2018 $state = STATE_BODY; 2019 # if there's no @param blocks need to set up default section 2020 # here 2021 $contents = ""; 2022 $section = $section_default; 2023 $new_start_line = $. + 1; 2024 if (/[-:](.*)/) { 2025 # strip leading/trailing/multiple spaces 2026 $descr= $1; 2027 $descr =~ s/^\s*//; 2028 $descr =~ s/\s*$//; 2029 $descr =~ s/\s+/ /g; 2030 $declaration_purpose = $descr; 2031 $state = STATE_BODY_MAYBE; 2032 } else { 2033 $declaration_purpose = ""; 2034 } 2035 2036 if (!$is_kernel_comment) { 2037 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_"); 2038 $state = STATE_NORMAL; 2039 } 2040 2041 if (($declaration_purpose eq "") && $verbose) { 2042 emit_warning("${file}:$.", "missing initial short description on line:\n$_"); 2043 } 2044 2045 if ($identifier eq "" && $decl_type ne "enum") { 2046 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_"); 2047 $state = STATE_NORMAL; 2048 } 2049 2050 if ($verbose) { 2051 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n"; 2052 } 2053 } else { 2054 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n"); 2055 $state = STATE_NORMAL; 2056 } 2057} 2058 2059 2060# 2061# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. 2062# 2063sub process_body($$) { 2064 my $file = shift; 2065 2066 # Until all named variable macro parameters are 2067 # documented using the bare name (`x`) rather than with 2068 # dots (`x...`), strip the dots: 2069 if ($section =~ /\w\.\.\.$/) { 2070 $section =~ s/\.\.\.$//; 2071 2072 if ($verbose) { 2073 emit_warning("${file}:$.", "Variable macro arguments should be documented without dots\n"); 2074 } 2075 } 2076 2077 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) { 2078 dump_section($file, $section, $contents); 2079 $section = $section_default; 2080 $new_start_line = $.; 2081 $contents = ""; 2082 } 2083 2084 if (/$doc_sect/i) { # case insensitive for supported section names 2085 $newsection = $1; 2086 $newcontents = $2; 2087 2088 # map the supported section names to the canonical names 2089 if ($newsection =~ m/^description$/i) { 2090 $newsection = $section_default; 2091 } elsif ($newsection =~ m/^context$/i) { 2092 $newsection = $section_context; 2093 } elsif ($newsection =~ m/^returns?$/i) { 2094 $newsection = $section_return; 2095 } elsif ($newsection =~ m/^\@return$/) { 2096 # special: @return is a section, not a param description 2097 $newsection = $section_return; 2098 } 2099 2100 if (($contents ne "") && ($contents ne "\n")) { 2101 if (!$in_doc_sect && $verbose) { 2102 emit_warning("${file}:$.", "contents before sections\n"); 2103 } 2104 dump_section($file, $section, $contents); 2105 $section = $section_default; 2106 } 2107 2108 $in_doc_sect = 1; 2109 $state = STATE_BODY; 2110 $contents = $newcontents; 2111 $new_start_line = $.; 2112 while (substr($contents, 0, 1) eq " ") { 2113 $contents = substr($contents, 1); 2114 } 2115 if ($contents ne "") { 2116 $contents .= "\n"; 2117 } 2118 $section = $newsection; 2119 $leading_space = undef; 2120 } elsif (/$doc_end/) { 2121 if (($contents ne "") && ($contents ne "\n")) { 2122 dump_section($file, $section, $contents); 2123 $section = $section_default; 2124 $contents = ""; 2125 } 2126 # look for doc_com + <text> + doc_end: 2127 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { 2128 emit_warning("${file}:$.", "suspicious ending line: $_"); 2129 } 2130 2131 $prototype = ""; 2132 $state = STATE_PROTO; 2133 $brcount = 0; 2134 $new_start_line = $. + 1; 2135 } elsif (/$doc_content/) { 2136 if ($1 eq "") { 2137 if ($section eq $section_context) { 2138 dump_section($file, $section, $contents); 2139 $section = $section_default; 2140 $contents = ""; 2141 $new_start_line = $.; 2142 $state = STATE_BODY; 2143 } else { 2144 if ($section ne $section_default) { 2145 $state = STATE_BODY_WITH_BLANK_LINE; 2146 } else { 2147 $state = STATE_BODY; 2148 } 2149 $contents .= "\n"; 2150 } 2151 } elsif ($state == STATE_BODY_MAYBE) { 2152 # Continued declaration purpose 2153 chomp($declaration_purpose); 2154 $declaration_purpose .= " " . $1; 2155 $declaration_purpose =~ s/\s+/ /g; 2156 } else { 2157 my $cont = $1; 2158 if ($section =~ m/^@/ || $section eq $section_context) { 2159 if (!defined $leading_space) { 2160 if ($cont =~ m/^(\s+)/) { 2161 $leading_space = $1; 2162 } else { 2163 $leading_space = ""; 2164 } 2165 } 2166 $cont =~ s/^$leading_space//; 2167 } 2168 $contents .= $cont . "\n"; 2169 } 2170 } else { 2171 # i dont know - bad line? ignore. 2172 emit_warning("${file}:$.", "bad line: $_"); 2173 } 2174} 2175 2176 2177# 2178# STATE_PROTO: reading a function/whatever prototype. 2179# 2180sub process_proto($$) { 2181 my $file = shift; 2182 2183 if (/$doc_inline_oneline/) { 2184 $section = $1; 2185 $contents = $2; 2186 if ($contents ne "") { 2187 $contents .= "\n"; 2188 dump_section($file, $section, $contents); 2189 $section = $section_default; 2190 $contents = ""; 2191 } 2192 } elsif (/$doc_inline_start/) { 2193 $state = STATE_INLINE; 2194 $inline_doc_state = STATE_INLINE_NAME; 2195 } elsif ($decl_type eq 'function') { 2196 process_proto_function($_, $file); 2197 } else { 2198 process_proto_type($_, $file); 2199 } 2200} 2201 2202# 2203# STATE_DOCBLOCK: within a DOC: block. 2204# 2205sub process_docblock($$) { 2206 my $file = shift; 2207 2208 if (/$doc_end/) { 2209 dump_doc_section($file, $section, $contents); 2210 $section = $section_default; 2211 $contents = ""; 2212 $function = ""; 2213 %parameterdescs = (); 2214 %parametertypes = (); 2215 @parameterlist = (); 2216 %sections = (); 2217 @sectionlist = (); 2218 $prototype = ""; 2219 $state = STATE_NORMAL; 2220 } elsif (/$doc_content/) { 2221 if ( $1 eq "" ) { 2222 $contents .= $blankline; 2223 } else { 2224 $contents .= $1 . "\n"; 2225 } 2226 } 2227} 2228 2229# 2230# STATE_INLINE: docbook comments within a prototype. 2231# 2232sub process_inline($$) { 2233 my $file = shift; 2234 2235 # First line (state 1) needs to be a @parameter 2236 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) { 2237 $section = $1; 2238 $contents = $2; 2239 $new_start_line = $.; 2240 if ($contents ne "") { 2241 while (substr($contents, 0, 1) eq " ") { 2242 $contents = substr($contents, 1); 2243 } 2244 $contents .= "\n"; 2245 } 2246 $inline_doc_state = STATE_INLINE_TEXT; 2247 # Documentation block end */ 2248 } elsif (/$doc_inline_end/) { 2249 if (($contents ne "") && ($contents ne "\n")) { 2250 dump_section($file, $section, $contents); 2251 $section = $section_default; 2252 $contents = ""; 2253 } 2254 $state = STATE_PROTO; 2255 $inline_doc_state = STATE_INLINE_NA; 2256 # Regular text 2257 } elsif (/$doc_content/) { 2258 if ($inline_doc_state == STATE_INLINE_TEXT) { 2259 $contents .= $1 . "\n"; 2260 # nuke leading blank lines 2261 if ($contents =~ /^\s*$/) { 2262 $contents = ""; 2263 } 2264 } elsif ($inline_doc_state == STATE_INLINE_NAME) { 2265 $inline_doc_state = STATE_INLINE_ERROR; 2266 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_"); 2267 } 2268 } 2269} 2270 2271 2272sub process_file($) { 2273 my $file; 2274 my $initial_section_counter = $section_counter; 2275 my ($orig_file) = @_; 2276 2277 $file = map_filename($orig_file); 2278 2279 if (!open(IN_FILE,"<$file")) { 2280 print STDERR "Error: Cannot open file $file\n"; 2281 ++$errors; 2282 return; 2283 } 2284 2285 $. = 1; 2286 2287 $section_counter = 0; 2288 while (<IN_FILE>) { 2289 while (s/\\\s*$//) { 2290 $_ .= <IN_FILE>; 2291 } 2292 # Replace tabs by spaces 2293 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; 2294 # Hand this line to the appropriate state handler 2295 if ($state == STATE_NORMAL) { 2296 process_normal(); 2297 } elsif ($state == STATE_NAME) { 2298 process_name($file, $_); 2299 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE || 2300 $state == STATE_BODY_WITH_BLANK_LINE) { 2301 process_body($file, $_); 2302 } elsif ($state == STATE_INLINE) { # scanning for inline parameters 2303 process_inline($file, $_); 2304 } elsif ($state == STATE_PROTO) { 2305 process_proto($file, $_); 2306 } elsif ($state == STATE_DOCBLOCK) { 2307 process_docblock($file, $_); 2308 } 2309 } 2310 2311 # Make sure we got something interesting. 2312 if ($initial_section_counter == $section_counter && $ 2313 output_mode ne "none") { 2314 if ($output_selection == OUTPUT_INCLUDE) { 2315 emit_warning("${file}:1", "'$_' not found\n") 2316 for keys %function_table; 2317 } 2318 else { 2319 emit_warning("${file}:1", "no structured comments found\n"); 2320 } 2321 } 2322 close IN_FILE; 2323} 2324 2325 2326if ($output_mode eq "rst") { 2327 get_sphinx_version() if (!$sphinx_major); 2328} 2329 2330$kernelversion = get_kernel_version(); 2331 2332# generate a sequence of code that will splice in highlighting information 2333# using the s// operator. 2334for (my $k = 0; $k < @highlights; $k++) { 2335 my $pattern = $highlights[$k][0]; 2336 my $result = $highlights[$k][1]; 2337# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; 2338 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n"; 2339} 2340 2341# Read the file that maps relative names to absolute names for 2342# separate source and object directories and for shadow trees. 2343if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { 2344 my ($relname, $absname); 2345 while(<SOURCE_MAP>) { 2346 chop(); 2347 ($relname, $absname) = (split())[0..1]; 2348 $relname =~ s:^/+::; 2349 $source_map{$relname} = $absname; 2350 } 2351 close(SOURCE_MAP); 2352} 2353 2354if ($output_selection == OUTPUT_EXPORTED || 2355 $output_selection == OUTPUT_INTERNAL) { 2356 2357 push(@export_file_list, @ARGV); 2358 2359 foreach (@export_file_list) { 2360 chomp; 2361 process_export_file($_); 2362 } 2363} 2364 2365foreach (@ARGV) { 2366 chomp; 2367 process_file($_); 2368} 2369if ($verbose && $errors) { 2370 print STDERR "$errors errors\n"; 2371} 2372if ($verbose && $warnings) { 2373 print STDERR "$warnings warnings\n"; 2374} 2375 2376if ($Werror && $warnings) { 2377 print STDERR "$warnings warnings as Errors\n"; 2378 exit($warnings); 2379} else { 2380 exit($output_mode eq "none" ? 0 : $errors) 2381} 2382 2383__END__ 2384 2385=head1 OPTIONS 2386 2387=head2 Output format selection (mutually exclusive): 2388 2389=over 8 2390 2391=item -man 2392 2393Output troff manual page format. 2394 2395=item -rst 2396 2397Output reStructuredText format. This is the default. 2398 2399=item -none 2400 2401Do not output documentation, only warnings. 2402 2403=back 2404 2405=head2 Output format modifiers 2406 2407=head3 reStructuredText only 2408 2409=over 8 2410 2411=item -sphinx-version VERSION 2412 2413Use the ReST C domain dialect compatible with a specific Sphinx Version. 2414 2415If not specified, kernel-doc will auto-detect using the sphinx-build version 2416found on PATH. 2417 2418=back 2419 2420=head2 Output selection (mutually exclusive): 2421 2422=over 8 2423 2424=item -export 2425 2426Only output documentation for the symbols that have been exported using 2427EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. 2428 2429=item -internal 2430 2431Only output documentation for the symbols that have NOT been exported using 2432EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. 2433 2434=item -function NAME 2435 2436Only output documentation for the given function or DOC: section title. 2437All other functions and DOC: sections are ignored. 2438 2439May be specified multiple times. 2440 2441=item -nosymbol NAME 2442 2443Exclude the specified symbol from the output documentation. 2444 2445May be specified multiple times. 2446 2447=back 2448 2449=head2 Output selection modifiers: 2450 2451=over 8 2452 2453=item -no-doc-sections 2454 2455Do not output DOC: sections. 2456 2457=item -export-file FILE 2458 2459Specify an additional FILE in which to look for EXPORT_SYMBOL information. 2460 2461To be used with -export or -internal. 2462 2463May be specified multiple times. 2464 2465=back 2466 2467=head3 reStructuredText only 2468 2469=over 8 2470 2471=item -enable-lineno 2472 2473Enable output of .. LINENO lines. 2474 2475=back 2476 2477=head2 Other parameters: 2478 2479=over 8 2480 2481=item -h, -help 2482 2483Print this help. 2484 2485=item -v 2486 2487Verbose output, more warnings and other information. 2488 2489=item -Werror 2490 2491Treat warnings as errors. 2492 2493=back 2494 2495=cut 2496