xref: /linux-6.15/include/linux/nfs_xdr.h (revision db4e8395)
1 #ifndef _LINUX_NFS_XDR_H
2 #define _LINUX_NFS_XDR_H
3 
4 #include <linux/nfsacl.h>
5 #include <linux/nfs3.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 /* Forward declaration for NFS v3 */
19 struct nfs4_secinfo_flavors;
20 
21 struct nfs_fsid {
22 	uint64_t		major;
23 	uint64_t		minor;
24 };
25 
26 /*
27  * Helper for checking equality between 2 fsids.
28  */
29 static inline int nfs_fsid_equal(const struct nfs_fsid *a, const struct nfs_fsid *b)
30 {
31 	return a->major == b->major && a->minor == b->minor;
32 }
33 
34 struct nfs_fattr {
35 	unsigned int		valid;		/* which fields are valid */
36 	umode_t			mode;
37 	__u32			nlink;
38 	__u32			uid;
39 	__u32			gid;
40 	dev_t			rdev;
41 	__u64			size;
42 	union {
43 		struct {
44 			__u32	blocksize;
45 			__u32	blocks;
46 		} nfs2;
47 		struct {
48 			__u64	used;
49 		} nfs3;
50 	} du;
51 	struct nfs_fsid		fsid;
52 	__u64			fileid;
53 	__u64			mounted_on_fileid;
54 	struct timespec		atime;
55 	struct timespec		mtime;
56 	struct timespec		ctime;
57 	__u64			change_attr;	/* NFSv4 change attribute */
58 	__u64			pre_change_attr;/* pre-op NFSv4 change attribute */
59 	__u64			pre_size;	/* pre_op_attr.size	  */
60 	struct timespec		pre_mtime;	/* pre_op_attr.mtime	  */
61 	struct timespec		pre_ctime;	/* pre_op_attr.ctime	  */
62 	unsigned long		time_start;
63 	unsigned long		gencount;
64 };
65 
66 #define NFS_ATTR_FATTR_TYPE		(1U << 0)
67 #define NFS_ATTR_FATTR_MODE		(1U << 1)
68 #define NFS_ATTR_FATTR_NLINK		(1U << 2)
69 #define NFS_ATTR_FATTR_OWNER		(1U << 3)
70 #define NFS_ATTR_FATTR_GROUP		(1U << 4)
71 #define NFS_ATTR_FATTR_RDEV		(1U << 5)
72 #define NFS_ATTR_FATTR_SIZE		(1U << 6)
73 #define NFS_ATTR_FATTR_PRESIZE		(1U << 7)
74 #define NFS_ATTR_FATTR_BLOCKS_USED	(1U << 8)
75 #define NFS_ATTR_FATTR_SPACE_USED	(1U << 9)
76 #define NFS_ATTR_FATTR_FSID		(1U << 10)
77 #define NFS_ATTR_FATTR_FILEID		(1U << 11)
78 #define NFS_ATTR_FATTR_ATIME		(1U << 12)
79 #define NFS_ATTR_FATTR_MTIME		(1U << 13)
80 #define NFS_ATTR_FATTR_CTIME		(1U << 14)
81 #define NFS_ATTR_FATTR_PREMTIME		(1U << 15)
82 #define NFS_ATTR_FATTR_PRECTIME		(1U << 16)
83 #define NFS_ATTR_FATTR_CHANGE		(1U << 17)
84 #define NFS_ATTR_FATTR_PRECHANGE	(1U << 18)
85 #define NFS_ATTR_FATTR_V4_REFERRAL	(1U << 19)	/* NFSv4 referral */
86 #define NFS_ATTR_FATTR_MOUNTPOINT	(1U << 20)	/* Treat as mountpoint */
87 #define NFS_ATTR_FATTR_MOUNTED_ON_FILEID		(1U << 21)
88 
89 #define NFS_ATTR_FATTR (NFS_ATTR_FATTR_TYPE \
90 		| NFS_ATTR_FATTR_MODE \
91 		| NFS_ATTR_FATTR_NLINK \
92 		| NFS_ATTR_FATTR_OWNER \
93 		| NFS_ATTR_FATTR_GROUP \
94 		| NFS_ATTR_FATTR_RDEV \
95 		| NFS_ATTR_FATTR_SIZE \
96 		| NFS_ATTR_FATTR_FSID \
97 		| NFS_ATTR_FATTR_FILEID \
98 		| NFS_ATTR_FATTR_ATIME \
99 		| NFS_ATTR_FATTR_MTIME \
100 		| NFS_ATTR_FATTR_CTIME)
101 #define NFS_ATTR_FATTR_V2 (NFS_ATTR_FATTR \
102 		| NFS_ATTR_FATTR_BLOCKS_USED)
103 #define NFS_ATTR_FATTR_V3 (NFS_ATTR_FATTR \
104 		| NFS_ATTR_FATTR_SPACE_USED)
105 #define NFS_ATTR_FATTR_V4 (NFS_ATTR_FATTR \
106 		| NFS_ATTR_FATTR_SPACE_USED \
107 		| NFS_ATTR_FATTR_CHANGE)
108 
109 /*
110  * Info on the file system
111  */
112 struct nfs_fsinfo {
113 	struct nfs_fattr	*fattr; /* Post-op attributes */
114 	__u32			rtmax;	/* max.  read transfer size */
115 	__u32			rtpref;	/* pref. read transfer size */
116 	__u32			rtmult;	/* reads should be multiple of this */
117 	__u32			wtmax;	/* max.  write transfer size */
118 	__u32			wtpref;	/* pref. write transfer size */
119 	__u32			wtmult;	/* writes should be multiple of this */
120 	__u32			dtpref;	/* pref. readdir transfer size */
121 	__u64			maxfilesize;
122 	struct timespec		time_delta; /* server time granularity */
123 	__u32			lease_time; /* in seconds */
124 	__u32			layouttype; /* supported pnfs layout driver */
125 	__u32			blksize; /* preferred pnfs io block size */
126 };
127 
128 struct nfs_fsstat {
129 	struct nfs_fattr	*fattr; /* Post-op attributes */
130 	__u64			tbytes;	/* total size in bytes */
131 	__u64			fbytes;	/* # of free bytes */
132 	__u64			abytes;	/* # of bytes available to user */
133 	__u64			tfiles;	/* # of files */
134 	__u64			ffiles;	/* # of free files */
135 	__u64			afiles;	/* # of files available to user */
136 };
137 
138 struct nfs2_fsstat {
139 	__u32			tsize;  /* Server transfer size */
140 	__u32			bsize;  /* Filesystem block size */
141 	__u32			blocks; /* No. of "bsize" blocks on filesystem */
142 	__u32			bfree;  /* No. of free "bsize" blocks */
143 	__u32			bavail; /* No. of available "bsize" blocks */
144 };
145 
146 struct nfs_pathconf {
147 	struct nfs_fattr	*fattr; /* Post-op attributes */
148 	__u32			max_link; /* max # of hard links */
149 	__u32			max_namelen; /* max name length */
150 };
151 
152 struct nfs4_change_info {
153 	u32			atomic;
154 	u64			before;
155 	u64			after;
156 };
157 
158 struct nfs_seqid;
159 
160 /* nfs41 sessions channel attributes */
161 struct nfs4_channel_attrs {
162 	u32			max_rqst_sz;
163 	u32			max_resp_sz;
164 	u32			max_resp_sz_cached;
165 	u32			max_ops;
166 	u32			max_reqs;
167 };
168 
169 /* nfs41 sessions slot seqid */
170 struct nfs4_slot {
171 	u32		 	seq_nr;
172 };
173 
174 struct nfs4_sequence_args {
175 	struct nfs4_session	*sa_session;
176 	u8			sa_slotid;
177 	u8			sa_cache_this;
178 };
179 
180 struct nfs4_sequence_res {
181 	struct nfs4_session	*sr_session;
182 	struct nfs4_slot	*sr_slot;	/* slot used to send request */
183 	int			sr_status;	/* sequence operation status */
184 	unsigned long		sr_renewal_time;
185 	u32			sr_status_flags;
186 };
187 
188 struct nfs4_get_lease_time_args {
189 	struct nfs4_sequence_args	la_seq_args;
190 };
191 
192 struct nfs4_get_lease_time_res {
193 	struct nfs_fsinfo	       *lr_fsinfo;
194 	struct nfs4_sequence_res	lr_seq_res;
195 };
196 
197 #define PNFS_LAYOUT_MAXSIZE 4096
198 
199 struct nfs4_layoutdriver_data {
200 	struct page **pages;
201 	__u32 pglen;
202 	__u32 len;
203 };
204 
205 struct pnfs_layout_range {
206 	u32 iomode;
207 	u64 offset;
208 	u64 length;
209 };
210 
211 struct nfs4_layoutget_args {
212 	__u32 type;
213 	struct pnfs_layout_range range;
214 	__u64 minlength;
215 	__u32 maxcount;
216 	struct inode *inode;
217 	struct nfs_open_context *ctx;
218 	struct nfs4_sequence_args seq_args;
219 	nfs4_stateid stateid;
220 	struct nfs4_layoutdriver_data layout;
221 };
222 
223 struct nfs4_layoutget_res {
224 	__u32 return_on_close;
225 	struct pnfs_layout_range range;
226 	__u32 type;
227 	nfs4_stateid stateid;
228 	struct nfs4_sequence_res seq_res;
229 	struct nfs4_layoutdriver_data *layoutp;
230 };
231 
232 struct nfs4_layoutget {
233 	struct nfs4_layoutget_args args;
234 	struct nfs4_layoutget_res res;
235 	struct pnfs_layout_segment **lsegpp;
236 	gfp_t gfp_flags;
237 };
238 
239 struct nfs4_getdevicelist_args {
240 	const struct nfs_fh *fh;
241 	u32 layoutclass;
242 	struct nfs4_sequence_args seq_args;
243 };
244 
245 struct nfs4_getdevicelist_res {
246 	struct pnfs_devicelist *devlist;
247 	struct nfs4_sequence_res seq_res;
248 };
249 
250 struct nfs4_getdeviceinfo_args {
251 	struct pnfs_device *pdev;
252 	struct nfs4_sequence_args seq_args;
253 };
254 
255 struct nfs4_getdeviceinfo_res {
256 	struct pnfs_device *pdev;
257 	struct nfs4_sequence_res seq_res;
258 };
259 
260 struct nfs4_layoutcommit_args {
261 	nfs4_stateid stateid;
262 	__u64 lastbytewritten;
263 	struct inode *inode;
264 	const u32 *bitmask;
265 	struct nfs4_sequence_args seq_args;
266 };
267 
268 struct nfs4_layoutcommit_res {
269 	struct nfs_fattr *fattr;
270 	const struct nfs_server *server;
271 	struct nfs4_sequence_res seq_res;
272 	int status;
273 };
274 
275 struct nfs4_layoutcommit_data {
276 	struct rpc_task task;
277 	struct nfs_fattr fattr;
278 	struct list_head lseg_list;
279 	struct rpc_cred *cred;
280 	struct nfs4_layoutcommit_args args;
281 	struct nfs4_layoutcommit_res res;
282 };
283 
284 struct nfs4_layoutreturn_args {
285 	struct pnfs_layout_hdr *layout;
286 	struct inode *inode;
287 	nfs4_stateid stateid;
288 	__u32   layout_type;
289 	struct nfs4_sequence_args seq_args;
290 };
291 
292 struct nfs4_layoutreturn_res {
293 	struct nfs4_sequence_res seq_res;
294 	u32 lrs_present;
295 	nfs4_stateid stateid;
296 };
297 
298 struct nfs4_layoutreturn {
299 	struct nfs4_layoutreturn_args args;
300 	struct nfs4_layoutreturn_res res;
301 	struct rpc_cred *cred;
302 	struct nfs_client *clp;
303 	int rpc_status;
304 };
305 
306 /*
307  * Arguments to the open call.
308  */
309 struct nfs_openargs {
310 	const struct nfs_fh *	fh;
311 	struct nfs_seqid *	seqid;
312 	int			open_flags;
313 	fmode_t			fmode;
314 	__u64                   clientid;
315 	__u64                   id;
316 	union {
317 		struct {
318 			struct iattr *  attrs;    /* UNCHECKED, GUARDED */
319 			nfs4_verifier   verifier; /* EXCLUSIVE */
320 		};
321 		nfs4_stateid	delegation;		/* CLAIM_DELEGATE_CUR */
322 		fmode_t		delegation_type;	/* CLAIM_PREVIOUS */
323 	} u;
324 	const struct qstr *	name;
325 	const struct nfs_server *server;	 /* Needed for ID mapping */
326 	const u32 *		bitmask;
327 	__u32			claim;
328 	struct nfs4_sequence_args	seq_args;
329 };
330 
331 struct nfs_openres {
332 	nfs4_stateid            stateid;
333 	struct nfs_fh           fh;
334 	struct nfs4_change_info	cinfo;
335 	__u32                   rflags;
336 	struct nfs_fattr *      f_attr;
337 	struct nfs_fattr *      dir_attr;
338 	struct nfs_seqid *	seqid;
339 	const struct nfs_server *server;
340 	fmode_t			delegation_type;
341 	nfs4_stateid		delegation;
342 	__u32			do_recall;
343 	__u64			maxsize;
344 	__u32			attrset[NFS4_BITMAP_SIZE];
345 	struct nfs4_sequence_res	seq_res;
346 };
347 
348 /*
349  * Arguments to the open_confirm call.
350  */
351 struct nfs_open_confirmargs {
352 	const struct nfs_fh *	fh;
353 	nfs4_stateid *		stateid;
354 	struct nfs_seqid *	seqid;
355 };
356 
357 struct nfs_open_confirmres {
358 	nfs4_stateid            stateid;
359 	struct nfs_seqid *	seqid;
360 };
361 
362 /*
363  * Arguments to the close call.
364  */
365 struct nfs_closeargs {
366 	struct nfs_fh *         fh;
367 	nfs4_stateid *		stateid;
368 	struct nfs_seqid *	seqid;
369 	fmode_t			fmode;
370 	const u32 *		bitmask;
371 	struct nfs4_sequence_args	seq_args;
372 };
373 
374 struct nfs_closeres {
375 	nfs4_stateid            stateid;
376 	struct nfs_fattr *	fattr;
377 	struct nfs_seqid *	seqid;
378 	const struct nfs_server *server;
379 	struct nfs4_sequence_res	seq_res;
380 };
381 /*
382  *  * Arguments to the lock,lockt, and locku call.
383  *   */
384 struct nfs_lowner {
385 	__u64			clientid;
386 	__u64			id;
387 	dev_t			s_dev;
388 };
389 
390 struct nfs_lock_args {
391 	struct nfs_fh *		fh;
392 	struct file_lock *	fl;
393 	struct nfs_seqid *	lock_seqid;
394 	nfs4_stateid *		lock_stateid;
395 	struct nfs_seqid *	open_seqid;
396 	nfs4_stateid *		open_stateid;
397 	struct nfs_lowner	lock_owner;
398 	unsigned char		block : 1;
399 	unsigned char		reclaim : 1;
400 	unsigned char		new_lock_owner : 1;
401 	struct nfs4_sequence_args	seq_args;
402 };
403 
404 struct nfs_lock_res {
405 	nfs4_stateid		stateid;
406 	struct nfs_seqid *	lock_seqid;
407 	struct nfs_seqid *	open_seqid;
408 	struct nfs4_sequence_res	seq_res;
409 };
410 
411 struct nfs_locku_args {
412 	struct nfs_fh *		fh;
413 	struct file_lock *	fl;
414 	struct nfs_seqid *	seqid;
415 	nfs4_stateid *		stateid;
416 	struct nfs4_sequence_args	seq_args;
417 };
418 
419 struct nfs_locku_res {
420 	nfs4_stateid		stateid;
421 	struct nfs_seqid *	seqid;
422 	struct nfs4_sequence_res	seq_res;
423 };
424 
425 struct nfs_lockt_args {
426 	struct nfs_fh *		fh;
427 	struct file_lock *	fl;
428 	struct nfs_lowner	lock_owner;
429 	struct nfs4_sequence_args	seq_args;
430 };
431 
432 struct nfs_lockt_res {
433 	struct file_lock *	denied; /* LOCK, LOCKT failed */
434 	struct nfs4_sequence_res	seq_res;
435 };
436 
437 struct nfs_release_lockowner_args {
438 	struct nfs_lowner	lock_owner;
439 };
440 
441 struct nfs4_delegreturnargs {
442 	const struct nfs_fh *fhandle;
443 	const nfs4_stateid *stateid;
444 	const u32 * bitmask;
445 	struct nfs4_sequence_args	seq_args;
446 };
447 
448 struct nfs4_delegreturnres {
449 	struct nfs_fattr * fattr;
450 	const struct nfs_server *server;
451 	struct nfs4_sequence_res	seq_res;
452 };
453 
454 /*
455  * Arguments to the read call.
456  */
457 struct nfs_readargs {
458 	struct nfs_fh *		fh;
459 	struct nfs_open_context *context;
460 	struct nfs_lock_context *lock_context;
461 	__u64			offset;
462 	__u32			count;
463 	unsigned int		pgbase;
464 	struct page **		pages;
465 	struct nfs4_sequence_args	seq_args;
466 };
467 
468 struct nfs_readres {
469 	struct nfs_fattr *	fattr;
470 	__u32			count;
471 	int                     eof;
472 	struct nfs4_sequence_res	seq_res;
473 };
474 
475 /*
476  * Arguments to the write call.
477  */
478 struct nfs_writeargs {
479 	struct nfs_fh *		fh;
480 	struct nfs_open_context *context;
481 	struct nfs_lock_context *lock_context;
482 	__u64			offset;
483 	__u32			count;
484 	enum nfs3_stable_how	stable;
485 	unsigned int		pgbase;
486 	struct page **		pages;
487 	const u32 *		bitmask;
488 	struct nfs4_sequence_args	seq_args;
489 };
490 
491 struct nfs_writeverf {
492 	enum nfs3_stable_how	committed;
493 	__be32			verifier[2];
494 };
495 
496 struct nfs_writeres {
497 	struct nfs_fattr *	fattr;
498 	struct nfs_writeverf *	verf;
499 	__u32			count;
500 	const struct nfs_server *server;
501 	struct nfs4_sequence_res	seq_res;
502 };
503 
504 /*
505  * Common arguments to the unlink call
506  */
507 struct nfs_removeargs {
508 	const struct nfs_fh	*fh;
509 	struct qstr		name;
510 	const u32 *		bitmask;
511 	struct nfs4_sequence_args	seq_args;
512 };
513 
514 struct nfs_removeres {
515 	const struct nfs_server *server;
516 	struct nfs_fattr	*dir_attr;
517 	struct nfs4_change_info	cinfo;
518 	struct nfs4_sequence_res 	seq_res;
519 };
520 
521 /*
522  * Common arguments to the rename call
523  */
524 struct nfs_renameargs {
525 	const struct nfs_fh		*old_dir;
526 	const struct nfs_fh		*new_dir;
527 	const struct qstr		*old_name;
528 	const struct qstr		*new_name;
529 	const u32			*bitmask;
530 	struct nfs4_sequence_args	seq_args;
531 };
532 
533 struct nfs_renameres {
534 	const struct nfs_server		*server;
535 	struct nfs4_change_info		old_cinfo;
536 	struct nfs_fattr		*old_fattr;
537 	struct nfs4_change_info		new_cinfo;
538 	struct nfs_fattr		*new_fattr;
539 	struct nfs4_sequence_res	seq_res;
540 };
541 
542 /*
543  * Argument struct for decode_entry function
544  */
545 struct nfs_entry {
546 	__u64			ino;
547 	__u64			cookie,
548 				prev_cookie;
549 	const char *		name;
550 	unsigned int		len;
551 	int			eof;
552 	struct nfs_fh *		fh;
553 	struct nfs_fattr *	fattr;
554 	unsigned char		d_type;
555 	struct nfs_server *	server;
556 };
557 
558 /*
559  * The following types are for NFSv2 only.
560  */
561 struct nfs_sattrargs {
562 	struct nfs_fh *		fh;
563 	struct iattr *		sattr;
564 };
565 
566 struct nfs_diropargs {
567 	struct nfs_fh *		fh;
568 	const char *		name;
569 	unsigned int		len;
570 };
571 
572 struct nfs_createargs {
573 	struct nfs_fh *		fh;
574 	const char *		name;
575 	unsigned int		len;
576 	struct iattr *		sattr;
577 };
578 
579 struct nfs_setattrargs {
580 	struct nfs_fh *                 fh;
581 	nfs4_stateid                    stateid;
582 	struct iattr *                  iap;
583 	const struct nfs_server *	server; /* Needed for name mapping */
584 	const u32 *			bitmask;
585 	struct nfs4_sequence_args 	seq_args;
586 };
587 
588 struct nfs_setaclargs {
589 	struct nfs_fh *			fh;
590 	size_t				acl_len;
591 	unsigned int			acl_pgbase;
592 	struct page **			acl_pages;
593 	struct nfs4_sequence_args	seq_args;
594 };
595 
596 struct nfs_setaclres {
597 	struct nfs4_sequence_res	seq_res;
598 };
599 
600 struct nfs_getaclargs {
601 	struct nfs_fh *			fh;
602 	size_t				acl_len;
603 	unsigned int			acl_pgbase;
604 	struct page **			acl_pages;
605 	struct nfs4_sequence_args 	seq_args;
606 };
607 
608 struct nfs_getaclres {
609 	size_t				acl_len;
610 	struct nfs4_sequence_res	seq_res;
611 };
612 
613 struct nfs_setattrres {
614 	struct nfs_fattr *              fattr;
615 	const struct nfs_server *	server;
616 	struct nfs4_sequence_res	seq_res;
617 };
618 
619 struct nfs_linkargs {
620 	struct nfs_fh *		fromfh;
621 	struct nfs_fh *		tofh;
622 	const char *		toname;
623 	unsigned int		tolen;
624 };
625 
626 struct nfs_symlinkargs {
627 	struct nfs_fh *		fromfh;
628 	const char *		fromname;
629 	unsigned int		fromlen;
630 	struct page **		pages;
631 	unsigned int		pathlen;
632 	struct iattr *		sattr;
633 };
634 
635 struct nfs_readdirargs {
636 	struct nfs_fh *		fh;
637 	__u32			cookie;
638 	unsigned int		count;
639 	struct page **		pages;
640 };
641 
642 struct nfs3_getaclargs {
643 	struct nfs_fh *		fh;
644 	int			mask;
645 	struct page **		pages;
646 };
647 
648 struct nfs3_setaclargs {
649 	struct inode *		inode;
650 	int			mask;
651 	struct posix_acl *	acl_access;
652 	struct posix_acl *	acl_default;
653 	size_t			len;
654 	unsigned int		npages;
655 	struct page **		pages;
656 };
657 
658 struct nfs_diropok {
659 	struct nfs_fh *		fh;
660 	struct nfs_fattr *	fattr;
661 };
662 
663 struct nfs_readlinkargs {
664 	struct nfs_fh *		fh;
665 	unsigned int		pgbase;
666 	unsigned int		pglen;
667 	struct page **		pages;
668 };
669 
670 struct nfs3_sattrargs {
671 	struct nfs_fh *		fh;
672 	struct iattr *		sattr;
673 	unsigned int		guard;
674 	struct timespec		guardtime;
675 };
676 
677 struct nfs3_diropargs {
678 	struct nfs_fh *		fh;
679 	const char *		name;
680 	unsigned int		len;
681 };
682 
683 struct nfs3_accessargs {
684 	struct nfs_fh *		fh;
685 	__u32			access;
686 };
687 
688 struct nfs3_createargs {
689 	struct nfs_fh *		fh;
690 	const char *		name;
691 	unsigned int		len;
692 	struct iattr *		sattr;
693 	enum nfs3_createmode	createmode;
694 	__be32			verifier[2];
695 };
696 
697 struct nfs3_mkdirargs {
698 	struct nfs_fh *		fh;
699 	const char *		name;
700 	unsigned int		len;
701 	struct iattr *		sattr;
702 };
703 
704 struct nfs3_symlinkargs {
705 	struct nfs_fh *		fromfh;
706 	const char *		fromname;
707 	unsigned int		fromlen;
708 	struct page **		pages;
709 	unsigned int		pathlen;
710 	struct iattr *		sattr;
711 };
712 
713 struct nfs3_mknodargs {
714 	struct nfs_fh *		fh;
715 	const char *		name;
716 	unsigned int		len;
717 	enum nfs3_ftype		type;
718 	struct iattr *		sattr;
719 	dev_t			rdev;
720 };
721 
722 struct nfs3_linkargs {
723 	struct nfs_fh *		fromfh;
724 	struct nfs_fh *		tofh;
725 	const char *		toname;
726 	unsigned int		tolen;
727 };
728 
729 struct nfs3_readdirargs {
730 	struct nfs_fh *		fh;
731 	__u64			cookie;
732 	__be32			verf[2];
733 	int			plus;
734 	unsigned int            count;
735 	struct page **		pages;
736 };
737 
738 struct nfs3_diropres {
739 	struct nfs_fattr *	dir_attr;
740 	struct nfs_fh *		fh;
741 	struct nfs_fattr *	fattr;
742 };
743 
744 struct nfs3_accessres {
745 	struct nfs_fattr *	fattr;
746 	__u32			access;
747 };
748 
749 struct nfs3_readlinkargs {
750 	struct nfs_fh *		fh;
751 	unsigned int		pgbase;
752 	unsigned int		pglen;
753 	struct page **		pages;
754 };
755 
756 struct nfs3_linkres {
757 	struct nfs_fattr *	dir_attr;
758 	struct nfs_fattr *	fattr;
759 };
760 
761 struct nfs3_readdirres {
762 	struct nfs_fattr *	dir_attr;
763 	__be32 *		verf;
764 	int			plus;
765 };
766 
767 struct nfs3_getaclres {
768 	struct nfs_fattr *	fattr;
769 	int			mask;
770 	unsigned int		acl_access_count;
771 	unsigned int		acl_default_count;
772 	struct posix_acl *	acl_access;
773 	struct posix_acl *	acl_default;
774 };
775 
776 struct nfs4_string {
777 	unsigned int len;
778 	char *data;
779 };
780 
781 #ifdef CONFIG_NFS_V4
782 
783 typedef u64 clientid4;
784 
785 struct nfs4_accessargs {
786 	const struct nfs_fh *		fh;
787 	const u32 *			bitmask;
788 	u32				access;
789 	struct nfs4_sequence_args	seq_args;
790 };
791 
792 struct nfs4_accessres {
793 	const struct nfs_server *	server;
794 	struct nfs_fattr *		fattr;
795 	u32				supported;
796 	u32				access;
797 	struct nfs4_sequence_res	seq_res;
798 };
799 
800 struct nfs4_create_arg {
801 	u32				ftype;
802 	union {
803 		struct {
804 			struct page **	pages;
805 			unsigned int	len;
806 		} symlink;   /* NF4LNK */
807 		struct {
808 			u32		specdata1;
809 			u32		specdata2;
810 		} device;    /* NF4BLK, NF4CHR */
811 	} u;
812 	const struct qstr *		name;
813 	const struct nfs_server *	server;
814 	const struct iattr *		attrs;
815 	const struct nfs_fh *		dir_fh;
816 	const u32 *			bitmask;
817 	struct nfs4_sequence_args 	seq_args;
818 };
819 
820 struct nfs4_create_res {
821 	const struct nfs_server *	server;
822 	struct nfs_fh *			fh;
823 	struct nfs_fattr *		fattr;
824 	struct nfs4_change_info		dir_cinfo;
825 	struct nfs_fattr *		dir_fattr;
826 	struct nfs4_sequence_res	seq_res;
827 };
828 
829 struct nfs4_fsinfo_arg {
830 	const struct nfs_fh *		fh;
831 	const u32 *			bitmask;
832 	struct nfs4_sequence_args	seq_args;
833 };
834 
835 struct nfs4_fsinfo_res {
836 	struct nfs_fsinfo	       *fsinfo;
837 	struct nfs4_sequence_res	seq_res;
838 };
839 
840 struct nfs4_getattr_arg {
841 	const struct nfs_fh *		fh;
842 	const u32 *			bitmask;
843 	struct nfs4_sequence_args	seq_args;
844 };
845 
846 struct nfs4_getattr_res {
847 	const struct nfs_server *	server;
848 	struct nfs_fattr *		fattr;
849 	struct nfs4_sequence_res	seq_res;
850 };
851 
852 struct nfs4_link_arg {
853 	const struct nfs_fh *		fh;
854 	const struct nfs_fh *		dir_fh;
855 	const struct qstr *		name;
856 	const u32 *			bitmask;
857 	struct nfs4_sequence_args 	seq_args;
858 };
859 
860 struct nfs4_link_res {
861 	const struct nfs_server *	server;
862 	struct nfs_fattr *		fattr;
863 	struct nfs4_change_info		cinfo;
864 	struct nfs_fattr *		dir_attr;
865 	struct nfs4_sequence_res	seq_res;
866 };
867 
868 
869 struct nfs4_lookup_arg {
870 	const struct nfs_fh *		dir_fh;
871 	const struct qstr *		name;
872 	const u32 *			bitmask;
873 	struct nfs4_sequence_args	seq_args;
874 };
875 
876 struct nfs4_lookup_res {
877 	const struct nfs_server *	server;
878 	struct nfs_fattr *		fattr;
879 	struct nfs_fh *			fh;
880 	struct nfs4_sequence_res	seq_res;
881 };
882 
883 struct nfs4_lookup_root_arg {
884 	const u32 *			bitmask;
885 	struct nfs4_sequence_args	seq_args;
886 };
887 
888 struct nfs4_pathconf_arg {
889 	const struct nfs_fh *		fh;
890 	const u32 *			bitmask;
891 	struct nfs4_sequence_args	seq_args;
892 };
893 
894 struct nfs4_pathconf_res {
895 	struct nfs_pathconf	       *pathconf;
896 	struct nfs4_sequence_res	seq_res;
897 };
898 
899 struct nfs4_readdir_arg {
900 	const struct nfs_fh *		fh;
901 	u64				cookie;
902 	nfs4_verifier			verifier;
903 	u32				count;
904 	struct page **			pages;	/* zero-copy data */
905 	unsigned int			pgbase;	/* zero-copy data */
906 	const u32 *			bitmask;
907 	int				plus;
908 	struct nfs4_sequence_args	seq_args;
909 };
910 
911 struct nfs4_readdir_res {
912 	nfs4_verifier			verifier;
913 	unsigned int			pgbase;
914 	struct nfs4_sequence_res	seq_res;
915 };
916 
917 struct nfs4_readlink {
918 	const struct nfs_fh *		fh;
919 	unsigned int			pgbase;
920 	unsigned int			pglen;   /* zero-copy data */
921 	struct page **			pages;   /* zero-copy data */
922 	struct nfs4_sequence_args	seq_args;
923 };
924 
925 struct nfs4_readlink_res {
926 	struct nfs4_sequence_res	seq_res;
927 };
928 
929 #define NFS4_SETCLIENTID_NAMELEN	(127)
930 struct nfs4_setclientid {
931 	const nfs4_verifier *		sc_verifier;
932 	unsigned int			sc_name_len;
933 	char				sc_name[NFS4_SETCLIENTID_NAMELEN + 1];
934 	u32				sc_prog;
935 	unsigned int			sc_netid_len;
936 	char				sc_netid[RPCBIND_MAXNETIDLEN + 1];
937 	unsigned int			sc_uaddr_len;
938 	char				sc_uaddr[RPCBIND_MAXUADDRLEN + 1];
939 	u32				sc_cb_ident;
940 };
941 
942 struct nfs4_setclientid_res {
943 	u64				clientid;
944 	nfs4_verifier			confirm;
945 };
946 
947 struct nfs4_statfs_arg {
948 	const struct nfs_fh *		fh;
949 	const u32 *			bitmask;
950 	struct nfs4_sequence_args	seq_args;
951 };
952 
953 struct nfs4_statfs_res {
954 	struct nfs_fsstat	       *fsstat;
955 	struct nfs4_sequence_res	seq_res;
956 };
957 
958 struct nfs4_server_caps_arg {
959 	struct nfs_fh		       *fhandle;
960 	struct nfs4_sequence_args	seq_args;
961 };
962 
963 struct nfs4_server_caps_res {
964 	u32				attr_bitmask[3];
965 	u32				acl_bitmask;
966 	u32				has_links;
967 	u32				has_symlinks;
968 	struct nfs4_sequence_res	seq_res;
969 };
970 
971 #define NFS4_PATHNAME_MAXCOMPONENTS 512
972 struct nfs4_pathname {
973 	unsigned int ncomponents;
974 	struct nfs4_string components[NFS4_PATHNAME_MAXCOMPONENTS];
975 };
976 
977 #define NFS4_FS_LOCATION_MAXSERVERS 10
978 struct nfs4_fs_location {
979 	unsigned int nservers;
980 	struct nfs4_string servers[NFS4_FS_LOCATION_MAXSERVERS];
981 	struct nfs4_pathname rootpath;
982 };
983 
984 #define NFS4_FS_LOCATIONS_MAXENTRIES 10
985 struct nfs4_fs_locations {
986 	struct nfs_fattr fattr;
987 	const struct nfs_server *server;
988 	struct nfs4_pathname fs_path;
989 	int nlocations;
990 	struct nfs4_fs_location locations[NFS4_FS_LOCATIONS_MAXENTRIES];
991 };
992 
993 struct nfs4_fs_locations_arg {
994 	const struct nfs_fh *dir_fh;
995 	const struct qstr *name;
996 	struct page *page;
997 	const u32 *bitmask;
998 	struct nfs4_sequence_args	seq_args;
999 };
1000 
1001 struct nfs4_fs_locations_res {
1002 	struct nfs4_fs_locations       *fs_locations;
1003 	struct nfs4_sequence_res	seq_res;
1004 };
1005 
1006 struct nfs4_secinfo_oid {
1007 	unsigned int len;
1008 	char data[GSS_OID_MAX_LEN];
1009 };
1010 
1011 struct nfs4_secinfo_gss {
1012 	struct nfs4_secinfo_oid sec_oid4;
1013 	unsigned int qop4;
1014 	unsigned int service;
1015 };
1016 
1017 struct nfs4_secinfo_flavor {
1018 	unsigned int 		flavor;
1019 	struct nfs4_secinfo_gss	gss;
1020 };
1021 
1022 struct nfs4_secinfo_flavors {
1023 	unsigned int num_flavors;
1024 	struct nfs4_secinfo_flavor flavors[0];
1025 };
1026 
1027 struct nfs4_secinfo_arg {
1028 	const struct nfs_fh		*dir_fh;
1029 	const struct qstr		*name;
1030 	struct nfs4_sequence_args	seq_args;
1031 };
1032 
1033 struct nfs4_secinfo_res {
1034 	struct nfs4_secinfo_flavors	*flavors;
1035 	struct nfs4_sequence_res	seq_res;
1036 };
1037 
1038 #endif /* CONFIG_NFS_V4 */
1039 
1040 struct nfstime4 {
1041 	u64	seconds;
1042 	u32	nseconds;
1043 };
1044 
1045 #ifdef CONFIG_NFS_V4_1
1046 struct nfs_impl_id4 {
1047 	u32		domain_len;
1048 	char		*domain;
1049 	u32		name_len;
1050 	char		*name;
1051 	struct nfstime4	date;
1052 };
1053 
1054 #define NFS4_EXCHANGE_ID_LEN	(48)
1055 struct nfs41_exchange_id_args {
1056 	struct nfs_client		*client;
1057 	nfs4_verifier			*verifier;
1058 	unsigned int 			id_len;
1059 	char 				id[NFS4_EXCHANGE_ID_LEN];
1060 	u32				flags;
1061 };
1062 
1063 struct server_owner {
1064 	uint64_t			minor_id;
1065 	uint32_t			major_id_sz;
1066 	char				major_id[NFS4_OPAQUE_LIMIT];
1067 };
1068 
1069 struct server_scope {
1070 	uint32_t			server_scope_sz;
1071 	char 				server_scope[NFS4_OPAQUE_LIMIT];
1072 };
1073 
1074 struct nfs41_exchange_id_res {
1075 	struct nfs_client		*client;
1076 	u32				flags;
1077 	struct server_scope		*server_scope;
1078 };
1079 
1080 struct nfs41_create_session_args {
1081 	struct nfs_client	       *client;
1082 	uint32_t			flags;
1083 	uint32_t			cb_program;
1084 	struct nfs4_channel_attrs	fc_attrs;	/* Fore Channel */
1085 	struct nfs4_channel_attrs	bc_attrs;	/* Back Channel */
1086 };
1087 
1088 struct nfs41_create_session_res {
1089 	struct nfs_client	       *client;
1090 };
1091 
1092 struct nfs41_reclaim_complete_args {
1093 	/* In the future extend to include curr_fh for use with migration */
1094 	unsigned char			one_fs:1;
1095 	struct nfs4_sequence_args	seq_args;
1096 };
1097 
1098 struct nfs41_reclaim_complete_res {
1099 	struct nfs4_sequence_res	seq_res;
1100 };
1101 
1102 #define SECINFO_STYLE_CURRENT_FH 0
1103 #define SECINFO_STYLE_PARENT 1
1104 struct nfs41_secinfo_no_name_args {
1105 	int				style;
1106 	struct nfs4_sequence_args	seq_args;
1107 };
1108 
1109 struct nfs41_test_stateid_args {
1110 	nfs4_stateid			*stateid;
1111 	struct nfs4_sequence_args	seq_args;
1112 };
1113 
1114 struct nfs41_test_stateid_res {
1115 	unsigned int			status;
1116 	struct nfs4_sequence_res	seq_res;
1117 };
1118 
1119 struct nfs41_free_stateid_args {
1120 	nfs4_stateid			*stateid;
1121 	struct nfs4_sequence_args	seq_args;
1122 };
1123 
1124 struct nfs41_free_stateid_res {
1125 	unsigned int			status;
1126 	struct nfs4_sequence_res	seq_res;
1127 };
1128 
1129 #endif /* CONFIG_NFS_V4_1 */
1130 
1131 struct nfs_page;
1132 
1133 #define NFS_PAGEVEC_SIZE	(8U)
1134 
1135 struct nfs_read_data {
1136 	struct rpc_task		task;
1137 	struct inode		*inode;
1138 	struct rpc_cred		*cred;
1139 	struct nfs_fattr	fattr;	/* fattr storage */
1140 	struct list_head	pages;	/* Coalesced read requests */
1141 	struct list_head	list;	/* lists of struct nfs_read_data */
1142 	struct nfs_page		*req;	/* multi ops per nfs_page */
1143 	struct page		**pagevec;
1144 	unsigned int		npages;	/* Max length of pagevec */
1145 	struct nfs_readargs args;
1146 	struct nfs_readres  res;
1147 	unsigned long		timestamp;	/* For lease renewal */
1148 	struct pnfs_layout_segment *lseg;
1149 	struct nfs_client	*ds_clp;	/* pNFS data server */
1150 	const struct rpc_call_ops *mds_ops;
1151 	int (*read_done_cb) (struct rpc_task *task, struct nfs_read_data *data);
1152 	__u64			mds_offset;
1153 	int			pnfs_error;
1154 	struct page		*page_array[NFS_PAGEVEC_SIZE];
1155 };
1156 
1157 struct nfs_write_data {
1158 	struct rpc_task		task;
1159 	struct inode		*inode;
1160 	struct rpc_cred		*cred;
1161 	struct nfs_fattr	fattr;
1162 	struct nfs_writeverf	verf;
1163 	struct list_head	pages;		/* Coalesced requests we wish to flush */
1164 	struct list_head	list;		/* lists of struct nfs_write_data */
1165 	struct nfs_page		*req;		/* multi ops per nfs_page */
1166 	struct page		**pagevec;
1167 	unsigned int		npages;		/* Max length of pagevec */
1168 	struct nfs_writeargs	args;		/* argument struct */
1169 	struct nfs_writeres	res;		/* result struct */
1170 	struct pnfs_layout_segment *lseg;
1171 	struct nfs_client	*ds_clp;	/* pNFS data server */
1172 	int			ds_commit_index;
1173 	const struct rpc_call_ops *mds_ops;
1174 	int (*write_done_cb) (struct rpc_task *task, struct nfs_write_data *data);
1175 #ifdef CONFIG_NFS_V4
1176 	unsigned long		timestamp;	/* For lease renewal */
1177 #endif
1178 	__u64			mds_offset;	/* Filelayout dense stripe */
1179 	int			pnfs_error;
1180 	struct page		*page_array[NFS_PAGEVEC_SIZE];
1181 };
1182 
1183 struct nfs_access_entry;
1184 struct nfs_client;
1185 struct rpc_timeout;
1186 
1187 /*
1188  * RPC procedure vector for NFSv2/NFSv3 demuxing
1189  */
1190 struct nfs_rpc_ops {
1191 	u32	version;		/* Protocol version */
1192 	const struct dentry_operations *dentry_ops;
1193 	const struct inode_operations *dir_inode_ops;
1194 	const struct inode_operations *file_inode_ops;
1195 
1196 	int	(*getroot) (struct nfs_server *, struct nfs_fh *,
1197 			    struct nfs_fsinfo *);
1198 	int	(*getattr) (struct nfs_server *, struct nfs_fh *,
1199 			    struct nfs_fattr *);
1200 	int	(*setattr) (struct dentry *, struct nfs_fattr *,
1201 			    struct iattr *);
1202 	int	(*lookup)  (struct rpc_clnt *clnt, struct inode *, struct qstr *,
1203 			    struct nfs_fh *, struct nfs_fattr *);
1204 	int	(*access)  (struct inode *, struct nfs_access_entry *);
1205 	int	(*readlink)(struct inode *, struct page *, unsigned int,
1206 			    unsigned int);
1207 	int	(*create)  (struct inode *, struct dentry *,
1208 			    struct iattr *, int, struct nfs_open_context *);
1209 	int	(*remove)  (struct inode *, struct qstr *);
1210 	void	(*unlink_setup)  (struct rpc_message *, struct inode *dir);
1211 	int	(*unlink_done) (struct rpc_task *, struct inode *);
1212 	int	(*rename)  (struct inode *, struct qstr *,
1213 			    struct inode *, struct qstr *);
1214 	void	(*rename_setup)  (struct rpc_message *msg, struct inode *dir);
1215 	int	(*rename_done) (struct rpc_task *task, struct inode *old_dir, struct inode *new_dir);
1216 	int	(*link)    (struct inode *, struct inode *, struct qstr *);
1217 	int	(*symlink) (struct inode *, struct dentry *, struct page *,
1218 			    unsigned int, struct iattr *);
1219 	int	(*mkdir)   (struct inode *, struct dentry *, struct iattr *);
1220 	int	(*rmdir)   (struct inode *, struct qstr *);
1221 	int	(*readdir) (struct dentry *, struct rpc_cred *,
1222 			    u64, struct page **, unsigned int, int);
1223 	int	(*mknod)   (struct inode *, struct dentry *, struct iattr *,
1224 			    dev_t);
1225 	int	(*statfs)  (struct nfs_server *, struct nfs_fh *,
1226 			    struct nfs_fsstat *);
1227 	int	(*fsinfo)  (struct nfs_server *, struct nfs_fh *,
1228 			    struct nfs_fsinfo *);
1229 	int	(*pathconf) (struct nfs_server *, struct nfs_fh *,
1230 			     struct nfs_pathconf *);
1231 	int	(*set_capabilities)(struct nfs_server *, struct nfs_fh *);
1232 	int	(*decode_dirent)(struct xdr_stream *, struct nfs_entry *, int);
1233 	void	(*read_setup)   (struct nfs_read_data *, struct rpc_message *);
1234 	int	(*read_done)  (struct rpc_task *, struct nfs_read_data *);
1235 	void	(*write_setup)  (struct nfs_write_data *, struct rpc_message *);
1236 	int	(*write_done)  (struct rpc_task *, struct nfs_write_data *);
1237 	void	(*commit_setup) (struct nfs_write_data *, struct rpc_message *);
1238 	int	(*commit_done) (struct rpc_task *, struct nfs_write_data *);
1239 	int	(*lock)(struct file *, int, struct file_lock *);
1240 	int	(*lock_check_bounds)(const struct file_lock *);
1241 	void	(*clear_acl_cache)(struct inode *);
1242 	void	(*close_context)(struct nfs_open_context *ctx, int);
1243 	struct inode * (*open_context) (struct inode *dir,
1244 				struct nfs_open_context *ctx,
1245 				int open_flags,
1246 				struct iattr *iattr);
1247 	int	(*init_client) (struct nfs_client *, const struct rpc_timeout *,
1248 				const char *, rpc_authflavor_t, int);
1249 	int	(*secinfo)(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
1250 };
1251 
1252 /*
1253  * 	NFS_CALL(getattr, inode, (fattr));
1254  * into
1255  *	NFS_PROTO(inode)->getattr(fattr);
1256  */
1257 #define NFS_CALL(op, inode, args)	NFS_PROTO(inode)->op args
1258 
1259 /*
1260  * Function vectors etc. for the NFS client
1261  */
1262 extern const struct nfs_rpc_ops	nfs_v2_clientops;
1263 extern const struct nfs_rpc_ops	nfs_v3_clientops;
1264 extern const struct nfs_rpc_ops	nfs_v4_clientops;
1265 extern struct rpc_version	nfs_version2;
1266 extern struct rpc_version	nfs_version3;
1267 extern struct rpc_version	nfs_version4;
1268 
1269 extern struct rpc_version	nfsacl_version3;
1270 extern struct rpc_program	nfsacl_program;
1271 
1272 #endif
1273