xref: /openbmc/linux/fs/nfsd/xdr4.h (revision 3a237b4a) 
1 /*
2  *  Server-side types for NFSv4.
3  *
4  *  Copyright (c) 2002 The Regents of the University of Michigan.
5  *  All rights reserved.
6  *
7  *  Kendrick Smith <kmsmith@umich.edu>
8  *  Andy Adamson   <andros@umich.edu>
9  *
10  *  Redistribution and use in source and binary forms, with or without
11  *  modification, are permitted provided that the following conditions
12  *  are met:
13  *
14  *  1. Redistributions of source code must retain the above copyright
15  *     notice, this list of conditions and the following disclaimer.
16  *  2. Redistributions in binary form must reproduce the above copyright
17  *     notice, this list of conditions and the following disclaimer in the
18  *     documentation and/or other materials provided with the distribution.
19  *  3. Neither the name of the University nor the names of its
20  *     contributors may be used to endorse or promote products derived
21  *     from this software without specific prior written permission.
22  *
23  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
24  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  */
36 
37 #ifndef _LINUX_NFSD_XDR4_H
38 #define _LINUX_NFSD_XDR4_H
39 
40 #include "state.h"
41 #include "nfsd.h"
42 
43 #define NFSD4_MAX_TAGLEN	128
44 #define XDR_LEN(n)                     (((n) + 3) & ~3)
45 
46 #define CURRENT_STATE_ID_FLAG (1<<0)
47 #define SAVED_STATE_ID_FLAG (1<<1)
48 
49 #define SET_CSTATE_FLAG(c, f) ((c)->sid_flags |= (f))
50 #define HAS_CSTATE_FLAG(c, f) ((c)->sid_flags & (f))
51 #define CLEAR_CSTATE_FLAG(c, f) ((c)->sid_flags &= ~(f))
52 
53 struct nfsd4_compound_state {
54 	struct svc_fh		current_fh;
55 	struct svc_fh		save_fh;
56 	struct nfs4_stateowner	*replay_owner;
57 	struct nfs4_client	*clp;
58 	/* For sessions DRC */
59 	struct nfsd4_session	*session;
60 	struct nfsd4_slot	*slot;
61 	int			data_offset;
62 	bool                    spo_must_allowed;
63 	size_t			iovlen;
64 	u32			minorversion;
65 	__be32			status;
66 	stateid_t	current_stateid;
67 	stateid_t	save_stateid;
68 	/* to indicate current and saved state id presents */
69 	u32		sid_flags;
70 };
71 
72 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
73 {
74 	return cs->slot != NULL;
75 }
76 
77 struct nfsd4_change_info {
78 	u32		atomic;
79 	bool		change_supported;
80 	u32		before_ctime_sec;
81 	u32		before_ctime_nsec;
82 	u64		before_change;
83 	u32		after_ctime_sec;
84 	u32		after_ctime_nsec;
85 	u64		after_change;
86 };
87 
88 struct nfsd4_access {
89 	u32		ac_req_access;      /* request */
90 	u32		ac_supported;       /* response */
91 	u32		ac_resp_access;     /* response */
92 };
93 
94 struct nfsd4_close {
95 	u32		cl_seqid;           /* request */
96 	stateid_t	cl_stateid;         /* request+response */
97 };
98 
99 struct nfsd4_commit {
100 	u64		co_offset;          /* request */
101 	u32		co_count;           /* request */
102 	nfs4_verifier	co_verf;            /* response */
103 };
104 
105 struct nfsd4_create {
106 	u32		cr_namelen;         /* request */
107 	char *		cr_name;            /* request */
108 	u32		cr_type;            /* request */
109 	union {                             /* request */
110 		struct {
111 			u32 datalen;
112 			char *data;
113 			struct kvec first;
114 		} link;   /* NF4LNK */
115 		struct {
116 			u32 specdata1;
117 			u32 specdata2;
118 		} dev;    /* NF4BLK, NF4CHR */
119 	} u;
120 	u32		cr_bmval[3];        /* request */
121 	struct iattr	cr_iattr;           /* request */
122 	int		cr_umask;           /* request */
123 	struct nfsd4_change_info  cr_cinfo; /* response */
124 	struct nfs4_acl *cr_acl;
125 	struct xdr_netobj cr_label;
126 };
127 #define cr_datalen	u.link.datalen
128 #define cr_data		u.link.data
129 #define cr_first	u.link.first
130 #define cr_specdata1	u.dev.specdata1
131 #define cr_specdata2	u.dev.specdata2
132 
133 struct nfsd4_delegreturn {
134 	stateid_t	dr_stateid;
135 };
136 
137 struct nfsd4_getattr {
138 	u32		ga_bmval[3];        /* request */
139 	struct svc_fh	*ga_fhp;            /* response */
140 };
141 
142 struct nfsd4_link {
143 	u32		li_namelen;         /* request */
144 	char *		li_name;            /* request */
145 	struct nfsd4_change_info  li_cinfo; /* response */
146 };
147 
148 struct nfsd4_lock_denied {
149 	clientid_t	ld_clientid;
150 	struct xdr_netobj	ld_owner;
151 	u64             ld_start;
152 	u64             ld_length;
153 	u32             ld_type;
154 };
155 
156 struct nfsd4_lock {
157 	/* request */
158 	u32             lk_type;
159 	u32             lk_reclaim;         /* boolean */
160 	u64             lk_offset;
161 	u64             lk_length;
162 	u32             lk_is_new;
163 	union {
164 		struct {
165 			u32             open_seqid;
166 			stateid_t       open_stateid;
167 			u32             lock_seqid;
168 			clientid_t      clientid;
169 			struct xdr_netobj owner;
170 		} new;
171 		struct {
172 			stateid_t       lock_stateid;
173 			u32             lock_seqid;
174 		} old;
175 	} v;
176 
177 	/* response */
178 	union {
179 		struct {
180 			stateid_t               stateid;
181 		} ok;
182 		struct nfsd4_lock_denied        denied;
183 	} u;
184 };
185 #define lk_new_open_seqid       v.new.open_seqid
186 #define lk_new_open_stateid     v.new.open_stateid
187 #define lk_new_lock_seqid       v.new.lock_seqid
188 #define lk_new_clientid         v.new.clientid
189 #define lk_new_owner            v.new.owner
190 #define lk_old_lock_stateid     v.old.lock_stateid
191 #define lk_old_lock_seqid       v.old.lock_seqid
192 
193 #define lk_resp_stateid u.ok.stateid
194 #define lk_denied       u.denied
195 
196 
197 struct nfsd4_lockt {
198 	u32				lt_type;
199 	clientid_t			lt_clientid;
200 	struct xdr_netobj		lt_owner;
201 	u64				lt_offset;
202 	u64				lt_length;
203 	struct nfsd4_lock_denied  	lt_denied;
204 };
205 
206 
207 struct nfsd4_locku {
208 	u32             lu_type;
209 	u32             lu_seqid;
210 	stateid_t       lu_stateid;
211 	u64             lu_offset;
212 	u64             lu_length;
213 };
214 
215 
216 struct nfsd4_lookup {
217 	u32		lo_len;             /* request */
218 	char *		lo_name;            /* request */
219 };
220 
221 struct nfsd4_putfh {
222 	u32		pf_fhlen;           /* request */
223 	char		*pf_fhval;          /* request */
224 	bool		no_verify;	    /* represents foreigh fh */
225 };
226 
227 struct nfsd4_getxattr {
228 	char		*getxa_name;		/* request */
229 	u32		getxa_len;		/* request */
230 	void		*getxa_buf;
231 };
232 
233 struct nfsd4_setxattr {
234 	u32		setxa_flags;		/* request */
235 	char		*setxa_name;		/* request */
236 	char		*setxa_buf;		/* request */
237 	u32		setxa_len;		/* request */
238 	struct nfsd4_change_info  setxa_cinfo;	/* response */
239 };
240 
241 struct nfsd4_removexattr {
242 	char		*rmxa_name;		/* request */
243 	struct nfsd4_change_info  rmxa_cinfo;	/* response */
244 };
245 
246 struct nfsd4_listxattrs {
247 	u64		lsxa_cookie;		/* request */
248 	u32		lsxa_maxcount;		/* request */
249 	char		*lsxa_buf;		/* unfiltered buffer (reply) */
250 	u32		lsxa_len;		/* unfiltered len (reply) */
251 };
252 
253 struct nfsd4_open {
254 	u32		op_claim_type;      /* request */
255 	u32		op_fnamelen;
256 	char *		op_fname;	    /* request - everything but CLAIM_PREV */
257 	u32		op_delegate_type;   /* request - CLAIM_PREV only */
258 	stateid_t       op_delegate_stateid; /* request - response */
259 	u32		op_why_no_deleg;    /* response - DELEG_NONE_EXT only */
260 	u32		op_create;     	    /* request */
261 	u32		op_createmode;      /* request */
262 	int		op_umask;           /* request */
263 	u32		op_bmval[3];        /* request */
264 	struct iattr	op_iattr;           /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
265 	nfs4_verifier	op_verf __attribute__((aligned(32)));
266 					    /* EXCLUSIVE4 */
267 	clientid_t	op_clientid;        /* request */
268 	struct xdr_netobj op_owner;           /* request */
269 	u32		op_seqid;           /* request */
270 	u32		op_share_access;    /* request */
271 	u32		op_share_deny;      /* request */
272 	u32		op_deleg_want;      /* request */
273 	stateid_t	op_stateid;         /* response */
274 	__be32		op_xdr_error;       /* see nfsd4_open_omfg() */
275 	u32		op_recall;          /* recall */
276 	struct nfsd4_change_info  op_cinfo; /* response */
277 	u32		op_rflags;          /* response */
278 	bool		op_truncate;        /* used during processing */
279 	bool		op_created;         /* used during processing */
280 	struct nfs4_openowner *op_openowner; /* used during processing */
281 	struct nfs4_file *op_file;          /* used during processing */
282 	struct nfs4_ol_stateid *op_stp;	    /* used during processing */
283 	struct nfs4_clnt_odstate *op_odstate; /* used during processing */
284 	struct nfs4_acl *op_acl;
285 	struct xdr_netobj op_label;
286 };
287 
288 struct nfsd4_open_confirm {
289 	stateid_t	oc_req_stateid		/* request */;
290 	u32		oc_seqid    		/* request */;
291 	stateid_t	oc_resp_stateid		/* response */;
292 };
293 
294 struct nfsd4_open_downgrade {
295 	stateid_t       od_stateid;
296 	u32             od_seqid;
297 	u32             od_share_access;	/* request */
298 	u32		od_deleg_want;		/* request */
299 	u32             od_share_deny;		/* request */
300 };
301 
302 
303 struct nfsd4_read {
304 	stateid_t		rd_stateid;         /* request */
305 	u64			rd_offset;          /* request */
306 	u32			rd_length;          /* request */
307 	int			rd_vlen;
308 	struct nfsd_file	*rd_nf;
309 
310 	struct svc_rqst		*rd_rqstp;          /* response */
311 	struct svc_fh		*rd_fhp;             /* response */
312 };
313 
314 struct nfsd4_readdir {
315 	u64		rd_cookie;          /* request */
316 	nfs4_verifier	rd_verf;            /* request */
317 	u32		rd_dircount;        /* request */
318 	u32		rd_maxcount;        /* request */
319 	u32		rd_bmval[3];        /* request */
320 	struct svc_rqst *rd_rqstp;          /* response */
321 	struct svc_fh * rd_fhp;             /* response */
322 
323 	struct readdir_cd	common;
324 	struct xdr_stream	*xdr;
325 	int			cookie_offset;
326 };
327 
328 struct nfsd4_release_lockowner {
329 	clientid_t        rl_clientid;
330 	struct xdr_netobj rl_owner;
331 };
332 struct nfsd4_readlink {
333 	struct svc_rqst *rl_rqstp;          /* request */
334 	struct svc_fh *	rl_fhp;             /* request */
335 };
336 
337 struct nfsd4_remove {
338 	u32		rm_namelen;         /* request */
339 	char *		rm_name;            /* request */
340 	struct nfsd4_change_info  rm_cinfo; /* response */
341 };
342 
343 struct nfsd4_rename {
344 	u32		rn_snamelen;        /* request */
345 	char *		rn_sname;           /* request */
346 	u32		rn_tnamelen;        /* request */
347 	char *		rn_tname;           /* request */
348 	struct nfsd4_change_info  rn_sinfo; /* response */
349 	struct nfsd4_change_info  rn_tinfo; /* response */
350 };
351 
352 struct nfsd4_secinfo {
353 	u32 si_namelen;					/* request */
354 	char *si_name;					/* request */
355 	struct svc_export *si_exp;			/* response */
356 };
357 
358 struct nfsd4_secinfo_no_name {
359 	u32 sin_style;					/* request */
360 	struct svc_export *sin_exp;			/* response */
361 };
362 
363 struct nfsd4_setattr {
364 	stateid_t	sa_stateid;         /* request */
365 	u32		sa_bmval[3];        /* request */
366 	struct iattr	sa_iattr;           /* request */
367 	struct nfs4_acl *sa_acl;
368 	struct xdr_netobj sa_label;
369 };
370 
371 struct nfsd4_setclientid {
372 	nfs4_verifier	se_verf;            /* request */
373 	struct xdr_netobj se_name;
374 	u32		se_callback_prog;   /* request */
375 	u32		se_callback_netid_len;  /* request */
376 	char *		se_callback_netid_val;  /* request */
377 	u32		se_callback_addr_len;   /* request */
378 	char *		se_callback_addr_val;   /* request */
379 	u32		se_callback_ident;  /* request */
380 	clientid_t	se_clientid;        /* response */
381 	nfs4_verifier	se_confirm;         /* response */
382 };
383 
384 struct nfsd4_setclientid_confirm {
385 	clientid_t	sc_clientid;
386 	nfs4_verifier	sc_confirm;
387 };
388 
389 struct nfsd4_saved_compoundargs {
390 	__be32 *p;
391 	__be32 *end;
392 	int pagelen;
393 	struct page **pagelist;
394 };
395 
396 struct nfsd4_test_stateid_id {
397 	__be32			ts_id_status;
398 	stateid_t		ts_id_stateid;
399 	struct list_head	ts_id_list;
400 };
401 
402 struct nfsd4_test_stateid {
403 	u32		ts_num_ids;
404 	struct list_head ts_stateid_list;
405 };
406 
407 struct nfsd4_free_stateid {
408 	stateid_t	fr_stateid;         /* request */
409 };
410 
411 /* also used for NVERIFY */
412 struct nfsd4_verify {
413 	u32		ve_bmval[3];        /* request */
414 	u32		ve_attrlen;         /* request */
415 	char *		ve_attrval;         /* request */
416 };
417 
418 struct nfsd4_write {
419 	stateid_t	wr_stateid;         /* request */
420 	u64		wr_offset;          /* request */
421 	u32		wr_stable_how;      /* request */
422 	u32		wr_buflen;          /* request */
423 	struct xdr_buf	wr_payload;         /* request */
424 
425 	u32		wr_bytes_written;   /* response */
426 	u32		wr_how_written;     /* response */
427 	nfs4_verifier	wr_verifier;        /* response */
428 };
429 
430 struct nfsd4_exchange_id {
431 	nfs4_verifier	verifier;
432 	struct xdr_netobj clname;
433 	u32		flags;
434 	clientid_t	clientid;
435 	u32		seqid;
436 	u32		spa_how;
437 	u32             spo_must_enforce[3];
438 	u32             spo_must_allow[3];
439 	struct xdr_netobj nii_domain;
440 	struct xdr_netobj nii_name;
441 	struct timespec64 nii_time;
442 };
443 
444 struct nfsd4_sequence {
445 	struct nfs4_sessionid	sessionid;		/* request/response */
446 	u32			seqid;			/* request/response */
447 	u32			slotid;			/* request/response */
448 	u32			maxslots;		/* request/response */
449 	u32			cachethis;		/* request */
450 #if 0
451 	u32			target_maxslots;	/* response */
452 #endif /* not yet */
453 	u32			status_flags;		/* response */
454 };
455 
456 struct nfsd4_destroy_session {
457 	struct nfs4_sessionid	sessionid;
458 };
459 
460 struct nfsd4_destroy_clientid {
461 	clientid_t clientid;
462 };
463 
464 struct nfsd4_reclaim_complete {
465 	u32 rca_one_fs;
466 };
467 
468 struct nfsd4_deviceid {
469 	u64			fsid_idx;
470 	u32			generation;
471 	u32			pad;
472 };
473 
474 struct nfsd4_layout_seg {
475 	u32			iomode;
476 	u64			offset;
477 	u64			length;
478 };
479 
480 struct nfsd4_getdeviceinfo {
481 	struct nfsd4_deviceid	gd_devid;	/* request */
482 	u32			gd_layout_type;	/* request */
483 	u32			gd_maxcount;	/* request */
484 	u32			gd_notify_types;/* request - response */
485 	void			*gd_device;	/* response */
486 };
487 
488 struct nfsd4_layoutget {
489 	u64			lg_minlength;	/* request */
490 	u32			lg_signal;	/* request */
491 	u32			lg_layout_type;	/* request */
492 	u32			lg_maxcount;	/* request */
493 	stateid_t		lg_sid;		/* request/response */
494 	struct nfsd4_layout_seg	lg_seg;		/* request/response */
495 	void			*lg_content;	/* response */
496 };
497 
498 struct nfsd4_layoutcommit {
499 	stateid_t		lc_sid;		/* request */
500 	struct nfsd4_layout_seg	lc_seg;		/* request */
501 	u32			lc_reclaim;	/* request */
502 	u32			lc_newoffset;	/* request */
503 	u64			lc_last_wr;	/* request */
504 	struct timespec64	lc_mtime;	/* request */
505 	u32			lc_layout_type;	/* request */
506 	u32			lc_up_len;	/* layout length */
507 	void			*lc_up_layout;	/* decoded by callback */
508 	u32			lc_size_chg;	/* boolean for response */
509 	u64			lc_newsize;	/* response */
510 };
511 
512 struct nfsd4_layoutreturn {
513 	u32			lr_return_type;	/* request */
514 	u32			lr_layout_type;	/* request */
515 	struct nfsd4_layout_seg	lr_seg;		/* request */
516 	u32			lr_reclaim;	/* request */
517 	u32			lrf_body_len;	/* request */
518 	void			*lrf_body;	/* request */
519 	stateid_t		lr_sid;		/* request/response */
520 	u32			lrs_present;	/* response */
521 };
522 
523 struct nfsd4_fallocate {
524 	/* request */
525 	stateid_t	falloc_stateid;
526 	loff_t		falloc_offset;
527 	u64		falloc_length;
528 };
529 
530 struct nfsd4_clone {
531 	/* request */
532 	stateid_t	cl_src_stateid;
533 	stateid_t	cl_dst_stateid;
534 	u64		cl_src_pos;
535 	u64		cl_dst_pos;
536 	u64		cl_count;
537 };
538 
539 struct nfsd42_write_res {
540 	u64			wr_bytes_written;
541 	u32			wr_stable_how;
542 	nfs4_verifier		wr_verifier;
543 	stateid_t		cb_stateid;
544 };
545 
546 struct nfsd4_copy {
547 	/* request */
548 	stateid_t		cp_src_stateid;
549 	stateid_t		cp_dst_stateid;
550 	u64			cp_src_pos;
551 	u64			cp_dst_pos;
552 	u64			cp_count;
553 	struct nl4_server	cp_src;
554 	bool			cp_intra;
555 
556 	/* both */
557 	u32			cp_synchronous;
558 
559 	/* response */
560 	struct nfsd42_write_res	cp_res;
561 
562 	/* for cb_offload */
563 	struct nfsd4_callback	cp_cb;
564 	__be32			nfserr;
565 	struct knfsd_fh		fh;
566 
567 	struct nfs4_client      *cp_clp;
568 
569 	struct nfsd_file        *nf_src;
570 	struct nfsd_file        *nf_dst;
571 
572 	copy_stateid_t		cp_stateid;
573 
574 	struct list_head	copies;
575 	struct task_struct	*copy_task;
576 	refcount_t		refcount;
577 	bool			stopped;
578 
579 	struct vfsmount		*ss_mnt;
580 	struct nfs_fh		c_fh;
581 	nfs4_stateid		stateid;
582 };
583 extern bool inter_copy_offload_enable;
584 
585 struct nfsd4_seek {
586 	/* request */
587 	stateid_t	seek_stateid;
588 	loff_t		seek_offset;
589 	u32		seek_whence;
590 
591 	/* response */
592 	u32		seek_eof;
593 	loff_t		seek_pos;
594 };
595 
596 struct nfsd4_offload_status {
597 	/* request */
598 	stateid_t	stateid;
599 
600 	/* response */
601 	u64		count;
602 	u32		status;
603 };
604 
605 struct nfsd4_copy_notify {
606 	/* request */
607 	stateid_t		cpn_src_stateid;
608 	struct nl4_server	cpn_dst;
609 
610 	/* response */
611 	stateid_t		cpn_cnr_stateid;
612 	u64			cpn_sec;
613 	u32			cpn_nsec;
614 	struct nl4_server	cpn_src;
615 };
616 
617 struct nfsd4_op {
618 	u32					opnum;
619 	const struct nfsd4_operation *		opdesc;
620 	__be32					status;
621 	union nfsd4_op_u {
622 		struct nfsd4_access		access;
623 		struct nfsd4_close		close;
624 		struct nfsd4_commit		commit;
625 		struct nfsd4_create		create;
626 		struct nfsd4_delegreturn	delegreturn;
627 		struct nfsd4_getattr		getattr;
628 		struct svc_fh *			getfh;
629 		struct nfsd4_link		link;
630 		struct nfsd4_lock		lock;
631 		struct nfsd4_lockt		lockt;
632 		struct nfsd4_locku		locku;
633 		struct nfsd4_lookup		lookup;
634 		struct nfsd4_verify		nverify;
635 		struct nfsd4_open		open;
636 		struct nfsd4_open_confirm	open_confirm;
637 		struct nfsd4_open_downgrade	open_downgrade;
638 		struct nfsd4_putfh		putfh;
639 		struct nfsd4_read		read;
640 		struct nfsd4_readdir		readdir;
641 		struct nfsd4_readlink		readlink;
642 		struct nfsd4_remove		remove;
643 		struct nfsd4_rename		rename;
644 		clientid_t			renew;
645 		struct nfsd4_secinfo		secinfo;
646 		struct nfsd4_setattr		setattr;
647 		struct nfsd4_setclientid	setclientid;
648 		struct nfsd4_setclientid_confirm setclientid_confirm;
649 		struct nfsd4_verify		verify;
650 		struct nfsd4_write		write;
651 		struct nfsd4_release_lockowner	release_lockowner;
652 
653 		/* NFSv4.1 */
654 		struct nfsd4_exchange_id	exchange_id;
655 		struct nfsd4_backchannel_ctl	backchannel_ctl;
656 		struct nfsd4_bind_conn_to_session bind_conn_to_session;
657 		struct nfsd4_create_session	create_session;
658 		struct nfsd4_destroy_session	destroy_session;
659 		struct nfsd4_destroy_clientid	destroy_clientid;
660 		struct nfsd4_sequence		sequence;
661 		struct nfsd4_reclaim_complete	reclaim_complete;
662 		struct nfsd4_test_stateid	test_stateid;
663 		struct nfsd4_free_stateid	free_stateid;
664 		struct nfsd4_getdeviceinfo	getdeviceinfo;
665 		struct nfsd4_layoutget		layoutget;
666 		struct nfsd4_layoutcommit	layoutcommit;
667 		struct nfsd4_layoutreturn	layoutreturn;
668 		struct nfsd4_secinfo_no_name	secinfo_no_name;
669 
670 		/* NFSv4.2 */
671 		struct nfsd4_fallocate		allocate;
672 		struct nfsd4_fallocate		deallocate;
673 		struct nfsd4_clone		clone;
674 		struct nfsd4_copy		copy;
675 		struct nfsd4_offload_status	offload_status;
676 		struct nfsd4_copy_notify	copy_notify;
677 		struct nfsd4_seek		seek;
678 
679 		struct nfsd4_getxattr		getxattr;
680 		struct nfsd4_setxattr		setxattr;
681 		struct nfsd4_listxattrs		listxattrs;
682 		struct nfsd4_removexattr	removexattr;
683 	} u;
684 	struct nfs4_replay *			replay;
685 };
686 
687 bool nfsd4_cache_this_op(struct nfsd4_op *);
688 
689 /*
690  * Memory needed just for the duration of processing one compound:
691  */
692 struct svcxdr_tmpbuf {
693 	struct svcxdr_tmpbuf *next;
694 	char buf[];
695 };
696 
697 struct nfsd4_compoundargs {
698 	/* scratch variables for XDR decode */
699 	__be32				tmp[8];
700 	__be32 *			tmpp;
701 	struct xdr_stream		*xdr;
702 	struct svcxdr_tmpbuf		*to_free;
703 	struct svc_rqst			*rqstp;
704 
705 	u32				taglen;
706 	char *				tag;
707 	u32				minorversion;
708 	u32				opcnt;
709 	struct nfsd4_op			*ops;
710 	struct nfsd4_op			iops[8];
711 	int				cachetype;
712 };
713 
714 struct nfsd4_compoundres {
715 	/* scratch variables for XDR encode */
716 	struct xdr_stream		xdr;
717 	struct svc_rqst *		rqstp;
718 
719 	u32				taglen;
720 	char *				tag;
721 	u32				opcnt;
722 	__be32 *			tagp; /* tag, opcount encode location */
723 	struct nfsd4_compound_state	cstate;
724 };
725 
726 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
727 {
728 	struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
729 	return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
730 }
731 
732 /*
733  * The session reply cache only needs to cache replies that the client
734  * actually asked us to.  But it's almost free for us to cache compounds
735  * consisting of only a SEQUENCE op, so we may as well cache those too.
736  * Also, the protocol doesn't give us a convenient response in the case
737  * of a replay of a solo SEQUENCE op that wasn't cached
738  * (RETRY_UNCACHED_REP can only be returned in the second op of a
739  * compound).
740  */
741 static inline bool nfsd4_cache_this(struct nfsd4_compoundres *resp)
742 {
743 	return (resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
744 		|| nfsd4_is_solo_sequence(resp);
745 }
746 
747 static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
748 {
749 	struct nfsd4_compoundres *resp = rqstp->rq_resp;
750 	struct nfsd4_compoundargs *argp = rqstp->rq_argp;
751 
752 	return argp->opcnt == resp->opcnt;
753 }
754 
755 const struct nfsd4_operation *OPDESC(struct nfsd4_op *op);
756 int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op);
757 void warn_on_nonidempotent_op(struct nfsd4_op *op);
758 
759 #define NFS4_SVC_XDRSIZE		sizeof(struct nfsd4_compoundargs)
760 
761 static inline void
762 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
763 {
764 	BUG_ON(!fhp->fh_pre_saved);
765 	cinfo->atomic = (u32)fhp->fh_post_saved;
766 	cinfo->change_supported = IS_I_VERSION(d_inode(fhp->fh_dentry));
767 
768 	cinfo->before_change = fhp->fh_pre_change;
769 	cinfo->after_change = fhp->fh_post_change;
770 	cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
771 	cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
772 	cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
773 	cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
774 
775 }
776 
777 
778 bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp);
779 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *);
780 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *);
781 __be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
782 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
783 void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op);
784 __be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words,
785 		struct svc_fh *fhp, struct svc_export *exp,
786 		struct dentry *dentry,
787 		u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
788 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
789 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
790 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
791 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
792 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
793 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
794 extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *,
795 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
796 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *,
797 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
798 extern __be32 nfsd4_create_session(struct svc_rqst *,
799 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
800 extern __be32 nfsd4_sequence(struct svc_rqst *,
801 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
802 extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp);
803 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
804 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
805 extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *,
806 		union nfsd4_op_u *u);
807 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *,
808 		union nfsd4_op_u *u);
809 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
810 		struct nfsd4_open *open, struct nfsd_net *nn);
811 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
812 		struct svc_fh *current_fh, struct nfsd4_open *open);
813 extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate);
814 extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate,
815 		struct nfsd4_open *open);
816 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
817 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
818 extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
819 		union nfsd4_op_u *u);
820 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
821 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
822 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
823 		union nfsd4_op_u *u);
824 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
825 		union nfsd4_op_u *u);
826 extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
827 		union nfsd4_op_u *u);
828 extern __be32
829 nfsd4_release_lockowner(struct svc_rqst *rqstp,
830 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
831 extern void nfsd4_release_compoundargs(struct svc_rqst *rqstp);
832 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
833 		struct nfsd4_compound_state *, union nfsd4_op_u *u);
834 extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
835 		union nfsd4_op_u *u);
836 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
837 		struct nfsd4_compound_state *, union nfsd4_op_u *);
838 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
839 		struct nfsd4_compound_state *, union nfsd4_op_u *);
840 extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
841 
842 enum nfsd4_op_flags {
843 	ALLOWED_WITHOUT_FH = 1 << 0,    /* No current filehandle required */
844 	ALLOWED_ON_ABSENT_FS = 1 << 1,  /* ops processed on absent fs */
845 	ALLOWED_AS_FIRST_OP = 1 << 2,   /* ops reqired first in compound */
846 	/* For rfc 5661 section 2.6.3.1.1: */
847 	OP_HANDLES_WRONGSEC = 1 << 3,
848 	OP_IS_PUTFH_LIKE = 1 << 4,
849 	/*
850 	 * These are the ops whose result size we estimate before
851 	 * encoding, to avoid performing an op then not being able to
852 	 * respond or cache a response.  This includes writes and setattrs
853 	 * as well as the operations usually called "nonidempotent":
854 	 */
855 	OP_MODIFIES_SOMETHING = 1 << 5,
856 	/*
857 	 * Cache compounds containing these ops in the xid-based drc:
858 	 * We use the DRC for compounds containing non-idempotent
859 	 * operations, *except* those that are 4.1-specific (since
860 	 * sessions provide their own EOS), and except for stateful
861 	 * operations other than setclientid and setclientid_confirm
862 	 * (since sequence numbers provide EOS for open, lock, etc in
863 	 * the v4.0 case).
864 	 */
865 	OP_CACHEME = 1 << 6,
866 	/*
867 	 * These are ops which clear current state id.
868 	 */
869 	OP_CLEAR_STATEID = 1 << 7,
870 	/* Most ops return only an error on failure; some may do more: */
871 	OP_NONTRIVIAL_ERROR_ENCODE = 1 << 8,
872 };
873 
874 struct nfsd4_operation {
875 	__be32 (*op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
876 			union nfsd4_op_u *);
877 	void (*op_release)(union nfsd4_op_u *);
878 	u32 op_flags;
879 	char *op_name;
880 	/* Try to get response size before operation */
881 	u32 (*op_rsize_bop)(struct svc_rqst *, struct nfsd4_op *);
882 	void (*op_get_currentstateid)(struct nfsd4_compound_state *,
883 			union nfsd4_op_u *);
884 	void (*op_set_currentstateid)(struct nfsd4_compound_state *,
885 			union nfsd4_op_u *);
886 };
887 
888 
889 #endif
890 
891 /*
892  * Local variables:
893  *  c-basic-offset: 8
894  * End:
895  */
896