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 #define CURRENT_STATE_ID_FLAG (1<<0)
47 #define SAVED_STATE_ID_FLAG (1<<1)
49 #define SET_STATE_ID(c, f) ((c)->sid_flags |= (f))
50 #define HAS_STATE_ID(c, f) ((c)->sid_flags & (f))
51 #define CLEAR_STATE_ID(c, f) ((c)->sid_flags &= ~(f))
53 struct nfsd4_compound_state
{
54 struct svc_fh current_fh
;
55 struct svc_fh save_fh
;
56 struct nfs4_stateowner
*replay_owner
;
57 /* For sessions DRC */
58 struct nfsd4_session
*session
;
59 struct nfsd4_slot
*slot
;
64 stateid_t current_stateid
;
65 stateid_t save_stateid
;
66 /* to indicate current and saved state id presents */
70 static inline bool nfsd4_has_session(struct nfsd4_compound_state
*cs
)
72 return cs
->slot
!= NULL
;
75 struct nfsd4_change_info
{
77 bool change_supported
;
79 u32 before_ctime_nsec
;
87 u32 ac_req_access
; /* request */
88 u32 ac_supported
; /* response */
89 u32 ac_resp_access
; /* response */
93 u32 cl_seqid
; /* request */
94 stateid_t cl_stateid
; /* request+response */
98 u64 co_offset
; /* request */
99 u32 co_count
; /* request */
100 nfs4_verifier co_verf
; /* response */
103 struct nfsd4_create
{
104 u32 cr_namelen
; /* request */
105 char * cr_name
; /* request */
106 u32 cr_type
; /* request */
107 union { /* request */
115 } dev
; /* NF4BLK, NF4CHR */
117 u32 cr_bmval
[3]; /* request */
118 struct iattr cr_iattr
; /* request */
119 struct nfsd4_change_info cr_cinfo
; /* response */
120 struct nfs4_acl
*cr_acl
;
122 #define cr_linklen u.link.namelen
123 #define cr_linkname u.link.name
124 #define cr_specdata1 u.dev.specdata1
125 #define cr_specdata2 u.dev.specdata2
127 struct nfsd4_delegreturn
{
128 stateid_t dr_stateid
;
131 struct nfsd4_getattr
{
132 u32 ga_bmval
[3]; /* request */
133 struct svc_fh
*ga_fhp
; /* response */
137 u32 li_namelen
; /* request */
138 char * li_name
; /* request */
139 struct nfsd4_change_info li_cinfo
; /* response */
142 struct nfsd4_lock_denied
{
143 clientid_t ld_clientid
;
144 struct xdr_netobj ld_owner
;
153 u32 lk_reclaim
; /* boolean */
160 stateid_t open_stateid
;
163 struct xdr_netobj owner
;
166 stateid_t lock_stateid
;
176 struct nfsd4_lock_denied denied
;
179 #define lk_new_open_seqid v.new.open_seqid
180 #define lk_new_open_stateid v.new.open_stateid
181 #define lk_new_lock_seqid v.new.lock_seqid
182 #define lk_new_clientid v.new.clientid
183 #define lk_new_owner v.new.owner
184 #define lk_old_lock_stateid v.old.lock_stateid
185 #define lk_old_lock_seqid v.old.lock_seqid
187 #define lk_resp_stateid u.ok.stateid
188 #define lk_denied u.denied
193 clientid_t lt_clientid
;
194 struct xdr_netobj lt_owner
;
197 struct nfsd4_lock_denied lt_denied
;
204 stateid_t lu_stateid
;
210 struct nfsd4_lookup
{
211 u32 lo_len
; /* request */
212 char * lo_name
; /* request */
216 u32 pf_fhlen
; /* request */
217 char *pf_fhval
; /* request */
221 u32 op_claim_type
; /* request */
222 struct xdr_netobj op_fname
; /* request - everything but CLAIM_PREV */
223 u32 op_delegate_type
; /* request - CLAIM_PREV only */
224 stateid_t op_delegate_stateid
; /* request - response */
225 u32 op_why_no_deleg
; /* response - DELEG_NONE_EXT only */
226 u32 op_create
; /* request */
227 u32 op_createmode
; /* request */
228 u32 op_bmval
[3]; /* request */
229 struct iattr iattr
; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
230 nfs4_verifier op_verf
__attribute__((aligned(32)));
232 clientid_t op_clientid
; /* request */
233 struct xdr_netobj op_owner
; /* request */
234 u32 op_seqid
; /* request */
235 u32 op_share_access
; /* request */
236 u32 op_share_deny
; /* request */
237 u32 op_deleg_want
; /* request */
238 stateid_t op_stateid
; /* response */
239 __be32 op_xdr_error
; /* see nfsd4_open_omfg() */
240 u32 op_recall
; /* recall */
241 struct nfsd4_change_info op_cinfo
; /* response */
242 u32 op_rflags
; /* response */
243 bool op_truncate
; /* used during processing */
244 bool op_created
; /* used during processing */
245 struct nfs4_openowner
*op_openowner
; /* used during processing */
246 struct nfs4_file
*op_file
; /* used during processing */
247 struct nfs4_ol_stateid
*op_stp
; /* used during processing */
248 struct nfs4_acl
*op_acl
;
250 #define op_iattr iattr
252 struct nfsd4_open_confirm
{
253 stateid_t oc_req_stateid
/* request */;
254 u32 oc_seqid
/* request */;
255 stateid_t oc_resp_stateid
/* response */;
258 struct nfsd4_open_downgrade
{
259 stateid_t od_stateid
;
261 u32 od_share_access
; /* request */
262 u32 od_deleg_want
; /* request */
263 u32 od_share_deny
; /* request */
268 stateid_t rd_stateid
; /* request */
269 u64 rd_offset
; /* request */
270 u32 rd_length
; /* request */
272 struct file
*rd_filp
;
274 struct svc_rqst
*rd_rqstp
; /* response */
275 struct svc_fh
* rd_fhp
; /* response */
278 struct nfsd4_readdir
{
279 u64 rd_cookie
; /* request */
280 nfs4_verifier rd_verf
; /* request */
281 u32 rd_dircount
; /* request */
282 u32 rd_maxcount
; /* request */
283 u32 rd_bmval
[3]; /* request */
284 struct svc_rqst
*rd_rqstp
; /* response */
285 struct svc_fh
* rd_fhp
; /* response */
287 struct readdir_cd common
;
293 struct nfsd4_release_lockowner
{
294 clientid_t rl_clientid
;
295 struct xdr_netobj rl_owner
;
297 struct nfsd4_readlink
{
298 struct svc_rqst
*rl_rqstp
; /* request */
299 struct svc_fh
* rl_fhp
; /* request */
302 struct nfsd4_remove
{
303 u32 rm_namelen
; /* request */
304 char * rm_name
; /* request */
305 struct nfsd4_change_info rm_cinfo
; /* response */
308 struct nfsd4_rename
{
309 u32 rn_snamelen
; /* request */
310 char * rn_sname
; /* request */
311 u32 rn_tnamelen
; /* request */
312 char * rn_tname
; /* request */
313 struct nfsd4_change_info rn_sinfo
; /* response */
314 struct nfsd4_change_info rn_tinfo
; /* response */
317 struct nfsd4_secinfo
{
318 u32 si_namelen
; /* request */
319 char *si_name
; /* request */
320 struct svc_export
*si_exp
; /* response */
323 struct nfsd4_secinfo_no_name
{
324 u32 sin_style
; /* request */
325 struct svc_export
*sin_exp
; /* response */
328 struct nfsd4_setattr
{
329 stateid_t sa_stateid
; /* request */
330 u32 sa_bmval
[3]; /* request */
331 struct iattr sa_iattr
; /* request */
332 struct nfs4_acl
*sa_acl
;
335 struct nfsd4_setclientid
{
336 nfs4_verifier se_verf
; /* request */
337 struct xdr_netobj se_name
;
338 u32 se_callback_prog
; /* request */
339 u32 se_callback_netid_len
; /* request */
340 char * se_callback_netid_val
; /* request */
341 u32 se_callback_addr_len
; /* request */
342 char * se_callback_addr_val
; /* request */
343 u32 se_callback_ident
; /* request */
344 clientid_t se_clientid
; /* response */
345 nfs4_verifier se_confirm
; /* response */
348 struct nfsd4_setclientid_confirm
{
349 clientid_t sc_clientid
;
350 nfs4_verifier sc_confirm
;
353 struct nfsd4_saved_compoundargs
{
357 struct page
**pagelist
;
360 struct nfsd4_test_stateid_id
{
362 stateid_t ts_id_stateid
;
363 struct list_head ts_id_list
;
366 struct nfsd4_test_stateid
{
368 struct list_head ts_stateid_list
;
371 struct nfsd4_free_stateid
{
372 stateid_t fr_stateid
; /* request */
373 __be32 fr_status
; /* response */
376 /* also used for NVERIFY */
377 struct nfsd4_verify
{
378 u32 ve_bmval
[3]; /* request */
379 u32 ve_attrlen
; /* request */
380 char * ve_attrval
; /* request */
384 stateid_t wr_stateid
; /* request */
385 u64 wr_offset
; /* request */
386 u32 wr_stable_how
; /* request */
387 u32 wr_buflen
; /* request */
389 struct page
** wr_pagelist
; /* request */
391 u32 wr_bytes_written
; /* response */
392 u32 wr_how_written
; /* response */
393 nfs4_verifier wr_verifier
; /* response */
396 struct nfsd4_exchange_id
{
397 nfs4_verifier verifier
;
398 struct xdr_netobj clname
;
405 struct nfsd4_sequence
{
406 struct nfs4_sessionid sessionid
; /* request/response */
407 u32 seqid
; /* request/response */
408 u32 slotid
; /* request/response */
409 u32 maxslots
; /* request/response */
410 u32 cachethis
; /* request */
412 u32 target_maxslots
; /* response */
414 u32 status_flags
; /* response */
417 struct nfsd4_destroy_session
{
418 struct nfs4_sessionid sessionid
;
421 struct nfsd4_destroy_clientid
{
425 struct nfsd4_reclaim_complete
{
433 struct nfsd4_access access
;
434 struct nfsd4_close close
;
435 struct nfsd4_commit commit
;
436 struct nfsd4_create create
;
437 struct nfsd4_delegreturn delegreturn
;
438 struct nfsd4_getattr getattr
;
439 struct svc_fh
* getfh
;
440 struct nfsd4_link link
;
441 struct nfsd4_lock lock
;
442 struct nfsd4_lockt lockt
;
443 struct nfsd4_locku locku
;
444 struct nfsd4_lookup lookup
;
445 struct nfsd4_verify nverify
;
446 struct nfsd4_open open
;
447 struct nfsd4_open_confirm open_confirm
;
448 struct nfsd4_open_downgrade open_downgrade
;
449 struct nfsd4_putfh putfh
;
450 struct nfsd4_read read
;
451 struct nfsd4_readdir readdir
;
452 struct nfsd4_readlink readlink
;
453 struct nfsd4_remove remove
;
454 struct nfsd4_rename rename
;
456 struct nfsd4_secinfo secinfo
;
457 struct nfsd4_setattr setattr
;
458 struct nfsd4_setclientid setclientid
;
459 struct nfsd4_setclientid_confirm setclientid_confirm
;
460 struct nfsd4_verify verify
;
461 struct nfsd4_write write
;
462 struct nfsd4_release_lockowner release_lockowner
;
465 struct nfsd4_exchange_id exchange_id
;
466 struct nfsd4_backchannel_ctl backchannel_ctl
;
467 struct nfsd4_bind_conn_to_session bind_conn_to_session
;
468 struct nfsd4_create_session create_session
;
469 struct nfsd4_destroy_session destroy_session
;
470 struct nfsd4_sequence sequence
;
471 struct nfsd4_reclaim_complete reclaim_complete
;
472 struct nfsd4_test_stateid test_stateid
;
473 struct nfsd4_free_stateid free_stateid
;
475 struct nfs4_replay
* replay
;
478 bool nfsd4_cache_this_op(struct nfsd4_op
*);
480 struct nfsd4_compoundargs
{
481 /* scratch variables for XDR decode */
484 struct page
** pagelist
;
490 void (*release
)(const void *);
494 struct svc_rqst
*rqstp
;
500 struct nfsd4_op
*ops
;
501 struct nfsd4_op iops
[8];
505 struct nfsd4_compoundres
{
506 /* scratch variables for XDR encode */
509 struct xdr_buf
* xbuf
;
510 struct svc_rqst
* rqstp
;
515 __be32
* tagp
; /* tag, opcount encode location */
516 struct nfsd4_compound_state cstate
;
519 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres
*resp
)
521 struct nfsd4_compoundargs
*args
= resp
->rqstp
->rq_argp
;
522 return resp
->opcnt
== 1 && args
->ops
[0].opnum
== OP_SEQUENCE
;
525 static inline bool nfsd4_not_cached(struct nfsd4_compoundres
*resp
)
527 return !(resp
->cstate
.slot
->sl_flags
& NFSD4_SLOT_CACHETHIS
)
528 || nfsd4_is_solo_sequence(resp
);
531 static inline bool nfsd4_last_compound_op(struct svc_rqst
*rqstp
)
533 struct nfsd4_compoundres
*resp
= rqstp
->rq_resp
;
534 struct nfsd4_compoundargs
*argp
= rqstp
->rq_argp
;
536 return argp
->opcnt
== resp
->opcnt
;
539 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
542 set_change_info(struct nfsd4_change_info
*cinfo
, struct svc_fh
*fhp
)
544 BUG_ON(!fhp
->fh_pre_saved
);
545 cinfo
->atomic
= fhp
->fh_post_saved
;
546 cinfo
->change_supported
= IS_I_VERSION(fhp
->fh_dentry
->d_inode
);
548 cinfo
->before_change
= fhp
->fh_pre_change
;
549 cinfo
->after_change
= fhp
->fh_post_change
;
550 cinfo
->before_ctime_sec
= fhp
->fh_pre_ctime
.tv_sec
;
551 cinfo
->before_ctime_nsec
= fhp
->fh_pre_ctime
.tv_nsec
;
552 cinfo
->after_ctime_sec
= fhp
->fh_post_attr
.ctime
.tv_sec
;
553 cinfo
->after_ctime_nsec
= fhp
->fh_post_attr
.ctime
.tv_nsec
;
557 int nfs4svc_encode_voidres(struct svc_rqst
*, __be32
*, void *);
558 int nfs4svc_decode_compoundargs(struct svc_rqst
*, __be32
*,
559 struct nfsd4_compoundargs
*);
560 int nfs4svc_encode_compoundres(struct svc_rqst
*, __be32
*,
561 struct nfsd4_compoundres
*);
562 __be32
nfsd4_check_resp_size(struct nfsd4_compoundres
*, u32
);
563 void nfsd4_encode_operation(struct nfsd4_compoundres
*, struct nfsd4_op
*);
564 void nfsd4_encode_replay(struct nfsd4_compoundres
*resp
, struct nfsd4_op
*op
);
565 __be32
nfsd4_encode_fattr(struct svc_fh
*fhp
, struct svc_export
*exp
,
566 struct dentry
*dentry
, __be32
**buffer
, int countp
,
567 u32
*bmval
, struct svc_rqst
*, int ignore_crossmnt
);
568 extern __be32
nfsd4_setclientid(struct svc_rqst
*rqstp
,
569 struct nfsd4_compound_state
*,
570 struct nfsd4_setclientid
*setclid
);
571 extern __be32
nfsd4_setclientid_confirm(struct svc_rqst
*rqstp
,
572 struct nfsd4_compound_state
*,
573 struct nfsd4_setclientid_confirm
*setclientid_confirm
);
574 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres
*resp
);
575 extern __be32
nfsd4_replay_cache_entry(struct nfsd4_compoundres
*resp
,
576 struct nfsd4_sequence
*seq
);
577 extern __be32
nfsd4_exchange_id(struct svc_rqst
*rqstp
,
578 struct nfsd4_compound_state
*, struct nfsd4_exchange_id
*);
579 extern __be32
nfsd4_backchannel_ctl(struct svc_rqst
*, struct nfsd4_compound_state
*, struct nfsd4_backchannel_ctl
*);
580 extern __be32
nfsd4_bind_conn_to_session(struct svc_rqst
*, struct nfsd4_compound_state
*, struct nfsd4_bind_conn_to_session
*);
581 extern __be32
nfsd4_create_session(struct svc_rqst
*,
582 struct nfsd4_compound_state
*,
583 struct nfsd4_create_session
*);
584 extern __be32
nfsd4_sequence(struct svc_rqst
*,
585 struct nfsd4_compound_state
*,
586 struct nfsd4_sequence
*);
587 extern __be32
nfsd4_destroy_session(struct svc_rqst
*,
588 struct nfsd4_compound_state
*,
589 struct nfsd4_destroy_session
*);
590 extern __be32
nfsd4_destroy_clientid(struct svc_rqst
*, struct nfsd4_compound_state
*, struct nfsd4_destroy_clientid
*);
591 __be32
nfsd4_reclaim_complete(struct svc_rqst
*, struct nfsd4_compound_state
*, struct nfsd4_reclaim_complete
*);
592 extern __be32
nfsd4_process_open1(struct nfsd4_compound_state
*,
593 struct nfsd4_open
*open
, struct nfsd_net
*nn
);
594 extern __be32
nfsd4_process_open2(struct svc_rqst
*rqstp
,
595 struct svc_fh
*current_fh
, struct nfsd4_open
*open
);
596 extern void nfsd4_cleanup_open_state(struct nfsd4_open
*open
, __be32 status
);
597 extern __be32
nfsd4_open_confirm(struct svc_rqst
*rqstp
,
598 struct nfsd4_compound_state
*, struct nfsd4_open_confirm
*oc
);
599 extern __be32
nfsd4_close(struct svc_rqst
*rqstp
,
600 struct nfsd4_compound_state
*,
601 struct nfsd4_close
*close
);
602 extern __be32
nfsd4_open_downgrade(struct svc_rqst
*rqstp
,
603 struct nfsd4_compound_state
*,
604 struct nfsd4_open_downgrade
*od
);
605 extern __be32
nfsd4_lock(struct svc_rqst
*rqstp
, struct nfsd4_compound_state
*,
606 struct nfsd4_lock
*lock
);
607 extern __be32
nfsd4_lockt(struct svc_rqst
*rqstp
,
608 struct nfsd4_compound_state
*,
609 struct nfsd4_lockt
*lockt
);
610 extern __be32
nfsd4_locku(struct svc_rqst
*rqstp
,
611 struct nfsd4_compound_state
*,
612 struct nfsd4_locku
*locku
);
614 nfsd4_release_lockowner(struct svc_rqst
*rqstp
,
615 struct nfsd4_compound_state
*,
616 struct nfsd4_release_lockowner
*rlockowner
);
617 extern int nfsd4_release_compoundargs(void *rq
, __be32
*p
, void *resp
);
618 extern __be32
nfsd4_delegreturn(struct svc_rqst
*rqstp
,
619 struct nfsd4_compound_state
*, struct nfsd4_delegreturn
*dr
);
620 extern __be32
nfsd4_renew(struct svc_rqst
*rqstp
,
621 struct nfsd4_compound_state
*, clientid_t
*clid
);
622 extern __be32
nfsd4_test_stateid(struct svc_rqst
*rqstp
,
623 struct nfsd4_compound_state
*, struct nfsd4_test_stateid
*test_stateid
);
624 extern __be32
nfsd4_free_stateid(struct svc_rqst
*rqstp
,
625 struct nfsd4_compound_state
*, struct nfsd4_free_stateid
*free_stateid
);
626 extern void nfsd4_bump_seqid(struct nfsd4_compound_state
*, __be32 nfserr
);