xref: /kernel/linux/linux-5.10/fs/nfsd/xdr4.h (revision 8c2ecf20)
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
53struct 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
72static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
73{
74	return cs->slot != NULL;
75}
76
77struct 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
88struct nfsd4_access {
89	u32		ac_req_access;      /* request */
90	u32		ac_supported;       /* response */
91	u32		ac_resp_access;     /* response */
92};
93
94struct nfsd4_close {
95	u32		cl_seqid;           /* request */
96	stateid_t	cl_stateid;         /* request+response */
97};
98
99struct nfsd4_commit {
100	u64		co_offset;          /* request */
101	u32		co_count;           /* request */
102	nfs4_verifier	co_verf;            /* response */
103};
104
105struct 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
133struct nfsd4_delegreturn {
134	stateid_t	dr_stateid;
135};
136
137struct nfsd4_getattr {
138	u32		ga_bmval[3];        /* request */
139	struct svc_fh	*ga_fhp;            /* response */
140};
141
142struct nfsd4_link {
143	u32		li_namelen;         /* request */
144	char *		li_name;            /* request */
145	struct nfsd4_change_info  li_cinfo; /* response */
146};
147
148struct 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
156struct 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
197struct 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
207struct 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
216struct nfsd4_lookup {
217	u32		lo_len;             /* request */
218	char *		lo_name;            /* request */
219};
220
221struct nfsd4_putfh {
222	u32		pf_fhlen;           /* request */
223	char		*pf_fhval;          /* request */
224	bool		no_verify;	    /* represents foreigh fh */
225};
226
227struct nfsd4_getxattr {
228	char		*getxa_name;		/* request */
229	u32		getxa_len;		/* request */
230	void		*getxa_buf;
231};
232
233struct 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
241struct nfsd4_removexattr {
242	char		*rmxa_name;		/* request */
243	struct nfsd4_change_info  rmxa_cinfo;	/* response */
244};
245
246struct 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
253struct nfsd4_open {
254	u32		op_claim_type;      /* request */
255	struct xdr_netobj op_fname;	    /* request - everything but CLAIM_PREV */
256	u32		op_delegate_type;   /* request - CLAIM_PREV only */
257	stateid_t       op_delegate_stateid; /* request - response */
258	u32		op_why_no_deleg;    /* response - DELEG_NONE_EXT only */
259	u32		op_create;     	    /* request */
260	u32		op_createmode;      /* request */
261	int		op_umask;           /* request */
262	u32		op_bmval[3];        /* request */
263	struct iattr	op_iattr;           /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
264	nfs4_verifier	op_verf __attribute__((aligned(32)));
265					    /* EXCLUSIVE4 */
266	clientid_t	op_clientid;        /* request */
267	struct xdr_netobj op_owner;           /* request */
268	u32		op_seqid;           /* request */
269	u32		op_share_access;    /* request */
270	u32		op_share_deny;      /* request */
271	u32		op_deleg_want;      /* request */
272	stateid_t	op_stateid;         /* response */
273	__be32		op_xdr_error;       /* see nfsd4_open_omfg() */
274	u32		op_recall;          /* recall */
275	struct nfsd4_change_info  op_cinfo; /* response */
276	u32		op_rflags;          /* response */
277	bool		op_truncate;        /* used during processing */
278	bool		op_created;         /* used during processing */
279	struct nfs4_openowner *op_openowner; /* used during processing */
280	struct nfs4_file *op_file;          /* used during processing */
281	struct nfs4_ol_stateid *op_stp;	    /* used during processing */
282	struct nfs4_clnt_odstate *op_odstate; /* used during processing */
283	struct nfs4_acl *op_acl;
284	struct xdr_netobj op_label;
285};
286
287struct nfsd4_open_confirm {
288	stateid_t	oc_req_stateid		/* request */;
289	u32		oc_seqid    		/* request */;
290	stateid_t	oc_resp_stateid		/* response */;
291};
292
293struct nfsd4_open_downgrade {
294	stateid_t       od_stateid;
295	u32             od_seqid;
296	u32             od_share_access;	/* request */
297	u32		od_deleg_want;		/* request */
298	u32             od_share_deny;		/* request */
299};
300
301
302struct nfsd4_read {
303	stateid_t		rd_stateid;         /* request */
304	u64			rd_offset;          /* request */
305	u32			rd_length;          /* request */
306	int			rd_vlen;
307	struct nfsd_file	*rd_nf;
308
309	struct svc_rqst		*rd_rqstp;          /* response */
310	struct svc_fh		*rd_fhp;             /* response */
311};
312
313struct nfsd4_readdir {
314	u64		rd_cookie;          /* request */
315	nfs4_verifier	rd_verf;            /* request */
316	u32		rd_dircount;        /* request */
317	u32		rd_maxcount;        /* request */
318	u32		rd_bmval[3];        /* request */
319	struct svc_rqst *rd_rqstp;          /* response */
320	struct svc_fh * rd_fhp;             /* response */
321
322	struct readdir_cd	common;
323	struct xdr_stream	*xdr;
324	int			cookie_offset;
325};
326
327struct nfsd4_release_lockowner {
328	clientid_t        rl_clientid;
329	struct xdr_netobj rl_owner;
330};
331struct nfsd4_readlink {
332	struct svc_rqst *rl_rqstp;          /* request */
333	struct svc_fh *	rl_fhp;             /* request */
334};
335
336struct nfsd4_remove {
337	u32		rm_namelen;         /* request */
338	char *		rm_name;            /* request */
339	struct nfsd4_change_info  rm_cinfo; /* response */
340};
341
342struct nfsd4_rename {
343	u32		rn_snamelen;        /* request */
344	char *		rn_sname;           /* request */
345	u32		rn_tnamelen;        /* request */
346	char *		rn_tname;           /* request */
347	struct nfsd4_change_info  rn_sinfo; /* response */
348	struct nfsd4_change_info  rn_tinfo; /* response */
349};
350
351struct nfsd4_secinfo {
352	u32 si_namelen;					/* request */
353	char *si_name;					/* request */
354	struct svc_export *si_exp;			/* response */
355};
356
357struct nfsd4_secinfo_no_name {
358	u32 sin_style;					/* request */
359	struct svc_export *sin_exp;			/* response */
360};
361
362struct nfsd4_setattr {
363	stateid_t	sa_stateid;         /* request */
364	u32		sa_bmval[3];        /* request */
365	struct iattr	sa_iattr;           /* request */
366	struct nfs4_acl *sa_acl;
367	struct xdr_netobj sa_label;
368};
369
370struct nfsd4_setclientid {
371	nfs4_verifier	se_verf;            /* request */
372	struct xdr_netobj se_name;
373	u32		se_callback_prog;   /* request */
374	u32		se_callback_netid_len;  /* request */
375	char *		se_callback_netid_val;  /* request */
376	u32		se_callback_addr_len;   /* request */
377	char *		se_callback_addr_val;   /* request */
378	u32		se_callback_ident;  /* request */
379	clientid_t	se_clientid;        /* response */
380	nfs4_verifier	se_confirm;         /* response */
381};
382
383struct nfsd4_setclientid_confirm {
384	clientid_t	sc_clientid;
385	nfs4_verifier	sc_confirm;
386};
387
388struct nfsd4_saved_compoundargs {
389	__be32 *p;
390	__be32 *end;
391	int pagelen;
392	struct page **pagelist;
393};
394
395struct nfsd4_test_stateid_id {
396	__be32			ts_id_status;
397	stateid_t		ts_id_stateid;
398	struct list_head	ts_id_list;
399};
400
401struct nfsd4_test_stateid {
402	u32		ts_num_ids;
403	struct list_head ts_stateid_list;
404};
405
406struct nfsd4_free_stateid {
407	stateid_t	fr_stateid;         /* request */
408};
409
410/* also used for NVERIFY */
411struct nfsd4_verify {
412	u32		ve_bmval[3];        /* request */
413	u32		ve_attrlen;         /* request */
414	char *		ve_attrval;         /* request */
415};
416
417struct nfsd4_write {
418	stateid_t	wr_stateid;         /* request */
419	u64		wr_offset;          /* request */
420	u32		wr_stable_how;      /* request */
421	u32		wr_buflen;          /* request */
422	struct kvec	wr_head;
423	struct page **	wr_pagelist;        /* request */
424
425	u32		wr_bytes_written;   /* response */
426	u32		wr_how_written;     /* response */
427	nfs4_verifier	wr_verifier;        /* response */
428};
429
430struct nfsd4_exchange_id {
431	nfs4_verifier	verifier;
432	struct xdr_netobj clname;
433	u32		flags;
434	clientid_t	clientid;
435	u32		seqid;
436	int		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
444struct 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
456struct nfsd4_destroy_session {
457	struct nfs4_sessionid	sessionid;
458};
459
460struct nfsd4_destroy_clientid {
461	clientid_t clientid;
462};
463
464struct nfsd4_reclaim_complete {
465	u32 rca_one_fs;
466};
467
468struct nfsd4_deviceid {
469	u64			fsid_idx;
470	u32			generation;
471	u32			pad;
472};
473
474struct nfsd4_layout_seg {
475	u32			iomode;
476	u64			offset;
477	u64			length;
478};
479
480struct 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
488struct 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
498struct 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
512struct 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
523struct nfsd4_fallocate {
524	/* request */
525	stateid_t	falloc_stateid;
526	loff_t		falloc_offset;
527	u64		falloc_length;
528};
529
530struct 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
539struct 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
546struct 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	bool		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};
583extern bool inter_copy_offload_enable;
584
585struct 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
596struct nfsd4_offload_status {
597	/* request */
598	stateid_t	stateid;
599
600	/* response */
601	u64		count;
602	u32		status;
603};
604
605struct 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
617struct nfsd4_op {
618	int					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
687bool nfsd4_cache_this_op(struct nfsd4_op *);
688
689/*
690 * Memory needed just for the duration of processing one compound:
691 */
692struct svcxdr_tmpbuf {
693	struct svcxdr_tmpbuf *next;
694	char buf[];
695};
696
697struct nfsd4_compoundargs {
698	/* scratch variables for XDR decode */
699	__be32 *			p;
700	__be32 *			end;
701	struct page **			pagelist;
702	int				pagelen;
703	bool				tail;
704	__be32				tmp[8];
705	__be32 *			tmpp;
706	struct svcxdr_tmpbuf		*to_free;
707
708	struct svc_rqst			*rqstp;
709
710	u32				taglen;
711	char *				tag;
712	u32				minorversion;
713	u32				opcnt;
714	struct nfsd4_op			*ops;
715	struct nfsd4_op			iops[8];
716	int				cachetype;
717};
718
719struct nfsd4_compoundres {
720	/* scratch variables for XDR encode */
721	struct xdr_stream		xdr;
722	struct svc_rqst *		rqstp;
723
724	u32				taglen;
725	char *				tag;
726	u32				opcnt;
727	__be32 *			tagp; /* tag, opcount encode location */
728	struct nfsd4_compound_state	cstate;
729};
730
731static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
732{
733	struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
734	return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
735}
736
737/*
738 * The session reply cache only needs to cache replies that the client
739 * actually asked us to.  But it's almost free for us to cache compounds
740 * consisting of only a SEQUENCE op, so we may as well cache those too.
741 * Also, the protocol doesn't give us a convenient response in the case
742 * of a replay of a solo SEQUENCE op that wasn't cached
743 * (RETRY_UNCACHED_REP can only be returned in the second op of a
744 * compound).
745 */
746static inline bool nfsd4_cache_this(struct nfsd4_compoundres *resp)
747{
748	return (resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
749		|| nfsd4_is_solo_sequence(resp);
750}
751
752static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
753{
754	struct nfsd4_compoundres *resp = rqstp->rq_resp;
755	struct nfsd4_compoundargs *argp = rqstp->rq_argp;
756
757	return argp->opcnt == resp->opcnt;
758}
759
760const struct nfsd4_operation *OPDESC(struct nfsd4_op *op);
761int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op);
762void warn_on_nonidempotent_op(struct nfsd4_op *op);
763
764#define NFS4_SVC_XDRSIZE		sizeof(struct nfsd4_compoundargs)
765
766static inline void
767set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
768{
769	BUG_ON(!fhp->fh_pre_saved);
770	cinfo->atomic = (u32)fhp->fh_post_saved;
771	cinfo->change_supported = IS_I_VERSION(d_inode(fhp->fh_dentry));
772
773	cinfo->before_change = fhp->fh_pre_change;
774	cinfo->after_change = fhp->fh_post_change;
775	cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
776	cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
777	cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
778	cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
779
780}
781
782
783bool nfsd4_mach_creds_match(struct nfs4_client *cl, struct svc_rqst *rqstp);
784int nfs4svc_decode_voidarg(struct svc_rqst *, __be32 *);
785int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *);
786int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *);
787int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *);
788__be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
789void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
790void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op);
791__be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words,
792		struct svc_fh *fhp, struct svc_export *exp,
793		struct dentry *dentry,
794		u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
795extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
796		struct nfsd4_compound_state *, union nfsd4_op_u *u);
797extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
798		struct nfsd4_compound_state *, union nfsd4_op_u *u);
799extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
800		struct nfsd4_compound_state *, union nfsd4_op_u *u);
801extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *,
802		struct nfsd4_compound_state *, union nfsd4_op_u *u);
803extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *,
804		struct nfsd4_compound_state *, union nfsd4_op_u *u);
805extern __be32 nfsd4_create_session(struct svc_rqst *,
806		struct nfsd4_compound_state *, union nfsd4_op_u *u);
807extern __be32 nfsd4_sequence(struct svc_rqst *,
808		struct nfsd4_compound_state *, union nfsd4_op_u *u);
809extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp);
810extern __be32 nfsd4_destroy_session(struct svc_rqst *,
811		struct nfsd4_compound_state *, union nfsd4_op_u *u);
812extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *,
813		union nfsd4_op_u *u);
814__be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *,
815		union nfsd4_op_u *u);
816extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
817		struct nfsd4_open *open, struct nfsd_net *nn);
818extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
819		struct svc_fh *current_fh, struct nfsd4_open *open);
820extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate);
821extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate,
822		struct nfsd4_open *open);
823extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
824		struct nfsd4_compound_state *, union nfsd4_op_u *u);
825extern __be32 nfsd4_close(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
826		union nfsd4_op_u *u);
827extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
828		struct nfsd4_compound_state *, union nfsd4_op_u *u);
829extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
830		union nfsd4_op_u *u);
831extern __be32 nfsd4_lockt(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
832		union nfsd4_op_u *u);
833extern __be32 nfsd4_locku(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
834		union nfsd4_op_u *u);
835extern __be32
836nfsd4_release_lockowner(struct svc_rqst *rqstp,
837		struct nfsd4_compound_state *, union nfsd4_op_u *u);
838extern void nfsd4_release_compoundargs(struct svc_rqst *rqstp);
839extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
840		struct nfsd4_compound_state *, union nfsd4_op_u *u);
841extern __be32 nfsd4_renew(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
842		union nfsd4_op_u *u);
843extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
844		struct nfsd4_compound_state *, union nfsd4_op_u *);
845extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
846		struct nfsd4_compound_state *, union nfsd4_op_u *);
847extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
848
849enum nfsd4_op_flags {
850	ALLOWED_WITHOUT_FH = 1 << 0,    /* No current filehandle required */
851	ALLOWED_ON_ABSENT_FS = 1 << 1,  /* ops processed on absent fs */
852	ALLOWED_AS_FIRST_OP = 1 << 2,   /* ops reqired first in compound */
853	/* For rfc 5661 section 2.6.3.1.1: */
854	OP_HANDLES_WRONGSEC = 1 << 3,
855	OP_IS_PUTFH_LIKE = 1 << 4,
856	/*
857	 * These are the ops whose result size we estimate before
858	 * encoding, to avoid performing an op then not being able to
859	 * respond or cache a response.  This includes writes and setattrs
860	 * as well as the operations usually called "nonidempotent":
861	 */
862	OP_MODIFIES_SOMETHING = 1 << 5,
863	/*
864	 * Cache compounds containing these ops in the xid-based drc:
865	 * We use the DRC for compounds containing non-idempotent
866	 * operations, *except* those that are 4.1-specific (since
867	 * sessions provide their own EOS), and except for stateful
868	 * operations other than setclientid and setclientid_confirm
869	 * (since sequence numbers provide EOS for open, lock, etc in
870	 * the v4.0 case).
871	 */
872	OP_CACHEME = 1 << 6,
873	/*
874	 * These are ops which clear current state id.
875	 */
876	OP_CLEAR_STATEID = 1 << 7,
877	/* Most ops return only an error on failure; some may do more: */
878	OP_NONTRIVIAL_ERROR_ENCODE = 1 << 8,
879};
880
881struct nfsd4_operation {
882	__be32 (*op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
883			union nfsd4_op_u *);
884	void (*op_release)(union nfsd4_op_u *);
885	u32 op_flags;
886	char *op_name;
887	/* Try to get response size before operation */
888	u32 (*op_rsize_bop)(struct svc_rqst *, struct nfsd4_op *);
889	void (*op_get_currentstateid)(struct nfsd4_compound_state *,
890			union nfsd4_op_u *);
891	void (*op_set_currentstateid)(struct nfsd4_compound_state *,
892			union nfsd4_op_u *);
893};
894
895
896#endif
897
898/*
899 * Local variables:
900 *  c-basic-offset: 8
901 * End:
902 */
903