xref: /linux-6.15/include/linux/nfs_xdr.h (revision 1ff85bfa)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_NFS_XDR_H
3 #define _LINUX_NFS_XDR_H
4 
5 #include <linux/nfsacl.h>
6 #include <linux/sunrpc/gss_api.h>
7 
8 /*
9  * To change the maximum rsize and wsize supported by the NFS client, adjust
10  * NFS_MAX_FILE_IO_SIZE.  64KB is a typical maximum, but some servers can
11  * support a megabyte or more.  The default is left at 4096 bytes, which is
12  * reasonable for NFS over UDP.
13  */
14 #define NFS_MAX_FILE_IO_SIZE	(1048576U)
15 #define NFS_DEF_FILE_IO_SIZE	(4096U)
16 #define NFS_MIN_FILE_IO_SIZE	(1024U)
17 
18 struct nfs4_string {
19 	unsigned int len;
20 	char *data;
21 };
22 
23 struct nfs_fsid {
24 	uint64_t		major;
25 	uint64_t		minor;
26 };
27 
28 /*
29  * Helper for checking equality between 2 fsids.
30  */
31 static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
32 {
33 	return a->major == b->major && a->minor == b->minor;
34 }
35 
36 struct nfs4_threshold {
37 	__u32	bm;
38 	__u32	l_type;
39 	__u64	rd_sz;
40 	__u64	wr_sz;
41 	__u64	rd_io_sz;
42 	__u64	wr_io_sz;
43 };
44 
45 struct nfs_fattr {
46 	unsigned int		valid;		/* which fields are valid */
47 	umode_t			mode;
48 	__u32			nlink;
49 	kuid_t			uid;
50 	kgid_t			gid;
51 	dev_t			rdev;
52 	__u64			size;
53 	union {
54 		struct {
55 			__u32	blocksize;
56 			__u32	blocks;
57 		} nfs2;
58 		struct {
59 			__u64	used;
60 		} nfs3;
61 	} du;
62 	struct nfs_fsid		fsid;
63 	__u64			fileid;
64 	__u64			mounted_on_fileid;
65 	struct timespec		atime;
66 	struct timespec		mtime;
67 	struct timespec		ctime;
68 	__u64			change_attr;	/* NFSv4 change attribute */
69 	__u64			pre_change_attr;/* pre-op NFSv4 change attribute */
70 	__u64			pre_size;	/* pre_op_attr.size	  */
71 	struct timespec		pre_mtime;	/* pre_op_attr.mtime	  */
72 	struct timespec		pre_ctime;	/* pre_op_attr.ctime	  */
73 	unsigned long		time_start;
74 	unsigned long		gencount;
75 	struct nfs4_string	*owner_name;
76 	struct nfs4_string	*group_name;
77 	struct nfs4_threshold	*mdsthreshold;	/* pNFS threshold hints */
78 };
79 
80 #define NFS_ATTR_FATTR_TYPE		(1U << 0)
81 #define NFS_ATTR_FATTR_MODE		(1U << 1)
82 #define NFS_ATTR_FATTR_NLINK		(1U << 2)
83 #define NFS_ATTR_FATTR_OWNER		(1U << 3)
84 #define NFS_ATTR_FATTR_GROUP		(1U << 4)
85 #define NFS_ATTR_FATTR_RDEV		(1U << 5)
86 #define NFS_ATTR_FATTR_SIZE		(1U << 6)
87 #define NFS_ATTR_FATTR_PRESIZE		(1U << 7)
88 #define NFS_ATTR_FATTR_BLOCKS_USED	(1U << 8)
89 #define NFS_ATTR_FATTR_SPACE_USED	(1U << 9)
90 #define NFS_ATTR_FATTR_FSID		(1U << 10)
91 #define NFS_ATTR_FATTR_FILEID		(1U << 11)
92 #define NFS_ATTR_FATTR_ATIME		(1U << 12)
93 #define NFS_ATTR_FATTR_MTIME		(1U << 13)
94 #define NFS_ATTR_FATTR_CTIME		(1U << 14)
95 #define NFS_ATTR_FATTR_PREMTIME		(1U << 15)
96 #define NFS_ATTR_FATTR_PRECTIME		(1U << 16)
97 #define NFS_ATTR_FATTR_CHANGE		(1U << 17)
98 #define NFS_ATTR_FATTR_PRECHANGE	(1U << 18)
99 #define NFS_ATTR_FATTR_V4_LOCATIONS	(1U << 19)
100 #define NFS_ATTR_FATTR_V4_REFERRAL	(1U << 20)
101 #define NFS_ATTR_FATTR_MOUNTPOINT	(1U << 21)
102 #define NFS_ATTR_FATTR_MOUNTED_ON_FILEID (1U << 22)
103 #define NFS_ATTR_FATTR_OWNER_NAME	(1U << 23)
104 #define NFS_ATTR_FATTR_GROUP_NAME	(1U << 24)
105 #define NFS_ATTR_FATTR_V4_SECURITY_LABEL (1U << 25)
106 
107 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
108 		| NFS_ATTR_FATTR_MODE \
109 		| NFS_ATTR_FATTR_NLINK \
110 		| NFS_ATTR_FATTR_OWNER \
111 		| NFS_ATTR_FATTR_GROUP \
112 		| NFS_ATTR_FATTR_RDEV \
113 		| NFS_ATTR_FATTR_SIZE \
114 		| NFS_ATTR_FATTR_FSID \
115 		| NFS_ATTR_FATTR_FILEID \
116 		| NFS_ATTR_FATTR_ATIME \
117 		| NFS_ATTR_FATTR_MTIME \
118 		| NFS_ATTR_FATTR_CTIME \
119 		| NFS_ATTR_FATTR_CHANGE)
120 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
121 		| NFS_ATTR_FATTR_BLOCKS_USED)
122 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
123 		| NFS_ATTR_FATTR_SPACE_USED)
124 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
125 		| NFS_ATTR_FATTR_SPACE_USED \
126 		| NFS_ATTR_FATTR_V4_SECURITY_LABEL)
127 
128 /*
129  * Maximal number of supported layout drivers.
130  */
131 #define NFS_MAX_LAYOUT_TYPES 8
132 
133 /*
134  * Info on the file system
135  */
136 struct nfs_fsinfo {
137 	struct nfs_fattr	*fattr; /* Post-op attributes */
138 	__u32			rtmax;	/* max.  read transfer size */
139 	__u32			rtpref;	/* pref. read transfer size */
140 	__u32			rtmult;	/* reads should be multiple of this */
141 	__u32			wtmax;	/* max.  write transfer size */
142 	__u32			wtpref;	/* pref. write transfer size */
143 	__u32			wtmult;	/* writes should be multiple of this */
144 	__u32			dtpref;	/* pref. readdir transfer size */
145 	__u64			maxfilesize;
146 	struct timespec		time_delta; /* server time granularity */
147 	__u32			lease_time; /* in seconds */
148 	__u32			nlayouttypes; /* number of layouttypes */
149 	__u32			layouttype[NFS_MAX_LAYOUT_TYPES]; /* supported pnfs layout driver */
150 	__u32			blksize; /* preferred pnfs io block size */
151 	__u32			clone_blksize; /* granularity of a CLONE operation */
152 };
153 
154 struct nfs_fsstat {
155 	struct nfs_fattr	*fattr; /* Post-op attributes */
156 	__u64			tbytes;	/* total size in bytes */
157 	__u64			fbytes;	/* # of free bytes */
158 	__u64			abytes;	/* # of bytes available to user */
159 	__u64			tfiles;	/* # of files */
160 	__u64			ffiles;	/* # of free files */
161 	__u64			afiles;	/* # of files available to user */
162 };
163 
164 struct nfs2_fsstat {
165 	__u32			tsize;  /* Server transfer size */
166 	__u32			bsize;  /* Filesystem block size */
167 	__u32			blocks; /* No. of "bsize" blocks on filesystem */
168 	__u32			bfree;  /* No. of free "bsize" blocks */
169 	__u32			bavail; /* No. of available "bsize" blocks */
170 };
171 
172 struct nfs_pathconf {
173 	struct nfs_fattr	*fattr; /* Post-op attributes */
174 	__u32			max_link; /* max # of hard links */
175 	__u32			max_namelen; /* max name length */
176 };
177 
178 struct nfs4_change_info {
179 	u32			atomic;
180 	u64			before;
181 	u64			after;
182 };
183 
184 struct nfs_seqid;
185 
186 /* nfs41 sessions channel attributes */
187 struct nfs4_channel_attrs {
188 	u32			max_rqst_sz;
189 	u32			max_resp_sz;
190 	u32			max_resp_sz_cached;
191 	u32			max_ops;
192 	u32			max_reqs;
193 };
194 
195 struct nfs4_slot;
196 struct nfs4_sequence_args {
197 	struct nfs4_slot	*sa_slot;
198 	u8			sa_cache_this : 1,
199 				sa_privileged : 1;
200 };
201 
202 struct nfs4_sequence_res {
203 	struct nfs4_slot	*sr_slot;	/* slot used to send request */
204 	unsigned long		sr_timestamp;
205 	int			sr_status;	/* sequence operation status */
206 	u32			sr_status_flags;
207 	u32			sr_highest_slotid;
208 	u32			sr_target_highest_slotid;
209 };
210 
211 struct nfs4_get_lease_time_args {
212 	struct nfs4_sequence_args	la_seq_args;
213 };
214 
215 struct nfs4_get_lease_time_res {
216 	struct nfs4_sequence_res	lr_seq_res;
217 	struct nfs_fsinfo	       *lr_fsinfo;
218 };
219 
220 struct xdr_stream;
221 struct nfs4_xdr_opaque_data;
222 
223 struct nfs4_xdr_opaque_ops {
224 	void (*encode)(struct xdr_stream *, const void *args,
225 			const struct nfs4_xdr_opaque_data *);
226 	void (*free)(struct nfs4_xdr_opaque_data *);
227 };
228 
229 struct nfs4_xdr_opaque_data {
230 	const struct nfs4_xdr_opaque_ops *ops;
231 	void *data;
232 };
233 
234 #define PNFS_LAYOUT_MAXSIZE 4096
235 
236 struct nfs4_layoutdriver_data {
237 	struct page **pages;
238 	__u32 pglen;
239 	__u32 len;
240 };
241 
242 struct pnfs_layout_range {
243 	u32 iomode;
244 	u64 offset;
245 	u64 length;
246 };
247 
248 struct nfs4_layoutget_args {
249 	struct nfs4_sequence_args seq_args;
250 	__u32 type;
251 	struct pnfs_layout_range range;
252 	__u64 minlength;
253 	__u32 maxcount;
254 	struct inode *inode;
255 	struct nfs_open_context *ctx;
256 	nfs4_stateid stateid;
257 	struct nfs4_layoutdriver_data layout;
258 };
259 
260 struct nfs4_layoutget_res {
261 	struct nfs4_sequence_res seq_res;
262 	int status;
263 	__u32 return_on_close;
264 	struct pnfs_layout_range range;
265 	__u32 type;
266 	nfs4_stateid stateid;
267 	struct nfs4_layoutdriver_data *layoutp;
268 };
269 
270 struct nfs4_layoutget {
271 	struct nfs4_layoutget_args args;
272 	struct nfs4_layoutget_res res;
273 	const struct cred *cred;
274 	gfp_t gfp_flags;
275 };
276 
277 struct nfs4_getdeviceinfo_args {
278 	struct nfs4_sequence_args seq_args;
279 	struct pnfs_device *pdev;
280 	__u32 notify_types;
281 };
282 
283 struct nfs4_getdeviceinfo_res {
284 	struct nfs4_sequence_res seq_res;
285 	struct pnfs_device *pdev;
286 	__u32 notification;
287 };
288 
289 struct nfs4_layoutcommit_args {
290 	struct nfs4_sequence_args seq_args;
291 	nfs4_stateid stateid;
292 	__u64 lastbytewritten;
293 	struct inode *inode;
294 	const u32 *bitmask;
295 	size_t layoutupdate_len;
296 	struct page *layoutupdate_page;
297 	struct page **layoutupdate_pages;
298 	__be32 *start_p;
299 };
300 
301 struct nfs4_layoutcommit_res {
302 	struct nfs4_sequence_res seq_res;
303 	struct nfs_fattr *fattr;
304 	const struct nfs_server *server;
305 	int status;
306 };
307 
308 struct nfs4_layoutcommit_data {
309 	struct rpc_task task;
310 	struct nfs_fattr fattr;
311 	struct list_head lseg_list;
312 	const struct cred *cred;
313 	struct inode *inode;
314 	struct nfs4_layoutcommit_args args;
315 	struct nfs4_layoutcommit_res res;
316 };
317 
318 struct nfs4_layoutreturn_args {
319 	struct nfs4_sequence_args seq_args;
320 	struct pnfs_layout_hdr *layout;
321 	struct inode *inode;
322 	struct pnfs_layout_range range;
323 	nfs4_stateid stateid;
324 	__u32   layout_type;
325 	struct nfs4_xdr_opaque_data *ld_private;
326 };
327 
328 struct nfs4_layoutreturn_res {
329 	struct nfs4_sequence_res seq_res;
330 	u32 lrs_present;
331 	nfs4_stateid stateid;
332 };
333 
334 struct nfs4_layoutreturn {
335 	struct nfs4_layoutreturn_args args;
336 	struct nfs4_layoutreturn_res res;
337 	const struct cred *cred;
338 	struct nfs_client *clp;
339 	struct inode *inode;
340 	int rpc_status;
341 	struct nfs4_xdr_opaque_data ld_private;
342 };
343 
344 #define PNFS_LAYOUTSTATS_MAXSIZE 256
345 
346 struct nfs42_layoutstat_args;
347 struct nfs42_layoutstat_devinfo;
348 typedef	void (*layoutstats_encode_t)(struct xdr_stream *,
349 		struct nfs42_layoutstat_args *,
350 		struct nfs42_layoutstat_devinfo *);
351 
352 /* Per file per deviceid layoutstats */
353 struct nfs42_layoutstat_devinfo {
354 	struct nfs4_deviceid dev_id;
355 	__u64 offset;
356 	__u64 length;
357 	__u64 read_count;
358 	__u64 read_bytes;
359 	__u64 write_count;
360 	__u64 write_bytes;
361 	__u32 layout_type;
362 	struct nfs4_xdr_opaque_data ld_private;
363 };
364 
365 struct nfs42_layoutstat_args {
366 	struct nfs4_sequence_args seq_args;
367 	struct nfs_fh *fh;
368 	struct inode *inode;
369 	nfs4_stateid stateid;
370 	int num_dev;
371 	struct nfs42_layoutstat_devinfo *devinfo;
372 };
373 
374 struct nfs42_layoutstat_res {
375 	struct nfs4_sequence_res seq_res;
376 	int num_dev;
377 	int rpc_status;
378 };
379 
380 struct nfs42_layoutstat_data {
381 	struct inode *inode;
382 	struct nfs42_layoutstat_args args;
383 	struct nfs42_layoutstat_res res;
384 };
385 
386 struct nfs42_clone_args {
387 	struct nfs4_sequence_args	seq_args;
388 	struct nfs_fh			*src_fh;
389 	struct nfs_fh			*dst_fh;
390 	nfs4_stateid			src_stateid;
391 	nfs4_stateid			dst_stateid;
392 	__u64				src_offset;
393 	__u64				dst_offset;
394 	__u64				count;
395 	const u32			*dst_bitmask;
396 };
397 
398 struct nfs42_clone_res {
399 	struct nfs4_sequence_res	seq_res;
400 	unsigned int			rpc_status;
401 	struct nfs_fattr		*dst_fattr;
402 	const struct nfs_server		*server;
403 };
404 
405 struct stateowner_id {
406 	__u64	create_time;
407 	__u32	uniquifier;
408 };
409 
410 /*
411  * Arguments to the open call.
412  */
413 struct nfs_openargs {
414 	struct nfs4_sequence_args	seq_args;
415 	const struct nfs_fh *	fh;
416 	struct nfs_seqid *	seqid;
417 	int			open_flags;
418 	fmode_t			fmode;
419 	u32			share_access;
420 	u32			access;
421 	__u64                   clientid;
422 	struct stateowner_id	id;
423 	union {
424 		struct {
425 			struct iattr *  attrs;    /* UNCHECKED, GUARDED, EXCLUSIVE4_1 */
426 			nfs4_verifier   verifier; /* EXCLUSIVE */
427 		};
428 		nfs4_stateid	delegation;		/* CLAIM_DELEGATE_CUR */
429 		fmode_t		delegation_type;	/* CLAIM_PREVIOUS */
430 	} u;
431 	const struct qstr *	name;
432 	const struct nfs_server *server;	 /* Needed for ID mapping */
433 	const u32 *		bitmask;
434 	const u32 *		open_bitmap;
435 	enum open_claim_type4	claim;
436 	enum createmode4	createmode;
437 	const struct nfs4_label *label;
438 	umode_t			umask;
439 	struct nfs4_layoutget_args *lg_args;
440 };
441 
442 struct nfs_openres {
443 	struct nfs4_sequence_res	seq_res;
444 	nfs4_stateid            stateid;
445 	struct nfs_fh           fh;
446 	struct nfs4_change_info	cinfo;
447 	__u32                   rflags;
448 	struct nfs_fattr *      f_attr;
449 	struct nfs4_label	*f_label;
450 	struct nfs_seqid *	seqid;
451 	const struct nfs_server *server;
452 	fmode_t			delegation_type;
453 	nfs4_stateid		delegation;
454 	unsigned long		pagemod_limit;
455 	__u32			do_recall;
456 	__u32			attrset[NFS4_BITMAP_SIZE];
457 	struct nfs4_string	*owner;
458 	struct nfs4_string	*group_owner;
459 	__u32			access_request;
460 	__u32			access_supported;
461 	__u32			access_result;
462 	struct nfs4_layoutget_res *lg_res;
463 };
464 
465 /*
466  * Arguments to the open_confirm call.
467  */
468 struct nfs_open_confirmargs {
469 	struct nfs4_sequence_args	seq_args;
470 	const struct nfs_fh *	fh;
471 	nfs4_stateid *		stateid;
472 	struct nfs_seqid *	seqid;
473 };
474 
475 struct nfs_open_confirmres {
476 	struct nfs4_sequence_res	seq_res;
477 	nfs4_stateid            stateid;
478 	struct nfs_seqid *	seqid;
479 };
480 
481 /*
482  * Arguments to the close call.
483  */
484 struct nfs_closeargs {
485 	struct nfs4_sequence_args	seq_args;
486 	struct nfs_fh *         fh;
487 	nfs4_stateid 		stateid;
488 	struct nfs_seqid *	seqid;
489 	fmode_t			fmode;
490 	u32			share_access;
491 	const u32 *		bitmask;
492 	struct nfs4_layoutreturn_args *lr_args;
493 };
494 
495 struct nfs_closeres {
496 	struct nfs4_sequence_res	seq_res;
497 	nfs4_stateid            stateid;
498 	struct nfs_fattr *	fattr;
499 	struct nfs_seqid *	seqid;
500 	const struct nfs_server *server;
501 	struct nfs4_layoutreturn_res *lr_res;
502 	int lr_ret;
503 };
504 /*
505  *  * Arguments to the lock,lockt, and locku call.
506  *   */
507 struct nfs_lowner {
508 	__u64			clientid;
509 	__u64			id;
510 	dev_t			s_dev;
511 };
512 
513 struct nfs_lock_args {
514 	struct nfs4_sequence_args	seq_args;
515 	struct nfs_fh *		fh;
516 	struct file_lock *	fl;
517 	struct nfs_seqid *	lock_seqid;
518 	nfs4_stateid		lock_stateid;
519 	struct nfs_seqid *	open_seqid;
520 	nfs4_stateid		open_stateid;
521 	struct nfs_lowner	lock_owner;
522 	unsigned char		block : 1;
523 	unsigned char		reclaim : 1;
524 	unsigned char		new_lock : 1;
525 	unsigned char		new_lock_owner : 1;
526 };
527 
528 struct nfs_lock_res {
529 	struct nfs4_sequence_res	seq_res;
530 	nfs4_stateid		stateid;
531 	struct nfs_seqid *	lock_seqid;
532 	struct nfs_seqid *	open_seqid;
533 };
534 
535 struct nfs_locku_args {
536 	struct nfs4_sequence_args	seq_args;
537 	struct nfs_fh *		fh;
538 	struct file_lock *	fl;
539 	struct nfs_seqid *	seqid;
540 	nfs4_stateid 		stateid;
541 };
542 
543 struct nfs_locku_res {
544 	struct nfs4_sequence_res	seq_res;
545 	nfs4_stateid		stateid;
546 	struct nfs_seqid *	seqid;
547 };
548 
549 struct nfs_lockt_args {
550 	struct nfs4_sequence_args	seq_args;
551 	struct nfs_fh *		fh;
552 	struct file_lock *	fl;
553 	struct nfs_lowner	lock_owner;
554 };
555 
556 struct nfs_lockt_res {
557 	struct nfs4_sequence_res	seq_res;
558 	struct file_lock *	denied; /* LOCK, LOCKT failed */
559 };
560 
561 struct nfs_release_lockowner_args {
562 	struct nfs4_sequence_args	seq_args;
563 	struct nfs_lowner	lock_owner;
564 };
565 
566 struct nfs_release_lockowner_res {
567 	struct nfs4_sequence_res	seq_res;
568 };
569 
570 struct nfs4_delegreturnargs {
571 	struct nfs4_sequence_args	seq_args;
572 	const struct nfs_fh *fhandle;
573 	const nfs4_stateid *stateid;
574 	const u32 * bitmask;
575 	struct nfs4_layoutreturn_args *lr_args;
576 };
577 
578 struct nfs4_delegreturnres {
579 	struct nfs4_sequence_res	seq_res;
580 	struct nfs_fattr * fattr;
581 	struct nfs_server *server;
582 	struct nfs4_layoutreturn_res *lr_res;
583 	int lr_ret;
584 };
585 
586 /*
587  * Arguments to the write call.
588  */
589 struct nfs_write_verifier {
590 	char			data[8];
591 };
592 
593 struct nfs_writeverf {
594 	struct nfs_write_verifier verifier;
595 	enum nfs3_stable_how	committed;
596 };
597 
598 /*
599  * Arguments shared by the read and write call.
600  */
601 struct nfs_pgio_args {
602 	struct nfs4_sequence_args	seq_args;
603 	struct nfs_fh *		fh;
604 	struct nfs_open_context *context;
605 	struct nfs_lock_context *lock_context;
606 	nfs4_stateid		stateid;
607 	__u64			offset;
608 	__u32			count;
609 	unsigned int		pgbase;
610 	struct page **		pages;
611 	union {
612 		unsigned int		replen;			/* used by read */
613 		struct {
614 			const u32 *		bitmask;	/* used by write */
615 			enum nfs3_stable_how	stable;		/* used by write */
616 		};
617 	};
618 };
619 
620 struct nfs_pgio_res {
621 	struct nfs4_sequence_res	seq_res;
622 	struct nfs_fattr *	fattr;
623 	__u32			count;
624 	__u32			op_status;
625 	union {
626 		struct {
627 			unsigned int		replen;		/* used by read */
628 			int			eof;		/* used by read */
629 		};
630 		struct {
631 			struct nfs_writeverf *	verf;		/* used by write */
632 			const struct nfs_server *server;	/* used by write */
633 		};
634 	};
635 };
636 
637 /*
638  * Arguments to the commit call.
639  */
640 struct nfs_commitargs {
641 	struct nfs4_sequence_args	seq_args;
642 	struct nfs_fh		*fh;
643 	__u64			offset;
644 	__u32			count;
645 	const u32		*bitmask;
646 };
647 
648 struct nfs_commitres {
649 	struct nfs4_sequence_res	seq_res;
650 	__u32			op_status;
651 	struct nfs_fattr	*fattr;
652 	struct nfs_writeverf	*verf;
653 	const struct nfs_server *server;
654 };
655 
656 /*
657  * Common arguments to the unlink call
658  */
659 struct nfs_removeargs {
660 	struct nfs4_sequence_args	seq_args;
661 	const struct nfs_fh	*fh;
662 	struct qstr		name;
663 };
664 
665 struct nfs_removeres {
666 	struct nfs4_sequence_res 	seq_res;
667 	struct nfs_server *server;
668 	struct nfs_fattr	*dir_attr;
669 	struct nfs4_change_info	cinfo;
670 };
671 
672 /*
673  * Common arguments to the rename call
674  */
675 struct nfs_renameargs {
676 	struct nfs4_sequence_args	seq_args;
677 	const struct nfs_fh		*old_dir;
678 	const struct nfs_fh		*new_dir;
679 	const struct qstr		*old_name;
680 	const struct qstr		*new_name;
681 };
682 
683 struct nfs_renameres {
684 	struct nfs4_sequence_res	seq_res;
685 	struct nfs_server		*server;
686 	struct nfs4_change_info		old_cinfo;
687 	struct nfs_fattr		*old_fattr;
688 	struct nfs4_change_info		new_cinfo;
689 	struct nfs_fattr		*new_fattr;
690 };
691 
692 /* parsed sec= options */
693 #define NFS_AUTH_INFO_MAX_FLAVORS 12 /* see fs/nfs/super.c */
694 struct nfs_auth_info {
695 	unsigned int            flavor_len;
696 	rpc_authflavor_t        flavors[NFS_AUTH_INFO_MAX_FLAVORS];
697 };
698 
699 /*
700  * Argument struct for decode_entry function
701  */
702 struct nfs_entry {
703 	__u64			ino;
704 	__u64			cookie,
705 				prev_cookie;
706 	const char *		name;
707 	unsigned int		len;
708 	int			eof;
709 	struct nfs_fh *		fh;
710 	struct nfs_fattr *	fattr;
711 	struct nfs4_label  *label;
712 	unsigned char		d_type;
713 	struct nfs_server *	server;
714 };
715 
716 /*
717  * The following types are for NFSv2 only.
718  */
719 struct nfs_sattrargs {
720 	struct nfs_fh *		fh;
721 	struct iattr *		sattr;
722 };
723 
724 struct nfs_diropargs {
725 	struct nfs_fh *		fh;
726 	const char *		name;
727 	unsigned int		len;
728 };
729 
730 struct nfs_createargs {
731 	struct nfs_fh *		fh;
732 	const char *		name;
733 	unsigned int		len;
734 	struct iattr *		sattr;
735 };
736 
737 struct nfs_setattrargs {
738 	struct nfs4_sequence_args 	seq_args;
739 	struct nfs_fh *                 fh;
740 	nfs4_stateid                    stateid;
741 	struct iattr *                  iap;
742 	const struct nfs_server *	server; /* Needed for name mapping */
743 	const u32 *			bitmask;
744 	const struct nfs4_label		*label;
745 };
746 
747 struct nfs_setaclargs {
748 	struct nfs4_sequence_args	seq_args;
749 	struct nfs_fh *			fh;
750 	size_t				acl_len;
751 	struct page **			acl_pages;
752 };
753 
754 struct nfs_setaclres {
755 	struct nfs4_sequence_res	seq_res;
756 };
757 
758 struct nfs_getaclargs {
759 	struct nfs4_sequence_args 	seq_args;
760 	struct nfs_fh *			fh;
761 	size_t				acl_len;
762 	struct page **			acl_pages;
763 };
764 
765 /* getxattr ACL interface flags */
766 #define NFS4_ACL_TRUNC		0x0001	/* ACL was truncated */
767 struct nfs_getaclres {
768 	struct nfs4_sequence_res	seq_res;
769 	size_t				acl_len;
770 	size_t				acl_data_offset;
771 	int				acl_flags;
772 	struct page *			acl_scratch;
773 };
774 
775 struct nfs_setattrres {
776 	struct nfs4_sequence_res	seq_res;
777 	struct nfs_fattr *              fattr;
778 	struct nfs4_label		*label;
779 	const struct nfs_server *	server;
780 };
781 
782 struct nfs_linkargs {
783 	struct nfs_fh *		fromfh;
784 	struct nfs_fh *		tofh;
785 	const char *		toname;
786 	unsigned int		tolen;
787 };
788 
789 struct nfs_symlinkargs {
790 	struct nfs_fh *		fromfh;
791 	const char *		fromname;
792 	unsigned int		fromlen;
793 	struct page **		pages;
794 	unsigned int		pathlen;
795 	struct iattr *		sattr;
796 };
797 
798 struct nfs_readdirargs {
799 	struct nfs_fh *		fh;
800 	__u32			cookie;
801 	unsigned int		count;
802 	struct page **		pages;
803 };
804 
805 struct nfs3_getaclargs {
806 	struct nfs_fh *		fh;
807 	int			mask;
808 	struct page **		pages;
809 };
810 
811 struct nfs3_setaclargs {
812 	struct inode *		inode;
813 	int			mask;
814 	struct posix_acl *	acl_access;
815 	struct posix_acl *	acl_default;
816 	size_t			len;
817 	unsigned int		npages;
818 	struct page **		pages;
819 };
820 
821 struct nfs_diropok {
822 	struct nfs_fh *		fh;
823 	struct nfs_fattr *	fattr;
824 };
825 
826 struct nfs_readlinkargs {
827 	struct nfs_fh *		fh;
828 	unsigned int		pgbase;
829 	unsigned int		pglen;
830 	struct page **		pages;
831 };
832 
833 struct nfs3_sattrargs {
834 	struct nfs_fh *		fh;
835 	struct iattr *		sattr;
836 	unsigned int		guard;
837 	struct timespec		guardtime;
838 };
839 
840 struct nfs3_diropargs {
841 	struct nfs_fh *		fh;
842 	const char *		name;
843 	unsigned int		len;
844 };
845 
846 struct nfs3_accessargs {
847 	struct nfs_fh *		fh;
848 	__u32			access;
849 };
850 
851 struct nfs3_createargs {
852 	struct nfs_fh *		fh;
853 	const char *		name;
854 	unsigned int		len;
855 	struct iattr *		sattr;
856 	enum nfs3_createmode	createmode;
857 	__be32			verifier[2];
858 };
859 
860 struct nfs3_mkdirargs {
861 	struct nfs_fh *		fh;
862 	const char *		name;
863 	unsigned int		len;
864 	struct iattr *		sattr;
865 };
866 
867 struct nfs3_symlinkargs {
868 	struct nfs_fh *		fromfh;
869 	const char *		fromname;
870 	unsigned int		fromlen;
871 	struct page **		pages;
872 	unsigned int		pathlen;
873 	struct iattr *		sattr;
874 };
875 
876 struct nfs3_mknodargs {
877 	struct nfs_fh *		fh;
878 	const char *		name;
879 	unsigned int		len;
880 	enum nfs3_ftype		type;
881 	struct iattr *		sattr;
882 	dev_t			rdev;
883 };
884 
885 struct nfs3_linkargs {
886 	struct nfs_fh *		fromfh;
887 	struct nfs_fh *		tofh;
888 	const char *		toname;
889 	unsigned int		tolen;
890 };
891 
892 struct nfs3_readdirargs {
893 	struct nfs_fh *		fh;
894 	__u64			cookie;
895 	__be32			verf[2];
896 	bool			plus;
897 	unsigned int            count;
898 	struct page **		pages;
899 };
900 
901 struct nfs3_diropres {
902 	struct nfs_fattr *	dir_attr;
903 	struct nfs_fh *		fh;
904 	struct nfs_fattr *	fattr;
905 };
906 
907 struct nfs3_accessres {
908 	struct nfs_fattr *	fattr;
909 	__u32			access;
910 };
911 
912 struct nfs3_readlinkargs {
913 	struct nfs_fh *		fh;
914 	unsigned int		pgbase;
915 	unsigned int		pglen;
916 	struct page **		pages;
917 };
918 
919 struct nfs3_linkres {
920 	struct nfs_fattr *	dir_attr;
921 	struct nfs_fattr *	fattr;
922 };
923 
924 struct nfs3_readdirres {
925 	struct nfs_fattr *	dir_attr;
926 	__be32 *		verf;
927 	bool			plus;
928 };
929 
930 struct nfs3_getaclres {
931 	struct nfs_fattr *	fattr;
932 	int			mask;
933 	unsigned int		acl_access_count;
934 	unsigned int		acl_default_count;
935 	struct posix_acl *	acl_access;
936 	struct posix_acl *	acl_default;
937 };
938 
939 #if IS_ENABLED(CONFIG_NFS_V4)
940 
941 typedef u64 clientid4;
942 
943 struct nfs4_accessargs {
944 	struct nfs4_sequence_args	seq_args;
945 	const struct nfs_fh *		fh;
946 	const u32 *			bitmask;
947 	u32				access;
948 };
949 
950 struct nfs4_accessres {
951 	struct nfs4_sequence_res	seq_res;
952 	const struct nfs_server *	server;
953 	struct nfs_fattr *		fattr;
954 	u32				supported;
955 	u32				access;
956 };
957 
958 struct nfs4_create_arg {
959 	struct nfs4_sequence_args 	seq_args;
960 	u32				ftype;
961 	union {
962 		struct {
963 			struct page **	pages;
964 			unsigned int	len;
965 		} symlink;   /* NF4LNK */
966 		struct {
967 			u32		specdata1;
968 			u32		specdata2;
969 		} device;    /* NF4BLK, NF4CHR */
970 	} u;
971 	const struct qstr *		name;
972 	const struct nfs_server *	server;
973 	const struct iattr *		attrs;
974 	const struct nfs_fh *		dir_fh;
975 	const u32 *			bitmask;
976 	const struct nfs4_label		*label;
977 	umode_t				umask;
978 };
979 
980 struct nfs4_create_res {
981 	struct nfs4_sequence_res	seq_res;
982 	const struct nfs_server *	server;
983 	struct nfs_fh *			fh;
984 	struct nfs_fattr *		fattr;
985 	struct nfs4_label		*label;
986 	struct nfs4_change_info		dir_cinfo;
987 };
988 
989 struct nfs4_fsinfo_arg {
990 	struct nfs4_sequence_args	seq_args;
991 	const struct nfs_fh *		fh;
992 	const u32 *			bitmask;
993 };
994 
995 struct nfs4_fsinfo_res {
996 	struct nfs4_sequence_res	seq_res;
997 	struct nfs_fsinfo	       *fsinfo;
998 };
999 
1000 struct nfs4_getattr_arg {
1001 	struct nfs4_sequence_args	seq_args;
1002 	const struct nfs_fh *		fh;
1003 	const u32 *			bitmask;
1004 };
1005 
1006 struct nfs4_getattr_res {
1007 	struct nfs4_sequence_res	seq_res;
1008 	const struct nfs_server *	server;
1009 	struct nfs_fattr *		fattr;
1010 	struct nfs4_label		*label;
1011 };
1012 
1013 struct nfs4_link_arg {
1014 	struct nfs4_sequence_args 	seq_args;
1015 	const struct nfs_fh *		fh;
1016 	const struct nfs_fh *		dir_fh;
1017 	const struct qstr *		name;
1018 	const u32 *			bitmask;
1019 };
1020 
1021 struct nfs4_link_res {
1022 	struct nfs4_sequence_res	seq_res;
1023 	const struct nfs_server *	server;
1024 	struct nfs_fattr *		fattr;
1025 	struct nfs4_label		*label;
1026 	struct nfs4_change_info		cinfo;
1027 	struct nfs_fattr *		dir_attr;
1028 };
1029 
1030 struct nfs4_lookup_arg {
1031 	struct nfs4_sequence_args	seq_args;
1032 	const struct nfs_fh *		dir_fh;
1033 	const struct qstr *		name;
1034 	const u32 *			bitmask;
1035 };
1036 
1037 struct nfs4_lookup_res {
1038 	struct nfs4_sequence_res	seq_res;
1039 	const struct nfs_server *	server;
1040 	struct nfs_fattr *		fattr;
1041 	struct nfs_fh *			fh;
1042 	struct nfs4_label		*label;
1043 };
1044 
1045 struct nfs4_lookupp_arg {
1046 	struct nfs4_sequence_args	seq_args;
1047 	const struct nfs_fh		*fh;
1048 	const u32			*bitmask;
1049 };
1050 
1051 struct nfs4_lookupp_res {
1052 	struct nfs4_sequence_res	seq_res;
1053 	const struct nfs_server		*server;
1054 	struct nfs_fattr		*fattr;
1055 	struct nfs_fh			*fh;
1056 	struct nfs4_label		*label;
1057 };
1058 
1059 struct nfs4_lookup_root_arg {
1060 	struct nfs4_sequence_args	seq_args;
1061 	const u32 *			bitmask;
1062 };
1063 
1064 struct nfs4_pathconf_arg {
1065 	struct nfs4_sequence_args	seq_args;
1066 	const struct nfs_fh *		fh;
1067 	const u32 *			bitmask;
1068 };
1069 
1070 struct nfs4_pathconf_res {
1071 	struct nfs4_sequence_res	seq_res;
1072 	struct nfs_pathconf	       *pathconf;
1073 };
1074 
1075 struct nfs4_readdir_arg {
1076 	struct nfs4_sequence_args	seq_args;
1077 	const struct nfs_fh *		fh;
1078 	u64				cookie;
1079 	nfs4_verifier			verifier;
1080 	u32				count;
1081 	struct page **			pages;	/* zero-copy data */
1082 	unsigned int			pgbase;	/* zero-copy data */
1083 	const u32 *			bitmask;
1084 	bool				plus;
1085 };
1086 
1087 struct nfs4_readdir_res {
1088 	struct nfs4_sequence_res	seq_res;
1089 	nfs4_verifier			verifier;
1090 	unsigned int			pgbase;
1091 };
1092 
1093 struct nfs4_readlink {
1094 	struct nfs4_sequence_args	seq_args;
1095 	const struct nfs_fh *		fh;
1096 	unsigned int			pgbase;
1097 	unsigned int			pglen;   /* zero-copy data */
1098 	struct page **			pages;   /* zero-copy data */
1099 };
1100 
1101 struct nfs4_readlink_res {
1102 	struct nfs4_sequence_res	seq_res;
1103 };
1104 
1105 struct nfs4_setclientid {
1106 	const nfs4_verifier *		sc_verifier;
1107 	u32				sc_prog;
1108 	unsigned int			sc_netid_len;
1109 	char				sc_netid[RPCBIND_MAXNETIDLEN + 1];
1110 	unsigned int			sc_uaddr_len;
1111 	char				sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
1112 	struct nfs_client		*sc_clnt;
1113 	struct rpc_cred			*sc_cred;
1114 };
1115 
1116 struct nfs4_setclientid_res {
1117 	u64				clientid;
1118 	nfs4_verifier			confirm;
1119 };
1120 
1121 struct nfs4_statfs_arg {
1122 	struct nfs4_sequence_args	seq_args;
1123 	const struct nfs_fh *		fh;
1124 	const u32 *			bitmask;
1125 };
1126 
1127 struct nfs4_statfs_res {
1128 	struct nfs4_sequence_res	seq_res;
1129 	struct nfs_fsstat	       *fsstat;
1130 };
1131 
1132 struct nfs4_server_caps_arg {
1133 	struct nfs4_sequence_args	seq_args;
1134 	struct nfs_fh		       *fhandle;
1135 	const u32 *			bitmask;
1136 };
1137 
1138 struct nfs4_server_caps_res {
1139 	struct nfs4_sequence_res	seq_res;
1140 	u32				attr_bitmask[3];
1141 	u32				exclcreat_bitmask[3];
1142 	u32				acl_bitmask;
1143 	u32				has_links;
1144 	u32				has_symlinks;
1145 	u32				fh_expire_type;
1146 };
1147 
1148 #define NFS4_PATHNAME_MAXCOMPONENTS 512
1149 struct nfs4_pathname {
1150 	unsigned int ncomponents;
1151 	struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
1152 };
1153 
1154 #define NFS4_FS_LOCATION_MAXSERVERS 10
1155 struct nfs4_fs_location {
1156 	unsigned int nservers;
1157 	struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
1158 	struct nfs4_pathname rootpath;
1159 };
1160 
1161 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
1162 struct nfs4_fs_locations {
1163 	struct nfs_fattr fattr;
1164 	const struct nfs_server *server;
1165 	struct nfs4_pathname fs_path;
1166 	int nlocations;
1167 	struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
1168 };
1169 
1170 struct nfs4_fs_locations_arg {
1171 	struct nfs4_sequence_args	seq_args;
1172 	const struct nfs_fh *dir_fh;
1173 	const struct nfs_fh *fh;
1174 	const struct qstr *name;
1175 	struct page *page;
1176 	const u32 *bitmask;
1177 	clientid4 clientid;
1178 	unsigned char migration:1, renew:1;
1179 };
1180 
1181 struct nfs4_fs_locations_res {
1182 	struct nfs4_sequence_res	seq_res;
1183 	struct nfs4_fs_locations       *fs_locations;
1184 	unsigned char			migration:1, renew:1;
1185 };
1186 
1187 struct nfs4_secinfo4 {
1188 	u32			flavor;
1189 	struct rpcsec_gss_info	flavor_info;
1190 };
1191 
1192 struct nfs4_secinfo_flavors {
1193 	unsigned int		num_flavors;
1194 	struct nfs4_secinfo4	flavors[0];
1195 };
1196 
1197 struct nfs4_secinfo_arg {
1198 	struct nfs4_sequence_args	seq_args;
1199 	const struct nfs_fh		*dir_fh;
1200 	const struct qstr		*name;
1201 };
1202 
1203 struct nfs4_secinfo_res {
1204 	struct nfs4_sequence_res	seq_res;
1205 	struct nfs4_secinfo_flavors	*flavors;
1206 };
1207 
1208 struct nfs4_fsid_present_arg {
1209 	struct nfs4_sequence_args	seq_args;
1210 	const struct nfs_fh		*fh;
1211 	clientid4			clientid;
1212 	unsigned char			renew:1;
1213 };
1214 
1215 struct nfs4_fsid_present_res {
1216 	struct nfs4_sequence_res	seq_res;
1217 	struct nfs_fh			*fh;
1218 	unsigned char			renew:1;
1219 };
1220 
1221 #endif /* CONFIG_NFS_V4 */
1222 
1223 struct nfstime4 {
1224 	u64	seconds;
1225 	u32	nseconds;
1226 };
1227 
1228 #ifdef CONFIG_NFS_V4_1
1229 
1230 struct pnfs_commit_bucket {
1231 	struct list_head written;
1232 	struct list_head committing;
1233 	struct pnfs_layout_segment *wlseg;
1234 	struct pnfs_layout_segment *clseg;
1235 	struct nfs_writeverf direct_verf;
1236 };
1237 
1238 struct pnfs_ds_commit_info {
1239 	int nwritten;
1240 	int ncommitting;
1241 	int nbuckets;
1242 	struct pnfs_commit_bucket *buckets;
1243 };
1244 
1245 struct nfs41_state_protection {
1246 	u32 how;
1247 	struct nfs4_op_map enforce;
1248 	struct nfs4_op_map allow;
1249 };
1250 
1251 struct nfs41_exchange_id_args {
1252 	struct nfs_client		*client;
1253 	nfs4_verifier			verifier;
1254 	u32				flags;
1255 	struct nfs41_state_protection	state_protect;
1256 };
1257 
1258 struct nfs41_server_owner {
1259 	uint64_t			minor_id;
1260 	uint32_t			major_id_sz;
1261 	char				major_id[NFS4_OPAQUE_LIMIT];
1262 };
1263 
1264 struct nfs41_server_scope {
1265 	uint32_t			server_scope_sz;
1266 	char 				server_scope[NFS4_OPAQUE_LIMIT];
1267 };
1268 
1269 struct nfs41_impl_id {
1270 	char				domain[NFS4_OPAQUE_LIMIT + 1];
1271 	char				name[NFS4_OPAQUE_LIMIT + 1];
1272 	struct nfstime4			date;
1273 };
1274 
1275 struct nfs41_bind_conn_to_session_args {
1276 	struct nfs_client		*client;
1277 	struct nfs4_sessionid		sessionid;
1278 	u32				dir;
1279 	bool				use_conn_in_rdma_mode;
1280 };
1281 
1282 struct nfs41_bind_conn_to_session_res {
1283 	struct nfs4_sessionid		sessionid;
1284 	u32				dir;
1285 	bool				use_conn_in_rdma_mode;
1286 };
1287 
1288 struct nfs41_exchange_id_res {
1289 	u64				clientid;
1290 	u32				seqid;
1291 	u32				flags;
1292 	struct nfs41_server_owner	*server_owner;
1293 	struct nfs41_server_scope	*server_scope;
1294 	struct nfs41_impl_id		*impl_id;
1295 	struct nfs41_state_protection	state_protect;
1296 };
1297 
1298 struct nfs41_create_session_args {
1299 	struct nfs_client	       *client;
1300 	u64				clientid;
1301 	uint32_t			seqid;
1302 	uint32_t			flags;
1303 	uint32_t			cb_program;
1304 	struct nfs4_channel_attrs	fc_attrs;	/* Fore Channel */
1305 	struct nfs4_channel_attrs	bc_attrs;	/* Back Channel */
1306 };
1307 
1308 struct nfs41_create_session_res {
1309 	struct nfs4_sessionid		sessionid;
1310 	uint32_t			seqid;
1311 	uint32_t			flags;
1312 	struct nfs4_channel_attrs	fc_attrs;	/* Fore Channel */
1313 	struct nfs4_channel_attrs	bc_attrs;	/* Back Channel */
1314 };
1315 
1316 struct nfs41_reclaim_complete_args {
1317 	struct nfs4_sequence_args	seq_args;
1318 	/* In the future extend to include curr_fh for use with migration */
1319 	unsigned char			one_fs:1;
1320 };
1321 
1322 struct nfs41_reclaim_complete_res {
1323 	struct nfs4_sequence_res	seq_res;
1324 };
1325 
1326 #define SECINFO_STYLE_CURRENT_FH 0
1327 #define SECINFO_STYLE_PARENT 1
1328 struct nfs41_secinfo_no_name_args {
1329 	struct nfs4_sequence_args	seq_args;
1330 	int				style;
1331 };
1332 
1333 struct nfs41_test_stateid_args {
1334 	struct nfs4_sequence_args	seq_args;
1335 	nfs4_stateid			*stateid;
1336 };
1337 
1338 struct nfs41_test_stateid_res {
1339 	struct nfs4_sequence_res	seq_res;
1340 	unsigned int			status;
1341 };
1342 
1343 struct nfs41_free_stateid_args {
1344 	struct nfs4_sequence_args	seq_args;
1345 	nfs4_stateid			stateid;
1346 };
1347 
1348 struct nfs41_free_stateid_res {
1349 	struct nfs4_sequence_res	seq_res;
1350 	unsigned int			status;
1351 };
1352 
1353 static inline void
1354 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1355 {
1356 	kfree(cinfo->buckets);
1357 }
1358 
1359 #else
1360 
1361 struct pnfs_ds_commit_info {
1362 };
1363 
1364 static inline void
1365 nfs_free_pnfs_ds_cinfo(struct pnfs_ds_commit_info *cinfo)
1366 {
1367 }
1368 
1369 #endif /* CONFIG_NFS_V4_1 */
1370 
1371 #ifdef CONFIG_NFS_V4_2
1372 struct nfs42_falloc_args {
1373 	struct nfs4_sequence_args	seq_args;
1374 
1375 	struct nfs_fh			*falloc_fh;
1376 	nfs4_stateid			 falloc_stateid;
1377 	u64				 falloc_offset;
1378 	u64				 falloc_length;
1379 	const u32			*falloc_bitmask;
1380 };
1381 
1382 struct nfs42_falloc_res {
1383 	struct nfs4_sequence_res	seq_res;
1384 	unsigned int			status;
1385 
1386 	struct nfs_fattr		*falloc_fattr;
1387 	const struct nfs_server		*falloc_server;
1388 };
1389 
1390 struct nfs42_copy_args {
1391 	struct nfs4_sequence_args	seq_args;
1392 
1393 	struct nfs_fh			*src_fh;
1394 	nfs4_stateid			src_stateid;
1395 	u64				src_pos;
1396 
1397 	struct nfs_fh			*dst_fh;
1398 	nfs4_stateid			dst_stateid;
1399 	u64				dst_pos;
1400 
1401 	u64				count;
1402 	bool				sync;
1403 };
1404 
1405 struct nfs42_write_res {
1406 	nfs4_stateid		stateid;
1407 	u64			count;
1408 	struct nfs_writeverf	verifier;
1409 };
1410 
1411 struct nfs42_copy_res {
1412 	struct nfs4_sequence_res	seq_res;
1413 	struct nfs42_write_res		write_res;
1414 	bool				consecutive;
1415 	bool				synchronous;
1416 	struct nfs_commitres		commit_res;
1417 };
1418 
1419 struct nfs42_offload_status_args {
1420 	struct nfs4_sequence_args	osa_seq_args;
1421 	struct nfs_fh			*osa_src_fh;
1422 	nfs4_stateid			osa_stateid;
1423 };
1424 
1425 struct nfs42_offload_status_res {
1426 	struct nfs4_sequence_res	osr_seq_res;
1427 	uint64_t			osr_count;
1428 	int				osr_status;
1429 };
1430 
1431 struct nfs42_seek_args {
1432 	struct nfs4_sequence_args	seq_args;
1433 
1434 	struct nfs_fh			*sa_fh;
1435 	nfs4_stateid			sa_stateid;
1436 	u64				sa_offset;
1437 	u32				sa_what;
1438 };
1439 
1440 struct nfs42_seek_res {
1441 	struct nfs4_sequence_res	seq_res;
1442 	unsigned int			status;
1443 
1444 	u32	sr_eof;
1445 	u64	sr_offset;
1446 };
1447 #endif
1448 
1449 struct nfs_page;
1450 
1451 #define NFS_PAGEVEC_SIZE	(8U)
1452 
1453 struct nfs_page_array {
1454 	struct page		**pagevec;
1455 	unsigned int		npages;		/* Max length of pagevec */
1456 	struct page		*page_array[NFS_PAGEVEC_SIZE];
1457 };
1458 
1459 /* used as flag bits in nfs_pgio_header */
1460 enum {
1461 	NFS_IOHDR_ERROR = 0,
1462 	NFS_IOHDR_EOF,
1463 	NFS_IOHDR_REDO,
1464 	NFS_IOHDR_STAT,
1465 	NFS_IOHDR_RESEND_PNFS,
1466 	NFS_IOHDR_RESEND_MDS,
1467 };
1468 
1469 struct nfs_io_completion;
1470 struct nfs_pgio_header {
1471 	struct inode		*inode;
1472 	const struct cred		*cred;
1473 	struct list_head	pages;
1474 	struct nfs_page		*req;
1475 	struct nfs_writeverf	verf;		/* Used for writes */
1476 	fmode_t			rw_mode;
1477 	struct pnfs_layout_segment *lseg;
1478 	loff_t			io_start;
1479 	const struct rpc_call_ops *mds_ops;
1480 	void (*release) (struct nfs_pgio_header *hdr);
1481 	const struct nfs_pgio_completion_ops *completion_ops;
1482 	const struct nfs_rw_ops	*rw_ops;
1483 	struct nfs_io_completion *io_completion;
1484 	struct nfs_direct_req	*dreq;
1485 
1486 	int			pnfs_error;
1487 	int			error;		/* merge with pnfs_error */
1488 	unsigned int		good_bytes;	/* boundary of good data */
1489 	unsigned long		flags;
1490 
1491 	/*
1492 	 * rpc data
1493 	 */
1494 	struct rpc_task		task;
1495 	struct nfs_fattr	fattr;
1496 	struct nfs_pgio_args	args;		/* argument struct */
1497 	struct nfs_pgio_res	res;		/* result struct */
1498 	unsigned long		timestamp;	/* For lease renewal */
1499 	int (*pgio_done_cb)(struct rpc_task *, struct nfs_pgio_header *);
1500 	__u64			mds_offset;	/* Filelayout dense stripe */
1501 	struct nfs_page_array	page_array;
1502 	struct nfs_client	*ds_clp;	/* pNFS data server */
1503 	int			ds_commit_idx;	/* ds index if ds_clp is set */
1504 	int			pgio_mirror_idx;/* mirror index in pgio layer */
1505 };
1506 
1507 struct nfs_mds_commit_info {
1508 	atomic_t rpcs_out;
1509 	atomic_long_t		ncommit;
1510 	struct list_head	list;
1511 };
1512 
1513 struct nfs_commit_info;
1514 struct nfs_commit_data;
1515 struct nfs_inode;
1516 struct nfs_commit_completion_ops {
1517 	void (*completion) (struct nfs_commit_data *data);
1518 	void (*resched_write) (struct nfs_commit_info *, struct nfs_page *);
1519 };
1520 
1521 struct nfs_commit_info {
1522 	struct inode 			*inode;	/* Needed for inode->i_lock */
1523 	struct nfs_mds_commit_info	*mds;
1524 	struct pnfs_ds_commit_info	*ds;
1525 	struct nfs_direct_req		*dreq;	/* O_DIRECT request */
1526 	const struct nfs_commit_completion_ops *completion_ops;
1527 };
1528 
1529 struct nfs_commit_data {
1530 	struct rpc_task		task;
1531 	struct inode		*inode;
1532 	const struct cred		*cred;
1533 	struct nfs_fattr	fattr;
1534 	struct nfs_writeverf	verf;
1535 	struct list_head	pages;		/* Coalesced requests we wish to flush */
1536 	struct list_head	list;		/* lists of struct nfs_write_data */
1537 	struct nfs_direct_req	*dreq;		/* O_DIRECT request */
1538 	struct nfs_commitargs	args;		/* argument struct */
1539 	struct nfs_commitres	res;		/* result struct */
1540 	struct nfs_open_context *context;
1541 	struct pnfs_layout_segment *lseg;
1542 	struct nfs_client	*ds_clp;	/* pNFS data server */
1543 	int			ds_commit_index;
1544 	loff_t			lwb;
1545 	const struct rpc_call_ops *mds_ops;
1546 	const struct nfs_commit_completion_ops *completion_ops;
1547 	int (*commit_done_cb) (struct rpc_task *task, struct nfs_commit_data *data);
1548 	unsigned long		flags;
1549 };
1550 
1551 struct nfs_pgio_completion_ops {
1552 	void	(*error_cleanup)(struct list_head *head);
1553 	void	(*init_hdr)(struct nfs_pgio_header *hdr);
1554 	void	(*completion)(struct nfs_pgio_header *hdr);
1555 	void	(*reschedule_io)(struct nfs_pgio_header *hdr);
1556 };
1557 
1558 struct nfs_unlinkdata {
1559 	struct nfs_removeargs args;
1560 	struct nfs_removeres res;
1561 	struct dentry *dentry;
1562 	wait_queue_head_t wq;
1563 	const struct cred *cred;
1564 	struct nfs_fattr dir_attr;
1565 	long timeout;
1566 };
1567 
1568 struct nfs_renamedata {
1569 	struct nfs_renameargs	args;
1570 	struct nfs_renameres	res;
1571 	const struct cred	*cred;
1572 	struct inode		*old_dir;
1573 	struct dentry		*old_dentry;
1574 	struct nfs_fattr	old_fattr;
1575 	struct inode		*new_dir;
1576 	struct dentry		*new_dentry;
1577 	struct nfs_fattr	new_fattr;
1578 	void (*complete)(struct rpc_task *, struct nfs_renamedata *);
1579 	long timeout;
1580 	bool cancelled;
1581 };
1582 
1583 struct nfs_access_entry;
1584 struct nfs_client;
1585 struct rpc_timeout;
1586 struct nfs_subversion;
1587 struct nfs_mount_info;
1588 struct nfs_client_initdata;
1589 struct nfs_pageio_descriptor;
1590 
1591 /*
1592  * RPC procedure vector for NFSv2/NFSv3 demuxing
1593  */
1594 struct nfs_rpc_ops {
1595 	u32	version;		/* Protocol version */
1596 	const struct dentry_operations *dentry_ops;
1597 	const struct inode_operations *dir_inode_ops;
1598 	const struct inode_operations *file_inode_ops;
1599 	const struct file_operations *file_ops;
1600 	const struct nlmclnt_operations *nlmclnt_ops;
1601 
1602 	int	(*getroot) (struct nfs_server *, struct nfs_fh *,
1603 			    struct nfs_fsinfo *);
1604 	struct vfsmount *(*submount) (struct nfs_server *, struct dentry *,
1605 				      struct nfs_fh *, struct nfs_fattr *);
1606 	struct dentry *(*try_mount) (int, const char *, struct nfs_mount_info *,
1607 				     struct nfs_subversion *);
1608 	int	(*getattr) (struct nfs_server *, struct nfs_fh *,
1609 			    struct nfs_fattr *, struct nfs4_label *,
1610 			    struct inode *);
1611 	int	(*setattr) (struct dentry *, struct nfs_fattr *,
1612 			    struct iattr *);
1613 	int	(*lookup)  (struct inode *, const struct qstr *,
1614 			    struct nfs_fh *, struct nfs_fattr *,
1615 			    struct nfs4_label *);
1616 	int	(*lookupp) (struct inode *, struct nfs_fh *,
1617 			    struct nfs_fattr *, struct nfs4_label *);
1618 	int	(*access)  (struct inode *, struct nfs_access_entry *);
1619 	int	(*readlink)(struct inode *, struct page *, unsigned int,
1620 			    unsigned int);
1621 	int	(*create)  (struct inode *, struct dentry *,
1622 			    struct iattr *, int);
1623 	int	(*remove)  (struct inode *, struct dentry *);
1624 	void	(*unlink_setup)  (struct rpc_message *, struct dentry *, struct inode *);
1625 	void	(*unlink_rpc_prepare) (struct rpc_task *, struct nfs_unlinkdata *);
1626 	int	(*unlink_done) (struct rpc_task *, struct inode *);
1627 	void	(*rename_setup)  (struct rpc_message *msg,
1628 			struct dentry *old_dentry,
1629 			struct dentry *new_dentry);
1630 	void	(*rename_rpc_prepare)(struct rpc_task *task, struct nfs_renamedata *);
1631 	int	(*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1632 	int	(*link)    (struct inode *, struct inode *, const struct qstr *);
1633 	int	(*symlink) (struct inode *, struct dentry *, struct page *,
1634 			    unsigned int, struct iattr *);
1635 	int	(*mkdir)   (struct inode *, struct dentry *, struct iattr *);
1636 	int	(*rmdir)   (struct inode *, const struct qstr *);
1637 	int	(*readdir) (struct dentry *, const struct cred *,
1638 			    u64, struct page **, unsigned int, bool);
1639 	int	(*mknod)   (struct inode *, struct dentry *, struct iattr *,
1640 			    dev_t);
1641 	int	(*statfs)  (struct nfs_server *, struct nfs_fh *,
1642 			    struct nfs_fsstat *);
1643 	int	(*fsinfo)  (struct nfs_server *, struct nfs_fh *,
1644 			    struct nfs_fsinfo *);
1645 	int	(*pathconf) (struct nfs_server *, struct nfs_fh *,
1646 			     struct nfs_pathconf *);
1647 	int	(*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1648 	int	(*decode_dirent)(struct xdr_stream *, struct nfs_entry *, bool);
1649 	int	(*pgio_rpc_prepare)(struct rpc_task *,
1650 				    struct nfs_pgio_header *);
1651 	void	(*read_setup)(struct nfs_pgio_header *, struct rpc_message *);
1652 	int	(*read_done)(struct rpc_task *, struct nfs_pgio_header *);
1653 	void	(*write_setup)(struct nfs_pgio_header *, struct rpc_message *,
1654 				struct rpc_clnt **);
1655 	int	(*write_done)(struct rpc_task *, struct nfs_pgio_header *);
1656 	void	(*commit_setup) (struct nfs_commit_data *, struct rpc_message *,
1657 				struct rpc_clnt **);
1658 	void	(*commit_rpc_prepare)(struct rpc_task *, struct nfs_commit_data *);
1659 	int	(*commit_done) (struct rpc_task *, struct nfs_commit_data *);
1660 	int	(*lock)(struct file *, int, struct file_lock *);
1661 	int	(*lock_check_bounds)(const struct file_lock *);
1662 	void	(*clear_acl_cache)(struct inode *);
1663 	void	(*close_context)(struct nfs_open_context *ctx, int);
1664 	struct inode * (*open_context) (struct inode *dir,
1665 				struct nfs_open_context *ctx,
1666 				int open_flags,
1667 				struct iattr *iattr,
1668 				int *);
1669 	int (*have_delegation)(struct inode *, fmode_t);
1670 	struct nfs_client *(*alloc_client) (const struct nfs_client_initdata *);
1671 	struct nfs_client *(*init_client) (struct nfs_client *,
1672 				const struct nfs_client_initdata *);
1673 	void	(*free_client) (struct nfs_client *);
1674 	struct nfs_server *(*create_server)(struct nfs_mount_info *, struct nfs_subversion *);
1675 	struct nfs_server *(*clone_server)(struct nfs_server *, struct nfs_fh *,
1676 					   struct nfs_fattr *, rpc_authflavor_t);
1677 };
1678 
1679 /*
1680  * 	NFS_CALL(getattr, inode, (fattr));
1681  * into
1682  *	NFS_PROTO(inode)->getattr(fattr);
1683  */
1684 #define NFS_CALL(op, inode, args)	NFS_PROTO(inode)->op args
1685 
1686 /*
1687  * Function vectors etc. for the NFS client
1688  */
1689 extern const struct nfs_rpc_ops	nfs_v2_clientops;
1690 extern const struct nfs_rpc_ops	nfs_v3_clientops;
1691 extern const struct nfs_rpc_ops	nfs_v4_clientops;
1692 extern const struct rpc_version nfs_version2;
1693 extern const struct rpc_version nfs_version3;
1694 extern const struct rpc_version nfs_version4;
1695 
1696 extern const struct rpc_version nfsacl_version3;
1697 extern const struct rpc_program nfsacl_program;
1698 
1699 #endif
1700