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