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