2 * Server-side types for NFSv4.
4 * Copyright (c) 2002 The Regents of the University of Michigan.
7 * Kendrick Smith <kmsmith@umich.edu>
8 * Andy Adamson <andros@umich.edu>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
37 #ifndef _LINUX_NFSD_XDR4_H
38 #define _LINUX_NFSD_XDR4_H
43 #define NFSD4_MAX_TAGLEN 128
44 #define XDR_LEN(n) (((n) + 3) & ~3)
46 struct 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;
59 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
61 return cs->slot != NULL;
64 struct nfsd4_change_info {
66 bool change_supported;
68 u32 before_ctime_nsec;
76 u32 ac_req_access; /* request */
77 u32 ac_supported; /* response */
78 u32 ac_resp_access; /* response */
82 u32 cl_seqid; /* request */
83 stateid_t cl_stateid; /* request+response */
87 u64 co_offset; /* request */
88 u32 co_count; /* request */
89 nfs4_verifier co_verf; /* response */
93 u32 cr_namelen; /* request */
94 char * cr_name; /* request */
95 u32 cr_type; /* request */
104 } dev; /* NF4BLK, NF4CHR */
106 u32 cr_bmval[3]; /* request */
107 struct iattr cr_iattr; /* request */
108 struct nfsd4_change_info cr_cinfo; /* response */
109 struct nfs4_acl *cr_acl;
111 #define cr_linklen u.link.namelen
112 #define cr_linkname u.link.name
113 #define cr_specdata1 u.dev.specdata1
114 #define cr_specdata2 u.dev.specdata2
116 struct nfsd4_delegreturn {
117 stateid_t dr_stateid;
120 struct nfsd4_getattr {
121 u32 ga_bmval[3]; /* request */
122 struct svc_fh *ga_fhp; /* response */
126 u32 li_namelen; /* request */
127 char * li_name; /* request */
128 struct nfsd4_change_info li_cinfo; /* response */
131 struct nfsd4_lock_denied {
132 clientid_t ld_clientid;
133 struct xdr_netobj ld_owner;
142 u32 lk_reclaim; /* boolean */
149 stateid_t open_stateid;
152 struct xdr_netobj owner;
155 stateid_t lock_stateid;
165 struct nfsd4_lock_denied denied;
168 #define lk_new_open_seqid v.new.open_seqid
169 #define lk_new_open_stateid v.new.open_stateid
170 #define lk_new_lock_seqid v.new.lock_seqid
171 #define lk_new_clientid v.new.clientid
172 #define lk_new_owner v.new.owner
173 #define lk_old_lock_stateid v.old.lock_stateid
174 #define lk_old_lock_seqid v.old.lock_seqid
176 #define lk_rflags u.ok.rflags
177 #define lk_resp_stateid u.ok.stateid
178 #define lk_denied u.denied
183 clientid_t lt_clientid;
184 struct xdr_netobj lt_owner;
187 struct nfsd4_lock_denied lt_denied;
194 stateid_t lu_stateid;
200 struct nfsd4_lookup {
201 u32 lo_len; /* request */
202 char * lo_name; /* request */
206 u32 pf_fhlen; /* request */
207 char *pf_fhval; /* request */
211 u32 op_claim_type; /* request */
212 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
213 u32 op_delegate_type; /* request - CLAIM_PREV only */
214 stateid_t op_delegate_stateid; /* request - response */
215 u32 op_create; /* request */
216 u32 op_createmode; /* request */
217 u32 op_bmval[3]; /* request */
218 struct iattr iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
219 nfs4_verifier verf; /* EXCLUSIVE4 */
220 clientid_t op_clientid; /* request */
221 struct xdr_netobj op_owner; /* request */
222 u32 op_seqid; /* request */
223 u32 op_share_access; /* request */
224 u32 op_share_deny; /* request */
225 stateid_t op_stateid; /* response */
226 u32 op_recall; /* recall */
227 struct nfsd4_change_info op_cinfo; /* response */
228 u32 op_rflags; /* response */
229 int op_truncate; /* used during processing */
230 struct nfs4_openowner *op_openowner; /* used during processing */
231 struct nfs4_acl *op_acl;
233 #define op_iattr iattr
236 struct nfsd4_open_confirm {
237 stateid_t oc_req_stateid /* request */;
238 u32 oc_seqid /* request */;
239 stateid_t oc_resp_stateid /* response */;
242 struct nfsd4_open_downgrade {
243 stateid_t od_stateid;
251 stateid_t rd_stateid; /* request */
252 u64 rd_offset; /* request */
253 u32 rd_length; /* request */
255 struct file *rd_filp;
257 struct svc_rqst *rd_rqstp; /* response */
258 struct svc_fh * rd_fhp; /* response */
261 struct nfsd4_readdir {
262 u64 rd_cookie; /* request */
263 nfs4_verifier rd_verf; /* request */
264 u32 rd_dircount; /* request */
265 u32 rd_maxcount; /* request */
266 u32 rd_bmval[3]; /* request */
267 struct svc_rqst *rd_rqstp; /* response */
268 struct svc_fh * rd_fhp; /* response */
270 struct readdir_cd common;
276 struct nfsd4_release_lockowner {
277 clientid_t rl_clientid;
278 struct xdr_netobj rl_owner;
280 struct nfsd4_readlink {
281 struct svc_rqst *rl_rqstp; /* request */
282 struct svc_fh * rl_fhp; /* request */
285 struct nfsd4_remove {
286 u32 rm_namelen; /* request */
287 char * rm_name; /* request */
288 struct nfsd4_change_info rm_cinfo; /* response */
291 struct nfsd4_rename {
292 u32 rn_snamelen; /* request */
293 char * rn_sname; /* request */
294 u32 rn_tnamelen; /* request */
295 char * rn_tname; /* request */
296 struct nfsd4_change_info rn_sinfo; /* response */
297 struct nfsd4_change_info rn_tinfo; /* response */
300 struct nfsd4_secinfo {
301 u32 si_namelen; /* request */
302 char *si_name; /* request */
303 struct svc_export *si_exp; /* response */
306 struct nfsd4_secinfo_no_name {
307 u32 sin_style; /* request */
308 struct svc_export *sin_exp; /* response */
311 struct nfsd4_setattr {
312 stateid_t sa_stateid; /* request */
313 u32 sa_bmval[3]; /* request */
314 struct iattr sa_iattr; /* request */
315 struct nfs4_acl *sa_acl;
318 struct nfsd4_setclientid {
319 nfs4_verifier se_verf; /* request */
320 u32 se_namelen; /* request */
321 char * se_name; /* request */
322 u32 se_callback_prog; /* request */
323 u32 se_callback_netid_len; /* request */
324 char * se_callback_netid_val; /* request */
325 u32 se_callback_addr_len; /* request */
326 char * se_callback_addr_val; /* request */
327 u32 se_callback_ident; /* request */
328 clientid_t se_clientid; /* response */
329 nfs4_verifier se_confirm; /* response */
332 struct nfsd4_setclientid_confirm {
333 clientid_t sc_clientid;
334 nfs4_verifier sc_confirm;
337 struct nfsd4_saved_compoundargs {
341 struct page **pagelist;
344 struct nfsd4_test_stateid {
347 struct nfsd4_compoundargs *ts_saved_args;
348 struct nfsd4_saved_compoundargs ts_savedp;
351 struct nfsd4_free_stateid {
352 stateid_t fr_stateid; /* request */
353 __be32 fr_status; /* response */
356 /* also used for NVERIFY */
357 struct nfsd4_verify {
358 u32 ve_bmval[3]; /* request */
359 u32 ve_attrlen; /* request */
360 char * ve_attrval; /* request */
364 stateid_t wr_stateid; /* request */
365 u64 wr_offset; /* request */
366 u32 wr_stable_how; /* request */
367 u32 wr_buflen; /* request */
370 u32 wr_bytes_written; /* response */
371 u32 wr_how_written; /* response */
372 nfs4_verifier wr_verifier; /* response */
375 struct nfsd4_exchange_id {
376 nfs4_verifier verifier;
377 struct xdr_netobj clname;
384 struct nfsd4_sequence {
385 struct nfs4_sessionid sessionid; /* request/response */
386 u32 seqid; /* request/response */
387 u32 slotid; /* request/response */
388 u32 maxslots; /* request/response */
389 u32 cachethis; /* request */
391 u32 target_maxslots; /* response */
393 u32 status_flags; /* response */
396 struct nfsd4_destroy_session {
397 struct nfs4_sessionid sessionid;
400 struct nfsd4_reclaim_complete {
408 struct nfsd4_access access;
409 struct nfsd4_close close;
410 struct nfsd4_commit commit;
411 struct nfsd4_create create;
412 struct nfsd4_delegreturn delegreturn;
413 struct nfsd4_getattr getattr;
414 struct svc_fh * getfh;
415 struct nfsd4_link link;
416 struct nfsd4_lock lock;
417 struct nfsd4_lockt lockt;
418 struct nfsd4_locku locku;
419 struct nfsd4_lookup lookup;
420 struct nfsd4_verify nverify;
421 struct nfsd4_open open;
422 struct nfsd4_open_confirm open_confirm;
423 struct nfsd4_open_downgrade open_downgrade;
424 struct nfsd4_putfh putfh;
425 struct nfsd4_read read;
426 struct nfsd4_readdir readdir;
427 struct nfsd4_readlink readlink;
428 struct nfsd4_remove remove;
429 struct nfsd4_rename rename;
431 struct nfsd4_secinfo secinfo;
432 struct nfsd4_setattr setattr;
433 struct nfsd4_setclientid setclientid;
434 struct nfsd4_setclientid_confirm setclientid_confirm;
435 struct nfsd4_verify verify;
436 struct nfsd4_write write;
437 struct nfsd4_release_lockowner release_lockowner;
440 struct nfsd4_exchange_id exchange_id;
441 struct nfsd4_bind_conn_to_session bind_conn_to_session;
442 struct nfsd4_create_session create_session;
443 struct nfsd4_destroy_session destroy_session;
444 struct nfsd4_sequence sequence;
445 struct nfsd4_reclaim_complete reclaim_complete;
446 struct nfsd4_test_stateid test_stateid;
447 struct nfsd4_free_stateid free_stateid;
449 struct nfs4_replay * replay;
452 bool nfsd4_cache_this_op(struct nfsd4_op *);
454 struct nfsd4_compoundargs {
455 /* scratch variables for XDR decode */
458 struct page ** pagelist;
464 void (*release)(const void *);
468 struct svc_rqst *rqstp;
474 struct nfsd4_op *ops;
475 struct nfsd4_op iops[8];
479 struct nfsd4_compoundres {
480 /* scratch variables for XDR encode */
483 struct xdr_buf * xbuf;
484 struct svc_rqst * rqstp;
489 __be32 * tagp; /* tag, opcount encode location */
490 struct nfsd4_compound_state cstate;
493 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
495 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
496 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
499 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
501 return !resp->cstate.slot->sl_cachethis || nfsd4_is_solo_sequence(resp);
504 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
507 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
509 BUG_ON(!fhp->fh_pre_saved);
510 cinfo->atomic = fhp->fh_post_saved;
511 cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
513 cinfo->before_change = fhp->fh_pre_change;
514 cinfo->after_change = fhp->fh_post_change;
515 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
516 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
517 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
518 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
522 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
523 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
524 struct nfsd4_compoundargs *);
525 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
526 struct nfsd4_compoundres *);
527 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
528 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
529 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
530 struct dentry *dentry, __be32 *buffer, int *countp,
531 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
532 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
533 struct nfsd4_compound_state *,
534 struct nfsd4_setclientid *setclid);
535 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
536 struct nfsd4_compound_state *,
537 struct nfsd4_setclientid_confirm *setclientid_confirm);
538 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
539 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
540 struct nfsd4_sequence *seq);
541 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
542 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
543 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
544 extern __be32 nfsd4_create_session(struct svc_rqst *,
545 struct nfsd4_compound_state *,
546 struct nfsd4_create_session *);
547 extern __be32 nfsd4_sequence(struct svc_rqst *,
548 struct nfsd4_compound_state *,
549 struct nfsd4_sequence *);
550 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
551 struct nfsd4_compound_state *,
552 struct nfsd4_destroy_session *);
553 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
554 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
555 struct nfsd4_open *open);
556 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
557 struct svc_fh *current_fh, struct nfsd4_open *open);
558 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
559 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
560 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
561 struct nfsd4_compound_state *,
562 struct nfsd4_close *close);
563 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
564 struct nfsd4_compound_state *,
565 struct nfsd4_open_downgrade *od);
566 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
567 struct nfsd4_lock *lock);
568 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
569 struct nfsd4_compound_state *,
570 struct nfsd4_lockt *lockt);
571 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
572 struct nfsd4_compound_state *,
573 struct nfsd4_locku *locku);
575 nfsd4_release_lockowner(struct svc_rqst *rqstp,
576 struct nfsd4_compound_state *,
577 struct nfsd4_release_lockowner *rlockowner);
578 extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp);
579 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
580 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
581 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
582 struct nfsd4_compound_state *, clientid_t *clid);
583 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
584 struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid);
585 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
586 struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid);