1#!/usr/bin/env python3 2# SPDX-License-Identifier: GPL-2.0 3# Copyright(c) 2025: Mauro Carvalho Chehab <mchehab@kernel.org>. 4# 5# pylint: disable=C0301,C0302,R0904,R0912,R0913,R0914,R0915,R0917,R1702 6 7""" 8kdoc_parser 9=========== 10 11Read a C language source or header FILE and extract embedded 12documentation comments 13""" 14 15import sys 16import re 17from pprint import pformat 18 19from kdoc.kdoc_re import NestedMatch, KernRe 20from kdoc.kdoc_item import KdocItem 21 22# 23# Regular expressions used to parse kernel-doc markups at KernelDoc class. 24# 25# Let's declare them in lowercase outside any class to make it easier to 26# convert from the Perl script. 27# 28# As those are evaluated at the beginning, no need to cache them 29# 30 31# Allow whitespace at end of comment start. 32doc_start = KernRe(r'^/\*\*\s*$', cache=False) 33 34doc_end = KernRe(r'\*/', cache=False) 35doc_com = KernRe(r'\s*\*\s*', cache=False) 36doc_com_body = KernRe(r'\s*\* ?', cache=False) 37doc_decl = doc_com + KernRe(r'(\w+)', cache=False) 38 39# @params and a strictly limited set of supported section names 40# Specifically: 41# Match @word: 42# @...: 43# @{section-name}: 44# while trying to not match literal block starts like "example::" 45# 46known_section_names = 'description|context|returns?|notes?|examples?' 47known_sections = KernRe(known_section_names, flags = re.I) 48doc_sect = doc_com + \ 49 KernRe(r'\s*(@[.\w]+|@\.\.\.|' + known_section_names + r')\s*:([^:].*)?$', 50 flags=re.I, cache=False) 51 52doc_content = doc_com_body + KernRe(r'(.*)', cache=False) 53doc_inline_start = KernRe(r'^\s*/\*\*\s*$', cache=False) 54doc_inline_sect = KernRe(r'\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)', cache=False) 55doc_inline_end = KernRe(r'^\s*\*/\s*$', cache=False) 56doc_inline_oneline = KernRe(r'^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$', cache=False) 57 58export_symbol = KernRe(r'^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*', cache=False) 59export_symbol_ns = KernRe(r'^\s*EXPORT_SYMBOL_NS(_GPL)?\s*\(\s*(\w+)\s*,\s*"\S+"\)\s*', cache=False) 60 61type_param = KernRe(r"@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)", cache=False) 62 63# 64# Tests for the beginning of a kerneldoc block in its various forms. 65# 66doc_block = doc_com + KernRe(r'DOC:\s*(.*)?', cache=False) 67doc_begin_data = KernRe(r"^\s*\*?\s*(struct|union|enum|typedef|var)\b\s*(\w*)", cache = False) 68doc_begin_func = KernRe(str(doc_com) + # initial " * ' 69 r"(?:\w+\s*\*\s*)?" + # type (not captured) 70 r'(?:define\s+)?' + # possible "define" (not captured) 71 r'(\w+)\s*(?:\(\w*\))?\s*' + # name and optional "(...)" 72 r'(?:[-:].*)?$', # description (not captured) 73 cache = False) 74 75# 76# Here begins a long set of transformations to turn structure member prefixes 77# and macro invocations into something we can parse and generate kdoc for. 78# 79struct_args_pattern = r'([^,)]+)' 80 81struct_xforms = [ 82 # Strip attributes 83 (KernRe(r"__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)", flags=re.I | re.S, cache=False), ' '), 84 (KernRe(r'\s*__aligned\s*\([^;]*\)', re.S), ' '), 85 (KernRe(r'\s*__counted_by\s*\([^;]*\)', re.S), ' '), 86 (KernRe(r'\s*__counted_by_(le|be)\s*\([^;]*\)', re.S), ' '), 87 (KernRe(r'\s*__packed\s*', re.S), ' '), 88 (KernRe(r'\s*CRYPTO_MINALIGN_ATTR', re.S), ' '), 89 (KernRe(r'\s*__private', re.S), ' '), 90 (KernRe(r'\s*__rcu', re.S), ' '), 91 (KernRe(r'\s*____cacheline_aligned_in_smp', re.S), ' '), 92 (KernRe(r'\s*____cacheline_aligned', re.S), ' '), 93 (KernRe(r'\s*__cacheline_group_(begin|end)\([^\)]+\);'), ''), 94 # 95 # Unwrap struct_group macros based on this definition: 96 # __struct_group(TAG, NAME, ATTRS, MEMBERS...) 97 # which has variants like: struct_group(NAME, MEMBERS...) 98 # Only MEMBERS arguments require documentation. 99 # 100 # Parsing them happens on two steps: 101 # 102 # 1. drop struct group arguments that aren't at MEMBERS, 103 # storing them as STRUCT_GROUP(MEMBERS) 104 # 105 # 2. remove STRUCT_GROUP() ancillary macro. 106 # 107 # The original logic used to remove STRUCT_GROUP() using an 108 # advanced regex: 109 # 110 # \bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*; 111 # 112 # with two patterns that are incompatible with 113 # Python re module, as it has: 114 # 115 # - a recursive pattern: (?1) 116 # - an atomic grouping: (?>...) 117 # 118 # I tried a simpler version: but it didn't work either: 119 # \bSTRUCT_GROUP\(([^\)]+)\)[^;]*; 120 # 121 # As it doesn't properly match the end parenthesis on some cases. 122 # 123 # So, a better solution was crafted: there's now a NestedMatch 124 # class that ensures that delimiters after a search are properly 125 # matched. So, the implementation to drop STRUCT_GROUP() will be 126 # handled in separate. 127 # 128 (KernRe(r'\bstruct_group\s*\(([^,]*,)', re.S), r'STRUCT_GROUP('), 129 (KernRe(r'\bstruct_group_attr\s*\(([^,]*,){2}', re.S), r'STRUCT_GROUP('), 130 (KernRe(r'\bstruct_group_tagged\s*\(([^,]*),([^,]*),', re.S), r'struct \1 \2; STRUCT_GROUP('), 131 (KernRe(r'\b__struct_group\s*\(([^,]*,){3}', re.S), r'STRUCT_GROUP('), 132 # 133 # Replace macros 134 # 135 # TODO: use NestedMatch for FOO($1, $2, ...) matches 136 # 137 # it is better to also move those to the NestedMatch logic, 138 # to ensure that parentheses will be properly matched. 139 # 140 (KernRe(r'__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)', re.S), 141 r'DECLARE_BITMAP(\1, __ETHTOOL_LINK_MODE_MASK_NBITS)'), 142 (KernRe(r'DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)', re.S), 143 r'DECLARE_BITMAP(\1, PHY_INTERFACE_MODE_MAX)'), 144 (KernRe(r'DECLARE_BITMAP\s*\(' + struct_args_pattern + r',\s*' + struct_args_pattern + r'\)', 145 re.S), r'unsigned long \1[BITS_TO_LONGS(\2)]'), 146 (KernRe(r'DECLARE_HASHTABLE\s*\(' + struct_args_pattern + r',\s*' + struct_args_pattern + r'\)', 147 re.S), r'unsigned long \1[1 << ((\2) - 1)]'), 148 (KernRe(r'DECLARE_KFIFO\s*\(' + struct_args_pattern + r',\s*' + struct_args_pattern + 149 r',\s*' + struct_args_pattern + r'\)', re.S), r'\2 *\1'), 150 (KernRe(r'DECLARE_KFIFO_PTR\s*\(' + struct_args_pattern + r',\s*' + 151 struct_args_pattern + r'\)', re.S), r'\2 *\1'), 152 (KernRe(r'(?:__)?DECLARE_FLEX_ARRAY\s*\(' + struct_args_pattern + r',\s*' + 153 struct_args_pattern + r'\)', re.S), r'\1 \2[]'), 154 (KernRe(r'DEFINE_DMA_UNMAP_ADDR\s*\(' + struct_args_pattern + r'\)', re.S), r'dma_addr_t \1'), 155 (KernRe(r'DEFINE_DMA_UNMAP_LEN\s*\(' + struct_args_pattern + r'\)', re.S), r'__u32 \1'), 156] 157# 158# Regexes here are guaranteed to have the end delimiter matching 159# the start delimiter. Yet, right now, only one replace group 160# is allowed. 161# 162struct_nested_prefixes = [ 163 (re.compile(r'\bSTRUCT_GROUP\('), r'\1'), 164] 165 166# 167# Transforms for function prototypes 168# 169function_xforms = [ 170 (KernRe(r"^static +"), ""), 171 (KernRe(r"^extern +"), ""), 172 (KernRe(r"^asmlinkage +"), ""), 173 (KernRe(r"^inline +"), ""), 174 (KernRe(r"^__inline__ +"), ""), 175 (KernRe(r"^__inline +"), ""), 176 (KernRe(r"^__always_inline +"), ""), 177 (KernRe(r"^noinline +"), ""), 178 (KernRe(r"^__FORTIFY_INLINE +"), ""), 179 (KernRe(r"__init +"), ""), 180 (KernRe(r"__init_or_module +"), ""), 181 (KernRe(r"__deprecated +"), ""), 182 (KernRe(r"__flatten +"), ""), 183 (KernRe(r"__meminit +"), ""), 184 (KernRe(r"__must_check +"), ""), 185 (KernRe(r"__weak +"), ""), 186 (KernRe(r"__sched +"), ""), 187 (KernRe(r"_noprof"), ""), 188 (KernRe(r"__always_unused *"), ""), 189 (KernRe(r"__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +"), ""), 190 (KernRe(r"__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +"), ""), 191 (KernRe(r"__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +"), ""), 192 (KernRe(r"DECL_BUCKET_PARAMS\s*\(\s*(\S+)\s*,\s*(\S+)\s*\)"), r"\1, \2"), 193 (KernRe(r"__attribute_const__ +"), ""), 194 (KernRe(r"__attribute__\s*\(\((?:[\w\s]+(?:\([^)]*\))?\s*,?)+\)\)\s+"), ""), 195] 196 197# 198# Apply a set of transforms to a block of text. 199# 200def apply_transforms(xforms, text): 201 for search, subst in xforms: 202 text = search.sub(subst, text) 203 return text 204 205# 206# A little helper to get rid of excess white space 207# 208multi_space = KernRe(r'\s\s+') 209def trim_whitespace(s): 210 return multi_space.sub(' ', s.strip()) 211 212# 213# Remove struct/enum members that have been marked "private". 214# 215def trim_private_members(text): 216 # 217 # First look for a "public:" block that ends a private region, then 218 # handle the "private until the end" case. 219 # 220 text = KernRe(r'/\*\s*private:.*?/\*\s*public:.*?\*/', flags=re.S).sub('', text) 221 text = KernRe(r'/\*\s*private:.*', flags=re.S).sub('', text) 222 # 223 # We needed the comments to do the above, but now we can take them out. 224 # 225 return KernRe(r'\s*/\*.*?\*/\s*', flags=re.S).sub('', text).strip() 226 227class state: 228 """ 229 State machine enums 230 """ 231 232 # Parser states 233 NORMAL = 0 # normal code 234 NAME = 1 # looking for function name 235 DECLARATION = 2 # We have seen a declaration which might not be done 236 BODY = 3 # the body of the comment 237 SPECIAL_SECTION = 4 # doc section ending with a blank line 238 PROTO = 5 # scanning prototype 239 DOCBLOCK = 6 # documentation block 240 INLINE_NAME = 7 # gathering doc outside main block 241 INLINE_TEXT = 8 # reading the body of inline docs 242 243 name = [ 244 "NORMAL", 245 "NAME", 246 "DECLARATION", 247 "BODY", 248 "SPECIAL_SECTION", 249 "PROTO", 250 "DOCBLOCK", 251 "INLINE_NAME", 252 "INLINE_TEXT", 253 ] 254 255 256SECTION_DEFAULT = "Description" # default section 257 258class KernelEntry: 259 260 def __init__(self, config, fname, ln): 261 self.config = config 262 self.fname = fname 263 264 self._contents = [] 265 self.prototype = "" 266 267 self.warnings = [] 268 269 self.parameterlist = [] 270 self.parameterdescs = {} 271 self.parametertypes = {} 272 self.parameterdesc_start_lines = {} 273 274 self.section_start_lines = {} 275 self.sections = {} 276 277 self.anon_struct_union = False 278 279 self.leading_space = None 280 281 self.fname = fname 282 283 # State flags 284 self.brcount = 0 285 self.declaration_start_line = ln + 1 286 287 # 288 # Management of section contents 289 # 290 def add_text(self, text): 291 self._contents.append(text) 292 293 def contents(self): 294 return '\n'.join(self._contents) + '\n' 295 296 # TODO: rename to emit_message after removal of kernel-doc.pl 297 def emit_msg(self, ln, msg, *, warning=True): 298 """Emit a message""" 299 300 log_msg = f"{self.fname}:{ln} {msg}" 301 302 if not warning: 303 self.config.log.info(log_msg) 304 return 305 306 # Delegate warning output to output logic, as this way it 307 # will report warnings/info only for symbols that are output 308 309 self.warnings.append(log_msg) 310 return 311 312 # 313 # Begin a new section. 314 # 315 def begin_section(self, line_no, title = SECTION_DEFAULT, dump = False): 316 if dump: 317 self.dump_section(start_new = True) 318 self.section = title 319 self.new_start_line = line_no 320 321 def dump_section(self, start_new=True): 322 """ 323 Dumps section contents to arrays/hashes intended for that purpose. 324 """ 325 # 326 # If we have accumulated no contents in the default ("description") 327 # section, don't bother. 328 # 329 if self.section == SECTION_DEFAULT and not self._contents: 330 return 331 name = self.section 332 contents = self.contents() 333 334 if type_param.match(name): 335 name = type_param.group(1) 336 337 self.parameterdescs[name] = contents 338 self.parameterdesc_start_lines[name] = self.new_start_line 339 340 self.new_start_line = 0 341 342 else: 343 if name in self.sections and self.sections[name] != "": 344 # Only warn on user-specified duplicate section names 345 if name != SECTION_DEFAULT: 346 self.emit_msg(self.new_start_line, 347 f"duplicate section name '{name}'") 348 # Treat as a new paragraph - add a blank line 349 self.sections[name] += '\n' + contents 350 else: 351 self.sections[name] = contents 352 self.section_start_lines[name] = self.new_start_line 353 self.new_start_line = 0 354 355# self.config.log.debug("Section: %s : %s", name, pformat(vars(self))) 356 357 if start_new: 358 self.section = SECTION_DEFAULT 359 self._contents = [] 360 361python_warning = False 362 363class KernelDoc: 364 """ 365 Read a C language source or header FILE and extract embedded 366 documentation comments. 367 """ 368 369 # Section names 370 371 section_context = "Context" 372 section_return = "Return" 373 374 undescribed = "-- undescribed --" 375 376 def __init__(self, config, fname): 377 """Initialize internal variables""" 378 379 self.fname = fname 380 self.config = config 381 382 # Initial state for the state machines 383 self.state = state.NORMAL 384 385 # Store entry currently being processed 386 self.entry = None 387 388 # Place all potential outputs into an array 389 self.entries = [] 390 391 # 392 # We need Python 3.7 for its "dicts remember the insertion 393 # order" guarantee 394 # 395 global python_warning 396 if (not python_warning and 397 sys.version_info.major == 3 and sys.version_info.minor < 7): 398 399 self.emit_msg(0, 400 'Python 3.7 or later is required for correct results') 401 python_warning = True 402 403 def emit_msg(self, ln, msg, *, warning=True): 404 """Emit a message""" 405 406 if self.entry: 407 self.entry.emit_msg(ln, msg, warning=warning) 408 return 409 410 log_msg = f"{self.fname}:{ln} {msg}" 411 412 if warning: 413 self.config.log.warning(log_msg) 414 else: 415 self.config.log.info(log_msg) 416 417 def dump_section(self, start_new=True): 418 """ 419 Dumps section contents to arrays/hashes intended for that purpose. 420 """ 421 422 if self.entry: 423 self.entry.dump_section(start_new) 424 425 # TODO: rename it to store_declaration after removal of kernel-doc.pl 426 def output_declaration(self, dtype, name, **args): 427 """ 428 Stores the entry into an entry array. 429 430 The actual output and output filters will be handled elsewhere 431 """ 432 433 item = KdocItem(name, self.fname, dtype, 434 self.entry.declaration_start_line, **args) 435 item.warnings = self.entry.warnings 436 437 # Drop empty sections 438 # TODO: improve empty sections logic to emit warnings 439 sections = self.entry.sections 440 for section in ["Description", "Return"]: 441 if section in sections and not sections[section].rstrip(): 442 del sections[section] 443 item.set_sections(sections, self.entry.section_start_lines) 444 item.set_params(self.entry.parameterlist, self.entry.parameterdescs, 445 self.entry.parametertypes, 446 self.entry.parameterdesc_start_lines) 447 self.entries.append(item) 448 449 self.config.log.debug("Output: %s:%s = %s", dtype, name, pformat(args)) 450 451 def reset_state(self, ln): 452 """ 453 Ancillary routine to create a new entry. It initializes all 454 variables used by the state machine. 455 """ 456 457 # 458 # Flush the warnings out before we proceed further 459 # 460 if self.entry and self.entry not in self.entries: 461 for log_msg in self.entry.warnings: 462 self.config.log.warning(log_msg) 463 464 self.entry = KernelEntry(self.config, self.fname, ln) 465 466 # State flags 467 self.state = state.NORMAL 468 469 def push_parameter(self, ln, decl_type, param, dtype, 470 org_arg, declaration_name): 471 """ 472 Store parameters and their descriptions at self.entry. 473 """ 474 475 if self.entry.anon_struct_union and dtype == "" and param == "}": 476 return # Ignore the ending }; from anonymous struct/union 477 478 self.entry.anon_struct_union = False 479 480 param = KernRe(r'[\[\)].*').sub('', param, count=1) 481 482 # 483 # Look at various "anonymous type" cases. 484 # 485 if dtype == '': 486 if param.endswith("..."): 487 if len(param) > 3: # there is a name provided, use that 488 param = param[:-3] 489 if not self.entry.parameterdescs.get(param): 490 self.entry.parameterdescs[param] = "variable arguments" 491 492 elif (not param) or param == "void": 493 param = "void" 494 self.entry.parameterdescs[param] = "no arguments" 495 496 elif param in ["struct", "union"]: 497 # Handle unnamed (anonymous) union or struct 498 dtype = param 499 param = "{unnamed_" + param + "}" 500 self.entry.parameterdescs[param] = "anonymous\n" 501 self.entry.anon_struct_union = True 502 503 # Warn if parameter has no description 504 # (but ignore ones starting with # as these are not parameters 505 # but inline preprocessor statements) 506 if param not in self.entry.parameterdescs and not param.startswith("#"): 507 self.entry.parameterdescs[param] = self.undescribed 508 509 if "." not in param: 510 if decl_type == 'function': 511 dname = f"{decl_type} parameter" 512 else: 513 dname = f"{decl_type} member" 514 515 self.emit_msg(ln, 516 f"{dname} '{param}' not described in '{declaration_name}'") 517 518 # Strip spaces from param so that it is one continuous string on 519 # parameterlist. This fixes a problem where check_sections() 520 # cannot find a parameter like "addr[6 + 2]" because it actually 521 # appears as "addr[6", "+", "2]" on the parameter list. 522 # However, it's better to maintain the param string unchanged for 523 # output, so just weaken the string compare in check_sections() 524 # to ignore "[blah" in a parameter string. 525 526 self.entry.parameterlist.append(param) 527 org_arg = KernRe(r'\s\s+').sub(' ', org_arg) 528 self.entry.parametertypes[param] = org_arg 529 530 531 def create_parameter_list(self, ln, decl_type, args, 532 splitter, declaration_name): 533 """ 534 Creates a list of parameters, storing them at self.entry. 535 """ 536 537 # temporarily replace all commas inside function pointer definition 538 arg_expr = KernRe(r'(\([^\),]+),') 539 while arg_expr.search(args): 540 args = arg_expr.sub(r"\1#", args) 541 542 for arg in args.split(splitter): 543 # Ignore argument attributes 544 arg = KernRe(r'\sPOS0?\s').sub(' ', arg) 545 546 # Strip leading/trailing spaces 547 arg = arg.strip() 548 arg = KernRe(r'\s+').sub(' ', arg, count=1) 549 550 if arg.startswith('#'): 551 # Treat preprocessor directive as a typeless variable just to fill 552 # corresponding data structures "correctly". Catch it later in 553 # output_* subs. 554 555 # Treat preprocessor directive as a typeless variable 556 self.push_parameter(ln, decl_type, arg, "", 557 "", declaration_name) 558 # 559 # The pointer-to-function case. 560 # 561 elif KernRe(r'\(.+\)\s*\(').search(arg): 562 arg = arg.replace('#', ',') 563 r = KernRe(r'[^\(]+\(\*?\s*' # Everything up to "(*" 564 r'([\w\[\].]*)' # Capture the name and possible [array] 565 r'\s*\)') # Make sure the trailing ")" is there 566 if r.match(arg): 567 param = r.group(1) 568 else: 569 self.emit_msg(ln, f"Invalid param: {arg}") 570 param = arg 571 dtype = arg.replace(param, '') 572 self.push_parameter(ln, decl_type, param, dtype, arg, declaration_name) 573 # 574 # The array-of-pointers case. Dig the parameter name out from the middle 575 # of the declaration. 576 # 577 elif KernRe(r'\(.+\)\s*\[').search(arg): 578 r = KernRe(r'[^\(]+\(\s*\*\s*' # Up to "(" and maybe "*" 579 r'([\w.]*?)' # The actual pointer name 580 r'\s*(\[\s*\w+\s*\]\s*)*\)') # The [array portion] 581 if r.match(arg): 582 param = r.group(1) 583 else: 584 self.emit_msg(ln, f"Invalid param: {arg}") 585 param = arg 586 dtype = arg.replace(param, '') 587 self.push_parameter(ln, decl_type, param, dtype, arg, declaration_name) 588 elif arg: 589 # 590 # Clean up extraneous spaces and split the string at commas; the first 591 # element of the resulting list will also include the type information. 592 # 593 arg = KernRe(r'\s*:\s*').sub(":", arg) 594 arg = KernRe(r'\s*\[').sub('[', arg) 595 args = KernRe(r'\s*,\s*').split(arg) 596 args[0] = re.sub(r'(\*+)\s*', r' \1', args[0]) 597 # 598 # args[0] has a string of "type a". If "a" includes an [array] 599 # declaration, we want to not be fooled by any white space inside 600 # the brackets, so detect and handle that case specially. 601 # 602 r = KernRe(r'^([^[\]]*\s+)(.*)$') 603 if r.match(args[0]): 604 args[0] = r.group(2) 605 dtype = r.group(1) 606 else: 607 # No space in args[0]; this seems wrong but preserves previous behavior 608 dtype = '' 609 610 bitfield_re = KernRe(r'(.*?):(\w+)') 611 for param in args: 612 # 613 # For pointers, shift the star(s) from the variable name to the 614 # type declaration. 615 # 616 r = KernRe(r'^(\*+)\s*(.*)') 617 if r.match(param): 618 self.push_parameter(ln, decl_type, r.group(2), 619 f"{dtype} {r.group(1)}", 620 arg, declaration_name) 621 # 622 # Perform a similar shift for bitfields. 623 # 624 elif bitfield_re.search(param): 625 if dtype != "": # Skip unnamed bit-fields 626 self.push_parameter(ln, decl_type, bitfield_re.group(1), 627 f"{dtype}:{bitfield_re.group(2)}", 628 arg, declaration_name) 629 else: 630 self.push_parameter(ln, decl_type, param, dtype, 631 arg, declaration_name) 632 633 def check_sections(self, ln, decl_name, decl_type): 634 """ 635 Check for errors inside sections, emitting warnings if not found 636 parameters are described. 637 """ 638 for section in self.entry.sections: 639 if section not in self.entry.parameterlist and \ 640 not known_sections.search(section): 641 if decl_type == 'function': 642 dname = f"{decl_type} parameter" 643 else: 644 dname = f"{decl_type} member" 645 self.emit_msg(ln, 646 f"Excess {dname} '{section}' description in '{decl_name}'") 647 648 def check_return_section(self, ln, declaration_name, return_type): 649 """ 650 If the function doesn't return void, warns about the lack of a 651 return description. 652 """ 653 654 if not self.config.wreturn: 655 return 656 657 # Ignore an empty return type (It's a macro) 658 # Ignore functions with a "void" return type (but not "void *") 659 if not return_type or KernRe(r'void\s*\w*\s*$').search(return_type): 660 return 661 662 if not self.entry.sections.get("Return", None): 663 self.emit_msg(ln, 664 f"No description found for return value of '{declaration_name}'") 665 666 # 667 # Split apart a structure prototype; returns (struct|union, name, members) or None 668 # 669 def split_struct_proto(self, proto): 670 type_pattern = r'(struct|union)' 671 qualifiers = [ 672 "__attribute__", 673 "__packed", 674 "__aligned", 675 "____cacheline_aligned_in_smp", 676 "____cacheline_aligned", 677 ] 678 definition_body = r'\{(.*)\}\s*' + "(?:" + '|'.join(qualifiers) + ")?" 679 680 r = KernRe(type_pattern + r'\s+(\w+)\s*' + definition_body) 681 if r.search(proto): 682 return (r.group(1), r.group(2), r.group(3)) 683 else: 684 r = KernRe(r'typedef\s+' + type_pattern + r'\s*' + definition_body + r'\s*(\w+)\s*;') 685 if r.search(proto): 686 return (r.group(1), r.group(3), r.group(2)) 687 return None 688 # 689 # Rewrite the members of a structure or union for easier formatting later on. 690 # Among other things, this function will turn a member like: 691 # 692 # struct { inner_members; } foo; 693 # 694 # into: 695 # 696 # struct foo; inner_members; 697 # 698 def rewrite_struct_members(self, members): 699 # 700 # Process struct/union members from the most deeply nested outward. The 701 # trick is in the ^{ below - it prevents a match of an outer struct/union 702 # until the inner one has been munged (removing the "{" in the process). 703 # 704 struct_members = KernRe(r'(struct|union)' # 0: declaration type 705 r'([^\{\};]+)' # 1: possible name 706 r'(\{)' 707 r'([^\{\}]*)' # 3: Contents of declaration 708 r'(\})' 709 r'([^\{\};]*)(;)') # 5: Remaining stuff after declaration 710 tuples = struct_members.findall(members) 711 while tuples: 712 for t in tuples: 713 newmember = "" 714 oldmember = "".join(t) # Reconstruct the original formatting 715 dtype, name, lbr, content, rbr, rest, semi = t 716 # 717 # Pass through each field name, normalizing the form and formatting. 718 # 719 for s_id in rest.split(','): 720 s_id = s_id.strip() 721 newmember += f"{dtype} {s_id}; " 722 # 723 # Remove bitfield/array/pointer info, getting the bare name. 724 # 725 s_id = KernRe(r'[:\[].*').sub('', s_id) 726 s_id = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', s_id) 727 # 728 # Pass through the members of this inner structure/union. 729 # 730 for arg in content.split(';'): 731 arg = arg.strip() 732 # 733 # Look for (type)(*name)(args) - pointer to function 734 # 735 r = KernRe(r'^([^\(]+\(\*?\s*)([\w.]*)(\s*\).*)') 736 if r.match(arg): 737 dtype, name, extra = r.group(1), r.group(2), r.group(3) 738 # Pointer-to-function 739 if not s_id: 740 # Anonymous struct/union 741 newmember += f"{dtype}{name}{extra}; " 742 else: 743 newmember += f"{dtype}{s_id}.{name}{extra}; " 744 # 745 # Otherwise a non-function member. 746 # 747 else: 748 # 749 # Remove bitmap and array portions and spaces around commas 750 # 751 arg = KernRe(r':\s*\d+\s*').sub('', arg) 752 arg = KernRe(r'\[.*\]').sub('', arg) 753 arg = KernRe(r'\s*,\s*').sub(',', arg) 754 # 755 # Look for a normal decl - "type name[,name...]" 756 # 757 r = KernRe(r'(.*)\s+([\S+,]+)') 758 if r.search(arg): 759 for name in r.group(2).split(','): 760 name = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', name) 761 if not s_id: 762 # Anonymous struct/union 763 newmember += f"{r.group(1)} {name}; " 764 else: 765 newmember += f"{r.group(1)} {s_id}.{name}; " 766 else: 767 newmember += f"{arg}; " 768 # 769 # At the end of the s_id loop, replace the original declaration with 770 # the munged version. 771 # 772 members = members.replace(oldmember, newmember) 773 # 774 # End of the tuple loop - search again and see if there are outer members 775 # that now turn up. 776 # 777 tuples = struct_members.findall(members) 778 return members 779 780 # 781 # Format the struct declaration into a standard form for inclusion in the 782 # resulting docs. 783 # 784 def format_struct_decl(self, declaration): 785 # 786 # Insert newlines, get rid of extra spaces. 787 # 788 declaration = KernRe(r'([\{;])').sub(r'\1\n', declaration) 789 declaration = KernRe(r'\}\s+;').sub('};', declaration) 790 # 791 # Format inline enums with each member on its own line. 792 # 793 r = KernRe(r'(enum\s+\{[^\}]+),([^\n])') 794 while r.search(declaration): 795 declaration = r.sub(r'\1,\n\2', declaration) 796 # 797 # Now go through and supply the right number of tabs 798 # for each line. 799 # 800 def_args = declaration.split('\n') 801 level = 1 802 declaration = "" 803 for clause in def_args: 804 clause = KernRe(r'\s+').sub(' ', clause.strip(), count=1) 805 if clause: 806 if '}' in clause and level > 1: 807 level -= 1 808 if not clause.startswith('#'): 809 declaration += "\t" * level 810 declaration += "\t" + clause + "\n" 811 if "{" in clause and "}" not in clause: 812 level += 1 813 return declaration 814 815 816 def dump_struct(self, ln, proto): 817 """ 818 Store an entry for a struct or union 819 """ 820 # 821 # Do the basic parse to get the pieces of the declaration. 822 # 823 struct_parts = self.split_struct_proto(proto) 824 if not struct_parts: 825 self.emit_msg(ln, f"{proto} error: Cannot parse struct or union!") 826 return 827 decl_type, declaration_name, members = struct_parts 828 829 if self.entry.identifier != declaration_name: 830 self.emit_msg(ln, f"expecting prototype for {decl_type} {self.entry.identifier}. " 831 f"Prototype was for {decl_type} {declaration_name} instead\n") 832 return 833 # 834 # Go through the list of members applying all of our transformations. 835 # 836 members = trim_private_members(members) 837 members = apply_transforms(struct_xforms, members) 838 839 nested = NestedMatch() 840 for search, sub in struct_nested_prefixes: 841 members = nested.sub(search, sub, members) 842 # 843 # Deal with embedded struct and union members, and drop enums entirely. 844 # 845 declaration = members 846 members = self.rewrite_struct_members(members) 847 members = re.sub(r'(\{[^\{\}]*\})', '', members) 848 # 849 # Output the result and we are done. 850 # 851 self.create_parameter_list(ln, decl_type, members, ';', 852 declaration_name) 853 self.check_sections(ln, declaration_name, decl_type) 854 self.output_declaration(decl_type, declaration_name, 855 definition=self.format_struct_decl(declaration), 856 purpose=self.entry.declaration_purpose) 857 858 def dump_enum(self, ln, proto): 859 """ 860 Stores an enum inside self.entries array. 861 """ 862 # 863 # Strip preprocessor directives. Note that this depends on the 864 # trailing semicolon we added in process_proto_type(). 865 # 866 proto = KernRe(r'#\s*((define|ifdef|if)\s+|endif)[^;]*;', flags=re.S).sub('', proto) 867 # 868 # Parse out the name and members of the enum. Typedef form first. 869 # 870 r = KernRe(r'typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;') 871 if r.search(proto): 872 declaration_name = r.group(2) 873 members = trim_private_members(r.group(1)) 874 # 875 # Failing that, look for a straight enum 876 # 877 else: 878 r = KernRe(r'enum\s+(\w*)\s*\{(.*)\}') 879 if r.match(proto): 880 declaration_name = r.group(1) 881 members = trim_private_members(r.group(2)) 882 # 883 # OK, this isn't going to work. 884 # 885 else: 886 self.emit_msg(ln, f"{proto}: error: Cannot parse enum!") 887 return 888 # 889 # Make sure we found what we were expecting. 890 # 891 if self.entry.identifier != declaration_name: 892 if self.entry.identifier == "": 893 self.emit_msg(ln, 894 f"{proto}: wrong kernel-doc identifier on prototype") 895 else: 896 self.emit_msg(ln, 897 f"expecting prototype for enum {self.entry.identifier}. " 898 f"Prototype was for enum {declaration_name} instead") 899 return 900 901 if not declaration_name: 902 declaration_name = "(anonymous)" 903 # 904 # Parse out the name of each enum member, and verify that we 905 # have a description for it. 906 # 907 member_set = set() 908 members = KernRe(r'\([^;)]*\)').sub('', members) 909 for arg in members.split(','): 910 if not arg: 911 continue 912 arg = KernRe(r'^\s*(\w+).*').sub(r'\1', arg) 913 self.entry.parameterlist.append(arg) 914 if arg not in self.entry.parameterdescs: 915 self.entry.parameterdescs[arg] = self.undescribed 916 self.emit_msg(ln, 917 f"Enum value '{arg}' not described in enum '{declaration_name}'") 918 member_set.add(arg) 919 # 920 # Ensure that every described member actually exists in the enum. 921 # 922 for k in self.entry.parameterdescs: 923 if k not in member_set: 924 self.emit_msg(ln, 925 f"Excess enum value '@{k}' description in '{declaration_name}'") 926 927 self.output_declaration('enum', declaration_name, 928 purpose=self.entry.declaration_purpose) 929 930 def dump_var(self, ln, proto): 931 """ 932 Store variables that are part of kAPI. 933 """ 934 VAR_ATTRIBS = [ 935 "extern", 936 ] 937 OPTIONAL_VAR_ATTR = "^(?:" + "|".join(VAR_ATTRIBS) + ")?" 938 939 sub_prefixes = [ 940 (KernRe(r"__read_mostly"), ""), 941 (KernRe(r"__ro_after_init"), ""), 942 (KernRe(r"(?://.*)$"), ""), 943 (KernRe(r"(?:/\*.*\*/)"), ""), 944 (KernRe(r";$"), ""), 945 (KernRe(r"=.*"), ""), 946 ] 947 948 # 949 # Store the full prototype before modifying it 950 # 951 full_proto = proto 952 953 # 954 # Drop comments and macros to have a pure C prototype 955 # 956 for search, sub in sub_prefixes: 957 proto = search.sub(sub, proto) 958 959 proto = proto.rstrip() 960 961 # 962 # Variable name is at the end of the declaration 963 # 964 965 r= KernRe(OPTIONAL_VAR_ATTR + r"\w.*\s+(?:\*+)?([\w_]+)\s*[\d\]\[]*\s*(=.*)?") 966 if not r.match(proto): 967 self.emit_msg(ln,f"{proto}: can't parse variable") 968 return 969 970 var_type = r.group(0) 971 declaration_name = r.group(1) 972 default_val = r.group(2) 973 if default_val: 974 default_val = default_val.lstrip("=").strip() 975 976 self.output_declaration("var", declaration_name, 977 full_proto=full_proto, 978 var_type=var_type, 979 default_val=default_val, 980 purpose=self.entry.declaration_purpose) 981 982 def dump_declaration(self, ln, prototype): 983 """ 984 Stores a data declaration inside self.entries array. 985 """ 986 987 if self.entry.decl_type == "enum": 988 self.dump_enum(ln, prototype) 989 elif self.entry.decl_type == "typedef": 990 self.dump_typedef(ln, prototype) 991 elif self.entry.decl_type in ["union", "struct"]: 992 self.dump_struct(ln, prototype) 993 elif self.entry.decl_type == "var": 994 self.dump_var(ln, prototype) 995 else: 996 # This would be a bug 997 self.emit_message(ln, f'Unknown declaration type: {self.entry.decl_type}') 998 999 def dump_function(self, ln, prototype): 1000 """ 1001 Stores a function or function macro inside self.entries array. 1002 """ 1003 1004 found = func_macro = False 1005 return_type = '' 1006 decl_type = 'function' 1007 # 1008 # Apply the initial transformations. 1009 # 1010 prototype = apply_transforms(function_xforms, prototype) 1011 # 1012 # If we have a macro, remove the "#define" at the front. 1013 # 1014 new_proto = KernRe(r"^#\s*define\s+").sub("", prototype) 1015 if new_proto != prototype: 1016 prototype = new_proto 1017 # 1018 # Dispense with the simple "#define A B" case here; the key 1019 # is the space after the name of the symbol being defined. 1020 # NOTE that the seemingly misnamed "func_macro" indicates a 1021 # macro *without* arguments. 1022 # 1023 r = KernRe(r'^(\w+)\s+') 1024 if r.search(prototype): 1025 return_type = '' 1026 declaration_name = r.group(1) 1027 func_macro = True 1028 found = True 1029 1030 # Yes, this truly is vile. We are looking for: 1031 # 1. Return type (may be nothing if we're looking at a macro) 1032 # 2. Function name 1033 # 3. Function parameters. 1034 # 1035 # All the while we have to watch out for function pointer parameters 1036 # (which IIRC is what the two sections are for), C types (these 1037 # regexps don't even start to express all the possibilities), and 1038 # so on. 1039 # 1040 # If you mess with these regexps, it's a good idea to check that 1041 # the following functions' documentation still comes out right: 1042 # - parport_register_device (function pointer parameters) 1043 # - atomic_set (macro) 1044 # - pci_match_device, __copy_to_user (long return type) 1045 1046 name = r'\w+' 1047 type1 = r'(?:[\w\s]+)?' 1048 type2 = r'(?:[\w\s]+\*+)+' 1049 # 1050 # Attempt to match first on (args) with no internal parentheses; this 1051 # lets us easily filter out __acquires() and other post-args stuff. If 1052 # that fails, just grab the rest of the line to the last closing 1053 # parenthesis. 1054 # 1055 proto_args = r'\(([^\(]*|.*)\)' 1056 # 1057 # (Except for the simple macro case) attempt to split up the prototype 1058 # in the various ways we understand. 1059 # 1060 if not found: 1061 patterns = [ 1062 rf'^()({name})\s*{proto_args}', 1063 rf'^({type1})\s+({name})\s*{proto_args}', 1064 rf'^({type2})\s*({name})\s*{proto_args}', 1065 ] 1066 1067 for p in patterns: 1068 r = KernRe(p) 1069 if r.match(prototype): 1070 return_type = r.group(1) 1071 declaration_name = r.group(2) 1072 args = r.group(3) 1073 self.create_parameter_list(ln, decl_type, args, ',', 1074 declaration_name) 1075 found = True 1076 break 1077 # 1078 # Parsing done; make sure that things are as we expect. 1079 # 1080 if not found: 1081 self.emit_msg(ln, 1082 f"cannot understand function prototype: '{prototype}'") 1083 return 1084 if self.entry.identifier != declaration_name: 1085 self.emit_msg(ln, f"expecting prototype for {self.entry.identifier}(). " 1086 f"Prototype was for {declaration_name}() instead") 1087 return 1088 self.check_sections(ln, declaration_name, "function") 1089 self.check_return_section(ln, declaration_name, return_type) 1090 # 1091 # Store the result. 1092 # 1093 self.output_declaration(decl_type, declaration_name, 1094 typedef=('typedef' in return_type), 1095 functiontype=return_type, 1096 purpose=self.entry.declaration_purpose, 1097 func_macro=func_macro) 1098 1099 1100 def dump_typedef(self, ln, proto): 1101 """ 1102 Stores a typedef inside self.entries array. 1103 """ 1104 # 1105 # We start by looking for function typedefs. 1106 # 1107 typedef_type = r'typedef((?:\s+[\w*]+\b){0,7}\s+(?:\w+\b|\*+))\s*' 1108 typedef_ident = r'\*?\s*(\w\S+)\s*' 1109 typedef_args = r'\s*\((.*)\);' 1110 1111 typedef1 = KernRe(typedef_type + r'\(' + typedef_ident + r'\)' + typedef_args) 1112 typedef2 = KernRe(typedef_type + typedef_ident + typedef_args) 1113 1114 # Parse function typedef prototypes 1115 for r in [typedef1, typedef2]: 1116 if not r.match(proto): 1117 continue 1118 1119 return_type = r.group(1).strip() 1120 declaration_name = r.group(2) 1121 args = r.group(3) 1122 1123 if self.entry.identifier != declaration_name: 1124 self.emit_msg(ln, 1125 f"expecting prototype for typedef {self.entry.identifier}. Prototype was for typedef {declaration_name} instead\n") 1126 return 1127 1128 self.create_parameter_list(ln, 'function', args, ',', declaration_name) 1129 1130 self.output_declaration('function', declaration_name, 1131 typedef=True, 1132 functiontype=return_type, 1133 purpose=self.entry.declaration_purpose) 1134 return 1135 # 1136 # Not a function, try to parse a simple typedef. 1137 # 1138 r = KernRe(r'typedef.*\s+(\w+)\s*;') 1139 if r.match(proto): 1140 declaration_name = r.group(1) 1141 1142 if self.entry.identifier != declaration_name: 1143 self.emit_msg(ln, 1144 f"expecting prototype for typedef {self.entry.identifier}. Prototype was for typedef {declaration_name} instead\n") 1145 return 1146 1147 self.output_declaration('typedef', declaration_name, 1148 purpose=self.entry.declaration_purpose) 1149 return 1150 1151 self.emit_msg(ln, "error: Cannot parse typedef!") 1152 1153 @staticmethod 1154 def process_export(function_set, line): 1155 """ 1156 process EXPORT_SYMBOL* tags 1157 1158 This method doesn't use any variable from the class, so declare it 1159 with a staticmethod decorator. 1160 """ 1161 1162 # We support documenting some exported symbols with different 1163 # names. A horrible hack. 1164 suffixes = [ '_noprof' ] 1165 1166 # Note: it accepts only one EXPORT_SYMBOL* per line, as having 1167 # multiple export lines would violate Kernel coding style. 1168 1169 if export_symbol.search(line): 1170 symbol = export_symbol.group(2) 1171 elif export_symbol_ns.search(line): 1172 symbol = export_symbol_ns.group(2) 1173 else: 1174 return False 1175 # 1176 # Found an export, trim out any special suffixes 1177 # 1178 for suffix in suffixes: 1179 # Be backward compatible with Python < 3.9 1180 if symbol.endswith(suffix): 1181 symbol = symbol[:-len(suffix)] 1182 function_set.add(symbol) 1183 return True 1184 1185 def process_normal(self, ln, line): 1186 """ 1187 STATE_NORMAL: looking for the /** to begin everything. 1188 """ 1189 1190 if not doc_start.match(line): 1191 return 1192 1193 # start a new entry 1194 self.reset_state(ln) 1195 1196 # next line is always the function name 1197 self.state = state.NAME 1198 1199 def process_name(self, ln, line): 1200 """ 1201 STATE_NAME: Looking for the "name - description" line 1202 """ 1203 # 1204 # Check for a DOC: block and handle them specially. 1205 # 1206 if doc_block.search(line): 1207 1208 if not doc_block.group(1): 1209 self.entry.begin_section(ln, "Introduction") 1210 else: 1211 self.entry.begin_section(ln, doc_block.group(1)) 1212 1213 self.entry.identifier = self.entry.section 1214 self.state = state.DOCBLOCK 1215 # 1216 # Otherwise we're looking for a normal kerneldoc declaration line. 1217 # 1218 elif doc_decl.search(line): 1219 self.entry.identifier = doc_decl.group(1) 1220 1221 # Test for data declaration 1222 if doc_begin_data.search(line): 1223 self.entry.decl_type = doc_begin_data.group(1) 1224 self.entry.identifier = doc_begin_data.group(2) 1225 # 1226 # Look for a function description 1227 # 1228 elif doc_begin_func.search(line): 1229 self.entry.identifier = doc_begin_func.group(1) 1230 self.entry.decl_type = "function" 1231 # 1232 # We struck out. 1233 # 1234 else: 1235 self.emit_msg(ln, 1236 f"This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst\n{line}") 1237 self.state = state.NORMAL 1238 return 1239 # 1240 # OK, set up for a new kerneldoc entry. 1241 # 1242 self.state = state.BODY 1243 self.entry.identifier = self.entry.identifier.strip(" ") 1244 # if there's no @param blocks need to set up default section here 1245 self.entry.begin_section(ln + 1) 1246 # 1247 # Find the description portion, which *should* be there but 1248 # isn't always. 1249 # (We should be able to capture this from the previous parsing - someday) 1250 # 1251 r = KernRe("[-:](.*)") 1252 if r.search(line): 1253 self.entry.declaration_purpose = trim_whitespace(r.group(1)) 1254 self.state = state.DECLARATION 1255 else: 1256 self.entry.declaration_purpose = "" 1257 1258 if not self.entry.declaration_purpose and self.config.wshort_desc: 1259 self.emit_msg(ln, 1260 f"missing initial short description on line:\n{line}") 1261 1262 if not self.entry.identifier and self.entry.decl_type != "enum": 1263 self.emit_msg(ln, 1264 f"wrong kernel-doc identifier on line:\n{line}") 1265 self.state = state.NORMAL 1266 1267 if self.config.verbose: 1268 self.emit_msg(ln, 1269 f"Scanning doc for {self.entry.decl_type} {self.entry.identifier}", 1270 warning=False) 1271 # 1272 # Failed to find an identifier. Emit a warning 1273 # 1274 else: 1275 self.emit_msg(ln, f"Cannot find identifier on line:\n{line}") 1276 1277 # 1278 # Helper function to determine if a new section is being started. 1279 # 1280 def is_new_section(self, ln, line): 1281 if doc_sect.search(line): 1282 self.state = state.BODY 1283 # 1284 # Pick out the name of our new section, tweaking it if need be. 1285 # 1286 newsection = doc_sect.group(1) 1287 if newsection.lower() == 'description': 1288 newsection = 'Description' 1289 elif newsection.lower() == 'context': 1290 newsection = 'Context' 1291 self.state = state.SPECIAL_SECTION 1292 elif newsection.lower() in ["@return", "@returns", 1293 "return", "returns"]: 1294 newsection = "Return" 1295 self.state = state.SPECIAL_SECTION 1296 elif newsection[0] == '@': 1297 self.state = state.SPECIAL_SECTION 1298 # 1299 # Initialize the contents, and get the new section going. 1300 # 1301 newcontents = doc_sect.group(2) 1302 if not newcontents: 1303 newcontents = "" 1304 self.dump_section() 1305 self.entry.begin_section(ln, newsection) 1306 self.entry.leading_space = None 1307 1308 self.entry.add_text(newcontents.lstrip()) 1309 return True 1310 return False 1311 1312 # 1313 # Helper function to detect (and effect) the end of a kerneldoc comment. 1314 # 1315 def is_comment_end(self, ln, line): 1316 if doc_end.search(line): 1317 self.dump_section() 1318 1319 # Look for doc_com + <text> + doc_end: 1320 r = KernRe(r'\s*\*\s*[a-zA-Z_0-9:.]+\*/') 1321 if r.match(line): 1322 self.emit_msg(ln, f"suspicious ending line: {line}") 1323 1324 self.entry.prototype = "" 1325 self.entry.new_start_line = ln + 1 1326 1327 self.state = state.PROTO 1328 return True 1329 return False 1330 1331 1332 def process_decl(self, ln, line): 1333 """ 1334 STATE_DECLARATION: We've seen the beginning of a declaration 1335 """ 1336 if self.is_new_section(ln, line) or self.is_comment_end(ln, line): 1337 return 1338 # 1339 # Look for anything with the " * " line beginning. 1340 # 1341 if doc_content.search(line): 1342 cont = doc_content.group(1) 1343 # 1344 # A blank line means that we have moved out of the declaration 1345 # part of the comment (without any "special section" parameter 1346 # descriptions). 1347 # 1348 if cont == "": 1349 self.state = state.BODY 1350 # 1351 # Otherwise we have more of the declaration section to soak up. 1352 # 1353 else: 1354 self.entry.declaration_purpose = \ 1355 trim_whitespace(self.entry.declaration_purpose + ' ' + cont) 1356 else: 1357 # Unknown line, ignore 1358 self.emit_msg(ln, f"bad line: {line}") 1359 1360 1361 def process_special(self, ln, line): 1362 """ 1363 STATE_SPECIAL_SECTION: a section ending with a blank line 1364 """ 1365 # 1366 # If we have hit a blank line (only the " * " marker), then this 1367 # section is done. 1368 # 1369 if KernRe(r"\s*\*\s*$").match(line): 1370 self.entry.begin_section(ln, dump = True) 1371 self.state = state.BODY 1372 return 1373 # 1374 # Not a blank line, look for the other ways to end the section. 1375 # 1376 if self.is_new_section(ln, line) or self.is_comment_end(ln, line): 1377 return 1378 # 1379 # OK, we should have a continuation of the text for this section. 1380 # 1381 if doc_content.search(line): 1382 cont = doc_content.group(1) 1383 # 1384 # If the lines of text after the first in a special section have 1385 # leading white space, we need to trim it out or Sphinx will get 1386 # confused. For the second line (the None case), see what we 1387 # find there and remember it. 1388 # 1389 if self.entry.leading_space is None: 1390 r = KernRe(r'^(\s+)') 1391 if r.match(cont): 1392 self.entry.leading_space = len(r.group(1)) 1393 else: 1394 self.entry.leading_space = 0 1395 # 1396 # Otherwise, before trimming any leading chars, be *sure* 1397 # that they are white space. We should maybe warn if this 1398 # isn't the case. 1399 # 1400 for i in range(0, self.entry.leading_space): 1401 if cont[i] != " ": 1402 self.entry.leading_space = i 1403 break 1404 # 1405 # Add the trimmed result to the section and we're done. 1406 # 1407 self.entry.add_text(cont[self.entry.leading_space:]) 1408 else: 1409 # Unknown line, ignore 1410 self.emit_msg(ln, f"bad line: {line}") 1411 1412 def process_body(self, ln, line): 1413 """ 1414 STATE_BODY: the bulk of a kerneldoc comment. 1415 """ 1416 if self.is_new_section(ln, line) or self.is_comment_end(ln, line): 1417 return 1418 1419 if doc_content.search(line): 1420 cont = doc_content.group(1) 1421 self.entry.add_text(cont) 1422 else: 1423 # Unknown line, ignore 1424 self.emit_msg(ln, f"bad line: {line}") 1425 1426 def process_inline_name(self, ln, line): 1427 """STATE_INLINE_NAME: beginning of docbook comments within a prototype.""" 1428 1429 if doc_inline_sect.search(line): 1430 self.entry.begin_section(ln, doc_inline_sect.group(1)) 1431 self.entry.add_text(doc_inline_sect.group(2).lstrip()) 1432 self.state = state.INLINE_TEXT 1433 elif doc_inline_end.search(line): 1434 self.dump_section() 1435 self.state = state.PROTO 1436 elif doc_content.search(line): 1437 self.emit_msg(ln, f"Incorrect use of kernel-doc format: {line}") 1438 self.state = state.PROTO 1439 # else ... ?? 1440 1441 def process_inline_text(self, ln, line): 1442 """STATE_INLINE_TEXT: docbook comments within a prototype.""" 1443 1444 if doc_inline_end.search(line): 1445 self.dump_section() 1446 self.state = state.PROTO 1447 elif doc_content.search(line): 1448 self.entry.add_text(doc_content.group(1)) 1449 # else ... ?? 1450 1451 def syscall_munge(self, ln, proto): # pylint: disable=W0613 1452 """ 1453 Handle syscall definitions 1454 """ 1455 1456 is_void = False 1457 1458 # Strip newlines/CR's 1459 proto = re.sub(r'[\r\n]+', ' ', proto) 1460 1461 # Check if it's a SYSCALL_DEFINE0 1462 if 'SYSCALL_DEFINE0' in proto: 1463 is_void = True 1464 1465 # Replace SYSCALL_DEFINE with correct return type & function name 1466 proto = KernRe(r'SYSCALL_DEFINE.*\(').sub('long sys_', proto) 1467 1468 r = KernRe(r'long\s+(sys_.*?),') 1469 if r.search(proto): 1470 proto = KernRe(',').sub('(', proto, count=1) 1471 elif is_void: 1472 proto = KernRe(r'\)').sub('(void)', proto, count=1) 1473 1474 # Now delete all of the odd-numbered commas in the proto 1475 # so that argument types & names don't have a comma between them 1476 count = 0 1477 length = len(proto) 1478 1479 if is_void: 1480 length = 0 # skip the loop if is_void 1481 1482 for ix in range(length): 1483 if proto[ix] == ',': 1484 count += 1 1485 if count % 2 == 1: 1486 proto = proto[:ix] + ' ' + proto[ix + 1:] 1487 1488 return proto 1489 1490 def tracepoint_munge(self, ln, proto): 1491 """ 1492 Handle tracepoint definitions 1493 """ 1494 1495 tracepointname = None 1496 tracepointargs = None 1497 1498 # Match tracepoint name based on different patterns 1499 r = KernRe(r'TRACE_EVENT\((.*?),') 1500 if r.search(proto): 1501 tracepointname = r.group(1) 1502 1503 r = KernRe(r'DEFINE_SINGLE_EVENT\((.*?),') 1504 if r.search(proto): 1505 tracepointname = r.group(1) 1506 1507 r = KernRe(r'DEFINE_EVENT\((.*?),(.*?),') 1508 if r.search(proto): 1509 tracepointname = r.group(2) 1510 1511 if tracepointname: 1512 tracepointname = tracepointname.lstrip() 1513 1514 r = KernRe(r'TP_PROTO\((.*?)\)') 1515 if r.search(proto): 1516 tracepointargs = r.group(1) 1517 1518 if not tracepointname or not tracepointargs: 1519 self.emit_msg(ln, 1520 f"Unrecognized tracepoint format:\n{proto}\n") 1521 else: 1522 proto = f"static inline void trace_{tracepointname}({tracepointargs})" 1523 self.entry.identifier = f"trace_{self.entry.identifier}" 1524 1525 return proto 1526 1527 def process_proto_function(self, ln, line): 1528 """Ancillary routine to process a function prototype""" 1529 1530 # strip C99-style comments to end of line 1531 line = KernRe(r"//.*$", re.S).sub('', line) 1532 # 1533 # Soak up the line's worth of prototype text, stopping at { or ; if present. 1534 # 1535 if KernRe(r'\s*#\s*define').match(line): 1536 self.entry.prototype = line 1537 elif not line.startswith('#'): # skip other preprocessor stuff 1538 r = KernRe(r'([^\{]*)') 1539 if r.match(line): 1540 self.entry.prototype += r.group(1) + " " 1541 # 1542 # If we now have the whole prototype, clean it up and declare victory. 1543 # 1544 if '{' in line or ';' in line or KernRe(r'\s*#\s*define').match(line): 1545 # strip comments and surrounding spaces 1546 self.entry.prototype = KernRe(r'/\*.*\*/').sub('', self.entry.prototype).strip() 1547 # 1548 # Handle self.entry.prototypes for function pointers like: 1549 # int (*pcs_config)(struct foo) 1550 # by turning it into 1551 # int pcs_config(struct foo) 1552 # 1553 r = KernRe(r'^(\S+\s+)\(\s*\*(\S+)\)') 1554 self.entry.prototype = r.sub(r'\1\2', self.entry.prototype) 1555 # 1556 # Handle special declaration syntaxes 1557 # 1558 if 'SYSCALL_DEFINE' in self.entry.prototype: 1559 self.entry.prototype = self.syscall_munge(ln, 1560 self.entry.prototype) 1561 else: 1562 r = KernRe(r'TRACE_EVENT|DEFINE_EVENT|DEFINE_SINGLE_EVENT') 1563 if r.search(self.entry.prototype): 1564 self.entry.prototype = self.tracepoint_munge(ln, 1565 self.entry.prototype) 1566 # 1567 # ... and we're done 1568 # 1569 self.dump_function(ln, self.entry.prototype) 1570 self.reset_state(ln) 1571 1572 def process_proto_type(self, ln, line): 1573 """Ancillary routine to process a type""" 1574 1575 # Strip C99-style comments and surrounding whitespace 1576 line = KernRe(r"//.*$", re.S).sub('', line).strip() 1577 if not line: 1578 return # nothing to see here 1579 1580 # To distinguish preprocessor directive from regular declaration later. 1581 if line.startswith('#'): 1582 line += ";" 1583 # 1584 # Split the declaration on any of { } or ;, and accumulate pieces 1585 # until we hit a semicolon while not inside {brackets} 1586 # 1587 r = KernRe(r'(.*?)([{};])') 1588 for chunk in r.split(line): 1589 if chunk: # Ignore empty matches 1590 self.entry.prototype += chunk 1591 # 1592 # This cries out for a match statement ... someday after we can 1593 # drop Python 3.9 ... 1594 # 1595 if chunk == '{': 1596 self.entry.brcount += 1 1597 elif chunk == '}': 1598 self.entry.brcount -= 1 1599 elif chunk == ';' and self.entry.brcount <= 0: 1600 self.dump_declaration(ln, self.entry.prototype) 1601 self.reset_state(ln) 1602 return 1603 # 1604 # We hit the end of the line while still in the declaration; put 1605 # in a space to represent the newline. 1606 # 1607 self.entry.prototype += ' ' 1608 1609 def process_proto(self, ln, line): 1610 """STATE_PROTO: reading a function/whatever prototype.""" 1611 1612 if doc_inline_oneline.search(line): 1613 self.entry.begin_section(ln, doc_inline_oneline.group(1)) 1614 self.entry.add_text(doc_inline_oneline.group(2)) 1615 self.dump_section() 1616 1617 elif doc_inline_start.search(line): 1618 self.state = state.INLINE_NAME 1619 1620 elif self.entry.decl_type == 'function': 1621 self.process_proto_function(ln, line) 1622 1623 else: 1624 self.process_proto_type(ln, line) 1625 1626 def process_docblock(self, ln, line): 1627 """STATE_DOCBLOCK: within a DOC: block.""" 1628 1629 if doc_end.search(line): 1630 self.dump_section() 1631 self.output_declaration("doc", self.entry.identifier) 1632 self.reset_state(ln) 1633 1634 elif doc_content.search(line): 1635 self.entry.add_text(doc_content.group(1)) 1636 1637 def parse_export(self): 1638 """ 1639 Parses EXPORT_SYMBOL* macros from a single Kernel source file. 1640 """ 1641 1642 export_table = set() 1643 1644 try: 1645 with open(self.fname, "r", encoding="utf8", 1646 errors="backslashreplace") as fp: 1647 1648 for line in fp: 1649 self.process_export(export_table, line) 1650 1651 except IOError: 1652 return None 1653 1654 return export_table 1655 1656 # 1657 # The state/action table telling us which function to invoke in 1658 # each state. 1659 # 1660 state_actions = { 1661 state.NORMAL: process_normal, 1662 state.NAME: process_name, 1663 state.BODY: process_body, 1664 state.DECLARATION: process_decl, 1665 state.SPECIAL_SECTION: process_special, 1666 state.INLINE_NAME: process_inline_name, 1667 state.INLINE_TEXT: process_inline_text, 1668 state.PROTO: process_proto, 1669 state.DOCBLOCK: process_docblock, 1670 } 1671 1672 def parse_kdoc(self): 1673 """ 1674 Open and process each line of a C source file. 1675 The parsing is controlled via a state machine, and the line is passed 1676 to a different process function depending on the state. The process 1677 function may update the state as needed. 1678 1679 Besides parsing kernel-doc tags, it also parses export symbols. 1680 """ 1681 1682 prev = "" 1683 prev_ln = None 1684 export_table = set() 1685 1686 try: 1687 with open(self.fname, "r", encoding="utf8", 1688 errors="backslashreplace") as fp: 1689 for ln, line in enumerate(fp): 1690 1691 line = line.expandtabs().strip("\n") 1692 1693 # Group continuation lines on prototypes 1694 if self.state == state.PROTO: 1695 if line.endswith("\\"): 1696 prev += line.rstrip("\\") 1697 if not prev_ln: 1698 prev_ln = ln 1699 continue 1700 1701 if prev: 1702 ln = prev_ln 1703 line = prev + line 1704 prev = "" 1705 prev_ln = None 1706 1707 self.config.log.debug("%d %s: %s", 1708 ln, state.name[self.state], 1709 line) 1710 1711 # This is an optimization over the original script. 1712 # There, when export_file was used for the same file, 1713 # it was read twice. Here, we use the already-existing 1714 # loop to parse exported symbols as well. 1715 # 1716 if (self.state != state.NORMAL) or \ 1717 not self.process_export(export_table, line): 1718 # Hand this line to the appropriate state handler 1719 self.state_actions[self.state](self, ln, line) 1720 1721 except OSError: 1722 self.config.log.error(f"Error: Cannot open file {self.fname}") 1723 1724 return export_table, self.entries 1725