4b132aacb0
Add a Python-based tool for translating XDR specifications into XDR encoder and decoder functions written in the Linux kernel's C coding style. The generator attempts to match the usual C coding style of the Linux kernel's SunRPC consumers. This approach is similar to the netlink code generator in tools/net/ynl . The maintainability benefits of machine-generated XDR code include: - Stronger type checking - Reduces the number of bugs introduced by human error - Makes the XDR code easier to audit and analyze - Enables rapid prototyping of new RPC-based protocols - Hardens the layering between protocol logic and marshaling - Makes it easier to add observability on demand - Unit tests might be built for both the tool and (automatically) for the generated code In addition, converting the XDR layer to use memory-safe languages such as Rust will be easier if much of the code can be converted automatically. Tested-by: Jeff Layton <jlayton@kernel.org> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
34 lines
825 B
Python
34 lines
825 B
Python
#!/usr/bin/env python3
|
|
# ex: set filetype=python:
|
|
|
|
"""Translate an XDR specification into executable code that
|
|
can be compiled for the Linux kernel."""
|
|
|
|
import logging
|
|
|
|
from argparse import Namespace
|
|
from lark import logger
|
|
from lark.exceptions import UnexpectedInput
|
|
|
|
from xdr_parse import xdr_parser
|
|
from xdr_ast import transform_parse_tree
|
|
|
|
logger.setLevel(logging.DEBUG)
|
|
|
|
|
|
def handle_parse_error(e: UnexpectedInput) -> bool:
|
|
"""Simple parse error reporting, no recovery attempted"""
|
|
print(e)
|
|
return True
|
|
|
|
|
|
def subcmd(args: Namespace) -> int:
|
|
"""Lexical and syntax check of an XDR specification"""
|
|
|
|
parser = xdr_parser()
|
|
with open(args.filename, encoding="utf-8") as f:
|
|
parse_tree = parser.parse(f.read(), on_error=handle_parse_error)
|
|
transform_parse_tree(parse_tree)
|
|
|
|
return 0
|