github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-22 12:44:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

xdrgen: Record the source position of each declared identifier

Browse Source 
In preparation for semantic checks that reject a malformed
specification, record where each declared identifier appears in the
source so a diagnostic can point at the name in error.

The transformer keeps each identifier's spelling but discards its
position, retaining only the position of the enclosing definition.
A caret built from that position falls on the definition keyword
rather than on the identifier, because the definition production
begins at the keyword.

Store the identifier's own line and column on every named
construct: constants, enumerated types and their enumerators,
structs, unions, pointers, typedef declarations, and RPC program,
version, and procedure names. The fields live on the AST base node
and are keyword-only, so lark's positional construction of each
node is unaffected; a construct whose position is not recorded
leaves them zero.

Link: https://patch.msgid.link/20260712203451.124902-3-cel@kernel.org
Signed-off-by: Chuck Lever <cel@kernel.org>
This commit is contained in:
Chuck Lever 2026-07-12 16:34:48 -04:00
parent 883fe9a7ac
commit e1391920c6
1 changed files with 83 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
tools/net/sunrpc/xdrgen/xdr_ast.py
View File

@ -5,7 +5,7 @@
import sys
from typing import List
from dataclasses import dataclass
from dataclasses import dataclass, KW_ONLY
from lark import ast_utils, Transformer
from lark.tree import Meta
@ -65,6 +65,16 @@ max_widths = {
class _XdrAst(ast_utils.Ast):
"""Base class for the XDR abstract syntax tree"""
# Source position of the construct's declared identifier, when
# the transformer records one, so semantic diagnostics can point
# at the exact declaration. The KW_ONLY marker makes the fields
# keyword-only, so they never disturb the positional child
# ordering lark uses to build each node; 0 means the position was
# not recorded.
_: KW_ONLY
line: int = 0
column: int = 0
@dataclass
class _XdrIdentifier(_XdrAst):
@ -543,7 +553,8 @@ class ParseToAst(Transformer):
def identifier(self, children):
"""Instantiate one _XdrIdentifier object"""
return _XdrIdentifier(children[0].value)
token = children[0]
return _XdrIdentifier(token.value, line=token.line, column=token.column)
def value(self, children):
"""Instantiate one _XdrValue object"""
@ -573,84 +584,103 @@ class ParseToAst(Transformer):
def constant_def(self, children):
"""Instantiate one _XdrConstant object"""
name = children[0].symbol
ident = children[0]
value = children[1].value
return _XdrConstant(name, value)
return _XdrConstant(ident.symbol, value, line=ident.line, column=ident.column)
def enum(self, children):
"""Instantiate one _XdrEnum object"""
enum_name = children[0].symbol
name_ident = children[0]
i = 0
enumerators = []
body = children[1]
while i < len(body.children):
name = body.children[i].symbol
ident = body.children[i]
value = body.children[i + 1].value
enumerators.append(_XdrEnumerator(name, value))
enumerators.append(
_XdrEnumerator(
ident.symbol, value, line=ident.line, column=ident.column
)
)
i = i + 2
return _XdrEnum(enum_name, enumerators)
return _XdrEnum(
name_ident.symbol,
enumerators,
line=name_ident.line,
column=name_ident.column,
)
def fixed_length_opaque(self, children):
"""Instantiate one _XdrFixedLengthOpaque declaration object"""
name = children[0].symbol
ident = children[0]
size = children[1].value
return _XdrFixedLengthOpaque(name, size)
return _XdrFixedLengthOpaque(
ident.symbol, size, line=ident.line, column=ident.column
)
def variable_length_opaque(self, children):
"""Instantiate one _XdrVariableLengthOpaque declaration object"""
name = children[0].symbol
ident = children[0]
if children[1] is not None:
maxsize = children[1].value
else:
maxsize = "0"
return _XdrVariableLengthOpaque(name, maxsize)
return _XdrVariableLengthOpaque(
ident.symbol, maxsize, line=ident.line, column=ident.column
)
def string(self, children):
"""Instantiate one _XdrString declaration object"""
name = children[0].symbol
ident = children[0]
if children[1] is not None:
maxsize = children[1].value
else:
maxsize = "0"
return _XdrString(name, maxsize)
return _XdrString(ident.symbol, maxsize, line=ident.line, column=ident.column)
def fixed_length_array(self, children):
"""Instantiate one _XdrFixedLengthArray declaration object"""
spec = children[0]
name = children[1].symbol
ident = children[1]
size = children[2].value
return _XdrFixedLengthArray(name, spec, size)
return _XdrFixedLengthArray(
ident.symbol, spec, size, line=ident.line, column=ident.column
)
def variable_length_array(self, children):
"""Instantiate one _XdrVariableLengthArray declaration object"""
spec = children[0]
name = children[1].symbol
ident = children[1]
if children[2] is not None:
maxsize = children[2].value
else:
maxsize = "0"
return _XdrVariableLengthArray(name, spec, maxsize)
return _XdrVariableLengthArray(
ident.symbol, spec, maxsize, line=ident.line, column=ident.column
)
def optional_data(self, children):
"""Instantiate one _XdrOptionalData declaration object"""
spec = children[0]
name = children[1].symbol
ident = children[1]
return _XdrOptionalData(name, spec)
return _XdrOptionalData(
ident.symbol, spec, line=ident.line, column=ident.column
)
def basic(self, children):
"""Instantiate one _XdrBasic object"""
spec = children[0]
name = children[1].symbol
ident = children[1]
return _XdrBasic(name, spec)
return _XdrBasic(ident.symbol, spec, line=ident.line, column=ident.column)
def void(self, children):
"""Instantiate one _XdrVoid declaration object"""
@ -659,17 +689,19 @@ class ParseToAst(Transformer):
def struct(self, children):
"""Instantiate one _XdrStruct object"""
name = children[0].symbol
ident = children[0]
name = ident.symbol
fields = children[1].children
pos = {"line": ident.line, "column": ident.column}
last_field = fields[-1]
if (
isinstance(last_field, _XdrOptionalData)
and name == last_field.spec.type_name
):
return _XdrPointer(name, fields)
return _XdrPointer(name, fields, **pos)
return _XdrStruct(name, fields)
return _XdrStruct(name, fields, **pos)
def typedef(self, children):
"""Instantiate one _XdrTypedef object"""
@ -694,39 +726,57 @@ class ParseToAst(Transformer):
def union(self, children):
"""Instantiate one _XdrUnion object"""
name = children[0].symbol
ident = children[0]
body = children[1]
discriminant = body.children[0].children[0]
cases = body.children[1:-1]
default = body.children[-1]
return _XdrUnion(name, discriminant, cases, default)
return _XdrUnion(
ident.symbol,
discriminant,
cases,
default,
line=ident.line,
column=ident.column,
)
def procedure_def(self, children):
"""Instantiate one _RpcProcedure object"""
result = children[0]
name = children[1].symbol
ident = children[1]
argument = children[2]
number = children[3].value
return _RpcProcedure(name, number, argument, result)
return _RpcProcedure(
ident.symbol,
number,
argument,
result,
line=ident.line,
column=ident.column,
)
def version_def(self, children):
"""Instantiate one _RpcVersion object"""
name = children[0].symbol
ident = children[0]
number = children[-1].value
procedures = children[1:-1]
return _RpcVersion(name, number, procedures)
return _RpcVersion(
ident.symbol, number, procedures, line=ident.line, column=ident.column
)
def program_def(self, children):
"""Instantiate one _RpcProgram object"""
name = children[0].symbol
ident = children[0]
number = children[-1].value
versions = children[1:-1]
return _RpcProgram(name, number, versions)
return _RpcProgram(
ident.symbol, number, versions, line=ident.line, column=ident.column
)
def pragma_def(self, children):
"""Instantiate one _Pragma object"""