2 * include/linux/nfsd/xdr4.h
4 * Server-side types for NFSv4.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
9 * Kendrick Smith <kmsmith@umich.edu>
10 * Andy Adamson <andros@umich.edu>
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
26 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
27 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #ifndef _LINUX_NFSD_XDR4_H
40 #define _LINUX_NFSD_XDR4_H
42 #define NFSD4_MAX_TAGLEN 128
43 #define XDR_LEN(n) (((n) + 3) & ~3)
45 typedef u32 delegation_zero_t;
46 typedef u32 delegation_boot_t;
47 typedef u64 delegation_id_t;
50 delegation_zero_t ds_zero;
51 delegation_boot_t ds_boot;
52 delegation_id_t ds_id;
53 } delegation_stateid_t;
55 struct nfsd4_change_info {
58 u32 before_ctime_nsec;
64 u32 ac_req_access; /* request */
65 u32 ac_supported; /* response */
66 u32 ac_resp_access; /* response */
70 u32 cl_seqid; /* request */
71 stateid_t cl_stateid; /* request+response */
72 struct nfs4_stateowner * cl_stateowner; /* response */
76 u64 co_offset; /* request */
77 u32 co_count; /* request */
78 nfs4_verifier co_verf; /* response */
82 u32 cr_namelen; /* request */
83 char * cr_name; /* request */
84 u32 cr_type; /* request */
93 } dev; /* NF4BLK, NF4CHR */
95 u32 cr_bmval[2]; /* request */
96 struct iattr cr_iattr; /* request */
97 struct nfsd4_change_info cr_cinfo; /* response */
99 #define cr_linklen u.link.namelen
100 #define cr_linkname u.link.name
101 #define cr_specdata1 u.dev.specdata1
102 #define cr_specdata2 u.dev.specdata2
104 struct nfsd4_getattr {
105 u32 ga_bmval[2]; /* request */
106 struct svc_fh *ga_fhp; /* response */
110 u32 li_namelen; /* request */
111 char * li_name; /* request */
112 struct nfsd4_change_info li_cinfo; /* response */
115 struct nfsd4_lock_denied {
116 struct nfs4_stateowner *ld_sop;
125 u32 lk_reclaim; /* boolean */
132 stateid_t open_stateid;
135 struct xdr_netobj owner;
138 stateid_t lock_stateid;
148 struct nfsd4_lock_denied denied;
151 struct nfs4_stateowner *lk_stateowner;
153 #define lk_new_open_seqid v.new.open_seqid
154 #define lk_new_open_stateid v.new.open_stateid
155 #define lk_new_lock_seqid v.new.lock_seqid
156 #define lk_new_clientid v.new.clientid
157 #define lk_new_owner v.new.owner
158 #define lk_old_lock_stateid v.old.lock_stateid
159 #define lk_old_lock_seqid v.old.lock_seqid
161 #define lk_rflags u.ok.rflags
162 #define lk_resp_stateid u.ok.stateid
163 #define lk_denied u.denied
168 clientid_t lt_clientid;
169 struct xdr_netobj lt_owner;
172 struct nfs4_stateowner * lt_stateowner;
173 struct nfsd4_lock_denied lt_denied;
180 stateid_t lu_stateid;
183 struct nfs4_stateowner *lu_stateowner;
187 struct nfsd4_lookup {
188 u32 lo_len; /* request */
189 char * lo_name; /* request */
193 u32 pf_fhlen; /* request */
194 char *pf_fhval; /* request */
198 u32 op_claim_type; /* request */
199 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
200 u32 op_delegate_type; /* request - CLAIM_PREV only */
201 delegation_stateid_t op_delegate_stateid; /* request - CLAIM_DELEGATE_CUR only */
202 u32 op_create; /* request */
203 u32 op_createmode; /* request */
204 u32 op_bmval[2]; /* request */
205 union { /* request */
206 struct iattr iattr; /* UNCHECKED4,GUARDED4 */
207 nfs4_verifier verf; /* EXCLUSIVE4 */
209 clientid_t op_clientid; /* request */
210 struct xdr_netobj op_owner; /* request */
211 u32 op_seqid; /* request */
212 u32 op_share_access; /* request */
213 u32 op_share_deny; /* request */
214 stateid_t op_stateid; /* response */
215 struct nfsd4_change_info op_cinfo; /* response */
216 u32 op_rflags; /* response */
217 int op_truncate; /* used during processing */
218 struct nfs4_stateowner *op_stateowner; /* used during processing */
221 #define op_iattr u.iattr
222 #define op_verf u.verf
224 struct nfsd4_open_confirm {
225 stateid_t oc_req_stateid /* request */;
226 u32 oc_seqid /* request */;
227 stateid_t oc_resp_stateid /* response */;
228 struct nfs4_stateowner * oc_stateowner; /* response */
231 struct nfsd4_open_downgrade {
232 stateid_t od_stateid;
236 struct nfs4_stateowner *od_stateowner;
241 stateid_t rd_stateid; /* request */
242 u64 rd_offset; /* request */
243 u32 rd_length; /* request */
244 struct kvec rd_iov[RPCSVC_MAXPAGES];
247 struct svc_rqst *rd_rqstp; /* response */
248 struct svc_fh * rd_fhp; /* response */
251 struct nfsd4_readdir {
252 u64 rd_cookie; /* request */
253 nfs4_verifier rd_verf; /* request */
254 u32 rd_dircount; /* request */
255 u32 rd_maxcount; /* request */
256 u32 rd_bmval[2]; /* request */
257 struct svc_rqst *rd_rqstp; /* response */
258 struct svc_fh * rd_fhp; /* response */
260 struct readdir_cd common;
266 struct nfsd4_release_lockowner {
267 clientid_t rl_clientid;
268 struct xdr_netobj rl_owner;
270 struct nfsd4_readlink {
271 struct svc_rqst *rl_rqstp; /* request */
272 struct svc_fh * rl_fhp; /* request */
275 struct nfsd4_remove {
276 u32 rm_namelen; /* request */
277 char * rm_name; /* request */
278 struct nfsd4_change_info rm_cinfo; /* response */
281 struct nfsd4_rename {
282 u32 rn_snamelen; /* request */
283 char * rn_sname; /* request */
284 u32 rn_tnamelen; /* request */
285 char * rn_tname; /* request */
286 struct nfsd4_change_info rn_sinfo; /* response */
287 struct nfsd4_change_info rn_tinfo; /* response */
290 struct nfsd4_setattr {
291 stateid_t sa_stateid; /* request */
292 u32 sa_bmval[2]; /* request */
293 struct iattr sa_iattr; /* request */
296 struct nfsd4_setclientid {
297 nfs4_verifier se_verf; /* request */
298 u32 se_namelen; /* request */
299 char * se_name; /* request */
300 u32 se_callback_prog; /* request */
301 u32 se_callback_netid_len; /* request */
302 char * se_callback_netid_val; /* request */
303 u32 se_callback_addr_len; /* request */
304 char * se_callback_addr_val; /* request */
305 u32 se_callback_ident; /* request */
306 clientid_t se_clientid; /* response */
307 nfs4_verifier se_confirm; /* response */
310 struct nfsd4_setclientid_confirm {
311 clientid_t sc_clientid;
312 nfs4_verifier sc_confirm;
315 /* also used for NVERIFY */
316 struct nfsd4_verify {
317 u32 ve_bmval[2]; /* request */
318 u32 ve_attrlen; /* request */
319 char * ve_attrval; /* request */
323 stateid_t wr_stateid; /* request */
324 u64 wr_offset; /* request */
325 u32 wr_stable_how; /* request */
326 u32 wr_buflen; /* request */
327 struct kvec wr_vec[RPCSVC_MAXPAGES]; /* request */
330 u32 wr_bytes_written; /* response */
331 u32 wr_how_written; /* response */
332 nfs4_verifier wr_verifier; /* response */
339 struct nfsd4_access access;
340 struct nfsd4_close close;
341 struct nfsd4_commit commit;
342 struct nfsd4_create create;
343 struct nfsd4_getattr getattr;
344 struct svc_fh * getfh;
345 struct nfsd4_link link;
346 struct nfsd4_lock lock;
347 struct nfsd4_lockt lockt;
348 struct nfsd4_locku locku;
349 struct nfsd4_lookup lookup;
350 struct nfsd4_verify nverify;
351 struct nfsd4_open open;
352 struct nfsd4_open_confirm open_confirm;
353 struct nfsd4_open_downgrade open_downgrade;
354 struct nfsd4_putfh putfh;
355 struct nfsd4_read read;
356 struct nfsd4_readdir readdir;
357 struct nfsd4_readlink readlink;
358 struct nfsd4_remove remove;
359 struct nfsd4_rename rename;
361 struct nfsd4_setattr setattr;
362 struct nfsd4_setclientid setclientid;
363 struct nfsd4_setclientid_confirm setclientid_confirm;
364 struct nfsd4_verify verify;
365 struct nfsd4_write write;
366 struct nfsd4_release_lockowner release_lockowner;
368 struct nfs4_replay * replay;
371 struct nfsd4_compoundargs {
372 /* scratch variables for XDR decode */
375 struct page ** pagelist;
381 void (*release)(const void *);
385 struct svc_rqst *rqstp;
391 struct nfsd4_op *ops;
392 struct nfsd4_op iops[8];
395 struct nfsd4_compoundres {
396 /* scratch variables for XDR encode */
399 struct xdr_buf * xbuf;
400 struct svc_rqst * rqstp;
405 u32 * tagp; /* where to encode tag and opcount */
408 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
411 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
413 BUG_ON(!fhp->fh_pre_saved || !fhp->fh_post_saved);
415 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
416 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
417 cinfo->after_ctime_sec = fhp->fh_post_ctime.tv_sec;
418 cinfo->after_ctime_nsec = fhp->fh_post_ctime.tv_nsec;
421 int nfs4svc_encode_voidres(struct svc_rqst *, u32 *, void *);
422 int nfs4svc_decode_compoundargs(struct svc_rqst *, u32 *,
423 struct nfsd4_compoundargs *);
424 int nfs4svc_encode_compoundres(struct svc_rqst *, u32 *,
425 struct nfsd4_compoundres *);
426 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
427 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
428 int nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
429 struct dentry *dentry, u32 *buffer, int *countp,
430 u32 *bmval, struct svc_rqst *);
431 extern int nfsd4_setclientid(struct svc_rqst *rqstp,
432 struct nfsd4_setclientid *setclid);
433 extern int nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
434 struct nfsd4_setclientid_confirm *setclientid_confirm);
435 extern int nfsd4_process_open1(struct nfsd4_open *open);
436 extern int nfsd4_process_open2(struct svc_rqst *rqstp,
437 struct svc_fh *current_fh, struct nfsd4_open *open);
438 extern int nfsd4_open_confirm(struct svc_rqst *rqstp,
439 struct svc_fh *current_fh, struct nfsd4_open_confirm *oc);
440 extern int nfsd4_close(struct svc_rqst *rqstp, struct svc_fh *current_fh,
441 struct nfsd4_close *close);
442 extern int nfsd4_open_downgrade(struct svc_rqst *rqstp,
443 struct svc_fh *current_fh, struct nfsd4_open_downgrade *od);
444 extern int nfsd4_lock(struct svc_rqst *rqstp, struct svc_fh *current_fh,
445 struct nfsd4_lock *lock);
446 extern int nfsd4_lockt(struct svc_rqst *rqstp, struct svc_fh *current_fh,
447 struct nfsd4_lockt *lockt);
448 extern int nfsd4_locku(struct svc_rqst *rqstp, struct svc_fh *current_fh,
449 struct nfsd4_locku *locku);
451 nfsd4_release_lockowner(struct svc_rqst *rqstp,
452 struct nfsd4_release_lockowner *rlockowner);
453 extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs *);