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