From patchwork Sat Feb 18 19:12:43 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Trond Myklebust X-Patchwork-Id: 9581185 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id EC2EF6049F for ; Sat, 18 Feb 2017 19:12:53 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id DB69C286AE for ; Sat, 18 Feb 2017 19:12:53 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id D0138286DB; Sat, 18 Feb 2017 19:12:53 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.3 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI, RCVD_IN_SORBS_SPAM, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 51932286AE for ; Sat, 18 Feb 2017 19:12:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753872AbdBRTMw (ORCPT ); Sat, 18 Feb 2017 14:12:52 -0500 Received: from mail-it0-f68.google.com ([209.85.214.68]:32927 "EHLO mail-it0-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753550AbdBRTMv (ORCPT ); Sat, 18 Feb 2017 14:12:51 -0500 Received: by mail-it0-f68.google.com with SMTP id e137so6808277itc.0 for ; Sat, 18 Feb 2017 11:12:51 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=oMWE7YW7uGpqL02AvUI/+DTjLeTjC8ULYRdvd3/vuMc=; b=dqEXCj9aItSPxMpLDICkZ3cPqsOfajb8tsdvFNvdro4ReuD1a/ZQyhtbt1yR6dFhZb PD5SYzktIg0bwrr0pfHydCcrx5kqNstGh5sDAKJOKu1jzdoMRSVsRdnZe6+SQrJsiZuf XGat3+bD/s1b7MvN1Gnbu9yp9l/v2VCDuYOrpd42mF7LwZ2aphU8EcA7nIeQIlekr2g3 XnxWS5CD5fPAeAsVChMPnwdnHGSIbAgFG9x5ogZYcWYILZabHwd00OzrAp7X4Vm8MznV N9I0DDusJw2YE/7yQHbmxlkdE11kqyVKWjULbB2a+GHnXRxDlU+41p23ZoMHP0l5MMrx nS6w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references; bh=oMWE7YW7uGpqL02AvUI/+DTjLeTjC8ULYRdvd3/vuMc=; b=Y0EpSxAtrQIJQGsx/opDWUKiT3oD3i+gEHzhWNos3C0ercjlb14MviwB+jVmvE8iWH Mf6U1GIbi01hdYNiwEt8KoZb+rikXrZ/vs885Gtk/pJDHydYxZ0eb3zTfKuxeFAvqgzF XLJgITyDWncWrz9nzL+3K7c1SDdEtWFhqDY3ZGsFeRDkZ2830u9BwYTWQsvlC6DDsmWk gnLOYwXECRYEB6IonYBl46m8egVz0VpJD/vhNkFqiHw58CXXhBNnuK5Sinyls2b2vSZD qkY6Mpc59TTgYGvIHfdC28AASj5YRDpAxGHMLLGlZwmHU6UOnwpDne14XpU0Xhp+EcW/ ou9A== X-Gm-Message-State: AMke39lEI3BrIigTvrbCC3ZEx5E/atWiDjYBMlNHRukkg+y2MrClKRlQqlqGD9uO3YKCmA== X-Received: by 10.36.25.133 with SMTP id b127mr12509006itb.122.1487445170967; Sat, 18 Feb 2017 11:12:50 -0800 (PST) Received: from localhost.localdomain ([50.124.63.84]) by smtp.gmail.com with ESMTPSA id 35sm6823174ior.50.2017.02.18.11.12.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 18 Feb 2017 11:12:50 -0800 (PST) From: Trond Myklebust To: Anna Schumaker Cc: linux-nfs@vger.kernel.org Subject: [PATCH v3 1/4] SUNRPC: Add generic helpers for xdr_stream encode/decode Date: Sat, 18 Feb 2017 14:12:43 -0500 Message-Id: <20170218191246.32687-2-trond.myklebust@primarydata.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20170218191246.32687-1-trond.myklebust@primarydata.com> References: <20170218191246.32687-1-trond.myklebust@primarydata.com> Sender: linux-nfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-nfs@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add some generic helpers for encoding/decoding opaque structures and basic u32/u64. Signed-off-by: Trond Myklebust Reviewed-by: Chuck Lever --- include/linux/sunrpc/xdr.h | 173 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 173 insertions(+) diff --git a/include/linux/sunrpc/xdr.h b/include/linux/sunrpc/xdr.h index 56c48c884a24..37bf1be20b62 100644 --- a/include/linux/sunrpc/xdr.h +++ b/include/linux/sunrpc/xdr.h @@ -242,6 +242,179 @@ extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len); extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len); extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data); +/** + * xdr_align_size - Calculate padded size of an object + * @n: Size of an object being XDR encoded (in bytes) + * + * Return value: + * Size (in bytes) of the object including xdr padding + */ +static inline size_t +xdr_align_size(size_t n) +{ + const size_t mask = sizeof(__u32) - 1; + + return (n + mask) & ~mask; +} + +/** + * xdr_stream_encode_u32 - Encode a 32-bit integer + * @xdr: pointer to xdr_stream + * @n: integer to encode + * + * Return values: + * On success, returns length in bytes of XDR buffer consumed + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_encode_u32(struct xdr_stream *xdr, __u32 n) +{ + const size_t len = sizeof(n); + __be32 *p = xdr_reserve_space(xdr, len); + + if (unlikely(!p)) + return -ENOBUFS; + *p = cpu_to_be32(n); + return len; +} + +/** + * xdr_stream_encode_u64 - Encode a 64-bit integer + * @xdr: pointer to xdr_stream + * @n: 64-bit integer to encode + * + * Return values: + * On success, returns length in bytes of XDR buffer consumed + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_encode_u64(struct xdr_stream *xdr, __u64 n) +{ + const size_t len = sizeof(n); + __be32 *p = xdr_reserve_space(xdr, len); + + if (unlikely(!p)) + return -ENOBUFS; + xdr_encode_hyper(p, n); + return len; +} + +/** + * xdr_stream_encode_opaque_fixed - Encode fixed length opaque xdr data + * @xdr: pointer to xdr_stream + * @ptr: pointer to opaque data object + * @len: size of object pointed to by @ptr + * + * Return values: + * On success, returns length in bytes of XDR buffer consumed + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_encode_opaque_fixed(struct xdr_stream *xdr, const void *ptr, size_t len) +{ + __be32 *p = xdr_reserve_space(xdr, len); + + if (unlikely(!p)) + return -ENOBUFS; + xdr_encode_opaque_fixed(p, ptr, len); + return xdr_align_size(len); +} + +/** + * xdr_stream_encode_opaque - Encode variable length opaque xdr data + * @xdr: pointer to xdr_stream + * @ptr: pointer to opaque data object + * @len: size of object pointed to by @ptr + * + * Return values: + * On success, returns length in bytes of XDR buffer consumed + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_encode_opaque(struct xdr_stream *xdr, const void *ptr, size_t len) +{ + size_t count = sizeof(__u32) + xdr_align_size(len); + __be32 *p = xdr_reserve_space(xdr, count); + + if (unlikely(!p)) + return -ENOBUFS; + xdr_encode_opaque(p, ptr, len); + return count; +} + +/** + * xdr_stream_decode_u32 - Decode a 32-bit integer + * @xdr: pointer to xdr_stream + * @ptr: location to store integer + * + * Return values: + * %0 on success + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_decode_u32(struct xdr_stream *xdr, __u32 *ptr) +{ + const size_t count = sizeof(*ptr); + __be32 *p = xdr_inline_decode(xdr, count); + + if (unlikely(!p)) + return -ENOBUFS; + *ptr = be32_to_cpup(p); + return 0; +} + +/** + * xdr_stream_decode_opaque_fixed - Decode fixed length opaque xdr data + * @xdr: pointer to xdr_stream + * @ptr: location to store data + * @len: size of buffer pointed to by @ptr + * + * Return values: + * On success, returns size of object stored in @ptr + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_decode_opaque_fixed(struct xdr_stream *xdr, void *ptr, size_t len) +{ + __be32 *p = xdr_inline_decode(xdr, len); + + if (unlikely(!p)) + return -ENOBUFS; + xdr_decode_opaque_fixed(p, ptr, len); + return len; +} + +/** + * xdr_stream_decode_opaque_inline - Decode variable length opaque xdr data + * @xdr: pointer to xdr_stream + * @ptr: location to store pointer to opaque data + * + * Note: the pointer stored in @ptr cannot be assumed valid after the XDR + * buffer has been destroyed, or even after calling xdr_inline_decode() + * on @xdr. It is therefore expected that the object it points to should + * be processed immediately. + * + * Return values: + * On success, returns size of object stored in *@ptr + * %-ENOBUFS on XDR buffer overflow + */ +static inline ssize_t +xdr_stream_decode_opaque_inline(struct xdr_stream *xdr, void **ptr) +{ + __be32 *p; + __u32 len; + + if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0)) + return -ENOBUFS; + if (len != 0) { + p = xdr_inline_decode(xdr, len); + if (unlikely(!p)) + return -ENOBUFS; + *ptr = p; + } else + *ptr = NULL; + return len; +} #endif /* __KERNEL__ */ #endif /* _SUNRPC_XDR_H_ */