[mirror_ubuntu-jammy-kernel.git] / fs / nfsd / xdr.h

/* SPDX-License-Identifier: GPL-2.0 */
/* XDR types for nfsd. This is mainly a typing exercise. */

#ifndef LINUX_NFSD_H
#define LINUX_NFSD_H

#include <linux/vfs.h>
#include "nfsd.h"
#include "nfsfh.h"

struct nfsd_fhandle {
	struct svc_fh		fh;
};

struct nfsd_sattrargs {
	struct svc_fh		fh;
	struct iattr		attrs;
};

struct nfsd_diropargs {
	struct svc_fh		fh;
	char *			name;
	unsigned int		len;
};

struct nfsd_readargs {
	struct svc_fh		fh;
	__u32			offset;
	__u32			count;
};

struct nfsd_writeargs {
	svc_fh			fh;
	__u32			offset;
	__u32			len;
	struct xdr_buf		payload;
};

struct nfsd_createargs {
	struct svc_fh		fh;
	char *			name;
	unsigned int		len;
	struct iattr		attrs;
};

struct nfsd_renameargs {
	struct svc_fh		ffh;
	char *			fname;
	unsigned int		flen;
	struct svc_fh		tfh;
	char *			tname;
	unsigned int		tlen;
};

struct nfsd_linkargs {
	struct svc_fh		ffh;
	struct svc_fh		tfh;
	char *			tname;
	unsigned int		tlen;
};

struct nfsd_symlinkargs {
	struct svc_fh		ffh;
	char *			fname;
	unsigned int		flen;
	char *			tname;
	unsigned int		tlen;
	struct iattr		attrs;
	struct kvec		first;
};

struct nfsd_readdirargs {
	struct svc_fh		fh;
	__u32			cookie;
	__u32			count;
};

struct nfsd_stat {
	__be32			status;
};

struct nfsd_attrstat {
	__be32			status;
	struct svc_fh		fh;
	struct kstat		stat;
};

struct nfsd_diropres  {
	__be32			status;
	struct svc_fh		fh;
	struct kstat		stat;
};

struct nfsd_readlinkres {
	__be32			status;
	int			len;
	struct page		*page;
};

struct nfsd_readres {
	__be32			status;
	struct svc_fh		fh;
	unsigned long		count;
	struct kstat		stat;
	struct page		**pages;
};

struct nfsd_readdirres {
	/* Components of the reply */
	__be32			status;

	int			count;

	/* Used to encode the reply's entry list */
	struct xdr_stream	xdr;
	struct xdr_buf		dirlist;
	struct readdir_cd	common;
	unsigned int		cookie_offset;
};

struct nfsd_statfsres {
	__be32			status;
	struct kstatfs		stats;
};

/*
 * Storage requirements for XDR arguments and results.
 */
union nfsd_xdrstore {
	struct nfsd_sattrargs	sattr;
	struct nfsd_diropargs	dirop;
	struct nfsd_readargs	read;
	struct nfsd_writeargs	write;
	struct nfsd_createargs	create;
	struct nfsd_renameargs	rename;
	struct nfsd_linkargs	link;
	struct nfsd_symlinkargs	symlink;
	struct nfsd_readdirargs	readdir;
};

#define NFS2_SVC_XDRSIZE	sizeof(union nfsd_xdrstore)


int nfssvc_decode_fhandleargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_sattrargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_diropargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_readargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_writeargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_createargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_renameargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_linkargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_symlinkargs(struct svc_rqst *, __be32 *);
int nfssvc_decode_readdirargs(struct svc_rqst *, __be32 *);
int nfssvc_encode_statres(struct svc_rqst *, __be32 *);
int nfssvc_encode_attrstatres(struct svc_rqst *, __be32 *);
int nfssvc_encode_diropres(struct svc_rqst *, __be32 *);
int nfssvc_encode_readlinkres(struct svc_rqst *, __be32 *);
int nfssvc_encode_readres(struct svc_rqst *, __be32 *);
int nfssvc_encode_statfsres(struct svc_rqst *, __be32 *);
int nfssvc_encode_readdirres(struct svc_rqst *, __be32 *);

void nfssvc_encode_nfscookie(struct nfsd_readdirres *resp, u32 offset);
int nfssvc_encode_entry(void *data, const char *name, int namlen,
			loff_t offset, u64 ino, unsigned int d_type);

void nfssvc_release_attrstat(struct svc_rqst *rqstp);
void nfssvc_release_diropres(struct svc_rqst *rqstp);
void nfssvc_release_readres(struct svc_rqst *rqstp);

/* Helper functions for NFSv2 ACL code */
bool svcxdr_decode_fhandle(struct xdr_stream *xdr, struct svc_fh *fhp);
bool svcxdr_encode_stat(struct xdr_stream *xdr, __be32 status);
bool svcxdr_encode_fattr(struct svc_rqst *rqstp, struct xdr_stream *xdr,
			 const struct svc_fh *fhp, const struct kstat *stat);

#endif /* LINUX_NFSD_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
7663dacd	2	/* XDR types for nfsd. This is mainly a typing exercise. */
1da177e4 LT	3
	4	#ifndef LINUX_NFSD_H
	5	#define LINUX_NFSD_H
	6
1da177e4	7	#include <linux/vfs.h>
9a74af21	8	#include "nfsd.h"
1557aca7	9	#include "nfsfh.h"
1da177e4 LT	10
	11	struct nfsd_fhandle {
	12	struct svc_fh fh;
	13	};
	14
	15	struct nfsd_sattrargs {
	16	struct svc_fh fh;
	17	struct iattr attrs;
	18	};
	19
	20	struct nfsd_diropargs {
	21	struct svc_fh fh;
	22	char * name;
29d5e555	23	unsigned int len;
1da177e4 LT	24	};
	25
	26	struct nfsd_readargs {
	27	struct svc_fh fh;
	28	__u32 offset;
	29	__u32 count;
1da177e4 LT	30	};
	31
	32	struct nfsd_writeargs {
	33	svc_fh fh;
	34	__u32 offset;
bd6f674d	35	__u32 len;
3c1b1c7e	36	struct xdr_buf payload;
1da177e4 LT	37	};
	38
	39	struct nfsd_createargs {
	40	struct svc_fh fh;
	41	char * name;
29d5e555	42	unsigned int len;
1da177e4 LT	43	struct iattr attrs;
	44	};
	45
	46	struct nfsd_renameargs {
	47	struct svc_fh ffh;
	48	char * fname;
29d5e555	49	unsigned int flen;
1da177e4 LT	50	struct svc_fh tfh;
1da177e4 LT	51	char * tname;
29d5e555	52	unsigned int tlen;
1da177e4 LT	53	};
1da177e4 LT	54
1da177e4 LT	55	struct nfsd_linkargs {
	56	struct svc_fh ffh;
	57	struct svc_fh tfh;
	58	char * tname;
29d5e555	59	unsigned int tlen;
1da177e4 LT	60	};
	61
	62	struct nfsd_symlinkargs {
	63	struct svc_fh ffh;
	64	char * fname;
29d5e555	65	unsigned int flen;
1da177e4	66	char * tname;
48b4ba3f	67	unsigned int tlen;
1da177e4	68	struct iattr attrs;
38a70315	69	struct kvec first;
1da177e4 LT	70	};
	71
	72	struct nfsd_readdirargs {
	73	struct svc_fh fh;
	74	__u32 cookie;
	75	__u32 count;
1da177e4 LT	76	};
1da177e4 LT	77
cc028a10 CL	78	struct nfsd_stat {
	79	__be32 status;
	80	};
	81
1da177e4	82	struct nfsd_attrstat {
f0af2210	83	__be32 status;
1da177e4	84	struct svc_fh fh;
a334de28	85	struct kstat stat;
1da177e4 LT	86	};
	87
	88	struct nfsd_diropres {
f0af2210	89	__be32 status;
1da177e4	90	struct svc_fh fh;
a334de28	91	struct kstat stat;
1da177e4 LT	92	};
	93
	94	struct nfsd_readlinkres {
f0af2210	95	__be32 status;
1da177e4	96	int len;
d9014b0f	97	struct page *page;
1da177e4 LT	98	};
	99
	100	struct nfsd_readres {
f0af2210	101	__be32 status;
1da177e4 LT	102	struct svc_fh fh;
1da177e4 LT	103	unsigned long count;
a334de28	104	struct kstat stat;
a6f8d9dc	105	struct page **pages;
1da177e4 LT	106	};
	107
	108	struct nfsd_readdirres {
f5dcccd6	109	/* Components of the reply */
f0af2210 CL	110	__be32 status;
f0af2210 CL	111
1da177e4 LT	112	int count;
1da177e4 LT	113
f5dcccd6 CL	114	/* Used to encode the reply's entry list */
	115	struct xdr_stream xdr;
	116	struct xdr_buf dirlist;
1da177e4	117	struct readdir_cd common;
f5dcccd6	118	unsigned int cookie_offset;
1da177e4 LT	119	};
	120
	121	struct nfsd_statfsres {
f0af2210	122	__be32 status;
1da177e4 LT	123	struct kstatfs stats;
	124	};
	125
	126	/*
	127	* Storage requirements for XDR arguments and results.
	128	*/
	129	union nfsd_xdrstore {
	130	struct nfsd_sattrargs sattr;
	131	struct nfsd_diropargs dirop;
	132	struct nfsd_readargs read;
	133	struct nfsd_writeargs write;
	134	struct nfsd_createargs create;
	135	struct nfsd_renameargs rename;
	136	struct nfsd_linkargs link;
	137	struct nfsd_symlinkargs symlink;
	138	struct nfsd_readdirargs readdir;
	139	};
	140
	141	#define NFS2_SVC_XDRSIZE sizeof(union nfsd_xdrstore)
	142
	143
ebcd8e8b	144	int nfssvc_decode_fhandleargs(struct svc_rqst , __be32 );
026fec7e CH	145	int nfssvc_decode_sattrargs(struct svc_rqst , __be32 );
	146	int nfssvc_decode_diropargs(struct svc_rqst , __be32 );
	147	int nfssvc_decode_readargs(struct svc_rqst , __be32 );
	148	int nfssvc_decode_writeargs(struct svc_rqst , __be32 );
	149	int nfssvc_decode_createargs(struct svc_rqst , __be32 );
	150	int nfssvc_decode_renameargs(struct svc_rqst , __be32 );
026fec7e CH	151	int nfssvc_decode_linkargs(struct svc_rqst , __be32 );
	152	int nfssvc_decode_symlinkargs(struct svc_rqst , __be32 );
	153	int nfssvc_decode_readdirargs(struct svc_rqst , __be32 );
a887eaed	154	int nfssvc_encode_statres(struct svc_rqst , __be32 );
92b54a4f	155	int nfssvc_encode_attrstatres(struct svc_rqst , __be32 );
63f8de37 CH	156	int nfssvc_encode_diropres(struct svc_rqst , __be32 );
	157	int nfssvc_encode_readlinkres(struct svc_rqst , __be32 );
	158	int nfssvc_encode_readres(struct svc_rqst , __be32 );
	159	int nfssvc_encode_statfsres(struct svc_rqst , __be32 );
	160	int nfssvc_encode_readdirres(struct svc_rqst , __be32 );
1da177e4	161
d5253200	162	void nfssvc_encode_nfscookie(struct nfsd_readdirres *resp, u32 offset);
8a2cf9f5 CL	163	int nfssvc_encode_entry(void data, const char name, int namlen,
8a2cf9f5 CL	164	loff_t offset, u64 ino, unsigned int d_type);
1da177e4	165
1841b9b6 CL	166	void nfssvc_release_attrstat(struct svc_rqst *rqstp);
	167	void nfssvc_release_diropres(struct svc_rqst *rqstp);
	168	void nfssvc_release_readres(struct svc_rqst *rqstp);
1da177e4	169
a257cdd0	170	/* Helper functions for NFSv2 ACL code */
635a45d3	171	bool svcxdr_decode_fhandle(struct xdr_stream xdr, struct svc_fh fhp);
f8cba473 CL	172	bool svcxdr_encode_stat(struct xdr_stream *xdr, __be32 status);
	173	bool svcxdr_encode_fattr(struct svc_rqst rqstp, struct xdr_stream xdr,
	174	const struct svc_fh fhp, const struct kstat stat);
a257cdd0	175
1da177e4	176	#endif /* LINUX_NFSD_H */