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_SEC_LABEL_LEN 2048
44 #define NFSD4_MAX_TAGLEN 128
45 #define XDR_LEN(n) (((n) + 3) & ~3)
47 #define CURRENT_STATE_ID_FLAG (1<<0)
48 #define SAVED_STATE_ID_FLAG (1<<1)
50 #define SET_STATE_ID(c, f) ((c)->sid_flags |= (f))
51 #define HAS_STATE_ID(c, f) ((c)->sid_flags & (f))
52 #define CLEAR_STATE_ID(c, f) ((c)->sid_flags &= ~(f))
54 struct nfsd4_compound_state {
55 struct svc_fh current_fh;
56 struct svc_fh save_fh;
57 struct nfs4_stateowner *replay_owner;
58 /* For sessions DRC */
59 struct nfsd4_session *session;
60 struct nfsd4_slot *slot;
65 stateid_t current_stateid;
66 stateid_t save_stateid;
67 /* to indicate current and saved state id presents */
71 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
73 return cs->slot != NULL;
76 struct nfsd4_change_info {
78 bool change_supported;
80 u32 before_ctime_nsec;
88 u32 ac_req_access; /* request */
89 u32 ac_supported; /* response */
90 u32 ac_resp_access; /* response */
94 u32 cl_seqid; /* request */
95 stateid_t cl_stateid; /* request+response */
99 u64 co_offset; /* request */
100 u32 co_count; /* request */
101 nfs4_verifier co_verf; /* response */
104 struct nfsd4_create {
105 u32 cr_namelen; /* request */
106 char * cr_name; /* request */
107 u32 cr_type; /* request */
108 union { /* request */
116 } dev; /* NF4BLK, NF4CHR */
118 u32 cr_bmval[3]; /* request */
119 struct iattr cr_iattr; /* request */
120 struct nfsd4_change_info cr_cinfo; /* response */
121 struct nfs4_acl *cr_acl;
122 struct xdr_netobj cr_label;
124 #define cr_linklen u.link.namelen
125 #define cr_linkname u.link.name
126 #define cr_specdata1 u.dev.specdata1
127 #define cr_specdata2 u.dev.specdata2
129 struct nfsd4_delegreturn {
130 stateid_t dr_stateid;
133 struct nfsd4_getattr {
134 u32 ga_bmval[3]; /* request */
135 struct svc_fh *ga_fhp; /* response */
139 u32 li_namelen; /* request */
140 char * li_name; /* request */
141 struct nfsd4_change_info li_cinfo; /* response */
144 struct nfsd4_lock_denied {
145 clientid_t ld_clientid;
146 struct xdr_netobj ld_owner;
155 u32 lk_reclaim; /* boolean */
162 stateid_t open_stateid;
165 struct xdr_netobj owner;
168 stateid_t lock_stateid;
178 struct nfsd4_lock_denied denied;
181 #define lk_new_open_seqid v.new.open_seqid
182 #define lk_new_open_stateid v.new.open_stateid
183 #define lk_new_lock_seqid v.new.lock_seqid
184 #define lk_new_clientid v.new.clientid
185 #define lk_new_owner v.new.owner
186 #define lk_old_lock_stateid v.old.lock_stateid
187 #define lk_old_lock_seqid v.old.lock_seqid
189 #define lk_resp_stateid u.ok.stateid
190 #define lk_denied u.denied
195 clientid_t lt_clientid;
196 struct xdr_netobj lt_owner;
199 struct nfsd4_lock_denied lt_denied;
206 stateid_t lu_stateid;
212 struct nfsd4_lookup {
213 u32 lo_len; /* request */
214 char * lo_name; /* request */
218 u32 pf_fhlen; /* request */
219 char *pf_fhval; /* request */
223 u32 op_claim_type; /* request */
224 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
225 u32 op_delegate_type; /* request - CLAIM_PREV only */
226 stateid_t op_delegate_stateid; /* request - response */
227 u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */
228 u32 op_create; /* request */
229 u32 op_createmode; /* request */
230 u32 op_bmval[3]; /* request */
231 struct iattr op_iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
232 nfs4_verifier op_verf __attribute__((aligned(32)));
234 clientid_t op_clientid; /* request */
235 struct xdr_netobj op_owner; /* request */
236 u32 op_seqid; /* request */
237 u32 op_share_access; /* request */
238 u32 op_share_deny; /* request */
239 u32 op_deleg_want; /* request */
240 stateid_t op_stateid; /* response */
241 __be32 op_xdr_error; /* see nfsd4_open_omfg() */
242 u32 op_recall; /* recall */
243 struct nfsd4_change_info op_cinfo; /* response */
244 u32 op_rflags; /* response */
245 bool op_truncate; /* used during processing */
246 bool op_created; /* used during processing */
247 struct nfs4_openowner *op_openowner; /* used during processing */
248 struct nfs4_file *op_file; /* used during processing */
249 struct nfs4_ol_stateid *op_stp; /* used during processing */
250 struct nfs4_acl *op_acl;
251 struct xdr_netobj op_label;
254 struct nfsd4_open_confirm {
255 stateid_t oc_req_stateid /* request */;
256 u32 oc_seqid /* request */;
257 stateid_t oc_resp_stateid /* response */;
260 struct nfsd4_open_downgrade {
261 stateid_t od_stateid;
263 u32 od_share_access; /* request */
264 u32 od_deleg_want; /* request */
265 u32 od_share_deny; /* request */
270 stateid_t rd_stateid; /* request */
271 u64 rd_offset; /* request */
272 u32 rd_length; /* request */
274 struct file *rd_filp;
276 struct svc_rqst *rd_rqstp; /* response */
277 struct svc_fh * rd_fhp; /* response */
280 struct nfsd4_readdir {
281 u64 rd_cookie; /* request */
282 nfs4_verifier rd_verf; /* request */
283 u32 rd_dircount; /* request */
284 u32 rd_maxcount; /* request */
285 u32 rd_bmval[3]; /* request */
286 struct svc_rqst *rd_rqstp; /* response */
287 struct svc_fh * rd_fhp; /* response */
289 struct readdir_cd common;
295 struct nfsd4_release_lockowner {
296 clientid_t rl_clientid;
297 struct xdr_netobj rl_owner;
299 struct nfsd4_readlink {
300 struct svc_rqst *rl_rqstp; /* request */
301 struct svc_fh * rl_fhp; /* request */
304 struct nfsd4_remove {
305 u32 rm_namelen; /* request */
306 char * rm_name; /* request */
307 struct nfsd4_change_info rm_cinfo; /* response */
310 struct nfsd4_rename {
311 u32 rn_snamelen; /* request */
312 char * rn_sname; /* request */
313 u32 rn_tnamelen; /* request */
314 char * rn_tname; /* request */
315 struct nfsd4_change_info rn_sinfo; /* response */
316 struct nfsd4_change_info rn_tinfo; /* response */
319 struct nfsd4_secinfo {
320 u32 si_namelen; /* request */
321 char *si_name; /* request */
322 struct svc_export *si_exp; /* response */
325 struct nfsd4_secinfo_no_name {
326 u32 sin_style; /* request */
327 struct svc_export *sin_exp; /* response */
330 struct nfsd4_setattr {
331 stateid_t sa_stateid; /* request */
332 u32 sa_bmval[3]; /* request */
333 struct iattr sa_iattr; /* request */
334 struct nfs4_acl *sa_acl;
335 struct xdr_netobj sa_label;
338 struct nfsd4_setclientid {
339 nfs4_verifier se_verf; /* request */
340 struct xdr_netobj se_name;
341 u32 se_callback_prog; /* request */
342 u32 se_callback_netid_len; /* request */
343 char * se_callback_netid_val; /* request */
344 u32 se_callback_addr_len; /* request */
345 char * se_callback_addr_val; /* request */
346 u32 se_callback_ident; /* request */
347 clientid_t se_clientid; /* response */
348 nfs4_verifier se_confirm; /* response */
351 struct nfsd4_setclientid_confirm {
352 clientid_t sc_clientid;
353 nfs4_verifier sc_confirm;
356 struct nfsd4_saved_compoundargs {
360 struct page **pagelist;
363 struct nfsd4_test_stateid_id {
365 stateid_t ts_id_stateid;
366 struct list_head ts_id_list;
369 struct nfsd4_test_stateid {
371 struct list_head ts_stateid_list;
374 struct nfsd4_free_stateid {
375 stateid_t fr_stateid; /* request */
378 /* also used for NVERIFY */
379 struct nfsd4_verify {
380 u32 ve_bmval[3]; /* request */
381 u32 ve_attrlen; /* request */
382 char * ve_attrval; /* request */
386 stateid_t wr_stateid; /* request */
387 u64 wr_offset; /* request */
388 u32 wr_stable_how; /* request */
389 u32 wr_buflen; /* request */
391 struct page ** wr_pagelist; /* request */
393 u32 wr_bytes_written; /* response */
394 u32 wr_how_written; /* response */
395 nfs4_verifier wr_verifier; /* response */
398 struct nfsd4_exchange_id {
399 nfs4_verifier verifier;
400 struct xdr_netobj clname;
407 struct nfsd4_sequence {
408 struct nfs4_sessionid sessionid; /* request/response */
409 u32 seqid; /* request/response */
410 u32 slotid; /* request/response */
411 u32 maxslots; /* request/response */
412 u32 cachethis; /* request */
414 u32 target_maxslots; /* response */
416 u32 status_flags; /* response */
419 struct nfsd4_destroy_session {
420 struct nfs4_sessionid sessionid;
423 struct nfsd4_destroy_clientid {
427 struct nfsd4_reclaim_complete {
435 struct nfsd4_access access;
436 struct nfsd4_close close;
437 struct nfsd4_commit commit;
438 struct nfsd4_create create;
439 struct nfsd4_delegreturn delegreturn;
440 struct nfsd4_getattr getattr;
441 struct svc_fh * getfh;
442 struct nfsd4_link link;
443 struct nfsd4_lock lock;
444 struct nfsd4_lockt lockt;
445 struct nfsd4_locku locku;
446 struct nfsd4_lookup lookup;
447 struct nfsd4_verify nverify;
448 struct nfsd4_open open;
449 struct nfsd4_open_confirm open_confirm;
450 struct nfsd4_open_downgrade open_downgrade;
451 struct nfsd4_putfh putfh;
452 struct nfsd4_read read;
453 struct nfsd4_readdir readdir;
454 struct nfsd4_readlink readlink;
455 struct nfsd4_remove remove;
456 struct nfsd4_rename rename;
458 struct nfsd4_secinfo secinfo;
459 struct nfsd4_setattr setattr;
460 struct nfsd4_setclientid setclientid;
461 struct nfsd4_setclientid_confirm setclientid_confirm;
462 struct nfsd4_verify verify;
463 struct nfsd4_write write;
464 struct nfsd4_release_lockowner release_lockowner;
467 struct nfsd4_exchange_id exchange_id;
468 struct nfsd4_backchannel_ctl backchannel_ctl;
469 struct nfsd4_bind_conn_to_session bind_conn_to_session;
470 struct nfsd4_create_session create_session;
471 struct nfsd4_destroy_session destroy_session;
472 struct nfsd4_sequence sequence;
473 struct nfsd4_reclaim_complete reclaim_complete;
474 struct nfsd4_test_stateid test_stateid;
475 struct nfsd4_free_stateid free_stateid;
477 struct nfs4_replay * replay;
480 bool nfsd4_cache_this_op(struct nfsd4_op *);
482 struct nfsd4_compoundargs {
483 /* scratch variables for XDR decode */
486 struct page ** pagelist;
492 void (*release)(const void *);
496 struct svc_rqst *rqstp;
502 struct nfsd4_op *ops;
503 struct nfsd4_op iops[8];
507 struct nfsd4_compoundres {
508 /* scratch variables for XDR encode */
511 struct xdr_buf * xbuf;
512 struct svc_rqst * rqstp;
517 __be32 * tagp; /* tag, opcount encode location */
518 struct nfsd4_compound_state cstate;
521 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
523 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
524 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
527 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
529 return !(resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
530 || nfsd4_is_solo_sequence(resp);
533 static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
535 struct nfsd4_compoundres *resp = rqstp->rq_resp;
536 struct nfsd4_compoundargs *argp = rqstp->rq_argp;
538 return argp->opcnt == resp->opcnt;
541 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
544 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
546 BUG_ON(!fhp->fh_pre_saved);
547 cinfo->atomic = fhp->fh_post_saved;
548 cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
550 cinfo->before_change = fhp->fh_pre_change;
551 cinfo->after_change = fhp->fh_post_change;
552 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
553 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
554 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
555 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
559 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
560 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
561 struct nfsd4_compoundargs *);
562 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
563 struct nfsd4_compoundres *);
564 __be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
565 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
566 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
567 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
568 struct dentry *dentry, __be32 **buffer, int countp,
569 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
570 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
571 struct nfsd4_compound_state *,
572 struct nfsd4_setclientid *setclid);
573 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
574 struct nfsd4_compound_state *,
575 struct nfsd4_setclientid_confirm *setclientid_confirm);
576 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
577 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
578 struct nfsd4_sequence *seq);
579 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
580 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
581 extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_backchannel_ctl *);
582 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
583 extern __be32 nfsd4_create_session(struct svc_rqst *,
584 struct nfsd4_compound_state *,
585 struct nfsd4_create_session *);
586 extern __be32 nfsd4_sequence(struct svc_rqst *,
587 struct nfsd4_compound_state *,
588 struct nfsd4_sequence *);
589 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
590 struct nfsd4_compound_state *,
591 struct nfsd4_destroy_session *);
592 extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_destroy_clientid *);
593 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
594 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
595 struct nfsd4_open *open, struct nfsd_net *nn);
596 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
597 struct svc_fh *current_fh, struct nfsd4_open *open);
598 extern void nfsd4_cleanup_open_state(struct nfsd4_open *open, __be32 status);
599 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
600 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
601 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
602 struct nfsd4_compound_state *,
603 struct nfsd4_close *close);
604 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
605 struct nfsd4_compound_state *,
606 struct nfsd4_open_downgrade *od);
607 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
608 struct nfsd4_lock *lock);
609 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
610 struct nfsd4_compound_state *,
611 struct nfsd4_lockt *lockt);
612 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
613 struct nfsd4_compound_state *,
614 struct nfsd4_locku *locku);
616 nfsd4_release_lockowner(struct svc_rqst *rqstp,
617 struct nfsd4_compound_state *,
618 struct nfsd4_release_lockowner *rlockowner);
619 extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp);
620 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
621 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
622 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
623 struct nfsd4_compound_state *, clientid_t *clid);
624 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
625 struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid);
626 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
627 struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid);
628 extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);