linux-nfs.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Chuck Lever <cel@kernel.org>
To: NeilBrown <neil@brown.name>, Jeff Layton <jlayton@kernel.org>,
	Olga Kornievskaia <okorniev@redhat.com>,
	Dai Ngo <dai.ngo@oracle.com>, Tom Talpey <tom@talpey.com>
Cc: <linux-nfs@vger.kernel.org>, Chuck Lever <chuck.lever@oracle.com>
Subject: [PATCH v1 08/36] lockd: Move xdr.h from include/linux/lockd/ to fs/lockd/
Date: Thu, 18 Dec 2025 15:13:18 -0500	[thread overview]
Message-ID: <20251218201346.1190928-9-cel@kernel.org> (raw)
In-Reply-To: <20251218201346.1190928-1-cel@kernel.org>

From: Chuck Lever <chuck.lever@oracle.com>

The lockd subsystem unnecessarily exposes internal NLM XDR type
definitions through the global include path. These definitions are
not used by any code outside fs/lockd/, making them inappropriate
for include/linux/lockd/.

Moving xdr.h to fs/lockd/ narrows the API surface and clarifies
that these types are internal implementation details. The comment
in linux/lockd/bind.h claiming xdr.h was needed for "xdr-encoded
error codes" is stale: no lockd API consumers actually use those
codes. A forward declaration for struct nfs_fh is needed because
its definition was previously pulled in transitively through xdr.h.

Built and tested with lockd client/server operations. No functional
change.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 fs/lockd/lockd.h                  | 2 +-
 {include/linux => fs}/lockd/xdr.h | 8 +++-----
 include/linux/lockd/bind.h        | 3 +--
 3 files changed, 5 insertions(+), 8 deletions(-)
 rename {include/linux => fs}/lockd/xdr.h (96%)

diff --git a/fs/lockd/lockd.h b/fs/lockd/lockd.h
index 535f752d5de1..94345bf2d6ce 100644
--- a/fs/lockd/lockd.h
+++ b/fs/lockd/lockd.h
@@ -15,7 +15,7 @@
 #include <linux/refcount.h>
 #include <linux/utsname.h>
 #include <linux/lockd/bind.h>
-#include <linux/lockd/xdr.h>
+#include "xdr.h"
 #include <linux/sunrpc/debug.h>
 #include <linux/sunrpc/svc.h>
 
diff --git a/include/linux/lockd/xdr.h b/fs/lockd/xdr.h
similarity index 96%
rename from include/linux/lockd/xdr.h
rename to fs/lockd/xdr.h
index 17d53165d9f2..a8090191434e 100644
--- a/include/linux/lockd/xdr.h
+++ b/fs/lockd/xdr.h
@@ -1,14 +1,12 @@
 /* SPDX-License-Identifier: GPL-2.0 */
 /*
- * linux/include/linux/lockd/xdr.h
- *
  * XDR types for the NLM protocol
  *
  * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
  */
 
-#ifndef LOCKD_XDR_H
-#define LOCKD_XDR_H
+#ifndef _LOCKD_XDR_H
+#define _LOCKD_XDR_H
 
 #include <linux/fs.h>
 #include <linux/filelock.h>
@@ -112,4 +110,4 @@ bool	nlmsvc_encode_res(struct svc_rqst *rqstp, struct xdr_stream *xdr);
 bool	nlmsvc_encode_void(struct svc_rqst *rqstp, struct xdr_stream *xdr);
 bool	nlmsvc_encode_shareres(struct svc_rqst *rqstp, struct xdr_stream *xdr);
 
-#endif /* LOCKD_XDR_H */
+#endif /* _LOCKD_XDR_H */
diff --git a/include/linux/lockd/bind.h b/include/linux/lockd/bind.h
index be11b9795934..fdb906ae65d2 100644
--- a/include/linux/lockd/bind.h
+++ b/include/linux/lockd/bind.h
@@ -11,10 +11,9 @@
 #define LINUX_LOCKD_BIND_H
 
 #include <linux/lockd/nlm.h>
-/* need xdr-encoded error codes too, so... */
-#include <linux/lockd/xdr.h>
 
 /* Dummy declarations */
+struct nfs_fh;
 struct svc_rqst;
 struct rpc_task;
 struct rpc_clnt;
-- 
2.52.0


  parent reply	other threads:[~2025-12-18 20:13 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-18 20:13 [PATCH v1 00/36] Clarify module API boundaries Chuck Lever
2025-12-18 20:13 ` [PATCH v1 01/36] lockd: Have nlm_fopen() return errno values Chuck Lever
2025-12-18 20:13 ` [PATCH v1 02/36] lockd: Relocate nlmsvc_unlock API declarations Chuck Lever
2025-12-18 20:13 ` [PATCH v1 03/36] NFS: Use nlmclnt_rpc_clnt() helper to retrieve nlm_host's rpc_clnt Chuck Lever
2025-12-18 20:13 ` [PATCH v1 04/36] lockd: Move xdr4.h from include/linux/lockd/ to fs/lockd/ Chuck Lever
2025-12-18 20:13 ` [PATCH v1 05/36] lockd: Move share.h " Chuck Lever
2025-12-18 20:13 ` [PATCH v1 06/36] lockd: Relocate include/linux/lockd/lockd.h Chuck Lever
2025-12-18 20:13 ` [PATCH v1 07/36] lockd: Remove lockd/debug.h Chuck Lever
2025-12-18 20:13 ` Chuck Lever [this message]
2025-12-18 20:13 ` [PATCH v1 09/36] Documentation: Add the RPC language description of NLM version 4 Chuck Lever
2025-12-18 20:13 ` [PATCH v1 10/36] lockd: Use xdrgen XDR functions for the NLMv4 NULL procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 11/36] lockd: Use xdrgen XDR functions for the NLMv4 TEST procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 12/36] lockd: Use xdrgen XDR functions for the NLMv4 LOCK procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 13/36] lockd: Use xdrgen XDR functions for the NLMv4 CANCEL procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 14/36] lockd: Use xdrgen XDR functions for the NLMv4 UNLOCK procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 15/36] lockd: Use xdrgen XDR functions for the NLMv4 GRANTED procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 16/36] lockd: Refactor nlm4svc_callback() Chuck Lever
2025-12-18 20:13 ` [PATCH v1 17/36] lockd: Use xdrgen XDR functions for the NLMv4 TEST_MSG procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 18/36] lockd: Use xdrgen XDR functions for the NLMv4 LOCK_MSG procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 19/36] lockd: Use xdrgen XDR functions for the NLMv4 CANCEL_MSG procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 20/36] lockd: Use xdrgen XDR functions for the NLMv4 UNLOCK_MSG procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 21/36] lockd: Use xdrgen XDR functions for the NLMv4 GRANTED_MSG procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 22/36] lockd: Convert server-side NLMPROC4_TEST_RES to use xdrgen Chuck Lever
2025-12-18 20:13 ` [PATCH v1 23/36] lockd: Convert server-side NLMPROC4_LOCK_RES " Chuck Lever
2025-12-18 20:13 ` [PATCH v1 24/36] lockd: Convert server-side NLMPROC4_CANCEL_RES " Chuck Lever
2025-12-18 20:13 ` [PATCH v1 25/36] lockd: Convert server-side NLMPROC4_UNLOCK_RES " Chuck Lever
2025-12-18 20:13 ` [PATCH v1 26/36] lockd: Convert server-side NLMPROC4_GRANTED_RES " Chuck Lever
2025-12-18 20:13 ` [PATCH v1 27/36] lockd: Use xdrgen XDR functions for the NLMv4 SM_NOTIFY procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 28/36] lockd: Convert server-side undefined procedures to xdrgen Chuck Lever
2025-12-18 20:13 ` [PATCH v1 29/36] lockd: Hoist file_lock init out of nlm4svc_decode_shareargs() Chuck Lever
2025-12-18 20:13 ` [PATCH v1 30/36] lockd: Update share_file helpers Chuck Lever
2025-12-18 20:13 ` [PATCH v1 31/36] lockd: Use xdrgen XDR functions for the NLMv4 SHARE procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 32/36] lockd: Use xdrgen XDR functions for the NLMv4 UNSHARE procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 33/36] lockd: Use xdrgen XDR functions for the NLMv4 NM_LOCK procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 34/36] lockd: Use xdrgen XDR functions for the NLMv4 FREE_ALL procedure Chuck Lever
2025-12-18 20:13 ` [PATCH v1 35/36] lockd: Remove utilities that are no longer used Chuck Lever
2025-12-19 14:47   ` Jeff Layton
2025-12-18 20:13 ` [PATCH v1 36/36] lockd: Remove dead code from fs/lockd/xdr4.c Chuck Lever
2025-12-19 14:51 ` [PATCH v1 00/36] Clarify module API boundaries Jeff Layton

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=20251218201346.1190928-9-cel@kernel.org \
    --to=cel@kernel.org \
    --cc=chuck.lever@oracle.com \
    --cc=dai.ngo@oracle.com \
    --cc=jlayton@kernel.org \
    --cc=linux-nfs@vger.kernel.org \
    --cc=neil@brown.name \
    --cc=okorniev@redhat.com \
    --cc=tom@talpey.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;
as well as URLs for NNTP newsgroup(s).