public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: "Asbjørn Sloth Tønnesen" <ast@fiberby.net>
To: Donald Hunter <donald.hunter@gmail.com>,
	Jakub Kicinski <kuba@kernel.org>,
	"Jason A. Donenfeld" <Jason@zx2c4.com>
Cc: "Asbjørn Sloth Tønnesen" <ast@fiberby.net>,
	"Andrew Lunn" <andrew+netdev@lunn.ch>,
	"Anna Schumaker" <anna@kernel.org>,
	"Antonio Quartulli" <antonio@openvpn.net>,
	"Arkadiusz Kubalewski" <arkadiusz.kubalewski@intel.com>,
	"Arve Hjønnevåg" <arve@android.com>,
	"Carlos Llamas" <cmllamas@google.com>,
	"Christian Brauner" <brauner@kernel.org>,
	"Chuck Lever" <chuck.lever@oracle.com>,
	"Dai Ngo" <Dai.Ngo@oracle.com>,
	"Daniel Zahka" <daniel.zahka@gmail.com>,
	"David Ahern" <dsahern@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	"David Wei" <dw@davidwei.uk>,
	"Eric Dumazet" <edumazet@google.com>,
	"Geliang Tang" <geliang@kernel.org>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Hannes Reinecke" <hare@kernel.org>,
	"Jacob Keller" <jacob.e.keller@intel.com>,
	"Jeff Layton" <jlayton@kernel.org>,
	"Jiri Pirko" <jiri@resnulli.us>,
	"Joe Damato" <jdamato@fastly.com>,
	"Joel Fernandes" <joelagnelf@nvidia.com>,
	kernel-tls-handshake@lists.linux.dev, "Li Li" <dualli@google.com>,
	linux-kernel@vger.kernel.org, linux-nfs@vger.kernel.org,
	"Martijn Coenen" <maco@android.com>,
	"Mat Martineau" <martineau@kernel.org>,
	"Matthieu Baerts" <matttbe@kernel.org>,
	"Mina Almasry" <almasrymina@google.com>,
	mptcp@lists.linux.dev, NeilBrown <neil@brown.name>,
	netdev@vger.kernel.org, "Olga Kornievskaia" <okorniev@redhat.com>,
	"Paolo Abeni" <pabeni@redhat.com>,
	"Sabrina Dubroca" <sd@queasysnail.net>,
	"Samiullah Khawaja" <skhawaja@google.com>,
	"Simon Horman" <horms@kernel.org>,
	"Stanislav Fomichev" <sdf@fomichev.me>,
	"Suren Baghdasaryan" <surenb@google.com>,
	"Todd Kjos" <tkjos@android.com>, "Tom Talpey" <tom@talpey.com>,
	"Trond Myklebust" <trondmy@kernel.org>,
	"Vadim Fedorenko" <vadim.fedorenko@linux.dev>,
	"Willem de Bruijn" <willemb@google.com>
Subject: [PATCH net-next 1/2] tools: ynl-gen: add function prefix argument
Date: Thu, 20 Nov 2025 17:44:26 +0000	[thread overview]
Message-ID: <20251120174429.390574-2-ast@fiberby.net> (raw)
In-Reply-To: <20251120174429.390574-1-ast@fiberby.net>

This patch adds a new CLI argument for overriding the default
function prefix, as used for naming the doit/dumpit functions
in the generated kernel code.

When not specified the default "$(FAMILY)-nl" is used.

This can also be specified persistently in generated files:
  /* YNL-ARG --function-prefix wg */

In the above example it causes the following changes:
  wireguard_nl_get_device_dumpit() -> wg_get_device_dumpit()
  wireguard_nl_get_device_doit()   -> wg_get_device_doit()

The variable name fn_prefix, was chosen as it relates to op_prefix
which is used to prefix the UAPI commands enum entries.

Link: https://lore.kernel.org/r/aRvWzC8qz3iXDAb3@zx2c4.com/
Suggested-by: Jason A. Donenfeld <Jason@zx2c4.com>
Signed-off-by: Asbjørn Sloth Tønnesen <ast@fiberby.net>
---
 tools/net/ynl/pyynl/ynl_gen_c.py | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/tools/net/ynl/pyynl/ynl_gen_c.py b/tools/net/ynl/pyynl/ynl_gen_c.py
index aadeb3abcad8..0dd589e502cb 100755
--- a/tools/net/ynl/pyynl/ynl_gen_c.py
+++ b/tools/net/ynl/pyynl/ynl_gen_c.py
@@ -1205,7 +1205,7 @@ class SubMessage(SpecSubMessage):
 
 
 class Family(SpecFamily):
-    def __init__(self, file_name, exclude_ops):
+    def __init__(self, file_name, exclude_ops, fn_prefix):
         # Added by resolve:
         self.c_name = None
         delattr(self, "c_name")
@@ -1237,6 +1237,8 @@ class Family(SpecFamily):
         else:
             self.uapi_header_name = self.ident_name
 
+        self.fn_prefix = fn_prefix if fn_prefix else f'{self.ident_name}-nl'
+
     def resolve(self):
         self.resolve_up(super())
 
@@ -2911,12 +2913,12 @@ def print_kernel_op_table_fwd(family, cw, terminate):
             continue
 
         if 'do' in op:
-            name = c_lower(f"{family.ident_name}-nl-{op_name}-doit")
+            name = c_lower(f"{family.fn_prefix}-{op_name}-doit")
             cw.write_func_prot('int', name,
                                ['struct sk_buff *skb', 'struct genl_info *info'], suffix=';')
 
         if 'dump' in op:
-            name = c_lower(f"{family.ident_name}-nl-{op_name}-dumpit")
+            name = c_lower(f"{family.fn_prefix}-{op_name}-dumpit")
             cw.write_func_prot('int', name,
                                ['struct sk_buff *skb', 'struct netlink_callback *cb'], suffix=';')
     cw.nl()
@@ -2942,7 +2944,7 @@ def print_kernel_op_table(family, cw):
                                             for x in op['dont-validate']])), )
             for op_mode in ['do', 'dump']:
                 if op_mode in op:
-                    name = c_lower(f"{family.ident_name}-nl-{op_name}-{op_mode}it")
+                    name = c_lower(f"{family.fn_prefix}-{op_name}-{op_mode}it")
                     members.append((op_mode + 'it', name))
             if family.kernel_policy == 'per-op':
                 struct = Struct(family, op['attribute-set'],
@@ -2980,7 +2982,7 @@ def print_kernel_op_table(family, cw):
                         members.append(('validate',
                                         ' | '.join([c_upper('genl-dont-validate-' + x)
                                                     for x in dont_validate])), )
-                name = c_lower(f"{family.ident_name}-nl-{op_name}-{op_mode}it")
+                name = c_lower(f"{family.fn_prefix}-{op_name}-{op_mode}it")
                 if 'pre' in op[op_mode]:
                     members.append((cb_names[op_mode]['pre'], c_lower(op[op_mode]['pre'])))
                 members.append((op_mode + 'it', name))
@@ -3402,6 +3404,7 @@ def main():
                         help='Do not overwrite the output file if the new output is identical to the old')
     parser.add_argument('--exclude-op', action='append', default=[])
     parser.add_argument('-o', dest='out_file', type=str, default=None)
+    parser.add_argument('--function-prefix', dest='fn_prefix', type=str)
     args = parser.parse_args()
 
     if args.header is None:
@@ -3410,7 +3413,7 @@ def main():
     exclude_ops = [re.compile(expr) for expr in args.exclude_op]
 
     try:
-        parsed = Family(args.spec, exclude_ops)
+        parsed = Family(args.spec, exclude_ops, args.fn_prefix)
         if parsed.license != '((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)':
             print('Spec license:', parsed.license)
             print('License must be: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)')
@@ -3430,10 +3433,14 @@ def main():
     cw.p("/* Do not edit directly, auto-generated from: */")
     cw.p(f"/*\t{spec_kernel} */")
     cw.p(f"/* YNL-GEN {args.mode} {'header' if args.header else 'source'} */")
-    if args.exclude_op or args.user_header:
+    if args.exclude_op or args.user_header or args.fn_prefix:
         line = ''
-        line += ' --user-header '.join([''] + args.user_header)
-        line += ' --exclude-op '.join([''] + args.exclude_op)
+        if args.user_header:
+            line += ' --user-header '.join([''] + args.user_header)
+        if args.exclude_op:
+            line += ' --exclude-op '.join([''] + args.exclude_op)
+        if args.fn_prefix:
+            line += f' --function-prefix {args.fn_prefix}'
         cw.p(f'/* YNL-ARG{line} */')
     cw.nl()
 
-- 
2.51.0


  reply	other threads:[~2025-11-20 17:47 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-20 17:44 [PATCH net-next 0/2] tools: ynl-gen: regeneration comment + function prefix Asbjørn Sloth Tønnesen
2025-11-20 17:44 ` Asbjørn Sloth Tønnesen [this message]
2025-11-20 17:44 ` [PATCH net-next 2/2] tools: ynl-gen: add regeneration comment Asbjørn Sloth Tønnesen
2025-11-20 17:56   ` Matthieu Baerts
2025-11-20 18:02   ` Jakub Kicinski
2025-11-21  1:48     ` Jakub Kicinski
2025-11-26  4:00 ` [PATCH net-next 0/2] tools: ynl-gen: regeneration comment + function prefix patchwork-bot+netdevbpf

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251120174429.390574-2-ast@fiberby.net \
    --to=ast@fiberby.net \
    --cc=Dai.Ngo@oracle.com \
    --cc=Jason@zx2c4.com \
    --cc=almasrymina@google.com \
    --cc=andrew+netdev@lunn.ch \
    --cc=anna@kernel.org \
    --cc=antonio@openvpn.net \
    --cc=arkadiusz.kubalewski@intel.com \
    --cc=arve@android.com \
    --cc=brauner@kernel.org \
    --cc=chuck.lever@oracle.com \
    --cc=cmllamas@google.com \
    --cc=daniel.zahka@gmail.com \
    --cc=davem@davemloft.net \
    --cc=donald.hunter@gmail.com \
    --cc=dsahern@kernel.org \
    --cc=dualli@google.com \
    --cc=dw@davidwei.uk \
    --cc=edumazet@google.com \
    --cc=geliang@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=hare@kernel.org \
    --cc=horms@kernel.org \
    --cc=jacob.e.keller@intel.com \
    --cc=jdamato@fastly.com \
    --cc=jiri@resnulli.us \
    --cc=jlayton@kernel.org \
    --cc=joelagnelf@nvidia.com \
    --cc=kernel-tls-handshake@lists.linux.dev \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-nfs@vger.kernel.org \
    --cc=maco@android.com \
    --cc=martineau@kernel.org \
    --cc=matttbe@kernel.org \
    --cc=mptcp@lists.linux.dev \
    --cc=neil@brown.name \
    --cc=netdev@vger.kernel.org \
    --cc=okorniev@redhat.com \
    --cc=pabeni@redhat.com \
    --cc=sd@queasysnail.net \
    --cc=sdf@fomichev.me \
    --cc=skhawaja@google.com \
    --cc=surenb@google.com \
    --cc=tkjos@android.com \
    --cc=tom@talpey.com \
    --cc=trondmy@kernel.org \
    --cc=vadim.fedorenko@linux.dev \
    --cc=willemb@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox