mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-08-05 16:54:27 +00:00
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>
20 lines
733 B
Python
20 lines
733 B
Python
#!/usr/bin/env python3
|
|
# ex: set filetype=python:
|
|
|
|
"""Generate code to handle XDR constants"""
|
|
|
|
from generators import SourceGenerator, create_jinja2_environment
|
|
from xdr_ast import _XdrConstant
|
|
|
|
class XdrConstantGenerator(SourceGenerator):
|
|
"""Generate source code for XDR constants"""
|
|
|
|
def __init__(self, language: str, peer: str):
|
|
"""Initialize an instance of this class"""
|
|
self.environment = create_jinja2_environment(language, "constants")
|
|
self.peer = peer
|
|
|
|
def emit_definition(self, node: _XdrConstant) -> None:
|
|
"""Emit one definition for a constant"""
|
|
template = self.environment.get_template("definition.j2")
|
|
print(template.render(name=node.name, value=node.value))
|