blob: 6dda8cb51f20d8f34302dc8389126f9902fd2ecb [file] [log] [blame]
Mario Six78a88f72018-07-10 08:40:17 +02001#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
Marek Vasut30ff8912012-10-06 14:04:58 +00003
Mario Six78a88f72018-07-10 08:40:17 +02004use warnings;
Marek Vasut30ff8912012-10-06 14:04:58 +00005use strict;
6
7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
9## Copyright (C) 2001 Simon Huggins ##
10## Copyright (C) 2005-2012 Randy Dunlap ##
11## Copyright (C) 2012 Dan Luedtke ##
12## ##
13## #define enhancements by Armin Kuster <akuster@mvista.com> ##
14## Copyright (c) 2000 MontaVista Software, Inc. ##
15## ##
16## This software falls under the GNU General Public License. ##
17## Please read the COPYING file for more information ##
18
19# 18/01/2001 - Cleanups
20# Functions prototyped as foo(void) same as foo()
21# Stop eval'ing where we don't need to.
22# -- huggie@earth.li
23
24# 27/06/2001 - Allowed whitespace after initial "/**" and
25# allowed comments before function declarations.
26# -- Christian Kreibich <ck@whoop.org>
27
28# Still to do:
29# - add perldoc documentation
30# - Look more closely at some of the scarier bits :)
31
32# 26/05/2001 - Support for separate source and object trees.
33# Return error code.
34# Keith Owens <kaos@ocs.com.au>
35
36# 23/09/2001 - Added support for typedefs, structs, enums and unions
37# Support for Context section; can be terminated using empty line
38# Small fixes (like spaces vs. \s in regex)
39# -- Tim Jansen <tim@tjansen.de>
40
41# 25/07/2012 - Added support for HTML5
42# -- Dan Luedtke <mail@danrl.de>
43
Mario Six78a88f72018-07-10 08:40:17 +020044sub usage {
45 my $message = <<"EOF";
46Usage: $0 [OPTION ...] FILE ...
Marek Vasut30ff8912012-10-06 14:04:58 +000047
Mario Six78a88f72018-07-10 08:40:17 +020048Read C language source or header FILEs, extract embedded documentation comments,
49and print formatted documentation to standard output.
Marek Vasut30ff8912012-10-06 14:04:58 +000050
Mario Six78a88f72018-07-10 08:40:17 +020051The documentation comments are identified by "/**" opening comment mark. See
52Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
53
54Output format selection (mutually exclusive):
55 -man Output troff manual page format. This is the default.
56 -rst Output reStructuredText format.
57 -none Do not output documentation, only warnings.
58
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +010059Output format selection modifier (affects only ReST output):
60
61 -sphinx-version Use the ReST C domain dialect compatible with an
62 specific Sphinx Version.
63 If not specified, kernel-doc will auto-detect using
64 the sphinx-build version found on PATH.
65
Mario Six78a88f72018-07-10 08:40:17 +020066Output selection (mutually exclusive):
67 -export Only output documentation for symbols that have been
68 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
69 in any input FILE or -export-file FILE.
70 -internal Only output documentation for symbols that have NOT been
71 exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
72 in any input FILE or -export-file FILE.
73 -function NAME Only output documentation for the given function(s)
74 or DOC: section title(s). All other functions and DOC:
75 sections are ignored. May be specified multiple times.
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +010076 -nosymbol NAME Exclude the specified symbols from the output
77 documentation. May be specified multiple times.
Mario Six78a88f72018-07-10 08:40:17 +020078
79Output selection modifiers:
80 -no-doc-sections Do not output DOC: sections.
81 -enable-lineno Enable output of #define LINENO lines. Only works with
82 reStructuredText format.
83 -export-file FILE Specify an additional FILE in which to look for
84 EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with
85 -export or -internal. May be specified multiple times.
86
87Other parameters:
88 -v Verbose output, more warnings and other information.
89 -h Print this help.
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +010090 -Werror Treat warnings as errors.
Mario Six78a88f72018-07-10 08:40:17 +020091
92EOF
93 print $message;
94 exit 1;
95}
Marek Vasut30ff8912012-10-06 14:04:58 +000096
97#
98# format of comments.
99# In the following table, (...)? signifies optional structure.
100# (...)* signifies 0 or more structure elements
101# /**
102# * function_name(:)? (- short description)?
103# (* @parameterx: (description of parameter x)?)*
104# (* a blank line)?
105# * (Description:)? (Description of function)?
106# * (section header: (section description)? )*
107# (*)?*/
108#
109# So .. the trivial example would be:
110#
111# /**
112# * my_function
113# */
114#
115# If the Description: header tag is omitted, then there must be a blank line
116# after the last parameter specification.
117# e.g.
118# /**
119# * my_function - does my stuff
120# * @my_arg: its mine damnit
121# *
122# * Does my stuff explained.
123# */
124#
125# or, could also use:
126# /**
127# * my_function - does my stuff
128# * @my_arg: its mine damnit
129# * Description: Does my stuff explained.
130# */
131# etc.
132#
133# Besides functions you can also write documentation for structs, unions,
134# enums and typedefs. Instead of the function name you must write the name
135# of the declaration; the struct/union/enum/typedef must always precede
136# the name. Nesting of declarations is not supported.
137# Use the argument mechanism to document members or constants.
138# e.g.
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# /* private: */
150# int c;
151# };
152#
153# All descriptions can be multiline, except the short function description.
154#
Mario Six78a88f72018-07-10 08:40:17 +0200155# For really longs structs, you can also describe arguments inside the
156# body of the struct.
157# eg.
158# /**
159# * struct my_struct - short description
160# * @a: first member
161# * @b: second member
162# *
163# * Longer description
164# */
165# struct my_struct {
166# int a;
167# int b;
168# /**
169# * @c: This is longer description of C
170# *
171# * You can use paragraphs to describe arguments
172# * using this method.
173# */
174# int c;
175# };
176#
177# This should be use only for struct/enum members.
178#
Marek Vasut30ff8912012-10-06 14:04:58 +0000179# You can also add additional sections. When documenting kernel functions you
180# should document the "Context:" of the function, e.g. whether the functions
181# can be called form interrupts. Unlike other sections you can end it with an
182# empty line.
Masahiro Yamadaced03292014-02-05 10:52:51 +0900183# A non-void function should have a "Return:" section describing the return
184# value(s).
Marek Vasut30ff8912012-10-06 14:04:58 +0000185# Example-sections should contain the string EXAMPLE so that they are marked
186# appropriately in DocBook.
187#
188# Example:
189# /**
190# * user_function - function that can only be called in user context
191# * @a: some argument
192# * Context: !in_interrupt()
193# *
194# * Some description
195# * Example:
196# * user_function(22);
197# */
198# ...
199#
200#
201# All descriptive text is further processed, scanning for the following special
202# patterns, which are highlighted appropriately.
203#
204# 'funcname()' - function
205# '$ENVVAR' - environmental variable
206# '&struct_name' - name of a structure (up to two words including 'struct')
Mario Six78a88f72018-07-10 08:40:17 +0200207# '&struct_name.member' - name of a structure member
Marek Vasut30ff8912012-10-06 14:04:58 +0000208# '@parameter' - name of a parameter
209# '%CONST' - name of a constant.
Mario Six78a88f72018-07-10 08:40:17 +0200210# '``LITERAL``' - literal string without any spaces on it.
Marek Vasut30ff8912012-10-06 14:04:58 +0000211
212## init lots of data
213
214my $errors = 0;
215my $warnings = 0;
216my $anon_struct_union = 0;
217
218# match expressions used to find embedded type information
Mario Six78a88f72018-07-10 08:40:17 +0200219my $type_constant = '\b``([^\`]+)``\b';
220my $type_constant2 = '\%([-_\w]+)';
Marek Vasut30ff8912012-10-06 14:04:58 +0000221my $type_func = '(\w+)\(\)';
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +0200222my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100223my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
Mario Six78a88f72018-07-10 08:40:17 +0200224my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100225my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
Marek Vasut30ff8912012-10-06 14:04:58 +0000226my $type_env = '(\$\w+)';
Mario Six78a88f72018-07-10 08:40:17 +0200227my $type_enum = '\&(enum\s*([_\w]+))';
228my $type_struct = '\&(struct\s*([_\w]+))';
229my $type_typedef = '\&(typedef\s*([_\w]+))';
230my $type_union = '\&(union\s*([_\w]+))';
231my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
232my $type_fallback = '\&([_\w]+)';
233my $type_member_func = $type_member . '\(\)';
Marek Vasut30ff8912012-10-06 14:04:58 +0000234
235# Output conversion substitutions.
236# One for each output format
237
Marek Vasut30ff8912012-10-06 14:04:58 +0000238# these are pretty rough
Mario Six78a88f72018-07-10 08:40:17 +0200239my @highlights_man = (
240 [$type_constant, "\$1"],
241 [$type_constant2, "\$1"],
242 [$type_func, "\\\\fB\$1\\\\fP"],
243 [$type_enum, "\\\\fI\$1\\\\fP"],
244 [$type_struct, "\\\\fI\$1\\\\fP"],
245 [$type_typedef, "\\\\fI\$1\\\\fP"],
246 [$type_union, "\\\\fI\$1\\\\fP"],
247 [$type_param, "\\\\fI\$1\\\\fP"],
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100248 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
Mario Six78a88f72018-07-10 08:40:17 +0200249 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
250 [$type_fallback, "\\\\fI\$1\\\\fP"]
251 );
Marek Vasut30ff8912012-10-06 14:04:58 +0000252my $blankline_man = "";
253
Mario Six78a88f72018-07-10 08:40:17 +0200254# rst-mode
255my @highlights_rst = (
256 [$type_constant, "``\$1``"],
257 [$type_constant2, "``\$1``"],
258 # Note: need to escape () to avoid func matching later
259 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
260 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
261 [$type_fp_param, "**\$1\\\\(\\\\)**"],
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100262 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
263 [$type_func, "\$1()"],
Mario Six78a88f72018-07-10 08:40:17 +0200264 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
265 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
266 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
267 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
268 # in rst this can refer to any type
269 [$type_fallback, "\\:c\\:type\\:`\$1`"],
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100270 [$type_param_ref, "**\$1\$2**"]
Mario Six78a88f72018-07-10 08:40:17 +0200271 );
272my $blankline_rst = "\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000273
274# read arguments
275if ($#ARGV == -1) {
276 usage();
277}
278
279my $kernelversion;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100280my ($sphinx_major, $sphinx_minor, $sphinx_patch);
281
Marek Vasut30ff8912012-10-06 14:04:58 +0000282my $dohighlight = "";
283
284my $verbose = 0;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100285my $Werror = 0;
Mario Six78a88f72018-07-10 08:40:17 +0200286my $output_mode = "rst";
Masahiro Yamadaced03292014-02-05 10:52:51 +0900287my $output_preformatted = 0;
Marek Vasut30ff8912012-10-06 14:04:58 +0000288my $no_doc_sections = 0;
Mario Six78a88f72018-07-10 08:40:17 +0200289my $enable_lineno = 0;
290my @highlights = @highlights_rst;
291my $blankline = $blankline_rst;
292my $modulename = "Kernel API";
293
294use constant {
295 OUTPUT_ALL => 0, # output all symbols and doc sections
296 OUTPUT_INCLUDE => 1, # output only specified symbols
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100297 OUTPUT_EXPORTED => 2, # output exported symbols
298 OUTPUT_INTERNAL => 3, # output non-exported symbols
Mario Six78a88f72018-07-10 08:40:17 +0200299};
300my $output_selection = OUTPUT_ALL;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100301my $show_not_found = 0; # No longer used
Mario Six78a88f72018-07-10 08:40:17 +0200302
303my @export_file_list;
304
305my @build_time;
306if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
307 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
308 @build_time = gmtime($seconds);
309} else {
310 @build_time = localtime;
311}
312
Marek Vasut30ff8912012-10-06 14:04:58 +0000313my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
314 'July', 'August', 'September', 'October',
Mario Six78a88f72018-07-10 08:40:17 +0200315 'November', 'December')[$build_time[4]] .
316 " " . ($build_time[5]+1900);
Marek Vasut30ff8912012-10-06 14:04:58 +0000317
318# Essentially these are globals.
319# They probably want to be tidied up, made more localised or something.
320# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
321# could cause "use of undefined value" or other bugs.
322my ($function, %function_table, %parametertypes, $declaration_purpose);
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100323my %nosymbol_table = ();
Mario Six78a88f72018-07-10 08:40:17 +0200324my $declaration_start_line;
Marek Vasut30ff8912012-10-06 14:04:58 +0000325my ($type, $declaration_name, $return_type);
326my ($newsection, $newcontents, $prototype, $brcount, %source_map);
327
328if (defined($ENV{'KBUILD_VERBOSE'})) {
329 $verbose = "$ENV{'KBUILD_VERBOSE'}";
330}
331
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100332if (defined($ENV{'KDOC_WERROR'})) {
333 $Werror = "$ENV{'KDOC_WERROR'}";
334}
335
336if (defined($ENV{'KCFLAGS'})) {
337 my $kcflags = "$ENV{'KCFLAGS'}";
338
339 if ($kcflags =~ /Werror/) {
340 $Werror = 1;
341 }
342}
343
Marek Vasut30ff8912012-10-06 14:04:58 +0000344# Generated docbook code is inserted in a template at a point where
345# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100346# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
Marek Vasut30ff8912012-10-06 14:04:58 +0000347# We keep track of number of generated entries and generate a dummy
348# if needs be to ensure the expanded template can be postprocessed
349# into html.
350my $section_counter = 0;
351
352my $lineprefix="";
353
Mario Six78a88f72018-07-10 08:40:17 +0200354# Parser states
355use constant {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100356 STATE_NORMAL => 0, # normal code
357 STATE_NAME => 1, # looking for function name
358 STATE_BODY_MAYBE => 2, # body - or maybe more description
359 STATE_BODY => 3, # the body of the comment
360 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
361 STATE_PROTO => 5, # scanning prototype
362 STATE_DOCBLOCK => 6, # documentation block
363 STATE_INLINE => 7, # gathering doc outside main block
Mario Six78a88f72018-07-10 08:40:17 +0200364};
Marek Vasut30ff8912012-10-06 14:04:58 +0000365my $state;
366my $in_doc_sect;
Mario Six78a88f72018-07-10 08:40:17 +0200367my $leading_space;
368
369# Inline documentation state
370use constant {
371 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
372 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
373 STATE_INLINE_TEXT => 2, # looking for member documentation
374 STATE_INLINE_END => 3, # done
375 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
376 # Spit a warning as it's not
377 # proper kernel-doc and ignore the rest.
378};
379my $inline_doc_state;
Marek Vasut30ff8912012-10-06 14:04:58 +0000380
381#declaration types: can be
382# 'function', 'struct', 'union', 'enum', 'typedef'
383my $decl_type;
384
Marek Vasut30ff8912012-10-06 14:04:58 +0000385my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
386my $doc_end = '\*/';
387my $doc_com = '\s*\*\s*';
Masahiro Yamadaced03292014-02-05 10:52:51 +0900388my $doc_com_body = '\s*\* ?';
Marek Vasut30ff8912012-10-06 14:04:58 +0000389my $doc_decl = $doc_com . '(\w+)';
Mario Six78a88f72018-07-10 08:40:17 +0200390# @params and a strictly limited set of supported section names
391my $doc_sect = $doc_com .
392 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)';
Masahiro Yamadaced03292014-02-05 10:52:51 +0900393my $doc_content = $doc_com_body . '(.*)';
Marek Vasut30ff8912012-10-06 14:04:58 +0000394my $doc_block = $doc_com . 'DOC:\s*(.*)?';
Mario Six78a88f72018-07-10 08:40:17 +0200395my $doc_inline_start = '^\s*/\*\*\s*$';
396my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
397my $doc_inline_end = '^\s*\*/\s*$';
398my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
399my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
Marek Vasut30ff8912012-10-06 14:04:58 +0000400
Marek Vasut30ff8912012-10-06 14:04:58 +0000401my %parameterdescs;
Mario Six78a88f72018-07-10 08:40:17 +0200402my %parameterdesc_start_lines;
Marek Vasut30ff8912012-10-06 14:04:58 +0000403my @parameterlist;
404my %sections;
405my @sectionlist;
Mario Six78a88f72018-07-10 08:40:17 +0200406my %section_start_lines;
Marek Vasut30ff8912012-10-06 14:04:58 +0000407my $sectcheck;
408my $struct_actual;
409
410my $contents = "";
Mario Six78a88f72018-07-10 08:40:17 +0200411my $new_start_line = 0;
412
413# the canonical section names. see also $doc_sect above.
Marek Vasut30ff8912012-10-06 14:04:58 +0000414my $section_default = "Description"; # default section
415my $section_intro = "Introduction";
416my $section = $section_default;
417my $section_context = "Context";
Masahiro Yamadaced03292014-02-05 10:52:51 +0900418my $section_return = "Return";
Marek Vasut30ff8912012-10-06 14:04:58 +0000419
420my $undescribed = "-- undescribed --";
421
422reset_state();
423
Mario Six78a88f72018-07-10 08:40:17 +0200424while ($ARGV[0] =~ m/^--?(.*)/) {
425 my $cmd = $1;
426 shift @ARGV;
427 if ($cmd eq "man") {
Marek Vasut30ff8912012-10-06 14:04:58 +0000428 $output_mode = "man";
Mario Six78a88f72018-07-10 08:40:17 +0200429 @highlights = @highlights_man;
Marek Vasut30ff8912012-10-06 14:04:58 +0000430 $blankline = $blankline_man;
Mario Six78a88f72018-07-10 08:40:17 +0200431 } elsif ($cmd eq "rst") {
432 $output_mode = "rst";
433 @highlights = @highlights_rst;
434 $blankline = $blankline_rst;
435 } elsif ($cmd eq "none") {
436 $output_mode = "none";
437 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
Marek Vasut30ff8912012-10-06 14:04:58 +0000438 $modulename = shift @ARGV;
Mario Six78a88f72018-07-10 08:40:17 +0200439 } elsif ($cmd eq "function") { # to only output specific functions
440 $output_selection = OUTPUT_INCLUDE;
Marek Vasut30ff8912012-10-06 14:04:58 +0000441 $function = shift @ARGV;
442 $function_table{$function} = 1;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100443 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
444 my $symbol = shift @ARGV;
445 $nosymbol_table{$symbol} = 1;
Mario Six78a88f72018-07-10 08:40:17 +0200446 } elsif ($cmd eq "export") { # only exported symbols
447 $output_selection = OUTPUT_EXPORTED;
448 %function_table = ();
449 } elsif ($cmd eq "internal") { # only non-exported symbols
450 $output_selection = OUTPUT_INTERNAL;
451 %function_table = ();
452 } elsif ($cmd eq "export-file") {
453 my $file = shift @ARGV;
454 push(@export_file_list, $file);
455 } elsif ($cmd eq "v") {
Marek Vasut30ff8912012-10-06 14:04:58 +0000456 $verbose = 1;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100457 } elsif ($cmd eq "Werror") {
458 $Werror = 1;
Mario Six78a88f72018-07-10 08:40:17 +0200459 } elsif (($cmd eq "h") || ($cmd eq "help")) {
Marek Vasut30ff8912012-10-06 14:04:58 +0000460 usage();
Mario Six78a88f72018-07-10 08:40:17 +0200461 } elsif ($cmd eq 'no-doc-sections') {
Marek Vasut30ff8912012-10-06 14:04:58 +0000462 $no_doc_sections = 1;
Mario Six78a88f72018-07-10 08:40:17 +0200463 } elsif ($cmd eq 'enable-lineno') {
464 $enable_lineno = 1;
465 } elsif ($cmd eq 'show-not-found') {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100466 $show_not_found = 1; # A no-op but don't fail
467 } elsif ($cmd eq "sphinx-version") {
468 my $ver_string = shift @ARGV;
469 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
470 $sphinx_major = $1;
471 if (defined($2)) {
472 $sphinx_minor = substr($2,1);
473 } else {
474 $sphinx_minor = 0;
475 }
476 if (defined($3)) {
477 $sphinx_patch = substr($3,1)
478 } else {
479 $sphinx_patch = 0;
480 }
481 } else {
482 die "Sphinx version should either major.minor or major.minor.patch format\n";
483 }
Mario Six78a88f72018-07-10 08:40:17 +0200484 } else {
485 # Unknown argument
486 usage();
Marek Vasut30ff8912012-10-06 14:04:58 +0000487 }
488}
489
490# continue execution near EOF;
491
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100492# The C domain dialect changed on Sphinx 3. So, we need to check the
493# version in order to produce the right tags.
494sub findprog($)
495{
496 foreach(split(/:/, $ENV{PATH})) {
497 return "$_/$_[0]" if(-x "$_/$_[0]");
498 }
499}
500
501sub get_sphinx_version()
502{
503 my $ver;
504
505 my $cmd = "sphinx-build";
506 if (!findprog($cmd)) {
507 my $cmd = "sphinx-build3";
508 if (!findprog($cmd)) {
509 $sphinx_major = 1;
510 $sphinx_minor = 2;
511 $sphinx_patch = 0;
512 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
513 $sphinx_major, $sphinx_minor, $sphinx_patch;
514 return;
515 }
516 }
517
518 open IN, "$cmd --version 2>&1 |";
519 while (<IN>) {
520 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
521 $sphinx_major = $1;
522 $sphinx_minor = $2;
523 $sphinx_patch = $3;
524 last;
525 }
526 # Sphinx 1.2.x uses a different format
527 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
528 $sphinx_major = $1;
529 $sphinx_minor = $2;
530 $sphinx_patch = $3;
531 last;
532 }
533 }
534 close IN;
535}
536
Marek Vasut30ff8912012-10-06 14:04:58 +0000537# get kernel version from env
538sub get_kernel_version() {
539 my $version = 'unknown kernel version';
540
Mario Six78a88f72018-07-10 08:40:17 +0200541 if (defined($ENV{'KERNELVERSION'})) {
542 $version = $ENV{'KERNELVERSION'};
Marek Vasut30ff8912012-10-06 14:04:58 +0000543 }
544 return $version;
545}
546
Mario Six78a88f72018-07-10 08:40:17 +0200547#
548sub print_lineno {
549 my $lineno = shift;
550 if ($enable_lineno && defined($lineno)) {
551 print "#define LINENO " . $lineno . "\n";
552 }
553}
Marek Vasut30ff8912012-10-06 14:04:58 +0000554##
555# dumps section contents to arrays/hashes intended for that purpose.
556#
557sub dump_section {
558 my $file = shift;
559 my $name = shift;
560 my $contents = join "\n", @_;
561
Mario Six78a88f72018-07-10 08:40:17 +0200562 if ($name =~ m/$type_param/) {
Marek Vasut30ff8912012-10-06 14:04:58 +0000563 $name = $1;
564 $parameterdescs{$name} = $contents;
565 $sectcheck = $sectcheck . $name . " ";
Mario Six78a88f72018-07-10 08:40:17 +0200566 $parameterdesc_start_lines{$name} = $new_start_line;
567 $new_start_line = 0;
Marek Vasut30ff8912012-10-06 14:04:58 +0000568 } elsif ($name eq "@\.\.\.") {
Marek Vasut30ff8912012-10-06 14:04:58 +0000569 $name = "...";
570 $parameterdescs{$name} = $contents;
571 $sectcheck = $sectcheck . $name . " ";
Mario Six78a88f72018-07-10 08:40:17 +0200572 $parameterdesc_start_lines{$name} = $new_start_line;
573 $new_start_line = 0;
Marek Vasut30ff8912012-10-06 14:04:58 +0000574 } else {
Marek Vasut30ff8912012-10-06 14:04:58 +0000575 if (defined($sections{$name}) && ($sections{$name} ne "")) {
Mario Six78a88f72018-07-10 08:40:17 +0200576 # Only warn on user specified duplicate section names.
577 if ($name ne $section_default) {
578 print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
579 ++$warnings;
580 }
581 $sections{$name} .= $contents;
582 } else {
583 $sections{$name} = $contents;
584 push @sectionlist, $name;
585 $section_start_lines{$name} = $new_start_line;
586 $new_start_line = 0;
Marek Vasut30ff8912012-10-06 14:04:58 +0000587 }
Marek Vasut30ff8912012-10-06 14:04:58 +0000588 }
589}
590
591##
592# dump DOC: section after checking that it should go out
593#
594sub dump_doc_section {
595 my $file = shift;
596 my $name = shift;
597 my $contents = join "\n", @_;
598
599 if ($no_doc_sections) {
Masahiro Yamadaced03292014-02-05 10:52:51 +0900600 return;
Marek Vasut30ff8912012-10-06 14:04:58 +0000601 }
602
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100603 return if (defined($nosymbol_table{$name}));
604
Mario Six78a88f72018-07-10 08:40:17 +0200605 if (($output_selection == OUTPUT_ALL) ||
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100606 (($output_selection == OUTPUT_INCLUDE) &&
607 defined($function_table{$name})))
Marek Vasut30ff8912012-10-06 14:04:58 +0000608 {
609 dump_section($file, $name, $contents);
610 output_blockhead({'sectionlist' => \@sectionlist,
611 'sections' => \%sections,
612 'module' => $modulename,
Mario Six78a88f72018-07-10 08:40:17 +0200613 'content-only' => ($output_selection != OUTPUT_ALL), });
Marek Vasut30ff8912012-10-06 14:04:58 +0000614 }
615}
616
617##
618# output function
619#
620# parameterdescs, a hash.
621# function => "function name"
622# parameterlist => @list of parameters
623# parameterdescs => %parameter descriptions
624# sectionlist => @list of sections
625# sections => %section descriptions
626#
627
628sub output_highlight {
629 my $contents = join "\n",@_;
630 my $line;
631
632# DEBUG
633# if (!defined $contents) {
634# use Carp;
635# confess "output_highlight got called with no args?\n";
636# }
637
Marek Vasut30ff8912012-10-06 14:04:58 +0000638# print STDERR "contents b4:$contents\n";
639 eval $dohighlight;
640 die $@ if $@;
641# print STDERR "contents af:$contents\n";
642
Marek Vasut30ff8912012-10-06 14:04:58 +0000643 foreach $line (split "\n", $contents) {
Masahiro Yamadaced03292014-02-05 10:52:51 +0900644 if (! $output_preformatted) {
645 $line =~ s/^\s*//;
646 }
Marek Vasut30ff8912012-10-06 14:04:58 +0000647 if ($line eq ""){
Masahiro Yamadaced03292014-02-05 10:52:51 +0900648 if (! $output_preformatted) {
Mario Six78a88f72018-07-10 08:40:17 +0200649 print $lineprefix, $blankline;
Masahiro Yamadaced03292014-02-05 10:52:51 +0900650 }
Marek Vasut30ff8912012-10-06 14:04:58 +0000651 } else {
Marek Vasut30ff8912012-10-06 14:04:58 +0000652 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
653 print "\\&$line";
654 } else {
655 print $lineprefix, $line;
656 }
657 }
658 print "\n";
659 }
660}
661
Marek Vasut30ff8912012-10-06 14:04:58 +0000662##
663# output function in man
664sub output_function_man(%) {
665 my %args = %{$_[0]};
666 my ($parameter, $section);
667 my $count;
668
Mario Six78a88f72018-07-10 08:40:17 +0200669 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000670
671 print ".SH NAME\n";
672 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
673
674 print ".SH SYNOPSIS\n";
675 if ($args{'functiontype'} ne "") {
676 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
677 } else {
678 print ".B \"" . $args{'function'} . "\n";
679 }
680 $count = 0;
681 my $parenth = "(";
682 my $post = ",";
683 foreach my $parameter (@{$args{'parameterlist'}}) {
684 if ($count == $#{$args{'parameterlist'}}) {
685 $post = ");";
686 }
687 $type = $args{'parametertypes'}{$parameter};
688 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
689 # pointer-to-function
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100690 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000691 } else {
692 $type =~ s/([^\*])$/$1 /;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100693 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000694 }
695 $count++;
696 $parenth = "";
697 }
698
699 print ".SH ARGUMENTS\n";
700 foreach $parameter (@{$args{'parameterlist'}}) {
701 my $parameter_name = $parameter;
702 $parameter_name =~ s/\[.*//;
703
704 print ".IP \"" . $parameter . "\" 12\n";
705 output_highlight($args{'parameterdescs'}{$parameter_name});
706 }
707 foreach $section (@{$args{'sectionlist'}}) {
708 print ".SH \"", uc $section, "\"\n";
709 output_highlight($args{'sections'}{$section});
710 }
711}
712
713##
714# output enum in man
715sub output_enum_man(%) {
716 my %args = %{$_[0]};
717 my ($parameter, $section);
718 my $count;
719
Mario Six78a88f72018-07-10 08:40:17 +0200720 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000721
722 print ".SH NAME\n";
723 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
724
725 print ".SH SYNOPSIS\n";
726 print "enum " . $args{'enum'} . " {\n";
727 $count = 0;
728 foreach my $parameter (@{$args{'parameterlist'}}) {
729 print ".br\n.BI \" $parameter\"\n";
730 if ($count == $#{$args{'parameterlist'}}) {
731 print "\n};\n";
732 last;
733 }
734 else {
735 print ", \n.br\n";
736 }
737 $count++;
738 }
739
740 print ".SH Constants\n";
741 foreach $parameter (@{$args{'parameterlist'}}) {
742 my $parameter_name = $parameter;
743 $parameter_name =~ s/\[.*//;
744
745 print ".IP \"" . $parameter . "\" 12\n";
746 output_highlight($args{'parameterdescs'}{$parameter_name});
747 }
748 foreach $section (@{$args{'sectionlist'}}) {
749 print ".SH \"$section\"\n";
750 output_highlight($args{'sections'}{$section});
751 }
752}
753
754##
755# output struct in man
756sub output_struct_man(%) {
757 my %args = %{$_[0]};
758 my ($parameter, $section);
759
Mario Six78a88f72018-07-10 08:40:17 +0200760 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000761
762 print ".SH NAME\n";
763 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
764
Mario Six78a88f72018-07-10 08:40:17 +0200765 my $declaration = $args{'definition'};
766 $declaration =~ s/\t/ /g;
767 $declaration =~ s/\n/"\n.br\n.BI \"/g;
Marek Vasut30ff8912012-10-06 14:04:58 +0000768 print ".SH SYNOPSIS\n";
769 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
Mario Six78a88f72018-07-10 08:40:17 +0200770 print ".BI \"$declaration\n};\n.br\n\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000771
772 print ".SH Members\n";
773 foreach $parameter (@{$args{'parameterlist'}}) {
774 ($parameter =~ /^#/) && next;
775
776 my $parameter_name = $parameter;
777 $parameter_name =~ s/\[.*//;
778
779 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
780 print ".IP \"" . $parameter . "\" 12\n";
781 output_highlight($args{'parameterdescs'}{$parameter_name});
782 }
783 foreach $section (@{$args{'sectionlist'}}) {
784 print ".SH \"$section\"\n";
785 output_highlight($args{'sections'}{$section});
786 }
787}
788
789##
790# output typedef in man
791sub output_typedef_man(%) {
792 my %args = %{$_[0]};
793 my ($parameter, $section);
794
Mario Six78a88f72018-07-10 08:40:17 +0200795 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000796
797 print ".SH NAME\n";
798 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
799
800 foreach $section (@{$args{'sectionlist'}}) {
801 print ".SH \"$section\"\n";
802 output_highlight($args{'sections'}{$section});
803 }
804}
805
806sub output_blockhead_man(%) {
807 my %args = %{$_[0]};
808 my ($parameter, $section);
809 my $count;
810
Mario Six78a88f72018-07-10 08:40:17 +0200811 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000812
813 foreach $section (@{$args{'sectionlist'}}) {
814 print ".SH \"$section\"\n";
815 output_highlight($args{'sections'}{$section});
816 }
817}
818
819##
Mario Six78a88f72018-07-10 08:40:17 +0200820# output in restructured text
821#
822
823#
824# This could use some work; it's used to output the DOC: sections, and
825# starts by putting out the name of the doc section itself, but that tends
826# to duplicate a header already in the template file.
827#
828sub output_blockhead_rst(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +0000829 my %args = %{$_[0]};
830 my ($parameter, $section);
Marek Vasut30ff8912012-10-06 14:04:58 +0000831
Mario Six78a88f72018-07-10 08:40:17 +0200832 foreach $section (@{$args{'sectionlist'}}) {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100833 next if (defined($nosymbol_table{$section}));
834
Mario Six78a88f72018-07-10 08:40:17 +0200835 if ($output_selection != OUTPUT_INCLUDE) {
836 print "**$section**\n\n";
837 }
838 print_lineno($section_start_lines{$section});
839 output_highlight_rst($args{'sections'}{$section});
840 print "\n";
841 }
842}
Marek Vasut30ff8912012-10-06 14:04:58 +0000843
Mario Six78a88f72018-07-10 08:40:17 +0200844#
845# Apply the RST highlights to a sub-block of text.
846#
847sub highlight_block($) {
848 # The dohighlight kludge requires the text be called $contents
849 my $contents = shift;
850 eval $dohighlight;
851 die $@ if $@;
852 return $contents;
853}
854
855#
856# Regexes used only here.
857#
858my $sphinx_literal = '^[^.].*::$';
859my $sphinx_cblock = '^\.\.\ +code-block::';
860
861sub output_highlight_rst {
862 my $input = join "\n",@_;
863 my $output = "";
864 my $line;
865 my $in_literal = 0;
866 my $litprefix;
867 my $block = "";
868
869 foreach $line (split "\n",$input) {
870 #
871 # If we're in a literal block, see if we should drop out
872 # of it. Otherwise pass the line straight through unmunged.
873 #
874 if ($in_literal) {
875 if (! ($line =~ /^\s*$/)) {
876 #
877 # If this is the first non-blank line in a literal
878 # block we need to figure out what the proper indent is.
879 #
880 if ($litprefix eq "") {
881 $line =~ /^(\s*)/;
882 $litprefix = '^' . $1;
883 $output .= $line . "\n";
884 } elsif (! ($line =~ /$litprefix/)) {
885 $in_literal = 0;
886 } else {
887 $output .= $line . "\n";
888 }
889 } else {
890 $output .= $line . "\n";
891 }
892 }
893 #
894 # Not in a literal block (or just dropped out)
895 #
896 if (! $in_literal) {
897 $block .= $line . "\n";
898 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
899 $in_literal = 1;
900 $litprefix = "";
901 $output .= highlight_block($block);
902 $block = ""
903 }
904 }
905 }
906
907 if ($block) {
908 $output .= highlight_block($block);
909 }
910 foreach $line (split "\n", $output) {
911 print $lineprefix . $line . "\n";
912 }
913}
914
915sub output_function_rst(%) {
916 my %args = %{$_[0]};
917 my ($parameter, $section);
918 my $oldprefix = $lineprefix;
919 my $start = "";
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100920 my $is_macro = 0;
Mario Six78a88f72018-07-10 08:40:17 +0200921
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100922 if ($sphinx_major < 3) {
923 if ($args{'typedef'}) {
924 print ".. c:type:: ". $args{'function'} . "\n\n";
925 print_lineno($declaration_start_line);
926 print " **Typedef**: ";
927 $lineprefix = "";
928 output_highlight_rst($args{'purpose'});
929 $start = "\n\n**Syntax**\n\n ``";
930 $is_macro = 1;
931 } else {
932 print ".. c:function:: ";
933 }
Marek Vasut30ff8912012-10-06 14:04:58 +0000934 } else {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100935 if ($args{'typedef'} || $args{'functiontype'} eq "") {
936 $is_macro = 1;
937 print ".. c:macro:: ". $args{'function'} . "\n\n";
938 } else {
939 print ".. c:function:: ";
940 }
941
942 if ($args{'typedef'}) {
943 print_lineno($declaration_start_line);
944 print " **Typedef**: ";
945 $lineprefix = "";
946 output_highlight_rst($args{'purpose'});
947 $start = "\n\n**Syntax**\n\n ``";
948 } else {
949 print "``" if ($is_macro);
950 }
Mario Six78a88f72018-07-10 08:40:17 +0200951 }
952 if ($args{'functiontype'} ne "") {
953 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
954 } else {
955 $start .= $args{'function'} . " (";
Marek Vasut30ff8912012-10-06 14:04:58 +0000956 }
957 print $start;
958
959 my $count = 0;
960 foreach my $parameter (@{$args{'parameterlist'}}) {
Mario Six78a88f72018-07-10 08:40:17 +0200961 if ($count ne 0) {
962 print ", ";
963 }
964 $count++;
Marek Vasut30ff8912012-10-06 14:04:58 +0000965 $type = $args{'parametertypes'}{$parameter};
Mario Six78a88f72018-07-10 08:40:17 +0200966
Marek Vasut30ff8912012-10-06 14:04:58 +0000967 if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
968 # pointer-to-function
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100969 print $1 . $parameter . ") (" . $2 . ")";
Marek Vasut30ff8912012-10-06 14:04:58 +0000970 } else {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100971 print $type;
Marek Vasut30ff8912012-10-06 14:04:58 +0000972 }
Mario Six78a88f72018-07-10 08:40:17 +0200973 }
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100974 if ($is_macro) {
975 print ")``\n\n";
Mario Six78a88f72018-07-10 08:40:17 +0200976 } else {
977 print ")\n\n";
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100978 }
979 if (!$args{'typedef'}) {
Mario Six78a88f72018-07-10 08:40:17 +0200980 print_lineno($declaration_start_line);
981 $lineprefix = " ";
982 output_highlight_rst($args{'purpose'});
983 print "\n";
Marek Vasut30ff8912012-10-06 14:04:58 +0000984 }
985
Mario Six78a88f72018-07-10 08:40:17 +0200986 print "**Parameters**\n\n";
987 $lineprefix = " ";
Marek Vasut30ff8912012-10-06 14:04:58 +0000988 foreach $parameter (@{$args{'parameterlist'}}) {
989 my $parameter_name = $parameter;
990 $parameter_name =~ s/\[.*//;
Mario Six78a88f72018-07-10 08:40:17 +0200991 $type = $args{'parametertypes'}{$parameter};
Marek Vasut30ff8912012-10-06 14:04:58 +0000992
Mario Six78a88f72018-07-10 08:40:17 +0200993 if ($type ne "") {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +0100994 print "``$type``\n";
Mario Six78a88f72018-07-10 08:40:17 +0200995 } else {
996 print "``$parameter``\n";
997 }
Marek Vasut30ff8912012-10-06 14:04:58 +0000998
Mario Six78a88f72018-07-10 08:40:17 +0200999 print_lineno($parameterdesc_start_lines{$parameter_name});
Marek Vasut30ff8912012-10-06 14:04:58 +00001000
Mario Six78a88f72018-07-10 08:40:17 +02001001 if (defined($args{'parameterdescs'}{$parameter_name}) &&
1002 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
1003 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1004 } else {
1005 print " *undescribed*\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001006 }
1007 print "\n";
1008 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001009
Mario Six78a88f72018-07-10 08:40:17 +02001010 $lineprefix = $oldprefix;
1011 output_section_rst(@_);
Marek Vasut30ff8912012-10-06 14:04:58 +00001012}
1013
Mario Six78a88f72018-07-10 08:40:17 +02001014sub output_section_rst(%) {
1015 my %args = %{$_[0]};
1016 my $section;
1017 my $oldprefix = $lineprefix;
1018 $lineprefix = "";
1019
1020 foreach $section (@{$args{'sectionlist'}}) {
1021 print "**$section**\n\n";
1022 print_lineno($section_start_lines{$section});
1023 output_highlight_rst($args{'sections'}{$section});
1024 print "\n";
1025 }
1026 print "\n";
1027 $lineprefix = $oldprefix;
1028}
1029
1030sub output_enum_rst(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001031 my %args = %{$_[0]};
1032 my ($parameter);
Mario Six78a88f72018-07-10 08:40:17 +02001033 my $oldprefix = $lineprefix;
Marek Vasut30ff8912012-10-06 14:04:58 +00001034 my $count;
Marek Vasut30ff8912012-10-06 14:04:58 +00001035
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001036 if ($sphinx_major < 3) {
1037 my $name = "enum " . $args{'enum'};
1038 print "\n\n.. c:type:: " . $name . "\n\n";
1039 } else {
1040 my $name = $args{'enum'};
1041 print "\n\n.. c:enum:: " . $name . "\n\n";
1042 }
Mario Six78a88f72018-07-10 08:40:17 +02001043 print_lineno($declaration_start_line);
1044 $lineprefix = " ";
1045 output_highlight_rst($args{'purpose'});
1046 print "\n";
1047
1048 print "**Constants**\n\n";
1049 $lineprefix = " ";
1050 foreach $parameter (@{$args{'parameterlist'}}) {
1051 print "``$parameter``\n";
1052 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
1053 output_highlight_rst($args{'parameterdescs'}{$parameter});
1054 } else {
1055 print " *undescribed*\n";
1056 }
1057 print "\n";
1058 }
1059
1060 $lineprefix = $oldprefix;
1061 output_section_rst(@_);
Marek Vasut30ff8912012-10-06 14:04:58 +00001062}
1063
Mario Six78a88f72018-07-10 08:40:17 +02001064sub output_typedef_rst(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001065 my %args = %{$_[0]};
1066 my ($parameter);
Mario Six78a88f72018-07-10 08:40:17 +02001067 my $oldprefix = $lineprefix;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001068 my $name;
Marek Vasut30ff8912012-10-06 14:04:58 +00001069
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001070 if ($sphinx_major < 3) {
1071 $name = "typedef " . $args{'typedef'};
1072 } else {
1073 $name = $args{'typedef'};
1074 }
Mario Six78a88f72018-07-10 08:40:17 +02001075 print "\n\n.. c:type:: " . $name . "\n\n";
1076 print_lineno($declaration_start_line);
1077 $lineprefix = " ";
1078 output_highlight_rst($args{'purpose'});
1079 print "\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001080
Mario Six78a88f72018-07-10 08:40:17 +02001081 $lineprefix = $oldprefix;
1082 output_section_rst(@_);
1083}
Marek Vasut30ff8912012-10-06 14:04:58 +00001084
Mario Six78a88f72018-07-10 08:40:17 +02001085sub output_struct_rst(%) {
1086 my %args = %{$_[0]};
1087 my ($parameter);
1088 my $oldprefix = $lineprefix;
Marek Vasut30ff8912012-10-06 14:04:58 +00001089
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001090 if ($sphinx_major < 3) {
1091 my $name = $args{'type'} . " " . $args{'struct'};
1092 print "\n\n.. c:type:: " . $name . "\n\n";
1093 } else {
1094 my $name = $args{'struct'};
1095 if ($args{'type'} eq 'union') {
1096 print "\n\n.. c:union:: " . $name . "\n\n";
1097 } else {
1098 print "\n\n.. c:struct:: " . $name . "\n\n";
1099 }
1100 }
Mario Six78a88f72018-07-10 08:40:17 +02001101 print_lineno($declaration_start_line);
1102 $lineprefix = " ";
1103 output_highlight_rst($args{'purpose'});
1104 print "\n";
1105
1106 print "**Definition**\n\n";
1107 print "::\n\n";
1108 my $declaration = $args{'definition'};
1109 $declaration =~ s/\t/ /g;
1110 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n";
1111
1112 print "**Members**\n\n";
1113 $lineprefix = " ";
Marek Vasut30ff8912012-10-06 14:04:58 +00001114 foreach $parameter (@{$args{'parameterlist'}}) {
1115 ($parameter =~ /^#/) && next;
1116
1117 my $parameter_name = $parameter;
1118 $parameter_name =~ s/\[.*//;
1119
1120 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Mario Six78a88f72018-07-10 08:40:17 +02001121 $type = $args{'parametertypes'}{$parameter};
1122 print_lineno($parameterdesc_start_lines{$parameter_name});
1123 print "``" . $parameter . "``\n";
1124 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
1125 print "\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001126 }
1127 print "\n";
Mario Six78a88f72018-07-10 08:40:17 +02001128
1129 $lineprefix = $oldprefix;
1130 output_section_rst(@_);
Marek Vasut30ff8912012-10-06 14:04:58 +00001131}
1132
Mario Six78a88f72018-07-10 08:40:17 +02001133## none mode output functions
Marek Vasut30ff8912012-10-06 14:04:58 +00001134
Mario Six78a88f72018-07-10 08:40:17 +02001135sub output_function_none(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001136}
1137
Mario Six78a88f72018-07-10 08:40:17 +02001138sub output_enum_none(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001139}
1140
Mario Six78a88f72018-07-10 08:40:17 +02001141sub output_typedef_none(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001142}
1143
Mario Six78a88f72018-07-10 08:40:17 +02001144sub output_struct_none(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001145}
1146
Mario Six78a88f72018-07-10 08:40:17 +02001147sub output_blockhead_none(%) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001148}
1149
1150##
1151# generic output function for all types (function, struct/union, typedef, enum);
1152# calls the generated, variable output_ function name based on
1153# functype and output_mode
1154sub output_declaration {
1155 no strict 'refs';
1156 my $name = shift;
1157 my $functype = shift;
1158 my $func = "output_${functype}_$output_mode";
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001159
1160 return if (defined($nosymbol_table{$name}));
1161
Mario Six78a88f72018-07-10 08:40:17 +02001162 if (($output_selection == OUTPUT_ALL) ||
1163 (($output_selection == OUTPUT_INCLUDE ||
1164 $output_selection == OUTPUT_EXPORTED) &&
1165 defined($function_table{$name})) ||
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001166 ($output_selection == OUTPUT_INTERNAL &&
Mario Six78a88f72018-07-10 08:40:17 +02001167 !($functype eq "function" && defined($function_table{$name}))))
Marek Vasut30ff8912012-10-06 14:04:58 +00001168 {
1169 &$func(@_);
1170 $section_counter++;
1171 }
1172}
1173
1174##
1175# generic output function - calls the right one based on current output mode.
1176sub output_blockhead {
1177 no strict 'refs';
1178 my $func = "output_blockhead_" . $output_mode;
1179 &$func(@_);
1180 $section_counter++;
1181}
1182
1183##
1184# takes a declaration (struct, union, enum, typedef) and
1185# invokes the right handler. NOT called for functions.
1186sub dump_declaration($$) {
1187 no strict 'refs';
1188 my ($prototype, $file) = @_;
1189 my $func = "dump_" . $decl_type;
1190 &$func(@_);
1191}
1192
1193sub dump_union($$) {
1194 dump_struct(@_);
1195}
1196
1197sub dump_struct($$) {
1198 my $x = shift;
1199 my $file = shift;
Marek Vasut30ff8912012-10-06 14:04:58 +00001200
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001201 if ($x =~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned|__attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) {
Mario Six78a88f72018-07-10 08:40:17 +02001202 my $decl_type = $1;
Marek Vasut30ff8912012-10-06 14:04:58 +00001203 $declaration_name = $2;
1204 my $members = $3;
1205
Marek Vasut30ff8912012-10-06 14:04:58 +00001206 # ignore members marked private:
Mario Six78a88f72018-07-10 08:40:17 +02001207 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1208 $members =~ s/\/\*\s*private:.*//gosi;
Marek Vasut30ff8912012-10-06 14:04:58 +00001209 # strip comments:
1210 $members =~ s/\/\*.*?\*\///gos;
Marek Vasut30ff8912012-10-06 14:04:58 +00001211 # strip attributes
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001212 $members =~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)/ /gi;
1213 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1214 $members =~ s/\s*__packed\s*/ /gos;
1215 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
1216 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
1217 $members =~ s/\s*____cacheline_aligned/ /gos;
1218
Mario Six78a88f72018-07-10 08:40:17 +02001219 # replace DECLARE_BITMAP
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001220 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
Mario Six78a88f72018-07-10 08:40:17 +02001221 $members =~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
1222 # replace DECLARE_HASHTABLE
1223 $members =~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
1224 # replace DECLARE_KFIFO
1225 $members =~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
1226 # replace DECLARE_KFIFO_PTR
1227 $members =~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos;
Marek Vasut30ff8912012-10-06 14:04:58 +00001228
Mario Six78a88f72018-07-10 08:40:17 +02001229 my $declaration = $members;
Marek Vasut30ff8912012-10-06 14:04:58 +00001230
Mario Six78a88f72018-07-10 08:40:17 +02001231 # Split nested struct/union elements as newer ones
1232 while ($members =~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/) {
1233 my $newmember;
1234 my $maintype = $1;
1235 my $ids = $4;
1236 my $content = $3;
1237 foreach my $id(split /,/, $ids) {
1238 $newmember .= "$maintype $id; ";
1239
1240 $id =~ s/[:\[].*//;
1241 $id =~ s/^\s*\**(\S+)\s*/$1/;
1242 foreach my $arg (split /;/, $content) {
1243 next if ($arg =~ m/^\s*$/);
1244 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1245 # pointer-to-function
1246 my $type = $1;
1247 my $name = $2;
1248 my $extra = $3;
1249 next if (!$name);
1250 if ($id =~ m/^\s*$/) {
1251 # anonymous struct/union
1252 $newmember .= "$type$name$extra; ";
1253 } else {
1254 $newmember .= "$type$id.$name$extra; ";
1255 }
1256 } else {
1257 my $type;
1258 my $names;
1259 $arg =~ s/^\s+//;
1260 $arg =~ s/\s+$//;
1261 # Handle bitmaps
1262 $arg =~ s/:\s*\d+\s*//g;
1263 # Handle arrays
1264 $arg =~ s/\[.*\]//g;
1265 # The type may have multiple words,
1266 # and multiple IDs can be defined, like:
1267 # const struct foo, *bar, foobar
1268 # So, we remove spaces when parsing the
1269 # names, in order to match just names
1270 # and commas for the names
1271 $arg =~ s/\s*,\s*/,/g;
1272 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1273 $type = $1;
1274 $names = $2;
1275 } else {
1276 $newmember .= "$arg; ";
1277 next;
1278 }
1279 foreach my $name (split /,/, $names) {
1280 $name =~ s/^\s*\**(\S+)\s*/$1/;
1281 next if (($name =~ m/^\s*$/));
1282 if ($id =~ m/^\s*$/) {
1283 # anonymous struct/union
1284 $newmember .= "$type $name; ";
1285 } else {
1286 $newmember .= "$type $id.$name; ";
1287 }
1288 }
1289 }
1290 }
1291 }
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001292 $members =~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$newmember/;
Mario Six78a88f72018-07-10 08:40:17 +02001293 }
1294
1295 # Ignore other nested elements, like enums
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001296 $members =~ s/(\{[^\{\}]*\})//g;
Mario Six78a88f72018-07-10 08:40:17 +02001297
1298 create_parameterlist($members, ';', $file, $declaration_name);
1299 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
1300
1301 # Adjust declaration for better display
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001302 $declaration =~ s/([\{;])/$1\n/g;
1303 $declaration =~ s/\}\s+;/};/g;
Mario Six78a88f72018-07-10 08:40:17 +02001304 # Better handle inlined enums
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001305 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
Mario Six78a88f72018-07-10 08:40:17 +02001306
1307 my @def_args = split /\n/, $declaration;
1308 my $level = 1;
1309 $declaration = "";
1310 foreach my $clause (@def_args) {
1311 $clause =~ s/^\s+//;
1312 $clause =~ s/\s+$//;
1313 $clause =~ s/\s+/ /;
1314 next if (!$clause);
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001315 $level-- if ($clause =~ m/(\})/ && $level > 1);
Mario Six78a88f72018-07-10 08:40:17 +02001316 if (!($clause =~ m/^\s*#/)) {
1317 $declaration .= "\t" x $level;
1318 }
1319 $declaration .= "\t" . $clause . "\n";
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001320 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
Mario Six78a88f72018-07-10 08:40:17 +02001321 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001322 output_declaration($declaration_name,
1323 'struct',
1324 {'struct' => $declaration_name,
1325 'module' => $modulename,
Mario Six78a88f72018-07-10 08:40:17 +02001326 'definition' => $declaration,
Marek Vasut30ff8912012-10-06 14:04:58 +00001327 'parameterlist' => \@parameterlist,
1328 'parameterdescs' => \%parameterdescs,
1329 'parametertypes' => \%parametertypes,
1330 'sectionlist' => \@sectionlist,
1331 'sections' => \%sections,
1332 'purpose' => $declaration_purpose,
1333 'type' => $decl_type
1334 });
1335 }
1336 else {
Mario Six78a88f72018-07-10 08:40:17 +02001337 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001338 ++$errors;
1339 }
1340}
1341
Mario Six78a88f72018-07-10 08:40:17 +02001342
1343sub show_warnings($$) {
1344 my $functype = shift;
1345 my $name = shift;
1346
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001347 return 0 if (defined($nosymbol_table{$name}));
1348
Mario Six78a88f72018-07-10 08:40:17 +02001349 return 1 if ($output_selection == OUTPUT_ALL);
1350
1351 if ($output_selection == OUTPUT_EXPORTED) {
1352 if (defined($function_table{$name})) {
1353 return 1;
1354 } else {
1355 return 0;
1356 }
1357 }
1358 if ($output_selection == OUTPUT_INTERNAL) {
1359 if (!($functype eq "function" && defined($function_table{$name}))) {
1360 return 1;
1361 } else {
1362 return 0;
1363 }
1364 }
1365 if ($output_selection == OUTPUT_INCLUDE) {
1366 if (defined($function_table{$name})) {
1367 return 1;
1368 } else {
1369 return 0;
1370 }
1371 }
Mario Six78a88f72018-07-10 08:40:17 +02001372 die("Please add the new output type at show_warnings()");
1373}
1374
Marek Vasut30ff8912012-10-06 14:04:58 +00001375sub dump_enum($$) {
1376 my $x = shift;
1377 my $file = shift;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001378 my $members;
1379
Marek Vasut30ff8912012-10-06 14:04:58 +00001380
1381 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Mario Six78a88f72018-07-10 08:40:17 +02001382 # strip #define macros inside enums
1383 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
Marek Vasut30ff8912012-10-06 14:04:58 +00001384
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001385 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1386 $declaration_name = $2;
1387 $members = $1;
1388 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001389 $declaration_name = $1;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001390 $members = $2;
1391 }
1392
1393 if ($members) {
Mario Six78a88f72018-07-10 08:40:17 +02001394 my %_members;
1395
1396 $members =~ s/\s+$//;
Marek Vasut30ff8912012-10-06 14:04:58 +00001397
1398 foreach my $arg (split ',', $members) {
1399 $arg =~ s/^\s*(\w+).*/$1/;
1400 push @parameterlist, $arg;
1401 if (!$parameterdescs{$arg}) {
1402 $parameterdescs{$arg} = $undescribed;
Mario Six78a88f72018-07-10 08:40:17 +02001403 if (show_warnings("enum", $declaration_name)) {
1404 print STDERR "${file}:$.: warning: Enum value '$arg' not described in enum '$declaration_name'\n";
1405 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001406 }
Mario Six78a88f72018-07-10 08:40:17 +02001407 $_members{$arg} = 1;
Marek Vasut30ff8912012-10-06 14:04:58 +00001408 }
1409
Mario Six78a88f72018-07-10 08:40:17 +02001410 while (my ($k, $v) = each %parameterdescs) {
1411 if (!exists($_members{$k})) {
1412 if (show_warnings("enum", $declaration_name)) {
1413 print STDERR "${file}:$.: warning: Excess enum value '$k' description in '$declaration_name'\n";
1414 }
1415 }
1416 }
1417
Marek Vasut30ff8912012-10-06 14:04:58 +00001418 output_declaration($declaration_name,
1419 'enum',
1420 {'enum' => $declaration_name,
1421 'module' => $modulename,
1422 'parameterlist' => \@parameterlist,
1423 'parameterdescs' => \%parameterdescs,
1424 'sectionlist' => \@sectionlist,
1425 'sections' => \%sections,
1426 'purpose' => $declaration_purpose
1427 });
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001428 } else {
Mario Six78a88f72018-07-10 08:40:17 +02001429 print STDERR "${file}:$.: error: Cannot parse enum!\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001430 ++$errors;
1431 }
1432}
1433
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001434my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
1435my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1436my $typedef_args = qr { \s*\((.*)\); }x;
1437
1438my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1439my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1440
Marek Vasut30ff8912012-10-06 14:04:58 +00001441sub dump_typedef($$) {
1442 my $x = shift;
1443 my $file = shift;
1444
1445 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Mario Six78a88f72018-07-10 08:40:17 +02001446
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001447 # Parse function typedef prototypes
1448 if ($x =~ $typedef1 || $x =~ $typedef2) {
Mario Six78a88f72018-07-10 08:40:17 +02001449 $return_type = $1;
1450 $declaration_name = $2;
1451 my $args = $3;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001452 $return_type =~ s/^\s+//;
Mario Six78a88f72018-07-10 08:40:17 +02001453
1454 create_parameterlist($args, ',', $file, $declaration_name);
1455
1456 output_declaration($declaration_name,
1457 'function',
1458 {'function' => $declaration_name,
1459 'typedef' => 1,
1460 'module' => $modulename,
1461 'functiontype' => $return_type,
1462 'parameterlist' => \@parameterlist,
1463 'parameterdescs' => \%parameterdescs,
1464 'parametertypes' => \%parametertypes,
1465 'sectionlist' => \@sectionlist,
1466 'sections' => \%sections,
1467 'purpose' => $declaration_purpose
1468 });
1469 return;
1470 }
1471
Marek Vasut30ff8912012-10-06 14:04:58 +00001472 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
1473 $x =~ s/\(*.\)\s*;$/;/;
1474 $x =~ s/\[*.\]\s*;$/;/;
1475 }
1476
1477 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
1478 $declaration_name = $1;
1479
1480 output_declaration($declaration_name,
1481 'typedef',
1482 {'typedef' => $declaration_name,
1483 'module' => $modulename,
1484 'sectionlist' => \@sectionlist,
1485 'sections' => \%sections,
1486 'purpose' => $declaration_purpose
1487 });
1488 }
1489 else {
Mario Six78a88f72018-07-10 08:40:17 +02001490 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001491 ++$errors;
1492 }
1493}
1494
1495sub save_struct_actual($) {
1496 my $actual = shift;
1497
1498 # strip all spaces from the actual param so that it looks like one string item
1499 $actual =~ s/\s*//g;
1500 $struct_actual = $struct_actual . $actual . " ";
1501}
1502
Mario Six78a88f72018-07-10 08:40:17 +02001503sub create_parameterlist($$$$) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001504 my $args = shift;
1505 my $splitter = shift;
1506 my $file = shift;
Mario Six78a88f72018-07-10 08:40:17 +02001507 my $declaration_name = shift;
Marek Vasut30ff8912012-10-06 14:04:58 +00001508 my $type;
1509 my $param;
1510
1511 # temporarily replace commas inside function pointer definition
1512 while ($args =~ /(\([^\),]+),/) {
1513 $args =~ s/(\([^\),]+),/$1#/g;
1514 }
1515
1516 foreach my $arg (split($splitter, $args)) {
1517 # strip comments
1518 $arg =~ s/\/\*.*\*\///;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001519 $arg =~ s/\s*EFIAPI\s*/ /g;
Marek Vasut30ff8912012-10-06 14:04:58 +00001520 # strip leading/trailing spaces
1521 $arg =~ s/^\s*//;
1522 $arg =~ s/\s*$//;
1523 $arg =~ s/\s+/ /;
1524
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001525
Marek Vasut30ff8912012-10-06 14:04:58 +00001526 if ($arg =~ /^#/) {
1527 # Treat preprocessor directive as a typeless variable just to fill
1528 # corresponding data structures "correctly". Catch it later in
1529 # output_* subs.
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001530 push_parameter($arg, "", "", $file);
Marek Vasut30ff8912012-10-06 14:04:58 +00001531 } elsif ($arg =~ m/\(.+\)\s*\(/) {
1532 # pointer-to-function
1533 $arg =~ tr/#/,/;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001534 $arg =~ m/[^\(]+\(\s*\*?\s*([\w\.]*)\s*\)/;
Marek Vasut30ff8912012-10-06 14:04:58 +00001535 $param = $1;
1536 $type = $arg;
1537 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
1538 save_struct_actual($param);
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001539 push_parameter($param, $type, $arg, $file, $declaration_name);
Marek Vasut30ff8912012-10-06 14:04:58 +00001540 } elsif ($arg) {
1541 $arg =~ s/\s*:\s*/:/g;
1542 $arg =~ s/\s*\[/\[/g;
1543
1544 my @args = split('\s*,\s*', $arg);
1545 if ($args[0] =~ m/\*/) {
1546 $args[0] =~ s/(\*+)\s*/ $1/;
1547 }
1548
1549 my @first_arg;
1550 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1551 shift @args;
1552 push(@first_arg, split('\s+', $1));
1553 push(@first_arg, $2);
1554 } else {
1555 @first_arg = split('\s+', shift @args);
1556 }
1557
1558 unshift(@args, pop @first_arg);
1559 $type = join " ", @first_arg;
1560
1561 foreach $param (@args) {
1562 if ($param =~ m/^(\*+)\s*(.*)/) {
1563 save_struct_actual($2);
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001564
1565 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
Marek Vasut30ff8912012-10-06 14:04:58 +00001566 }
1567 elsif ($param =~ m/(.*?):(\d+)/) {
1568 if ($type ne "") { # skip unnamed bit-fields
1569 save_struct_actual($1);
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001570 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
Marek Vasut30ff8912012-10-06 14:04:58 +00001571 }
1572 }
1573 else {
1574 save_struct_actual($param);
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001575 push_parameter($param, $type, $arg, $file, $declaration_name);
Marek Vasut30ff8912012-10-06 14:04:58 +00001576 }
1577 }
1578 }
1579 }
1580}
1581
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001582sub push_parameter($$$$$) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001583 my $param = shift;
1584 my $type = shift;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001585 my $org_arg = shift;
Marek Vasut30ff8912012-10-06 14:04:58 +00001586 my $file = shift;
Mario Six78a88f72018-07-10 08:40:17 +02001587 my $declaration_name = shift;
Marek Vasut30ff8912012-10-06 14:04:58 +00001588
1589 if (($anon_struct_union == 1) && ($type eq "") &&
1590 ($param eq "}")) {
1591 return; # ignore the ending }; from anon. struct/union
1592 }
1593
1594 $anon_struct_union = 0;
Mario Six78a88f72018-07-10 08:40:17 +02001595 $param =~ s/[\[\)].*//;
Marek Vasut30ff8912012-10-06 14:04:58 +00001596
1597 if ($type eq "" && $param =~ /\.\.\.$/)
1598 {
Mario Six78a88f72018-07-10 08:40:17 +02001599 if (!$param =~ /\w\.\.\.$/) {
1600 # handles unnamed variable parameters
1601 $param = "...";
1602 }
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001603 elsif ($param =~ /\w\.\.\.$/) {
1604 # for named variable parameters of the form `x...`, remove the dots
1605 $param =~ s/\.\.\.$//;
1606 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001607 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1608 $parameterdescs{$param} = "variable arguments";
1609 }
1610 }
1611 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1612 {
1613 $param="void";
1614 $parameterdescs{void} = "no arguments";
1615 }
1616 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1617 # handle unnamed (anonymous) union or struct:
1618 {
1619 $type = $param;
1620 $param = "{unnamed_" . $param . "}";
1621 $parameterdescs{$param} = "anonymous\n";
1622 $anon_struct_union = 1;
1623 }
1624
1625 # warn if parameter has no description
1626 # (but ignore ones starting with # as these are not parameters
1627 # but inline preprocessor statements);
Mario Six78a88f72018-07-10 08:40:17 +02001628 # Note: It will also ignore void params and unnamed structs/unions
1629 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
1630 $parameterdescs{$param} = $undescribed;
Marek Vasut30ff8912012-10-06 14:04:58 +00001631
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001632 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
Mario Six78a88f72018-07-10 08:40:17 +02001633 print STDERR
1634 "${file}:$.: warning: Function parameter or member '$param' not described in '$declaration_name'\n";
1635 ++$warnings;
1636 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001637 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001638
1639 # strip spaces from $param so that it is one continuous string
1640 # on @parameterlist;
1641 # this fixes a problem where check_sections() cannot find
1642 # a parameter like "addr[6 + 2]" because it actually appears
1643 # as "addr[6", "+", "2]" on the parameter list;
1644 # but it's better to maintain the param string unchanged for output,
1645 # so just weaken the string compare in check_sections() to ignore
1646 # "[blah" in a parameter string;
1647 ###$param =~ s/\s*//g;
1648 push @parameterlist, $param;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001649 $org_arg =~ s/\s\s+/ /g;
1650 $parametertypes{$param} = $org_arg;
Marek Vasut30ff8912012-10-06 14:04:58 +00001651}
1652
Mario Six78a88f72018-07-10 08:40:17 +02001653sub check_sections($$$$$) {
1654 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
Marek Vasut30ff8912012-10-06 14:04:58 +00001655 my @sects = split ' ', $sectcheck;
1656 my @prms = split ' ', $prmscheck;
1657 my $err;
1658 my ($px, $sx);
1659 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1660
1661 foreach $sx (0 .. $#sects) {
1662 $err = 1;
1663 foreach $px (0 .. $#prms) {
1664 $prm_clean = $prms[$px];
1665 $prm_clean =~ s/\[.*\]//;
1666 $prm_clean =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;
1667 # ignore array size in a parameter string;
1668 # however, the original param string may contain
1669 # spaces, e.g.: addr[6 + 2]
1670 # and this appears in @prms as "addr[6" since the
1671 # parameter list is split at spaces;
1672 # hence just ignore "[..." for the sections check;
1673 $prm_clean =~ s/\[.*//;
1674
1675 ##$prm_clean =~ s/^\**//;
1676 if ($prm_clean eq $sects[$sx]) {
1677 $err = 0;
1678 last;
1679 }
1680 }
1681 if ($err) {
1682 if ($decl_type eq "function") {
Mario Six78a88f72018-07-10 08:40:17 +02001683 print STDERR "${file}:$.: warning: " .
Marek Vasut30ff8912012-10-06 14:04:58 +00001684 "Excess function parameter " .
1685 "'$sects[$sx]' " .
1686 "description in '$decl_name'\n";
1687 ++$warnings;
Marek Vasut30ff8912012-10-06 14:04:58 +00001688 }
1689 }
1690 }
1691}
1692
1693##
Masahiro Yamadaced03292014-02-05 10:52:51 +09001694# Checks the section describing the return value of a function.
1695sub check_return_section {
1696 my $file = shift;
1697 my $declaration_name = shift;
1698 my $return_type = shift;
1699
1700 # Ignore an empty return type (It's a macro)
1701 # Ignore functions with a "void" return type. (But don't ignore "void *")
1702 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1703 return;
1704 }
1705
1706 if (!defined($sections{$section_return}) ||
1707 $sections{$section_return} eq "") {
Mario Six78a88f72018-07-10 08:40:17 +02001708 print STDERR "${file}:$.: warning: " .
Masahiro Yamadaced03292014-02-05 10:52:51 +09001709 "No description found for return value of " .
1710 "'$declaration_name'\n";
1711 ++$warnings;
1712 }
1713}
1714
1715##
Marek Vasut30ff8912012-10-06 14:04:58 +00001716# takes a function prototype and the name of the current file being
1717# processed and spits out all the details stored in the global
1718# arrays/hashes.
1719sub dump_function($$) {
1720 my $prototype = shift;
1721 my $file = shift;
Masahiro Yamada176d0982014-10-30 11:06:13 +09001722 my $noret = 0;
Marek Vasut30ff8912012-10-06 14:04:58 +00001723
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001724 print_lineno($new_start_line);
1725
Marek Vasut30ff8912012-10-06 14:04:58 +00001726 $prototype =~ s/^static +//;
1727 $prototype =~ s/^extern +//;
1728 $prototype =~ s/^asmlinkage +//;
1729 $prototype =~ s/^inline +//;
1730 $prototype =~ s/^__inline__ +//;
1731 $prototype =~ s/^__inline +//;
1732 $prototype =~ s/^__always_inline +//;
1733 $prototype =~ s/^noinline +//;
Marek Vasut30ff8912012-10-06 14:04:58 +00001734 $prototype =~ s/__init +//;
1735 $prototype =~ s/__init_or_module +//;
Masahiro Yamada176d0982014-10-30 11:06:13 +09001736 $prototype =~ s/__meminit +//;
Marek Vasut30ff8912012-10-06 14:04:58 +00001737 $prototype =~ s/__must_check +//;
1738 $prototype =~ s/__weak +//;
Mario Six78a88f72018-07-10 08:40:17 +02001739 $prototype =~ s/__sched +//;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001740 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
Masahiro Yamada176d0982014-10-30 11:06:13 +09001741 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
Mario Six78a88f72018-07-10 08:40:17 +02001742 $prototype =~ s/__attribute__\s*\(\(
1743 (?:
1744 [\w\s]++ # attribute name
1745 (?:\([^)]*+\))? # attribute arguments
1746 \s*+,? # optional comma at the end
1747 )+
1748 \)\)\s+//x;
Marek Vasut30ff8912012-10-06 14:04:58 +00001749
1750 # Yes, this truly is vile. We are looking for:
1751 # 1. Return type (may be nothing if we're looking at a macro)
1752 # 2. Function name
1753 # 3. Function parameters.
1754 #
1755 # All the while we have to watch out for function pointer parameters
1756 # (which IIRC is what the two sections are for), C types (these
1757 # regexps don't even start to express all the possibilities), and
1758 # so on.
1759 #
1760 # If you mess with these regexps, it's a good idea to check that
1761 # the following functions' documentation still comes out right:
1762 # - parport_register_device (function pointer parameters)
1763 # - atomic_set (macro)
1764 # - pci_match_device, __copy_to_user (long return type)
1765
Masahiro Yamada176d0982014-10-30 11:06:13 +09001766 if ($define && $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s+/) {
1767 # This is an object-like macro, it has no return type and no parameter
1768 # list.
1769 # Function-like macros are not allowed to have spaces between
1770 # declaration_name and opening parenthesis (notice the \s+).
1771 $return_type = $1;
1772 $declaration_name = $2;
1773 $noret = 1;
1774 } elsif ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Marek Vasut30ff8912012-10-06 14:04:58 +00001775 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Mario Six78a88f72018-07-10 08:40:17 +02001776 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Marek Vasut30ff8912012-10-06 14:04:58 +00001777 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1778 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
1779 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Mario Six78a88f72018-07-10 08:40:17 +02001780 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
Marek Vasut30ff8912012-10-06 14:04:58 +00001781 $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1782 $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Mario Six78a88f72018-07-10 08:40:17 +02001783 $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Marek Vasut30ff8912012-10-06 14:04:58 +00001784 $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Mario Six78a88f72018-07-10 08:40:17 +02001785 $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Marek Vasut30ff8912012-10-06 14:04:58 +00001786 $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Mario Six78a88f72018-07-10 08:40:17 +02001787 $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Marek Vasut30ff8912012-10-06 14:04:58 +00001788 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
Mario Six78a88f72018-07-10 08:40:17 +02001789 $prototype =~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
1790 $prototype =~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001791 $return_type = $1;
1792 $declaration_name = $2;
1793 my $args = $3;
1794
Mario Six78a88f72018-07-10 08:40:17 +02001795 create_parameterlist($args, ',', $file, $declaration_name);
Marek Vasut30ff8912012-10-06 14:04:58 +00001796 } else {
Mario Six78a88f72018-07-10 08:40:17 +02001797 print STDERR "${file}:$.: warning: cannot understand function prototype: '$prototype'\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00001798 return;
1799 }
1800
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001801 my $prms = join " ", @parameterlist;
1802 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
Marek Vasut30ff8912012-10-06 14:04:58 +00001803
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001804 # This check emits a lot of warnings at the moment, because many
1805 # functions don't have a 'Return' doc section. So until the number
1806 # of warnings goes sufficiently down, the check is only performed in
1807 # verbose mode.
1808 # TODO: always perform the check.
1809 if ($verbose && !$noret) {
1810 check_return_section($file, $declaration_name, $return_type);
1811 }
Masahiro Yamadaced03292014-02-05 10:52:51 +09001812
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001813 # The function parser can be called with a typedef parameter.
1814 # Handle it.
1815 if ($return_type =~ /typedef/) {
1816 output_declaration($declaration_name,
1817 'function',
1818 {'function' => $declaration_name,
1819 'typedef' => 1,
1820 'module' => $modulename,
1821 'functiontype' => $return_type,
1822 'parameterlist' => \@parameterlist,
1823 'parameterdescs' => \%parameterdescs,
1824 'parametertypes' => \%parametertypes,
1825 'sectionlist' => \@sectionlist,
1826 'sections' => \%sections,
1827 'purpose' => $declaration_purpose
1828 });
1829 } else {
1830 output_declaration($declaration_name,
1831 'function',
1832 {'function' => $declaration_name,
1833 'module' => $modulename,
1834 'functiontype' => $return_type,
1835 'parameterlist' => \@parameterlist,
1836 'parameterdescs' => \%parameterdescs,
1837 'parametertypes' => \%parametertypes,
1838 'sectionlist' => \@sectionlist,
1839 'sections' => \%sections,
1840 'purpose' => $declaration_purpose
1841 });
1842 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001843}
1844
1845sub reset_state {
1846 $function = "";
Marek Vasut30ff8912012-10-06 14:04:58 +00001847 %parameterdescs = ();
1848 %parametertypes = ();
1849 @parameterlist = ();
1850 %sections = ();
1851 @sectionlist = ();
1852 $sectcheck = "";
1853 $struct_actual = "";
1854 $prototype = "";
1855
Mario Six78a88f72018-07-10 08:40:17 +02001856 $state = STATE_NORMAL;
1857 $inline_doc_state = STATE_INLINE_NA;
Marek Vasut30ff8912012-10-06 14:04:58 +00001858}
1859
1860sub tracepoint_munge($) {
1861 my $file = shift;
1862 my $tracepointname = 0;
1863 my $tracepointargs = 0;
1864
1865 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
1866 $tracepointname = $1;
1867 }
1868 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1869 $tracepointname = $1;
1870 }
1871 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1872 $tracepointname = $2;
1873 }
1874 $tracepointname =~ s/^\s+//; #strip leading whitespace
1875 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
1876 $tracepointargs = $1;
1877 }
1878 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
Mario Six78a88f72018-07-10 08:40:17 +02001879 print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n".
Marek Vasut30ff8912012-10-06 14:04:58 +00001880 "$prototype\n";
1881 } else {
1882 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
1883 }
1884}
1885
1886sub syscall_munge() {
1887 my $void = 0;
1888
Mario Six78a88f72018-07-10 08:40:17 +02001889 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
Marek Vasut30ff8912012-10-06 14:04:58 +00001890## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1891 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1892 $void = 1;
1893## $prototype = "long sys_$1(void)";
1894 }
1895
1896 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1897 if ($prototype =~ m/long (sys_.*?),/) {
1898 $prototype =~ s/,/\(/;
1899 } elsif ($void) {
1900 $prototype =~ s/\)/\(void\)/;
1901 }
1902
1903 # now delete all of the odd-number commas in $prototype
1904 # so that arg types & arg names don't have a comma between them
1905 my $count = 0;
1906 my $len = length($prototype);
1907 if ($void) {
1908 $len = 0; # skip the for-loop
1909 }
1910 for (my $ix = 0; $ix < $len; $ix++) {
1911 if (substr($prototype, $ix, 1) eq ',') {
1912 $count++;
1913 if ($count % 2 == 1) {
1914 substr($prototype, $ix, 1) = ' ';
1915 }
1916 }
1917 }
1918}
1919
Mario Six78a88f72018-07-10 08:40:17 +02001920sub process_proto_function($$) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001921 my $x = shift;
1922 my $file = shift;
1923
1924 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1925
1926 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
1927 # do nothing
1928 }
1929 elsif ($x =~ /([^\{]*)/) {
1930 $prototype .= $1;
1931 }
1932
1933 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
1934 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
1935 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1936 $prototype =~ s@^\s+@@gos; # strip leading spaces
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01001937
1938 # Handle prototypes for function pointers like:
1939 # int (*pcs_config)(struct foo)
1940 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1941
Marek Vasut30ff8912012-10-06 14:04:58 +00001942 if ($prototype =~ /SYSCALL_DEFINE/) {
1943 syscall_munge();
1944 }
1945 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1946 $prototype =~ /DEFINE_SINGLE_EVENT/)
1947 {
1948 tracepoint_munge($file);
1949 }
1950 dump_function($prototype, $file);
1951 reset_state();
1952 }
1953}
1954
Mario Six78a88f72018-07-10 08:40:17 +02001955sub process_proto_type($$) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001956 my $x = shift;
1957 my $file = shift;
1958
1959 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1960 $x =~ s@^\s+@@gos; # strip leading spaces
1961 $x =~ s@\s+$@@gos; # strip trailing spaces
1962 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1963
1964 if ($x =~ /^#/) {
1965 # To distinguish preprocessor directive from regular declaration later.
1966 $x .= ";";
1967 }
1968
1969 while (1) {
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02001970 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
Mario Six78a88f72018-07-10 08:40:17 +02001971 if( length $prototype ) {
1972 $prototype .= " "
1973 }
Marek Vasut30ff8912012-10-06 14:04:58 +00001974 $prototype .= $1 . $2;
1975 ($2 eq '{') && $brcount++;
1976 ($2 eq '}') && $brcount--;
1977 if (($2 eq ';') && ($brcount == 0)) {
1978 dump_declaration($prototype, $file);
1979 reset_state();
1980 last;
1981 }
1982 $x = $3;
1983 } else {
1984 $prototype .= $x;
1985 last;
1986 }
1987 }
1988}
1989
Marek Vasut30ff8912012-10-06 14:04:58 +00001990
Mario Six78a88f72018-07-10 08:40:17 +02001991sub map_filename($) {
Marek Vasut30ff8912012-10-06 14:04:58 +00001992 my $file;
Mario Six78a88f72018-07-10 08:40:17 +02001993 my ($orig_file) = @_;
Marek Vasut30ff8912012-10-06 14:04:58 +00001994
1995 if (defined($ENV{'SRCTREE'})) {
Mario Six78a88f72018-07-10 08:40:17 +02001996 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1997 } else {
1998 $file = $orig_file;
Marek Vasut30ff8912012-10-06 14:04:58 +00001999 }
Mario Six78a88f72018-07-10 08:40:17 +02002000
Marek Vasut30ff8912012-10-06 14:04:58 +00002001 if (defined($source_map{$file})) {
2002 $file = $source_map{$file};
2003 }
2004
Mario Six78a88f72018-07-10 08:40:17 +02002005 return $file;
2006}
2007
2008sub process_export_file($) {
2009 my ($orig_file) = @_;
2010 my $file = map_filename($orig_file);
2011
2012 if (!open(IN,"<$file")) {
2013 print STDERR "Error: Cannot open file $file\n";
2014 ++$errors;
2015 return;
2016 }
2017
2018 while (<IN>) {
2019 if (/$export_symbol/) {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002020 next if (defined($nosymbol_table{$2}));
Mario Six78a88f72018-07-10 08:40:17 +02002021 $function_table{$2} = 1;
2022 }
2023 }
2024
2025 close(IN);
2026}
2027
2028#
2029# Parsers for the various processing states.
2030#
2031# STATE_NORMAL: looking for the /** to begin everything.
2032#
2033sub process_normal() {
2034 if (/$doc_start/o) {
2035 $state = STATE_NAME; # next line is always the function name
2036 $in_doc_sect = 0;
2037 $declaration_start_line = $. + 1;
2038 }
2039}
2040
2041#
2042# STATE_NAME: Looking for the "name - description" line
2043#
2044sub process_name($$) {
2045 my $file = shift;
2046 my $identifier;
2047 my $descr;
2048
2049 if (/$doc_block/o) {
2050 $state = STATE_DOCBLOCK;
2051 $contents = "";
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002052 $new_start_line = $.;
Mario Six78a88f72018-07-10 08:40:17 +02002053
2054 if ( $1 eq "" ) {
2055 $section = $section_intro;
2056 } else {
2057 $section = $1;
2058 }
2059 }
2060 elsif (/$doc_decl/o) {
2061 $identifier = $1;
2062 if (/\s*([\w\s]+?)(\(\))?\s*-/) {
2063 $identifier = $1;
2064 }
2065
2066 $state = STATE_BODY;
2067 # if there's no @param blocks need to set up default section
2068 # here
2069 $contents = "";
2070 $section = $section_default;
2071 $new_start_line = $. + 1;
2072 if (/-(.*)/) {
2073 # strip leading/trailing/multiple spaces
2074 $descr= $1;
2075 $descr =~ s/^\s*//;
2076 $descr =~ s/\s*$//;
2077 $descr =~ s/\s+/ /g;
2078 $declaration_purpose = $descr;
2079 $state = STATE_BODY_MAYBE;
2080 } else {
2081 $declaration_purpose = "";
2082 }
2083
2084 if (($declaration_purpose eq "") && $verbose) {
2085 print STDERR "${file}:$.: warning: missing initial short description on line:\n";
2086 print STDERR $_;
2087 ++$warnings;
2088 }
2089
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02002090 if ($identifier =~ m/^struct\b/) {
Mario Six78a88f72018-07-10 08:40:17 +02002091 $decl_type = 'struct';
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02002092 } elsif ($identifier =~ m/^union\b/) {
Mario Six78a88f72018-07-10 08:40:17 +02002093 $decl_type = 'union';
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02002094 } elsif ($identifier =~ m/^enum\b/) {
Mario Six78a88f72018-07-10 08:40:17 +02002095 $decl_type = 'enum';
Heinrich Schuchardtb7ab0982019-07-14 11:30:22 +02002096 } elsif ($identifier =~ m/^typedef\b/) {
Mario Six78a88f72018-07-10 08:40:17 +02002097 $decl_type = 'typedef';
2098 } else {
2099 $decl_type = 'function';
2100 }
2101
2102 if ($verbose) {
2103 print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
2104 }
2105 } else {
2106 print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",
2107 " - I thought it was a doc line\n";
2108 ++$warnings;
2109 $state = STATE_NORMAL;
2110 }
2111}
2112
2113
2114#
2115# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2116#
2117sub process_body($$) {
2118 my $file = shift;
2119
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002120 # Until all named variable macro parameters are
2121 # documented using the bare name (`x`) rather than with
2122 # dots (`x...`), strip the dots:
2123 if ($section =~ /\w\.\.\.$/) {
2124 $section =~ s/\.\.\.$//;
2125
2126 if ($verbose) {
2127 print STDERR "${file}:$.: warning: Variable macro arguments should be documented without dots\n";
2128 ++$warnings;
2129 }
2130 }
2131
2132 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2133 dump_section($file, $section, $contents);
2134 $section = $section_default;
2135 $new_start_line = $.;
2136 $contents = "";
2137 }
2138
Mario Six78a88f72018-07-10 08:40:17 +02002139 if (/$doc_sect/i) { # case insensitive for supported section names
2140 $newsection = $1;
2141 $newcontents = $2;
2142
2143 # map the supported section names to the canonical names
2144 if ($newsection =~ m/^description$/i) {
2145 $newsection = $section_default;
2146 } elsif ($newsection =~ m/^context$/i) {
2147 $newsection = $section_context;
2148 } elsif ($newsection =~ m/^returns?$/i) {
2149 $newsection = $section_return;
2150 } elsif ($newsection =~ m/^\@return$/) {
2151 # special: @return is a section, not a param description
2152 $newsection = $section_return;
2153 }
2154
2155 if (($contents ne "") && ($contents ne "\n")) {
2156 if (!$in_doc_sect && $verbose) {
2157 print STDERR "${file}:$.: warning: contents before sections\n";
2158 ++$warnings;
2159 }
2160 dump_section($file, $section, $contents);
2161 $section = $section_default;
2162 }
2163
2164 $in_doc_sect = 1;
2165 $state = STATE_BODY;
2166 $contents = $newcontents;
2167 $new_start_line = $.;
2168 while (substr($contents, 0, 1) eq " ") {
2169 $contents = substr($contents, 1);
2170 }
2171 if ($contents ne "") {
2172 $contents .= "\n";
2173 }
2174 $section = $newsection;
2175 $leading_space = undef;
2176 } elsif (/$doc_end/) {
2177 if (($contents ne "") && ($contents ne "\n")) {
2178 dump_section($file, $section, $contents);
2179 $section = $section_default;
2180 $contents = "";
2181 }
2182 # look for doc_com + <text> + doc_end:
2183 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
2184 print STDERR "${file}:$.: warning: suspicious ending line: $_";
2185 ++$warnings;
2186 }
2187
2188 $prototype = "";
2189 $state = STATE_PROTO;
2190 $brcount = 0;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002191 $new_start_line = $. + 1;
Mario Six78a88f72018-07-10 08:40:17 +02002192 } elsif (/$doc_content/) {
Mario Six78a88f72018-07-10 08:40:17 +02002193 if ($1 eq "") {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002194 if ($section eq $section_context) {
Mario Six78a88f72018-07-10 08:40:17 +02002195 dump_section($file, $section, $contents);
2196 $section = $section_default;
2197 $contents = "";
2198 $new_start_line = $.;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002199 $state = STATE_BODY;
Mario Six78a88f72018-07-10 08:40:17 +02002200 } else {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002201 if ($section ne $section_default) {
2202 $state = STATE_BODY_WITH_BLANK_LINE;
2203 } else {
2204 $state = STATE_BODY;
2205 }
Mario Six78a88f72018-07-10 08:40:17 +02002206 $contents .= "\n";
2207 }
Mario Six78a88f72018-07-10 08:40:17 +02002208 } elsif ($state == STATE_BODY_MAYBE) {
2209 # Continued declaration purpose
2210 chomp($declaration_purpose);
2211 $declaration_purpose .= " " . $1;
2212 $declaration_purpose =~ s/\s+/ /g;
2213 } else {
2214 my $cont = $1;
2215 if ($section =~ m/^@/ || $section eq $section_context) {
2216 if (!defined $leading_space) {
2217 if ($cont =~ m/^(\s+)/) {
2218 $leading_space = $1;
2219 } else {
2220 $leading_space = "";
2221 }
2222 }
2223 $cont =~ s/^$leading_space//;
2224 }
2225 $contents .= $cont . "\n";
2226 }
2227 } else {
2228 # i dont know - bad line? ignore.
2229 print STDERR "${file}:$.: warning: bad line: $_";
2230 ++$warnings;
2231 }
2232}
2233
2234
2235#
2236# STATE_PROTO: reading a function/whatever prototype.
2237#
2238sub process_proto($$) {
2239 my $file = shift;
2240
2241 if (/$doc_inline_oneline/) {
2242 $section = $1;
2243 $contents = $2;
2244 if ($contents ne "") {
2245 $contents .= "\n";
2246 dump_section($file, $section, $contents);
2247 $section = $section_default;
2248 $contents = "";
2249 }
2250 } elsif (/$doc_inline_start/) {
2251 $state = STATE_INLINE;
2252 $inline_doc_state = STATE_INLINE_NAME;
2253 } elsif ($decl_type eq 'function') {
2254 process_proto_function($_, $file);
2255 } else {
2256 process_proto_type($_, $file);
2257 }
2258}
2259
2260#
2261# STATE_DOCBLOCK: within a DOC: block.
2262#
2263sub process_docblock($$) {
2264 my $file = shift;
2265
2266 if (/$doc_end/) {
2267 dump_doc_section($file, $section, $contents);
2268 $section = $section_default;
2269 $contents = "";
2270 $function = "";
2271 %parameterdescs = ();
2272 %parametertypes = ();
2273 @parameterlist = ();
2274 %sections = ();
2275 @sectionlist = ();
2276 $prototype = "";
2277 $state = STATE_NORMAL;
2278 } elsif (/$doc_content/) {
2279 if ( $1 eq "" ) {
2280 $contents .= $blankline;
2281 } else {
2282 $contents .= $1 . "\n";
2283 }
2284 }
2285}
2286
2287#
2288# STATE_INLINE: docbook comments within a prototype.
2289#
2290sub process_inline($$) {
2291 my $file = shift;
2292
2293 # First line (state 1) needs to be a @parameter
2294 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2295 $section = $1;
2296 $contents = $2;
2297 $new_start_line = $.;
2298 if ($contents ne "") {
2299 while (substr($contents, 0, 1) eq " ") {
2300 $contents = substr($contents, 1);
2301 }
2302 $contents .= "\n";
2303 }
2304 $inline_doc_state = STATE_INLINE_TEXT;
2305 # Documentation block end */
2306 } elsif (/$doc_inline_end/) {
2307 if (($contents ne "") && ($contents ne "\n")) {
2308 dump_section($file, $section, $contents);
2309 $section = $section_default;
2310 $contents = "";
2311 }
2312 $state = STATE_PROTO;
2313 $inline_doc_state = STATE_INLINE_NA;
2314 # Regular text
2315 } elsif (/$doc_content/) {
2316 if ($inline_doc_state == STATE_INLINE_TEXT) {
2317 $contents .= $1 . "\n";
2318 # nuke leading blank lines
2319 if ($contents =~ /^\s*$/) {
2320 $contents = "";
2321 }
2322 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2323 $inline_doc_state = STATE_INLINE_ERROR;
2324 print STDERR "${file}:$.: warning: ";
2325 print STDERR "Incorrect use of kernel-doc format: $_";
2326 ++$warnings;
2327 }
2328 }
2329}
2330
2331
2332sub process_file($) {
2333 my $file;
2334 my $initial_section_counter = $section_counter;
2335 my ($orig_file) = @_;
2336
2337 $file = map_filename($orig_file);
2338
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002339 if (!open(IN_FILE,"<$file")) {
Marek Vasut30ff8912012-10-06 14:04:58 +00002340 print STDERR "Error: Cannot open file $file\n";
2341 ++$errors;
2342 return;
2343 }
2344
2345 $. = 1;
2346
2347 $section_counter = 0;
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002348 while (<IN_FILE>) {
Masahiro Yamadaced03292014-02-05 10:52:51 +09002349 while (s/\\\s*$//) {
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002350 $_ .= <IN_FILE>;
Masahiro Yamadaced03292014-02-05 10:52:51 +09002351 }
Mario Six78a88f72018-07-10 08:40:17 +02002352 # Replace tabs by spaces
2353 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
2354 # Hand this line to the appropriate state handler
2355 if ($state == STATE_NORMAL) {
2356 process_normal();
2357 } elsif ($state == STATE_NAME) {
2358 process_name($file, $_);
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002359 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2360 $state == STATE_BODY_WITH_BLANK_LINE) {
Mario Six78a88f72018-07-10 08:40:17 +02002361 process_body($file, $_);
2362 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
2363 process_inline($file, $_);
2364 } elsif ($state == STATE_PROTO) {
2365 process_proto($file, $_);
2366 } elsif ($state == STATE_DOCBLOCK) {
2367 process_docblock($file, $_);
Marek Vasut30ff8912012-10-06 14:04:58 +00002368 }
2369 }
Mario Six78a88f72018-07-10 08:40:17 +02002370
2371 # Make sure we got something interesting.
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002372 if ($initial_section_counter == $section_counter && $
2373 output_mode ne "none") {
2374 if ($output_selection == OUTPUT_INCLUDE) {
2375 print STDERR "${file}:1: warning: '$_' not found\n"
2376 for keys %function_table;
2377 }
2378 else {
Mario Six78a88f72018-07-10 08:40:17 +02002379 print STDERR "${file}:1: warning: no structured comments found\n";
Masahiro Yamadaced03292014-02-05 10:52:51 +09002380 }
Marek Vasut30ff8912012-10-06 14:04:58 +00002381 }
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002382 close IN_FILE;
Marek Vasut30ff8912012-10-06 14:04:58 +00002383}
2384
2385
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002386if ($output_mode eq "rst") {
2387 get_sphinx_version() if (!$sphinx_major);
2388}
2389
Marek Vasut30ff8912012-10-06 14:04:58 +00002390$kernelversion = get_kernel_version();
2391
2392# generate a sequence of code that will splice in highlighting information
2393# using the s// operator.
Mario Six78a88f72018-07-10 08:40:17 +02002394for (my $k = 0; $k < @highlights; $k++) {
2395 my $pattern = $highlights[$k][0];
2396 my $result = $highlights[$k][1];
2397# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2398 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
Marek Vasut30ff8912012-10-06 14:04:58 +00002399}
2400
2401# Read the file that maps relative names to absolute names for
2402# separate source and object directories and for shadow trees.
2403if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2404 my ($relname, $absname);
2405 while(<SOURCE_MAP>) {
2406 chop();
2407 ($relname, $absname) = (split())[0..1];
2408 $relname =~ s:^/+::;
2409 $source_map{$relname} = $absname;
2410 }
2411 close(SOURCE_MAP);
2412}
2413
Mario Six78a88f72018-07-10 08:40:17 +02002414if ($output_selection == OUTPUT_EXPORTED ||
2415 $output_selection == OUTPUT_INTERNAL) {
2416
2417 push(@export_file_list, @ARGV);
2418
2419 foreach (@export_file_list) {
2420 chomp;
2421 process_export_file($_);
2422 }
2423}
2424
Marek Vasut30ff8912012-10-06 14:04:58 +00002425foreach (@ARGV) {
2426 chomp;
2427 process_file($_);
2428}
2429if ($verbose && $errors) {
2430 print STDERR "$errors errors\n";
2431}
2432if ($verbose && $warnings) {
2433 print STDERR "$warnings warnings\n";
2434}
2435
Heinrich Schuchardt98f01cf2020-12-31 23:16:46 +01002436if ($Werror && $warnings) {
2437 print STDERR "$warnings warnings as Errors\n";
2438 exit($warnings);
2439} else {
2440 exit($output_mode eq "none" ? 0 : $errors)
2441}