Commit 8e1d3227 authored by Jeff Layton's avatar Jeff Layton Committed by Chuck Lever
Browse files

nfs_common: make include/linux/nfs4.h include generated nfs4_1.h 



In the long run, the NFS development community intends to autogenerate a
lot of the XDR handling code.  Both the NFS client and server include
"include/linux/nfs4.hi". That file was hand-rolled, and some of the symbols
in it conflict with the autogenerated symbols.

Add a small nfs4_1.x to Documentation that currently just has the
necessary definitions for the delstid draft, and generate the relevant
header and source files. Make include/linux/nfs4.h include the generated
include/linux/sunrpc/xdrgen/nfs4_1.h and remove the conflicting
definitions from it and nfs_xdr.h.

Signed-off-by: default avatarJeff Layton <jlayton@kernel.org>
Signed-off-by: default avatarChuck Lever <chuck.lever@oracle.com>
parent 53150305

Documentation/sunrpc/xdr/nfs4_1.x

0 → 100644
+166 −0
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2010 IETF Trust and the persons identified

 * as the document authors.  All rights reserved.

 *

 * The document authors are identified in RFC 3530 and

 * RFC 5661.

 *

 * Redistribution and use in source and binary forms, with

 * or without modification, are permitted provided that the

 * following conditions are met:

 *

 * - Redistributions of source code must retain the above

 *   copyright notice, this list of conditions and the

 *   following disclaimer.

 *

 * - Redistributions in binary form must reproduce the above

 *   copyright notice, this list of conditions and the

 *   following disclaimer in the documentation and/or other

 *   materials provided with the distribution.

 *

 * - Neither the name of Internet Society, IETF or IETF

 *   Trust, nor the names of specific contributors, may be

 *   used to endorse or promote products derived from this

 *   software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS

 *   AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED

 *   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

 *   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

 *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO

 *   EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE

 *   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

 *   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

 *   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

 *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

 *   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING

 *   IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

 *   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



pragma header nfs4;



/*

 * Basic typedefs for RFC 1832 data type definitions

 */

typedef hyper		int64_t;

typedef unsigned int	uint32_t;



/*

 * Basic data types

 */

typedef uint32_t	bitmap4<>;



/*

 * Timeval

 */

struct nfstime4 {

	int64_t		seconds;

	uint32_t	nseconds;

};





/*

 * The following content was extracted from draft-ietf-nfsv4-delstid

 */



typedef bool            fattr4_offline;





const FATTR4_OFFLINE            = 83;





struct open_arguments4 {

  bitmap4  oa_share_access;

  bitmap4  oa_share_deny;

  bitmap4  oa_share_access_want;

  bitmap4  oa_open_claim;

  bitmap4  oa_create_mode;

};





enum open_args_share_access4 {

   OPEN_ARGS_SHARE_ACCESS_READ  = 1,

   OPEN_ARGS_SHARE_ACCESS_WRITE = 2,

   OPEN_ARGS_SHARE_ACCESS_BOTH  = 3

};





enum open_args_share_deny4 {

   OPEN_ARGS_SHARE_DENY_NONE  = 0,

   OPEN_ARGS_SHARE_DENY_READ  = 1,

   OPEN_ARGS_SHARE_DENY_WRITE = 2,

   OPEN_ARGS_SHARE_DENY_BOTH  = 3

};





enum open_args_share_access_want4 {

   OPEN_ARGS_SHARE_ACCESS_WANT_ANY_DELEG           = 3,

   OPEN_ARGS_SHARE_ACCESS_WANT_NO_DELEG            = 4,

   OPEN_ARGS_SHARE_ACCESS_WANT_CANCEL              = 5,

   OPEN_ARGS_SHARE_ACCESS_WANT_SIGNAL_DELEG_WHEN_RESRC_AVAIL

                                                   = 17,

   OPEN_ARGS_SHARE_ACCESS_WANT_PUSH_DELEG_WHEN_UNCONTENDED

                                                   = 18,

   OPEN_ARGS_SHARE_ACCESS_WANT_DELEG_TIMESTAMPS    = 20,

   OPEN_ARGS_SHARE_ACCESS_WANT_OPEN_XOR_DELEGATION = 21

};





enum open_args_open_claim4 {

   OPEN_ARGS_OPEN_CLAIM_NULL          = 0,

   OPEN_ARGS_OPEN_CLAIM_PREVIOUS      = 1,

   OPEN_ARGS_OPEN_CLAIM_DELEGATE_CUR  = 2,

   OPEN_ARGS_OPEN_CLAIM_DELEGATE_PREV = 3,

   OPEN_ARGS_OPEN_CLAIM_FH            = 4,

   OPEN_ARGS_OPEN_CLAIM_DELEG_CUR_FH  = 5,

   OPEN_ARGS_OPEN_CLAIM_DELEG_PREV_FH = 6

};





enum open_args_createmode4 {

   OPEN_ARGS_CREATEMODE_UNCHECKED4     = 0,

   OPEN_ARGS_CREATE_MODE_GUARDED       = 1,

   OPEN_ARGS_CREATEMODE_EXCLUSIVE4     = 2,

   OPEN_ARGS_CREATE_MODE_EXCLUSIVE4_1  = 3

};





typedef open_arguments4 fattr4_open_arguments;

pragma public fattr4_open_arguments;





%/*

% * Determine what OPEN supports.

% */

const FATTR4_OPEN_ARGUMENTS     = 86;





const OPEN4_SHARE_ACCESS_WANT_OPEN_XOR_DELEGATION = 0x200000;





const OPEN4_RESULT_NO_OPEN_STATEID = 0x00000010;





/*

 * attributes for the delegation times being

 * cached and served by the "client"

 */

typedef nfstime4        fattr4_time_deleg_access;

typedef nfstime4        fattr4_time_deleg_modify;

pragma public 		fattr4_time_deleg_access;

pragma public		fattr4_time_deleg_modify;





%/*

% * New RECOMMENDED Attribute for

% * delegation caching of times

% */

const FATTR4_TIME_DELEG_ACCESS  = 84;

const FATTR4_TIME_DELEG_MODIFY  = 85;





const OPEN4_SHARE_ACCESS_WANT_DELEG_TIMESTAMPS = 0x100000;

fs/nfsd/Makefile

+15 −1
Original line number Diff line number Diff line
@@ -18,9 +18,23 @@ nfsd-$(CONFIG_NFSD_V2) += nfsproc.o nfsxdr.o 
nfsd-$(CONFIG_NFSD_V2_ACL) += nfs2acl.o

nfsd-$(CONFIG_NFSD_V3_ACL) += nfs3acl.o

nfsd-$(CONFIG_NFSD_V4)	+= nfs4proc.o nfs4xdr.o nfs4state.o nfs4idmap.o \

			   nfs4acl.o nfs4callback.o nfs4recover.o

			   nfs4acl.o nfs4callback.o nfs4recover.o nfs4xdr_gen.o

nfsd-$(CONFIG_NFSD_PNFS) += nfs4layouts.o

nfsd-$(CONFIG_NFSD_BLOCKLAYOUT) += blocklayout.o blocklayoutxdr.o

nfsd-$(CONFIG_NFSD_SCSILAYOUT) += blocklayout.o blocklayoutxdr.o

nfsd-$(CONFIG_NFSD_FLEXFILELAYOUT) += flexfilelayout.o flexfilelayoutxdr.o

nfsd-$(CONFIG_NFS_LOCALIO) += localio.o





.PHONY: xdrgen



xdrgen: ../../include/linux/sunrpc/xdrgen/nfs4_1.h nfs4xdr_gen.h nfs4xdr_gen.c



../../include/linux/sunrpc/xdrgen/nfs4_1.h: ../../Documentation/sunrpc/xdr/nfs4_1.x

	../../tools/net/sunrpc/xdrgen/xdrgen definitions $< > $@



nfs4xdr_gen.h: ../../Documentation/sunrpc/xdr/nfs4_1.x

	../../tools/net/sunrpc/xdrgen/xdrgen declarations $< > $@



nfs4xdr_gen.c: ../../Documentation/sunrpc/xdr/nfs4_1.x

	../../tools/net/sunrpc/xdrgen/xdrgen source $< > $@

fs/nfsd/nfs4xdr_gen.c

0 → 100644
+239 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0

// Generated by xdrgen. Manual edits will be lost.

// XDR specification file: ../../Documentation/sunrpc/xdr/nfs4_1.x

// XDR specification modification time: Thu Oct  3 11:30:59 2024



#include <linux/sunrpc/svc.h>



#include "nfs4xdr_gen.h"



static bool __maybe_unused

xdrgen_decode_int64_t(struct xdr_stream *xdr, int64_t *ptr)

{

	return xdrgen_decode_hyper(xdr, ptr);

};



static bool __maybe_unused

xdrgen_decode_uint32_t(struct xdr_stream *xdr, uint32_t *ptr)

{

	return xdrgen_decode_unsigned_int(xdr, ptr);

};



static bool __maybe_unused

xdrgen_decode_bitmap4(struct xdr_stream *xdr, bitmap4 *ptr)

{

	if (xdr_stream_decode_u32(xdr, &ptr->count) < 0)

		return false;

	for (u32 i = 0; i < ptr->count; i++)

		if (!xdrgen_decode_uint32_t(xdr, &ptr->element[i]))

			return false;

	return true;

};



static bool __maybe_unused

xdrgen_decode_nfstime4(struct xdr_stream *xdr, struct nfstime4 *ptr)

{

	if (!xdrgen_decode_int64_t(xdr, &ptr->seconds))

		return false;

	if (!xdrgen_decode_uint32_t(xdr, &ptr->nseconds))

		return false;

	return true;

};



static bool __maybe_unused

xdrgen_decode_fattr4_offline(struct xdr_stream *xdr, fattr4_offline *ptr)

{

	return xdrgen_decode_bool(xdr, ptr);

};



static bool __maybe_unused

xdrgen_decode_open_arguments4(struct xdr_stream *xdr, struct open_arguments4 *ptr)

{

	if (!xdrgen_decode_bitmap4(xdr, &ptr->oa_share_access))

		return false;

	if (!xdrgen_decode_bitmap4(xdr, &ptr->oa_share_deny))

		return false;

	if (!xdrgen_decode_bitmap4(xdr, &ptr->oa_share_access_want))

		return false;

	if (!xdrgen_decode_bitmap4(xdr, &ptr->oa_open_claim))

		return false;

	if (!xdrgen_decode_bitmap4(xdr, &ptr->oa_create_mode))

		return false;

	return true;

};



static bool __maybe_unused

xdrgen_decode_open_args_share_access4(struct xdr_stream *xdr, open_args_share_access4 *ptr)

{

	u32 val;



	if (xdr_stream_decode_u32(xdr, &val) < 0)

		return false;

	*ptr = val;

	return true;

}



static bool __maybe_unused

xdrgen_decode_open_args_share_deny4(struct xdr_stream *xdr, open_args_share_deny4 *ptr)

{

	u32 val;



	if (xdr_stream_decode_u32(xdr, &val) < 0)

		return false;

	*ptr = val;

	return true;

}



static bool __maybe_unused

xdrgen_decode_open_args_share_access_want4(struct xdr_stream *xdr, open_args_share_access_want4 *ptr)

{

	u32 val;



	if (xdr_stream_decode_u32(xdr, &val) < 0)

		return false;

	*ptr = val;

	return true;

}



static bool __maybe_unused

xdrgen_decode_open_args_open_claim4(struct xdr_stream *xdr, open_args_open_claim4 *ptr)

{

	u32 val;



	if (xdr_stream_decode_u32(xdr, &val) < 0)

		return false;

	*ptr = val;

	return true;

}



static bool __maybe_unused

xdrgen_decode_open_args_createmode4(struct xdr_stream *xdr, open_args_createmode4 *ptr)

{

	u32 val;



	if (xdr_stream_decode_u32(xdr, &val) < 0)

		return false;

	*ptr = val;

	return true;

}



bool

xdrgen_decode_fattr4_open_arguments(struct xdr_stream *xdr, fattr4_open_arguments *ptr)

{

	return xdrgen_decode_open_arguments4(xdr, ptr);

};



bool

xdrgen_decode_fattr4_time_deleg_access(struct xdr_stream *xdr, fattr4_time_deleg_access *ptr)

{

	return xdrgen_decode_nfstime4(xdr, ptr);

};



bool

xdrgen_decode_fattr4_time_deleg_modify(struct xdr_stream *xdr, fattr4_time_deleg_modify *ptr)

{

	return xdrgen_decode_nfstime4(xdr, ptr);

};



static bool __maybe_unused

xdrgen_encode_int64_t(struct xdr_stream *xdr, const int64_t value)

{

	return xdrgen_encode_hyper(xdr, value);

};



static bool __maybe_unused

xdrgen_encode_uint32_t(struct xdr_stream *xdr, const uint32_t value)

{

	return xdrgen_encode_unsigned_int(xdr, value);

};



static bool __maybe_unused

xdrgen_encode_bitmap4(struct xdr_stream *xdr, const bitmap4 value)

{

	if (xdr_stream_encode_u32(xdr, value.count) != XDR_UNIT)

		return false;

	for (u32 i = 0; i < value.count; i++)

		if (!xdrgen_encode_uint32_t(xdr, value.element[i]))

			return false;

	return true;

};



static bool __maybe_unused

xdrgen_encode_nfstime4(struct xdr_stream *xdr, const struct nfstime4 *value)

{

	if (!xdrgen_encode_int64_t(xdr, value->seconds))

		return false;

	if (!xdrgen_encode_uint32_t(xdr, value->nseconds))

		return false;

	return true;

};



static bool __maybe_unused

xdrgen_encode_fattr4_offline(struct xdr_stream *xdr, const fattr4_offline value)

{

	return xdrgen_encode_bool(xdr, value);

};



static bool __maybe_unused

xdrgen_encode_open_arguments4(struct xdr_stream *xdr, const struct open_arguments4 *value)

{

	if (!xdrgen_encode_bitmap4(xdr, value->oa_share_access))

		return false;

	if (!xdrgen_encode_bitmap4(xdr, value->oa_share_deny))

		return false;

	if (!xdrgen_encode_bitmap4(xdr, value->oa_share_access_want))

		return false;

	if (!xdrgen_encode_bitmap4(xdr, value->oa_open_claim))

		return false;

	if (!xdrgen_encode_bitmap4(xdr, value->oa_create_mode))

		return false;

	return true;

};



static bool __maybe_unused

xdrgen_encode_open_args_share_access4(struct xdr_stream *xdr, open_args_share_access4 value)

{

	return xdr_stream_encode_u32(xdr, value) == XDR_UNIT;

}



static bool __maybe_unused

xdrgen_encode_open_args_share_deny4(struct xdr_stream *xdr, open_args_share_deny4 value)

{

	return xdr_stream_encode_u32(xdr, value) == XDR_UNIT;

}



static bool __maybe_unused

xdrgen_encode_open_args_share_access_want4(struct xdr_stream *xdr, open_args_share_access_want4 value)

{

	return xdr_stream_encode_u32(xdr, value) == XDR_UNIT;

}



static bool __maybe_unused

xdrgen_encode_open_args_open_claim4(struct xdr_stream *xdr, open_args_open_claim4 value)

{

	return xdr_stream_encode_u32(xdr, value) == XDR_UNIT;

}



static bool __maybe_unused

xdrgen_encode_open_args_createmode4(struct xdr_stream *xdr, open_args_createmode4 value)

{

	return xdr_stream_encode_u32(xdr, value) == XDR_UNIT;

}



bool

xdrgen_encode_fattr4_open_arguments(struct xdr_stream *xdr, const fattr4_open_arguments *value)

{

	return xdrgen_encode_open_arguments4(xdr, value);

};



bool

xdrgen_encode_fattr4_time_deleg_access(struct xdr_stream *xdr, const fattr4_time_deleg_access *value)

{

	return xdrgen_encode_nfstime4(xdr, value);

};



bool

xdrgen_encode_fattr4_time_deleg_modify(struct xdr_stream *xdr, const fattr4_time_deleg_modify *value)

{

	return xdrgen_encode_nfstime4(xdr, value);

};

fs/nfsd/nfs4xdr_gen.h

0 → 100644
+25 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 */

/* Generated by xdrgen. Manual edits will be lost. */

/* XDR specification file: ../../Documentation/sunrpc/xdr/nfs4_1.x */

/* XDR specification modification time: Thu Oct  3 11:30:59 2024 */



#ifndef _LINUX_XDRGEN_NFS4_1_DECL_H

#define _LINUX_XDRGEN_NFS4_1_DECL_H



#include <linux/types.h>



#include <linux/sunrpc/xdr.h>

#include <linux/sunrpc/xdrgen/_defs.h>

#include <linux/sunrpc/xdrgen/_builtins.h>

#include <linux/sunrpc/xdrgen/nfs4_1.h>



bool xdrgen_decode_fattr4_open_arguments(struct xdr_stream *xdr, fattr4_open_arguments *ptr);

bool xdrgen_encode_fattr4_open_arguments(struct xdr_stream *xdr, const fattr4_open_arguments *value);



bool xdrgen_decode_fattr4_time_deleg_access(struct xdr_stream *xdr, fattr4_time_deleg_access *ptr);

bool xdrgen_encode_fattr4_time_deleg_access(struct xdr_stream *xdr, const fattr4_time_deleg_access *value);



bool xdrgen_decode_fattr4_time_deleg_modify(struct xdr_stream *xdr, fattr4_time_deleg_modify *ptr);

bool xdrgen_encode_fattr4_time_deleg_modify(struct xdr_stream *xdr, const fattr4_time_deleg_modify *value);



#endif /* _LINUX_XDRGEN_NFS4_1_DECL_H */

include/linux/nfs4.h

+1 −6
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ 
#include <linux/uidgid.h>

#include <uapi/linux/nfs4.h>

#include <linux/sunrpc/msg_prot.h>

#include <linux/sunrpc/xdrgen/nfs4_1.h>



enum nfs4_acl_whotype {

	NFS4_ACL_WHO_NAMED = 0,
@@ -512,12 +513,6 @@ enum { 
	FATTR4_XATTR_SUPPORT		= 82,

};



enum {

	FATTR4_TIME_DELEG_ACCESS	= 84,

	FATTR4_TIME_DELEG_MODIFY	= 85,

	FATTR4_OPEN_ARGUMENTS		= 86,

};



/*

 * The following internal definitions enable processing the above

 * attribute bits within 32-bit word boundaries.