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 #include <linux/nfs4.h>
44 #define NFSD4_MAX_TAGLEN 128
45 #define XDR_LEN(n) (((n) + 3) & ~3)
47 struct nfsd4_compound_state
{
48 struct svc_fh current_fh
;
49 struct svc_fh save_fh
;
50 struct nfs4_stateowner
*replay_owner
;
51 /* For sessions DRC */
52 struct nfsd4_session
*session
;
53 struct nfsd4_slot
*slot
;
59 struct nfsd4_change_info
{
62 u32 before_ctime_nsec
;
68 u32 ac_req_access
; /* request */
69 u32 ac_supported
; /* response */
70 u32 ac_resp_access
; /* response */
74 u32 cl_seqid
; /* request */
75 stateid_t cl_stateid
; /* request+response */
76 struct nfs4_stateowner
* cl_stateowner
; /* response */
80 u64 co_offset
; /* request */
81 u32 co_count
; /* request */
82 nfs4_verifier co_verf
; /* response */
86 u32 cr_namelen
; /* request */
87 char * cr_name
; /* request */
88 u32 cr_type
; /* request */
97 } dev
; /* NF4BLK, NF4CHR */
99 u32 cr_bmval
[2]; /* request */
100 struct iattr cr_iattr
; /* request */
101 struct nfsd4_change_info cr_cinfo
; /* response */
102 struct nfs4_acl
*cr_acl
;
104 #define cr_linklen u.link.namelen
105 #define cr_linkname u.link.name
106 #define cr_specdata1 u.dev.specdata1
107 #define cr_specdata2 u.dev.specdata2
109 struct nfsd4_delegreturn
{
110 stateid_t dr_stateid
;
113 struct nfsd4_getattr
{
114 u32 ga_bmval
[2]; /* request */
115 struct svc_fh
*ga_fhp
; /* response */
119 u32 li_namelen
; /* request */
120 char * li_name
; /* request */
121 struct nfsd4_change_info li_cinfo
; /* response */
124 struct nfsd4_lock_denied
{
125 clientid_t ld_clientid
;
126 struct nfs4_stateowner
*ld_sop
;
135 u32 lk_reclaim
; /* boolean */
142 stateid_t open_stateid
;
145 struct xdr_netobj owner
;
148 stateid_t lock_stateid
;
158 struct nfsd4_lock_denied denied
;
160 /* The lk_replay_owner is the open owner in the open_to_lock_owner
161 * case and the lock owner otherwise: */
162 struct nfs4_stateowner
*lk_replay_owner
;
164 #define lk_new_open_seqid v.new.open_seqid
165 #define lk_new_open_stateid v.new.open_stateid
166 #define lk_new_lock_seqid v.new.lock_seqid
167 #define lk_new_clientid v.new.clientid
168 #define lk_new_owner v.new.owner
169 #define lk_old_lock_stateid v.old.lock_stateid
170 #define lk_old_lock_seqid v.old.lock_seqid
172 #define lk_rflags u.ok.rflags
173 #define lk_resp_stateid u.ok.stateid
174 #define lk_denied u.denied
179 clientid_t lt_clientid
;
180 struct xdr_netobj lt_owner
;
183 struct nfs4_stateowner
* lt_stateowner
;
184 struct nfsd4_lock_denied lt_denied
;
191 stateid_t lu_stateid
;
194 struct nfs4_stateowner
*lu_stateowner
;
198 struct nfsd4_lookup
{
199 u32 lo_len
; /* request */
200 char * lo_name
; /* request */
204 u32 pf_fhlen
; /* request */
205 char *pf_fhval
; /* request */
209 u32 op_claim_type
; /* request */
210 struct xdr_netobj op_fname
; /* request - everything but CLAIM_PREV */
211 u32 op_delegate_type
; /* request - CLAIM_PREV only */
212 stateid_t op_delegate_stateid
; /* request - response */
213 u32 op_create
; /* request */
214 u32 op_createmode
; /* request */
215 u32 op_bmval
[2]; /* request */
216 union { /* request */
217 struct iattr iattr
; /* UNCHECKED4,GUARDED4 */
218 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_stateowner
*op_stateowner
; /* used during processing */
231 struct nfs4_acl
*op_acl
;
233 #define op_iattr u.iattr
234 #define op_verf u.verf
236 struct nfsd4_open_confirm
{
237 stateid_t oc_req_stateid
/* request */;
238 u32 oc_seqid
/* request */;
239 stateid_t oc_resp_stateid
/* response */;
240 struct nfs4_stateowner
* oc_stateowner
; /* response */
243 struct nfsd4_open_downgrade
{
244 stateid_t od_stateid
;
248 struct nfs4_stateowner
*od_stateowner
;
253 stateid_t rd_stateid
; /* request */
254 u64 rd_offset
; /* request */
255 u32 rd_length
; /* request */
257 struct file
*rd_filp
;
259 struct svc_rqst
*rd_rqstp
; /* response */
260 struct svc_fh
* rd_fhp
; /* response */
263 struct nfsd4_readdir
{
264 u64 rd_cookie
; /* request */
265 nfs4_verifier rd_verf
; /* request */
266 u32 rd_dircount
; /* request */
267 u32 rd_maxcount
; /* request */
268 u32 rd_bmval
[2]; /* request */
269 struct svc_rqst
*rd_rqstp
; /* response */
270 struct svc_fh
* rd_fhp
; /* response */
272 struct readdir_cd common
;
278 struct nfsd4_release_lockowner
{
279 clientid_t rl_clientid
;
280 struct xdr_netobj rl_owner
;
282 struct nfsd4_readlink
{
283 struct svc_rqst
*rl_rqstp
; /* request */
284 struct svc_fh
* rl_fhp
; /* request */
287 struct nfsd4_remove
{
288 u32 rm_namelen
; /* request */
289 char * rm_name
; /* request */
290 struct nfsd4_change_info rm_cinfo
; /* response */
293 struct nfsd4_rename
{
294 u32 rn_snamelen
; /* request */
295 char * rn_sname
; /* request */
296 u32 rn_tnamelen
; /* request */
297 char * rn_tname
; /* request */
298 struct nfsd4_change_info rn_sinfo
; /* response */
299 struct nfsd4_change_info rn_tinfo
; /* response */
302 struct nfsd4_secinfo
{
303 u32 si_namelen
; /* request */
304 char *si_name
; /* request */
305 struct svc_export
*si_exp
; /* response */
308 struct nfsd4_setattr
{
309 stateid_t sa_stateid
; /* request */
310 u32 sa_bmval
[2]; /* request */
311 struct iattr sa_iattr
; /* request */
312 struct nfs4_acl
*sa_acl
;
315 struct nfsd4_setclientid
{
316 nfs4_verifier se_verf
; /* request */
317 u32 se_namelen
; /* request */
318 char * se_name
; /* request */
319 u32 se_callback_prog
; /* request */
320 u32 se_callback_netid_len
; /* request */
321 char * se_callback_netid_val
; /* request */
322 u32 se_callback_addr_len
; /* request */
323 char * se_callback_addr_val
; /* request */
324 u32 se_callback_ident
; /* request */
325 clientid_t se_clientid
; /* response */
326 nfs4_verifier se_confirm
; /* response */
329 struct nfsd4_setclientid_confirm
{
330 clientid_t sc_clientid
;
331 nfs4_verifier sc_confirm
;
334 /* also used for NVERIFY */
335 struct nfsd4_verify
{
336 u32 ve_bmval
[2]; /* request */
337 u32 ve_attrlen
; /* request */
338 char * ve_attrval
; /* request */
342 stateid_t wr_stateid
; /* request */
343 u64 wr_offset
; /* request */
344 u32 wr_stable_how
; /* request */
345 u32 wr_buflen
; /* request */
348 u32 wr_bytes_written
; /* response */
349 u32 wr_how_written
; /* response */
350 nfs4_verifier wr_verifier
; /* response */
353 struct nfsd4_exchange_id
{
354 nfs4_verifier verifier
;
355 struct xdr_netobj clname
;
362 struct nfsd4_channel_attrs
{
373 struct nfsd4_create_session
{
375 struct nfs4_sessionid sessionid
;
378 struct nfsd4_channel_attrs fore_channel
;
379 struct nfsd4_channel_attrs back_channel
;
385 struct nfsd4_sequence
{
386 struct nfs4_sessionid sessionid
; /* request/response */
387 u32 seqid
; /* request/response */
388 u32 slotid
; /* request/response */
389 u32 maxslots
; /* request/response */
390 u32 cachethis
; /* request */
392 u32 target_maxslots
; /* response */
393 u32 status_flags
; /* response */
397 struct nfsd4_destroy_session
{
405 struct nfsd4_access access
;
406 struct nfsd4_close close
;
407 struct nfsd4_commit commit
;
408 struct nfsd4_create create
;
409 struct nfsd4_delegreturn delegreturn
;
410 struct nfsd4_getattr getattr
;
411 struct svc_fh
* getfh
;
412 struct nfsd4_link link
;
413 struct nfsd4_lock lock
;
414 struct nfsd4_lockt lockt
;
415 struct nfsd4_locku locku
;
416 struct nfsd4_lookup lookup
;
417 struct nfsd4_verify nverify
;
418 struct nfsd4_open open
;
419 struct nfsd4_open_confirm open_confirm
;
420 struct nfsd4_open_downgrade open_downgrade
;
421 struct nfsd4_putfh putfh
;
422 struct nfsd4_read read
;
423 struct nfsd4_readdir readdir
;
424 struct nfsd4_readlink readlink
;
425 struct nfsd4_remove remove
;
426 struct nfsd4_rename rename
;
428 struct nfsd4_secinfo secinfo
;
429 struct nfsd4_setattr setattr
;
430 struct nfsd4_setclientid setclientid
;
431 struct nfsd4_setclientid_confirm setclientid_confirm
;
432 struct nfsd4_verify verify
;
433 struct nfsd4_write write
;
434 struct nfsd4_release_lockowner release_lockowner
;
437 struct nfsd4_exchange_id exchange_id
;
438 struct nfsd4_create_session create_session
;
439 struct nfsd4_destroy_session destroy_session
;
440 struct nfsd4_sequence sequence
;
442 struct nfs4_replay
* replay
;
445 struct nfsd4_compoundargs
{
446 /* scratch variables for XDR decode */
449 struct page
** pagelist
;
455 void (*release
)(const void *);
459 struct svc_rqst
*rqstp
;
465 struct nfsd4_op
*ops
;
466 struct nfsd4_op iops
[8];
469 struct nfsd4_compoundres
{
470 /* scratch variables for XDR encode */
473 struct xdr_buf
* xbuf
;
474 struct svc_rqst
* rqstp
;
479 __be32
* tagp
; /* tag, opcount encode location */
480 struct nfsd4_compound_state cstate
;
483 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
486 set_change_info(struct nfsd4_change_info
*cinfo
, struct svc_fh
*fhp
)
488 BUG_ON(!fhp
->fh_pre_saved
|| !fhp
->fh_post_saved
);
490 cinfo
->before_ctime_sec
= fhp
->fh_pre_ctime
.tv_sec
;
491 cinfo
->before_ctime_nsec
= fhp
->fh_pre_ctime
.tv_nsec
;
492 cinfo
->after_ctime_sec
= fhp
->fh_post_attr
.ctime
.tv_sec
;
493 cinfo
->after_ctime_nsec
= fhp
->fh_post_attr
.ctime
.tv_nsec
;
496 int nfs4svc_encode_voidres(struct svc_rqst
*, __be32
*, void *);
497 int nfs4svc_decode_compoundargs(struct svc_rqst
*, __be32
*,
498 struct nfsd4_compoundargs
*);
499 int nfs4svc_encode_compoundres(struct svc_rqst
*, __be32
*,
500 struct nfsd4_compoundres
*);
501 void nfsd4_encode_operation(struct nfsd4_compoundres
*, struct nfsd4_op
*);
502 void nfsd4_encode_replay(struct nfsd4_compoundres
*resp
, struct nfsd4_op
*op
);
503 __be32
nfsd4_encode_fattr(struct svc_fh
*fhp
, struct svc_export
*exp
,
504 struct dentry
*dentry
, __be32
*buffer
, int *countp
,
505 u32
*bmval
, struct svc_rqst
*, int ignore_crossmnt
);
506 extern __be32
nfsd4_setclientid(struct svc_rqst
*rqstp
,
507 struct nfsd4_compound_state
*,
508 struct nfsd4_setclientid
*setclid
);
509 extern __be32
nfsd4_setclientid_confirm(struct svc_rqst
*rqstp
,
510 struct nfsd4_compound_state
*,
511 struct nfsd4_setclientid_confirm
*setclientid_confirm
);
512 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres
*resp
);
513 extern __be32
nfsd4_replay_cache_entry(struct nfsd4_compoundres
*resp
);
514 extern __be32
nfsd4_exchange_id(struct svc_rqst
*rqstp
,
515 struct nfsd4_compound_state
*,
516 struct nfsd4_exchange_id
*);
517 extern __be32
nfsd4_create_session(struct svc_rqst
*,
518 struct nfsd4_compound_state
*,
519 struct nfsd4_create_session
*);
520 extern __be32
nfsd4_sequence(struct svc_rqst
*,
521 struct nfsd4_compound_state
*,
522 struct nfsd4_sequence
*);
523 extern __be32
nfsd4_destroy_session(struct svc_rqst
*,
524 struct nfsd4_compound_state
*,
525 struct nfsd4_destroy_session
*);
526 extern __be32
nfsd4_process_open1(struct nfsd4_open
*open
);
527 extern __be32
nfsd4_process_open2(struct svc_rqst
*rqstp
,
528 struct svc_fh
*current_fh
, struct nfsd4_open
*open
);
529 extern __be32
nfsd4_open_confirm(struct svc_rqst
*rqstp
,
530 struct nfsd4_compound_state
*, struct nfsd4_open_confirm
*oc
);
531 extern __be32
nfsd4_close(struct svc_rqst
*rqstp
,
532 struct nfsd4_compound_state
*,
533 struct nfsd4_close
*close
);
534 extern __be32
nfsd4_open_downgrade(struct svc_rqst
*rqstp
,
535 struct nfsd4_compound_state
*,
536 struct nfsd4_open_downgrade
*od
);
537 extern __be32
nfsd4_lock(struct svc_rqst
*rqstp
, struct nfsd4_compound_state
*,
538 struct nfsd4_lock
*lock
);
539 extern __be32
nfsd4_lockt(struct svc_rqst
*rqstp
,
540 struct nfsd4_compound_state
*,
541 struct nfsd4_lockt
*lockt
);
542 extern __be32
nfsd4_locku(struct svc_rqst
*rqstp
,
543 struct nfsd4_compound_state
*,
544 struct nfsd4_locku
*locku
);
546 nfsd4_release_lockowner(struct svc_rqst
*rqstp
,
547 struct nfsd4_compound_state
*,
548 struct nfsd4_release_lockowner
*rlockowner
);
549 extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs
*);
550 extern __be32
nfsd4_delegreturn(struct svc_rqst
*rqstp
,
551 struct nfsd4_compound_state
*, struct nfsd4_delegreturn
*dr
);
552 extern __be32
nfsd4_renew(struct svc_rqst
*rqstp
,
553 struct nfsd4_compound_state
*, clientid_t
*clid
);