All of lore.kernel.org
 help / color / mirror / Atom feed
From: Chuck Lever <chuck.lever@oracle.com>
To: bfields@fieldses.org
Cc: linux-nfs@vger.kernel.org
Subject: [PATCH 03/29] lockd: Common NLM XDR helpers
Date: Thu, 03 Jun 2021 16:50:52 -0400	[thread overview]
Message-ID: <162275345217.32691.12086548088820348898.stgit@klimt.1015granger.net> (raw)
In-Reply-To: <162275337584.32691.3943139351165347555.stgit@klimt.1015granger.net>

Add a .h file containing xdr_stream-based XDR helpers common to both
NLMv3 and NLMv4.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 fs/lockd/svcxdr.h |  151 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 151 insertions(+)
 create mode 100644 fs/lockd/svcxdr.h

diff --git a/fs/lockd/svcxdr.h b/fs/lockd/svcxdr.h
new file mode 100644
index 000000000000..c69a0bb76c94
--- /dev/null
+++ b/fs/lockd/svcxdr.h
@@ -0,0 +1,151 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Encode/decode NLM basic data types
+ *
+ * Basic NLMv3 XDR data types are not defined in an IETF standards
+ * document.  X/Open has a description of these data types that
+ * is useful.  See Chapter 10 of "Protocols for Interworking:
+ * XNFS, Version 3W".
+ *
+ * Basic NLMv4 XDR data types are defined in Appendix II.1.4 of
+ * RFC 1813: "NFS Version 3 Protocol Specification".
+ *
+ * Author: Chuck Lever <chuck.lever@oracle.com>
+ *
+ * Copyright (c) 2020, Oracle and/or its affiliates.
+ */
+
+#ifndef _LOCKD_SVCXDR_H_
+#define _LOCKD_SVCXDR_H_
+
+static inline bool
+svcxdr_decode_stats(struct xdr_stream *xdr, __be32 *status)
+{
+	__be32 *p;
+
+	p = xdr_inline_decode(xdr, XDR_UNIT);
+	if (!p)
+		return false;
+	*status = *p;
+
+	return true;
+}
+
+static inline bool
+svcxdr_encode_stats(struct xdr_stream *xdr, __be32 status)
+{
+	__be32 *p;
+
+	p = xdr_reserve_space(xdr, XDR_UNIT);
+	if (!p)
+		return false;
+	*p = status;
+
+	return true;
+}
+
+static inline bool
+svcxdr_decode_string(struct xdr_stream *xdr, char **data, unsigned int *data_len)
+{
+	__be32 *p;
+	u32 len;
+
+	if (xdr_stream_decode_u32(xdr, &len) < 0)
+		return false;
+	if (len > NLM_MAXSTRLEN)
+		return false;
+	p = xdr_inline_decode(xdr, len);
+	if (!p)
+		return false;
+	*data_len = len;
+	*data = (char *)p;
+
+	return true;
+}
+
+/*
+ * NLM cookies are defined by specification to be a variable-length
+ * XDR opaque no longer than 1024 bytes. However, this implementation
+ * limits their length to 32 bytes, and treats zero-length cookies
+ * specially.
+ */
+static inline bool
+svcxdr_decode_cookie(struct xdr_stream *xdr, struct nlm_cookie *cookie)
+{
+	__be32 *p;
+	u32 len;
+
+	if (xdr_stream_decode_u32(xdr, &len) < 0)
+		return false;
+	if (len > NLM_MAXCOOKIELEN)
+		return false;
+	if (!len)
+		goto out_hpux;
+
+	p = xdr_inline_decode(xdr, len);
+	if (!p)
+		return false;
+	cookie->len = len;
+	memcpy(cookie->data, p, len);
+
+	return true;
+
+	/* apparently HPUX can return empty cookies */
+out_hpux:
+	cookie->len = 4;
+	memset(cookie->data, 0, 4);
+	return true;
+}
+
+static inline bool
+svcxdr_encode_cookie(struct xdr_stream *xdr, const struct nlm_cookie *cookie)
+{
+	__be32 *p;
+
+	if (xdr_stream_encode_u32(xdr, cookie->len) < 0)
+		return false;
+	p = xdr_reserve_space(xdr, cookie->len);
+	if (!p)
+		return false;
+	memcpy(p, cookie->data, cookie->len);
+
+	return true;
+}
+
+static inline bool
+svcxdr_decode_owner(struct xdr_stream *xdr, struct xdr_netobj *obj)
+{
+	__be32 *p;
+	u32 len;
+
+	if (xdr_stream_decode_u32(xdr, &len) < 0)
+		return false;
+	if (len > XDR_MAX_NETOBJ)
+		return false;
+	p = xdr_inline_decode(xdr, len);
+	if (!p)
+		return false;
+	obj->len = len;
+	obj->data = (u8 *)p;
+
+	return true;
+}
+
+static inline bool
+svcxdr_encode_owner(struct xdr_stream *xdr, const struct xdr_netobj *obj)
+{
+	unsigned int quadlen = XDR_QUADLEN(obj->len);
+	__be32 *p;
+
+	if (xdr_stream_encode_u32(xdr, obj->len) < 0)
+		return false;
+	p = xdr_reserve_space(xdr, obj->len);
+	if (!p)
+		return false;
+	p[quadlen - 1] = 0;	/* XDR pad */
+	memcpy(p, obj->data, obj->len);
+
+	return true;
+}
+
+#endif /* _LOCKD_SVCXDR_H_ */



  parent reply	other threads:[~2021-06-03 20:50 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-03 20:50 [PATCH 00/29] XDR overhaul for server-side lockd Chuck Lever
2021-06-03 20:50 ` [PATCH 01/29] lockd: Remove stale comments Chuck Lever
2021-06-03 20:50 ` [PATCH 02/29] lockd: Create a simplified .vs_dispatch method for NLM requests Chuck Lever
2021-06-03 20:50 ` Chuck Lever [this message]
2021-06-03 20:50 ` [PATCH 04/29] lockd: Update the NLMv1 void argument decoder to use struct xdr_stream Chuck Lever
2021-06-03 20:51 ` [PATCH 05/29] lockd: Update the NLMv1 TEST arguments " Chuck Lever
2021-06-03 20:51 ` [PATCH 06/29] lockd: Update the NLMv1 LOCK " Chuck Lever
2021-06-03 20:51 ` [PATCH 07/29] lockd: Update the NLMv1 CANCEL " Chuck Lever
2021-06-03 20:51 ` [PATCH 08/29] lockd: Update the NLMv1 UNLOCK " Chuck Lever
2021-06-03 20:51 ` [PATCH 09/29] lockd: Update the NLMv1 nlm_res " Chuck Lever
2021-06-03 20:51 ` [PATCH 10/29] lockd: Update the NLMv1 SM_NOTIFY " Chuck Lever
2021-06-03 20:51 ` [PATCH 11/29] lockd: Update the NLMv1 SHARE " Chuck Lever
2021-06-03 20:51 ` [PATCH 12/29] lockd: Update the NLMv1 FREE_ALL " Chuck Lever
2021-06-03 20:51 ` [PATCH 13/29] lockd: Update the NLMv1 void results encoder " Chuck Lever
2021-06-03 20:51 ` [PATCH 14/29] lockd: Update the NLMv1 TEST " Chuck Lever
2021-06-03 20:52 ` [PATCH 15/29] lockd: Update the NLMv1 nlm_res " Chuck Lever
2021-06-03 20:52 ` [PATCH 16/29] lockd: Update the NLMv1 SHARE " Chuck Lever
2021-06-03 20:52 ` [PATCH 17/29] lockd: Update the NLMv4 void arguments decoder " Chuck Lever
2021-06-03 20:52 ` [PATCH 18/29] lockd: Update the NLMv4 TEST " Chuck Lever
2021-06-03 20:52 ` [PATCH 19/29] lockd: Update the NLMv4 LOCK " Chuck Lever
2021-06-03 20:52 ` [PATCH 20/29] lockd: Update the NLMv4 CANCEL " Chuck Lever
2021-06-03 20:52 ` [PATCH 21/29] lockd: Update the NLMv4 UNLOCK " Chuck Lever
2021-06-03 20:52 ` [PATCH 22/29] lockd: Update the NLMv4 nlm_res " Chuck Lever
2021-06-03 20:52 ` [PATCH 23/29] lockd: Update the NLMv4 SM_NOTIFY " Chuck Lever
2021-06-03 20:52 ` [PATCH 24/29] lockd: Update the NLMv4 SHARE " Chuck Lever
2021-06-03 20:53 ` [PATCH 25/29] lockd: Update the NLMv4 FREE_ALL " Chuck Lever
2021-06-03 20:53 ` [PATCH 26/29] lockd: Update the NLMv4 void results encoder " Chuck Lever
2021-06-03 20:53 ` [PATCH 27/29] lockd: Update the NLMv4 TEST " Chuck Lever
2021-06-03 20:53 ` [PATCH 28/29] lockd: Update the NLMv4 nlm_res " Chuck Lever
2021-06-03 20:53 ` [PATCH 29/29] lockd: Update the NLMv4 SHARE " Chuck Lever
2021-06-16 14:53 ` [PATCH 00/29] XDR overhaul for server-side lockd J. Bruce Fields

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=162275345217.32691.12086548088820348898.stgit@klimt.1015granger.net \
    --to=chuck.lever@oracle.com \
    --cc=bfields@fieldses.org \
    --cc=linux-nfs@vger.kernel.org \
    --subject='Re: [PATCH 03/29] lockd: Common NLM XDR helpers' \
    /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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.