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
;
53 struct nfsd4_change_info
{
56 u32 before_ctime_nsec
;
62 u32 ac_req_access
; /* request */
63 u32 ac_supported
; /* response */
64 u32 ac_resp_access
; /* response */
68 u32 cl_seqid
; /* request */
69 stateid_t cl_stateid
; /* request+response */
70 struct nfs4_stateowner
* cl_stateowner
; /* response */
74 u64 co_offset
; /* request */
75 u32 co_count
; /* request */
76 nfs4_verifier co_verf
; /* response */
80 u32 cr_namelen
; /* request */
81 char * cr_name
; /* request */
82 u32 cr_type
; /* request */
91 } dev
; /* NF4BLK, NF4CHR */
93 u32 cr_bmval
[2]; /* request */
94 struct iattr cr_iattr
; /* request */
95 struct nfsd4_change_info cr_cinfo
; /* response */
96 struct nfs4_acl
*cr_acl
;
98 #define cr_linklen u.link.namelen
99 #define cr_linkname u.link.name
100 #define cr_specdata1 u.dev.specdata1
101 #define cr_specdata2 u.dev.specdata2
103 struct nfsd4_delegreturn
{
104 stateid_t dr_stateid
;
107 struct nfsd4_getattr
{
108 u32 ga_bmval
[2]; /* request */
109 struct svc_fh
*ga_fhp
; /* response */
113 u32 li_namelen
; /* request */
114 char * li_name
; /* request */
115 struct nfsd4_change_info li_cinfo
; /* response */
118 struct nfsd4_lock_denied
{
119 clientid_t ld_clientid
;
120 struct nfs4_stateowner
*ld_sop
;
129 u32 lk_reclaim
; /* boolean */
136 stateid_t open_stateid
;
139 struct xdr_netobj owner
;
142 stateid_t lock_stateid
;
152 struct nfsd4_lock_denied denied
;
154 /* The lk_replay_owner is the open owner in the open_to_lock_owner
155 * case and the lock owner otherwise: */
156 struct nfs4_stateowner
*lk_replay_owner
;
158 #define lk_new_open_seqid v.new.open_seqid
159 #define lk_new_open_stateid v.new.open_stateid
160 #define lk_new_lock_seqid v.new.lock_seqid
161 #define lk_new_clientid v.new.clientid
162 #define lk_new_owner v.new.owner
163 #define lk_old_lock_stateid v.old.lock_stateid
164 #define lk_old_lock_seqid v.old.lock_seqid
166 #define lk_rflags u.ok.rflags
167 #define lk_resp_stateid u.ok.stateid
168 #define lk_denied u.denied
173 clientid_t lt_clientid
;
174 struct xdr_netobj lt_owner
;
177 struct nfs4_stateowner
* lt_stateowner
;
178 struct nfsd4_lock_denied lt_denied
;
185 stateid_t lu_stateid
;
188 struct nfs4_stateowner
*lu_stateowner
;
192 struct nfsd4_lookup
{
193 u32 lo_len
; /* request */
194 char * lo_name
; /* request */
198 u32 pf_fhlen
; /* request */
199 char *pf_fhval
; /* request */
203 u32 op_claim_type
; /* request */
204 struct xdr_netobj op_fname
; /* request - everything but CLAIM_PREV */
205 u32 op_delegate_type
; /* request - CLAIM_PREV only */
206 stateid_t op_delegate_stateid
; /* request - response */
207 u32 op_create
; /* request */
208 u32 op_createmode
; /* request */
209 u32 op_bmval
[2]; /* request */
210 union { /* request */
211 struct iattr iattr
; /* UNCHECKED4,GUARDED4 */
212 nfs4_verifier verf
; /* EXCLUSIVE4 */
214 clientid_t op_clientid
; /* request */
215 struct xdr_netobj op_owner
; /* request */
216 u32 op_seqid
; /* request */
217 u32 op_share_access
; /* request */
218 u32 op_share_deny
; /* request */
219 stateid_t op_stateid
; /* response */
220 u32 op_recall
; /* recall */
221 struct nfsd4_change_info op_cinfo
; /* response */
222 u32 op_rflags
; /* response */
223 int op_truncate
; /* used during processing */
224 struct nfs4_stateowner
*op_stateowner
; /* used during processing */
225 struct nfs4_acl
*op_acl
;
227 #define op_iattr u.iattr
228 #define op_verf u.verf
230 struct nfsd4_open_confirm
{
231 stateid_t oc_req_stateid
/* request */;
232 u32 oc_seqid
/* request */;
233 stateid_t oc_resp_stateid
/* response */;
234 struct nfs4_stateowner
* oc_stateowner
; /* response */
237 struct nfsd4_open_downgrade
{
238 stateid_t od_stateid
;
242 struct nfs4_stateowner
*od_stateowner
;
247 stateid_t rd_stateid
; /* request */
248 u64 rd_offset
; /* request */
249 u32 rd_length
; /* request */
251 struct file
*rd_filp
;
253 struct svc_rqst
*rd_rqstp
; /* response */
254 struct svc_fh
* rd_fhp
; /* response */
257 struct nfsd4_readdir
{
258 u64 rd_cookie
; /* request */
259 nfs4_verifier rd_verf
; /* request */
260 u32 rd_dircount
; /* request */
261 u32 rd_maxcount
; /* request */
262 u32 rd_bmval
[2]; /* request */
263 struct svc_rqst
*rd_rqstp
; /* response */
264 struct svc_fh
* rd_fhp
; /* response */
266 struct readdir_cd common
;
272 struct nfsd4_release_lockowner
{
273 clientid_t rl_clientid
;
274 struct xdr_netobj rl_owner
;
276 struct nfsd4_readlink
{
277 struct svc_rqst
*rl_rqstp
; /* request */
278 struct svc_fh
* rl_fhp
; /* request */
281 struct nfsd4_remove
{
282 u32 rm_namelen
; /* request */
283 char * rm_name
; /* request */
284 struct nfsd4_change_info rm_cinfo
; /* response */
287 struct nfsd4_rename
{
288 u32 rn_snamelen
; /* request */
289 char * rn_sname
; /* request */
290 u32 rn_tnamelen
; /* request */
291 char * rn_tname
; /* request */
292 struct nfsd4_change_info rn_sinfo
; /* response */
293 struct nfsd4_change_info rn_tinfo
; /* response */
296 struct nfsd4_setattr
{
297 stateid_t sa_stateid
; /* request */
298 u32 sa_bmval
[2]; /* request */
299 struct iattr sa_iattr
; /* request */
300 struct nfs4_acl
*sa_acl
;
303 struct nfsd4_setclientid
{
304 nfs4_verifier se_verf
; /* request */
305 u32 se_namelen
; /* request */
306 char * se_name
; /* request */
307 u32 se_callback_prog
; /* request */
308 u32 se_callback_netid_len
; /* request */
309 char * se_callback_netid_val
; /* request */
310 u32 se_callback_addr_len
; /* request */
311 char * se_callback_addr_val
; /* request */
312 u32 se_callback_ident
; /* request */
313 clientid_t se_clientid
; /* response */
314 nfs4_verifier se_confirm
; /* response */
317 struct nfsd4_setclientid_confirm
{
318 clientid_t sc_clientid
;
319 nfs4_verifier sc_confirm
;
322 /* also used for NVERIFY */
323 struct nfsd4_verify
{
324 u32 ve_bmval
[2]; /* request */
325 u32 ve_attrlen
; /* request */
326 char * ve_attrval
; /* request */
330 stateid_t wr_stateid
; /* request */
331 u64 wr_offset
; /* request */
332 u32 wr_stable_how
; /* request */
333 u32 wr_buflen
; /* request */
336 u32 wr_bytes_written
; /* response */
337 u32 wr_how_written
; /* response */
338 nfs4_verifier wr_verifier
; /* response */
345 struct nfsd4_access access
;
346 struct nfsd4_close close
;
347 struct nfsd4_commit commit
;
348 struct nfsd4_create create
;
349 struct nfsd4_delegreturn delegreturn
;
350 struct nfsd4_getattr getattr
;
351 struct svc_fh
* getfh
;
352 struct nfsd4_link link
;
353 struct nfsd4_lock lock
;
354 struct nfsd4_lockt lockt
;
355 struct nfsd4_locku locku
;
356 struct nfsd4_lookup lookup
;
357 struct nfsd4_verify nverify
;
358 struct nfsd4_open open
;
359 struct nfsd4_open_confirm open_confirm
;
360 struct nfsd4_open_downgrade open_downgrade
;
361 struct nfsd4_putfh putfh
;
362 struct nfsd4_read read
;
363 struct nfsd4_readdir readdir
;
364 struct nfsd4_readlink readlink
;
365 struct nfsd4_remove remove
;
366 struct nfsd4_rename rename
;
368 struct nfsd4_setattr setattr
;
369 struct nfsd4_setclientid setclientid
;
370 struct nfsd4_setclientid_confirm setclientid_confirm
;
371 struct nfsd4_verify verify
;
372 struct nfsd4_write write
;
373 struct nfsd4_release_lockowner release_lockowner
;
375 struct nfs4_replay
* replay
;
378 struct nfsd4_compoundargs
{
379 /* scratch variables for XDR decode */
382 struct page
** pagelist
;
388 void (*release
)(const void *);
392 struct svc_rqst
*rqstp
;
398 struct nfsd4_op
*ops
;
399 struct nfsd4_op iops
[8];
402 struct nfsd4_compoundres
{
403 /* scratch variables for XDR encode */
406 struct xdr_buf
* xbuf
;
407 struct svc_rqst
* rqstp
;
412 __be32
* tagp
; /* where to encode tag and opcount */
415 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
418 set_change_info(struct nfsd4_change_info
*cinfo
, struct svc_fh
*fhp
)
420 BUG_ON(!fhp
->fh_pre_saved
|| !fhp
->fh_post_saved
);
422 cinfo
->before_ctime_sec
= fhp
->fh_pre_ctime
.tv_sec
;
423 cinfo
->before_ctime_nsec
= fhp
->fh_pre_ctime
.tv_nsec
;
424 cinfo
->after_ctime_sec
= fhp
->fh_post_ctime
.tv_sec
;
425 cinfo
->after_ctime_nsec
= fhp
->fh_post_ctime
.tv_nsec
;
428 int nfs4svc_encode_voidres(struct svc_rqst
*, __be32
*, void *);
429 int nfs4svc_decode_compoundargs(struct svc_rqst
*, __be32
*,
430 struct nfsd4_compoundargs
*);
431 int nfs4svc_encode_compoundres(struct svc_rqst
*, __be32
*,
432 struct nfsd4_compoundres
*);
433 void nfsd4_encode_operation(struct nfsd4_compoundres
*, struct nfsd4_op
*);
434 void nfsd4_encode_replay(struct nfsd4_compoundres
*resp
, struct nfsd4_op
*op
);
435 __be32
nfsd4_encode_fattr(struct svc_fh
*fhp
, struct svc_export
*exp
,
436 struct dentry
*dentry
, __be32
*buffer
, int *countp
,
437 u32
*bmval
, struct svc_rqst
*);
438 extern __be32
nfsd4_setclientid(struct svc_rqst
*rqstp
,
439 struct nfsd4_compound_state
*,
440 struct nfsd4_setclientid
*setclid
);
441 extern __be32
nfsd4_setclientid_confirm(struct svc_rqst
*rqstp
,
442 struct nfsd4_compound_state
*,
443 struct nfsd4_setclientid_confirm
*setclientid_confirm
);
444 extern __be32
nfsd4_process_open1(struct nfsd4_open
*open
);
445 extern __be32
nfsd4_process_open2(struct svc_rqst
*rqstp
,
446 struct svc_fh
*current_fh
, struct nfsd4_open
*open
);
447 extern __be32
nfsd4_open_confirm(struct svc_rqst
*rqstp
,
448 struct nfsd4_compound_state
*, struct nfsd4_open_confirm
*oc
);
449 extern __be32
nfsd4_close(struct svc_rqst
*rqstp
,
450 struct nfsd4_compound_state
*,
451 struct nfsd4_close
*close
);
452 extern __be32
nfsd4_open_downgrade(struct svc_rqst
*rqstp
,
453 struct nfsd4_compound_state
*,
454 struct nfsd4_open_downgrade
*od
);
455 extern __be32
nfsd4_lock(struct svc_rqst
*rqstp
, struct nfsd4_compound_state
*,
456 struct nfsd4_lock
*lock
);
457 extern __be32
nfsd4_lockt(struct svc_rqst
*rqstp
,
458 struct nfsd4_compound_state
*,
459 struct nfsd4_lockt
*lockt
);
460 extern __be32
nfsd4_locku(struct svc_rqst
*rqstp
,
461 struct nfsd4_compound_state
*,
462 struct nfsd4_locku
*locku
);
464 nfsd4_release_lockowner(struct svc_rqst
*rqstp
,
465 struct nfsd4_compound_state
*,
466 struct nfsd4_release_lockowner
*rlockowner
);
467 extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs
*);
468 extern __be32
nfsd4_delegreturn(struct svc_rqst
*rqstp
,
469 struct nfsd4_compound_state
*, struct nfsd4_delegreturn
*dr
);
470 extern __be32
nfsd4_renew(struct svc_rqst
*rqstp
,
471 struct nfsd4_compound_state
*, clientid_t
*clid
);