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
46struct nfsd4_compound_state {
47	struct svc_fh		current_fh;
48	struct svc_fh		save_fh;
49	struct nfs4_stateowner	*replay_owner;
50	/* For sessions DRC */
51	struct nfsd4_session	*session;
52	struct nfsd4_slot	*slot;
53	__be32			*datap;
54	size_t			iovlen;
55	u32			minorversion;
56	u32			status;
57};
58
59static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
60{
61	return cs->slot != NULL;
62}
63
64struct nfsd4_change_info {
65	u32		atomic;
66	bool		change_supported;
67	u32		before_ctime_sec;
68	u32		before_ctime_nsec;
69	u64		before_change;
70	u32		after_ctime_sec;
71	u32		after_ctime_nsec;
72	u64		after_change;
73};
74
75struct nfsd4_access {
76	u32		ac_req_access;      /* request */
77	u32		ac_supported;       /* response */
78	u32		ac_resp_access;     /* response */
79};
80
81struct nfsd4_close {
82	u32		cl_seqid;           /* request */
83	stateid_t	cl_stateid;         /* request+response */
84	struct nfs4_stateowner * cl_stateowner;	/* response */
85};
86
87struct nfsd4_commit {
88	u64		co_offset;          /* request */
89	u32		co_count;           /* request */
90	nfs4_verifier	co_verf;            /* response */
91};
92
93struct nfsd4_create {
94	u32		cr_namelen;         /* request */
95	char *		cr_name;            /* request */
96	u32		cr_type;            /* request */
97	union {                             /* request */
98		struct {
99			u32 namelen;
100			char *name;
101		} link;   /* NF4LNK */
102		struct {
103			u32 specdata1;
104			u32 specdata2;
105		} dev;    /* NF4BLK, NF4CHR */
106	} u;
107	u32		cr_bmval[3];        /* request */
108	struct iattr	cr_iattr;           /* request */
109	struct nfsd4_change_info  cr_cinfo; /* response */
110	struct nfs4_acl *cr_acl;
111};
112#define cr_linklen	u.link.namelen
113#define cr_linkname	u.link.name
114#define cr_specdata1	u.dev.specdata1
115#define cr_specdata2	u.dev.specdata2
116
117struct nfsd4_delegreturn {
118	stateid_t	dr_stateid;
119};
120
121struct nfsd4_getattr {
122	u32		ga_bmval[3];        /* request */
123	struct svc_fh	*ga_fhp;            /* response */
124};
125
126struct nfsd4_link {
127	u32		li_namelen;         /* request */
128	char *		li_name;            /* request */
129	struct nfsd4_change_info  li_cinfo; /* response */
130};
131
132struct nfsd4_lock_denied {
133	clientid_t	ld_clientid;
134	struct nfs4_stateowner   *ld_sop;
135	u64             ld_start;
136	u64             ld_length;
137	u32             ld_type;
138};
139
140struct nfsd4_lock {
141	/* request */
142	u32             lk_type;
143	u32             lk_reclaim;         /* boolean */
144	u64             lk_offset;
145	u64             lk_length;
146	u32             lk_is_new;
147	union {
148		struct {
149			u32             open_seqid;
150			stateid_t       open_stateid;
151			u32             lock_seqid;
152			clientid_t      clientid;
153			struct xdr_netobj owner;
154		} new;
155		struct {
156			stateid_t       lock_stateid;
157			u32             lock_seqid;
158		} old;
159	} v;
160
161	/* response */
162	union {
163		struct {
164			stateid_t               stateid;
165		} ok;
166		struct nfsd4_lock_denied        denied;
167	} u;
168	/* The lk_replay_owner is the open owner in the open_to_lock_owner
169	 * case and the lock owner otherwise: */
170	struct nfs4_stateowner *lk_replay_owner;
171};
172#define lk_new_open_seqid       v.new.open_seqid
173#define lk_new_open_stateid     v.new.open_stateid
174#define lk_new_lock_seqid       v.new.lock_seqid
175#define lk_new_clientid         v.new.clientid
176#define lk_new_owner            v.new.owner
177#define lk_old_lock_stateid     v.old.lock_stateid
178#define lk_old_lock_seqid       v.old.lock_seqid
179
180#define lk_rflags       u.ok.rflags
181#define lk_resp_stateid u.ok.stateid
182#define lk_denied       u.denied
183
184
185struct nfsd4_lockt {
186	u32				lt_type;
187	clientid_t			lt_clientid;
188	struct xdr_netobj		lt_owner;
189	u64				lt_offset;
190	u64				lt_length;
191	struct nfs4_stateowner * 	lt_stateowner;
192	struct nfsd4_lock_denied  	lt_denied;
193};
194
195
196struct nfsd4_locku {
197	u32             lu_type;
198	u32             lu_seqid;
199	stateid_t       lu_stateid;
200	u64             lu_offset;
201	u64             lu_length;
202	struct nfs4_stateowner  *lu_stateowner;
203};
204
205
206struct nfsd4_lookup {
207	u32		lo_len;             /* request */
208	char *		lo_name;            /* request */
209};
210
211struct nfsd4_putfh {
212	u32		pf_fhlen;           /* request */
213	char		*pf_fhval;          /* request */
214};
215
216struct nfsd4_open {
217	u32		op_claim_type;      /* request */
218	struct xdr_netobj op_fname;	    /* request - everything but CLAIM_PREV */
219	u32		op_delegate_type;   /* request - CLAIM_PREV only */
220	stateid_t       op_delegate_stateid; /* request - response */
221	u32		op_create;     	    /* request */
222	u32		op_createmode;      /* request */
223	u32		op_bmval[3];        /* request */
224	struct iattr	iattr;              /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
225	nfs4_verifier	verf;               /* EXCLUSIVE4 */
226	clientid_t	op_clientid;        /* request */
227	struct xdr_netobj op_owner;           /* request */
228	u32		op_seqid;           /* request */
229	u32		op_share_access;    /* request */
230	u32		op_share_deny;      /* request */
231	stateid_t	op_stateid;         /* response */
232	u32		op_recall;          /* recall */
233	struct nfsd4_change_info  op_cinfo; /* response */
234	u32		op_rflags;          /* response */
235	int		op_truncate;        /* used during processing */
236	struct nfs4_stateowner *op_stateowner; /* used during processing */
237	struct nfs4_acl *op_acl;
238};
239#define op_iattr	iattr
240#define op_verf		verf
241
242struct nfsd4_open_confirm {
243	stateid_t	oc_req_stateid		/* request */;
244	u32		oc_seqid    		/* request */;
245	stateid_t	oc_resp_stateid		/* response */;
246	struct nfs4_stateowner * oc_stateowner;	/* response */
247};
248
249struct nfsd4_open_downgrade {
250	stateid_t       od_stateid;
251	u32             od_seqid;
252	u32             od_share_access;
253	u32             od_share_deny;
254	struct nfs4_stateowner *od_stateowner;
255};
256
257
258struct nfsd4_read {
259	stateid_t	rd_stateid;         /* request */
260	u64		rd_offset;          /* request */
261	u32		rd_length;          /* request */
262	int		rd_vlen;
263	struct file     *rd_filp;
264
265	struct svc_rqst *rd_rqstp;          /* response */
266	struct svc_fh * rd_fhp;             /* response */
267};
268
269struct nfsd4_readdir {
270	u64		rd_cookie;          /* request */
271	nfs4_verifier	rd_verf;            /* request */
272	u32		rd_dircount;        /* request */
273	u32		rd_maxcount;        /* request */
274	u32		rd_bmval[3];        /* request */
275	struct svc_rqst *rd_rqstp;          /* response */
276	struct svc_fh * rd_fhp;             /* response */
277
278	struct readdir_cd	common;
279	__be32 *		buffer;
280	int			buflen;
281	__be32 *		offset;
282};
283
284struct nfsd4_release_lockowner {
285	clientid_t        rl_clientid;
286	struct xdr_netobj rl_owner;
287};
288struct nfsd4_readlink {
289	struct svc_rqst *rl_rqstp;          /* request */
290	struct svc_fh *	rl_fhp;             /* request */
291};
292
293struct nfsd4_remove {
294	u32		rm_namelen;         /* request */
295	char *		rm_name;            /* request */
296	struct nfsd4_change_info  rm_cinfo; /* response */
297};
298
299struct nfsd4_rename {
300	u32		rn_snamelen;        /* request */
301	char *		rn_sname;           /* request */
302	u32		rn_tnamelen;        /* request */
303	char *		rn_tname;           /* request */
304	struct nfsd4_change_info  rn_sinfo; /* response */
305	struct nfsd4_change_info  rn_tinfo; /* response */
306};
307
308struct nfsd4_secinfo {
309	u32 si_namelen;					/* request */
310	char *si_name;					/* request */
311	struct svc_export *si_exp;			/* response */
312};
313
314struct nfsd4_setattr {
315	stateid_t	sa_stateid;         /* request */
316	u32		sa_bmval[3];        /* request */
317	struct iattr	sa_iattr;           /* request */
318	struct nfs4_acl *sa_acl;
319};
320
321struct nfsd4_setclientid {
322	nfs4_verifier	se_verf;            /* request */
323	u32		se_namelen;         /* request */
324	char *		se_name;            /* request */
325	u32		se_callback_prog;   /* request */
326	u32		se_callback_netid_len;  /* request */
327	char *		se_callback_netid_val;  /* request */
328	u32		se_callback_addr_len;   /* request */
329	char *		se_callback_addr_val;   /* request */
330	u32		se_callback_ident;  /* request */
331	clientid_t	se_clientid;        /* response */
332	nfs4_verifier	se_confirm;         /* response */
333};
334
335struct nfsd4_setclientid_confirm {
336	clientid_t	sc_clientid;
337	nfs4_verifier	sc_confirm;
338};
339
340/* also used for NVERIFY */
341struct nfsd4_verify {
342	u32		ve_bmval[3];        /* request */
343	u32		ve_attrlen;         /* request */
344	char *		ve_attrval;         /* request */
345};
346
347struct nfsd4_write {
348	stateid_t	wr_stateid;         /* request */
349	u64		wr_offset;          /* request */
350	u32		wr_stable_how;      /* request */
351	u32		wr_buflen;          /* request */
352	int		wr_vlen;
353
354	u32		wr_bytes_written;   /* response */
355	u32		wr_how_written;     /* response */
356	nfs4_verifier	wr_verifier;        /* response */
357};
358
359struct nfsd4_exchange_id {
360	nfs4_verifier	verifier;
361	struct xdr_netobj clname;
362	u32		flags;
363	clientid_t	clientid;
364	u32		seqid;
365	int		spa_how;
366};
367
368struct nfsd4_sequence {
369	struct nfs4_sessionid	sessionid;		/* request/response */
370	u32			seqid;			/* request/response */
371	u32			slotid;			/* request/response */
372	u32			maxslots;		/* request/response */
373	u32			cachethis;		/* request */
374};
375
376struct nfsd4_destroy_session {
377	struct nfs4_sessionid	sessionid;
378};
379
380struct nfsd4_reclaim_complete {
381	u32 rca_one_fs;
382};
383
384struct nfsd4_op {
385	int					opnum;
386	__be32					status;
387	union {
388		struct nfsd4_access		access;
389		struct nfsd4_close		close;
390		struct nfsd4_commit		commit;
391		struct nfsd4_create		create;
392		struct nfsd4_delegreturn	delegreturn;
393		struct nfsd4_getattr		getattr;
394		struct svc_fh *			getfh;
395		struct nfsd4_link		link;
396		struct nfsd4_lock		lock;
397		struct nfsd4_lockt		lockt;
398		struct nfsd4_locku		locku;
399		struct nfsd4_lookup		lookup;
400		struct nfsd4_verify		nverify;
401		struct nfsd4_open		open;
402		struct nfsd4_open_confirm	open_confirm;
403		struct nfsd4_open_downgrade	open_downgrade;
404		struct nfsd4_putfh		putfh;
405		struct nfsd4_read		read;
406		struct nfsd4_readdir		readdir;
407		struct nfsd4_readlink		readlink;
408		struct nfsd4_remove		remove;
409		struct nfsd4_rename		rename;
410		clientid_t			renew;
411		struct nfsd4_secinfo		secinfo;
412		struct nfsd4_setattr		setattr;
413		struct nfsd4_setclientid	setclientid;
414		struct nfsd4_setclientid_confirm setclientid_confirm;
415		struct nfsd4_verify		verify;
416		struct nfsd4_write		write;
417		struct nfsd4_release_lockowner	release_lockowner;
418
419		/* NFSv4.1 */
420		struct nfsd4_exchange_id	exchange_id;
421		struct nfsd4_create_session	create_session;
422		struct nfsd4_destroy_session	destroy_session;
423		struct nfsd4_sequence		sequence;
424		struct nfsd4_reclaim_complete	reclaim_complete;
425	} u;
426	struct nfs4_replay *			replay;
427};
428
429struct nfsd4_compoundargs {
430	/* scratch variables for XDR decode */
431	__be32 *			p;
432	__be32 *			end;
433	struct page **			pagelist;
434	int				pagelen;
435	__be32				tmp[8];
436	__be32 *			tmpp;
437	struct tmpbuf {
438		struct tmpbuf *next;
439		void (*release)(const void *);
440		void *buf;
441	}				*to_free;
442
443	struct svc_rqst			*rqstp;
444
445	u32				taglen;
446	char *				tag;
447	u32				minorversion;
448	u32				opcnt;
449	struct nfsd4_op			*ops;
450	struct nfsd4_op			iops[8];
451};
452
453struct nfsd4_compoundres {
454	/* scratch variables for XDR encode */
455	__be32 *			p;
456	__be32 *			end;
457	struct xdr_buf *		xbuf;
458	struct svc_rqst *		rqstp;
459
460	u32				taglen;
461	char *				tag;
462	u32				opcnt;
463	__be32 *			tagp; /* tag, opcount encode location */
464	struct nfsd4_compound_state	cstate;
465};
466
467static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
468{
469	struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
470	return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
471}
472
473static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
474{
475	return !resp->cstate.slot->sl_cachethis || nfsd4_is_solo_sequence(resp);
476}
477
478#define NFS4_SVC_XDRSIZE		sizeof(struct nfsd4_compoundargs)
479
480static inline void
481set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
482{
483	BUG_ON(!fhp->fh_pre_saved);
484	cinfo->atomic = fhp->fh_post_saved;
485	cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
486
487	cinfo->before_change = fhp->fh_pre_change;
488	cinfo->after_change = fhp->fh_post_change;
489	cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
490	cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
491	cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
492	cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
493
494}
495
496int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
497int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
498		struct nfsd4_compoundargs *);
499int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
500		struct nfsd4_compoundres *);
501void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
502void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
503__be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
504		       struct dentry *dentry, __be32 *buffer, int *countp,
505		       u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
506extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
507		struct nfsd4_compound_state *,
508		struct nfsd4_setclientid *setclid);
509extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
510		struct nfsd4_compound_state *,
511		struct nfsd4_setclientid_confirm *setclientid_confirm);
512extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
513extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
514		struct nfsd4_sequence *seq);
515extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
516		struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
517extern __be32 nfsd4_create_session(struct svc_rqst *,
518		struct nfsd4_compound_state *,
519		struct nfsd4_create_session *);
520extern __be32 nfsd4_sequence(struct svc_rqst *,
521		struct nfsd4_compound_state *,
522		struct nfsd4_sequence *);
523extern __be32 nfsd4_destroy_session(struct svc_rqst *,
524		struct nfsd4_compound_state *,
525		struct nfsd4_destroy_session *);
526__be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
527extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
528		struct nfsd4_open *open);
529extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
530		struct svc_fh *current_fh, struct nfsd4_open *open);
531extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
532		struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
533extern __be32 nfsd4_close(struct svc_rqst *rqstp,
534		struct nfsd4_compound_state *,
535		struct nfsd4_close *close);
536extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
537		struct nfsd4_compound_state *,
538		struct nfsd4_open_downgrade *od);
539extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
540		struct nfsd4_lock *lock);
541extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
542		struct nfsd4_compound_state *,
543		struct nfsd4_lockt *lockt);
544extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
545		struct nfsd4_compound_state *,
546		struct nfsd4_locku *locku);
547extern __be32
548nfsd4_release_lockowner(struct svc_rqst *rqstp,
549		struct nfsd4_compound_state *,
550		struct nfsd4_release_lockowner *rlockowner);
551extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs *);
552extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
553		struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
554extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
555			  struct nfsd4_compound_state *, clientid_t *clid);
556#endif
557
558/*
559 * Local variables:
560 *  c-basic-offset: 8
561 * End:
562 */
563