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 */
84 struct nfs4_stateowner * cl_stateowner; /* response */
88 u64 co_offset; /* request */
89 u32 co_count; /* request */
90 nfs4_verifier co_verf; /* response */
94 u32 cr_namelen; /* request */
95 char * cr_name; /* request */
96 u32 cr_type; /* request */
105 } dev; /* NF4BLK, NF4CHR */
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;
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
117 struct nfsd4_delegreturn {
118 stateid_t dr_stateid;
121 struct nfsd4_getattr {
122 u32 ga_bmval[3]; /* request */
123 struct svc_fh *ga_fhp; /* response */
127 u32 li_namelen; /* request */
128 char * li_name; /* request */
129 struct nfsd4_change_info li_cinfo; /* response */
132 struct nfsd4_lock_denied {
133 clientid_t ld_clientid;
134 struct nfs4_stateowner *ld_sop;
143 u32 lk_reclaim; /* boolean */
150 stateid_t open_stateid;
153 struct xdr_netobj owner;
156 stateid_t lock_stateid;
166 struct nfsd4_lock_denied denied;
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;
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
180 #define lk_rflags u.ok.rflags
181 #define lk_resp_stateid u.ok.stateid
182 #define lk_denied u.denied
187 clientid_t lt_clientid;
188 struct xdr_netobj lt_owner;
191 struct nfs4_stateowner * lt_stateowner;
192 struct nfsd4_lock_denied lt_denied;
199 stateid_t lu_stateid;
202 struct nfs4_stateowner *lu_stateowner;
206 struct nfsd4_lookup {
207 u32 lo_len; /* request */
208 char * lo_name; /* request */
212 u32 pf_fhlen; /* request */
213 char *pf_fhval; /* request */
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;
239 #define op_iattr iattr
242 struct 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 */
249 struct nfsd4_open_downgrade {
250 stateid_t od_stateid;
254 struct nfs4_stateowner *od_stateowner;
259 stateid_t rd_stateid; /* request */
260 u64 rd_offset; /* request */
261 u32 rd_length; /* request */
263 struct file *rd_filp;
265 struct svc_rqst *rd_rqstp; /* response */
266 struct svc_fh * rd_fhp; /* response */
269 struct 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 */
278 struct readdir_cd common;
284 struct nfsd4_release_lockowner {
285 clientid_t rl_clientid;
286 struct xdr_netobj rl_owner;
288 struct nfsd4_readlink {
289 struct svc_rqst *rl_rqstp; /* request */
290 struct svc_fh * rl_fhp; /* request */
293 struct nfsd4_remove {
294 u32 rm_namelen; /* request */
295 char * rm_name; /* request */
296 struct nfsd4_change_info rm_cinfo; /* response */
299 struct 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 */
308 struct nfsd4_secinfo {
309 u32 si_namelen; /* request */
310 char *si_name; /* request */
311 struct svc_export *si_exp; /* response */
314 struct nfsd4_secinfo_no_name {
315 u32 sin_style; /* request */
316 struct svc_export *sin_exp; /* response */
319 struct nfsd4_setattr {
320 stateid_t sa_stateid; /* request */
321 u32 sa_bmval[3]; /* request */
322 struct iattr sa_iattr; /* request */
323 struct nfs4_acl *sa_acl;
326 struct nfsd4_setclientid {
327 nfs4_verifier se_verf; /* request */
328 u32 se_namelen; /* request */
329 char * se_name; /* request */
330 u32 se_callback_prog; /* request */
331 u32 se_callback_netid_len; /* request */
332 char * se_callback_netid_val; /* request */
333 u32 se_callback_addr_len; /* request */
334 char * se_callback_addr_val; /* request */
335 u32 se_callback_ident; /* request */
336 clientid_t se_clientid; /* response */
337 nfs4_verifier se_confirm; /* response */
340 struct nfsd4_setclientid_confirm {
341 clientid_t sc_clientid;
342 nfs4_verifier sc_confirm;
345 /* also used for NVERIFY */
346 struct nfsd4_verify {
347 u32 ve_bmval[3]; /* request */
348 u32 ve_attrlen; /* request */
349 char * ve_attrval; /* request */
353 stateid_t wr_stateid; /* request */
354 u64 wr_offset; /* request */
355 u32 wr_stable_how; /* request */
356 u32 wr_buflen; /* request */
359 u32 wr_bytes_written; /* response */
360 u32 wr_how_written; /* response */
361 nfs4_verifier wr_verifier; /* response */
364 struct nfsd4_exchange_id {
365 nfs4_verifier verifier;
366 struct xdr_netobj clname;
373 struct nfsd4_sequence {
374 struct nfs4_sessionid sessionid; /* request/response */
375 u32 seqid; /* request/response */
376 u32 slotid; /* request/response */
377 u32 maxslots; /* request/response */
378 u32 cachethis; /* request */
380 u32 target_maxslots; /* response */
381 u32 status_flags; /* response */
385 struct nfsd4_destroy_session {
386 struct nfs4_sessionid sessionid;
389 struct nfsd4_reclaim_complete {
397 struct nfsd4_access access;
398 struct nfsd4_close close;
399 struct nfsd4_commit commit;
400 struct nfsd4_create create;
401 struct nfsd4_delegreturn delegreturn;
402 struct nfsd4_getattr getattr;
403 struct svc_fh * getfh;
404 struct nfsd4_link link;
405 struct nfsd4_lock lock;
406 struct nfsd4_lockt lockt;
407 struct nfsd4_locku locku;
408 struct nfsd4_lookup lookup;
409 struct nfsd4_verify nverify;
410 struct nfsd4_open open;
411 struct nfsd4_open_confirm open_confirm;
412 struct nfsd4_open_downgrade open_downgrade;
413 struct nfsd4_putfh putfh;
414 struct nfsd4_read read;
415 struct nfsd4_readdir readdir;
416 struct nfsd4_readlink readlink;
417 struct nfsd4_remove remove;
418 struct nfsd4_rename rename;
420 struct nfsd4_secinfo secinfo;
421 struct nfsd4_setattr setattr;
422 struct nfsd4_setclientid setclientid;
423 struct nfsd4_setclientid_confirm setclientid_confirm;
424 struct nfsd4_verify verify;
425 struct nfsd4_write write;
426 struct nfsd4_release_lockowner release_lockowner;
429 struct nfsd4_exchange_id exchange_id;
430 struct nfsd4_create_session create_session;
431 struct nfsd4_destroy_session destroy_session;
432 struct nfsd4_sequence sequence;
433 struct nfsd4_reclaim_complete reclaim_complete;
435 struct nfs4_replay * replay;
438 struct nfsd4_compoundargs {
439 /* scratch variables for XDR decode */
442 struct page ** pagelist;
448 void (*release)(const void *);
452 struct svc_rqst *rqstp;
458 struct nfsd4_op *ops;
459 struct nfsd4_op iops[8];
462 struct nfsd4_compoundres {
463 /* scratch variables for XDR encode */
466 struct xdr_buf * xbuf;
467 struct svc_rqst * rqstp;
472 __be32 * tagp; /* tag, opcount encode location */
473 struct nfsd4_compound_state cstate;
476 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
478 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
479 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
482 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
484 return !resp->cstate.slot->sl_cachethis || nfsd4_is_solo_sequence(resp);
487 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
490 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
492 BUG_ON(!fhp->fh_pre_saved);
493 cinfo->atomic = fhp->fh_post_saved;
494 cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
496 cinfo->before_change = fhp->fh_pre_change;
497 cinfo->after_change = fhp->fh_post_change;
498 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
499 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
500 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
501 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
505 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
506 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
507 struct nfsd4_compoundargs *);
508 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
509 struct nfsd4_compoundres *);
510 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
511 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
512 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
513 struct dentry *dentry, __be32 *buffer, int *countp,
514 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
515 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
516 struct nfsd4_compound_state *,
517 struct nfsd4_setclientid *setclid);
518 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
519 struct nfsd4_compound_state *,
520 struct nfsd4_setclientid_confirm *setclientid_confirm);
521 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
522 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
523 struct nfsd4_sequence *seq);
524 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
525 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
526 extern __be32 nfsd4_create_session(struct svc_rqst *,
527 struct nfsd4_compound_state *,
528 struct nfsd4_create_session *);
529 extern __be32 nfsd4_sequence(struct svc_rqst *,
530 struct nfsd4_compound_state *,
531 struct nfsd4_sequence *);
532 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
533 struct nfsd4_compound_state *,
534 struct nfsd4_destroy_session *);
535 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
536 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
537 struct nfsd4_open *open);
538 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
539 struct svc_fh *current_fh, struct nfsd4_open *open);
540 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
541 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
542 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
543 struct nfsd4_compound_state *,
544 struct nfsd4_close *close);
545 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
546 struct nfsd4_compound_state *,
547 struct nfsd4_open_downgrade *od);
548 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
549 struct nfsd4_lock *lock);
550 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
551 struct nfsd4_compound_state *,
552 struct nfsd4_lockt *lockt);
553 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
554 struct nfsd4_compound_state *,
555 struct nfsd4_locku *locku);
557 nfsd4_release_lockowner(struct svc_rqst *rqstp,
558 struct nfsd4_compound_state *,
559 struct nfsd4_release_lockowner *rlockowner);
560 extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs *);
561 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
562 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
563 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
564 struct nfsd4_compound_state *, clientid_t *clid);