Merge remote-tracking branch 'moduleh/module.h-split'
[linux-2.6/next.git] / fs / nfsd / xdr4.h
blob663193b21a2403a767196bfde0051e8955511dbb
1 /*
2 * Server-side types for NFSv4.
4 * Copyright (c) 2002 The Regents of the University of Michigan.
5 * All rights reserved.
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
12 * are met:
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
40 #include "state.h"
41 #include "nfsd.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;
53 __be32 *datap;
54 size_t iovlen;
55 u32 minorversion;
56 u32 status;
59 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
61 return cs->slot != NULL;
64 struct nfsd4_change_info {
65 u32 atomic;
66 bool change_supported;
67 u32 before_ctime_sec;
68 u32 before_ctime_nsec;
69 u64 before_change;
70 u32 after_ctime_sec;
71 u32 after_ctime_nsec;
72 u64 after_change;
75 struct nfsd4_access {
76 u32 ac_req_access; /* request */
77 u32 ac_supported; /* response */
78 u32 ac_resp_access; /* response */
81 struct nfsd4_close {
82 u32 cl_seqid; /* request */
83 stateid_t cl_stateid; /* request+response */
84 struct nfs4_stateowner * cl_stateowner; /* response */
87 struct nfsd4_commit {
88 u64 co_offset; /* request */
89 u32 co_count; /* request */
90 nfs4_verifier co_verf; /* response */
93 struct nfsd4_create {
94 u32 cr_namelen; /* request */
95 char * cr_name; /* request */
96 u32 cr_type; /* request */
97 union { /* request */
98 struct {
99 u32 namelen;
100 char *name;
101 } link; /* NF4LNK */
102 struct {
103 u32 specdata1;
104 u32 specdata2;
105 } dev; /* NF4BLK, NF4CHR */
106 } u;
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 */
126 struct nfsd4_link {
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;
135 u64 ld_start;
136 u64 ld_length;
137 u32 ld_type;
140 struct nfsd4_lock {
141 /* request */
142 u32 lk_type;
143 u32 lk_reclaim; /* boolean */
144 u64 lk_offset;
145 u64 lk_length;
146 u32 lk_is_new;
147 union {
148 struct {
149 u32 open_seqid;
150 stateid_t open_stateid;
151 u32 lock_seqid;
152 clientid_t clientid;
153 struct xdr_netobj owner;
154 } new;
155 struct {
156 stateid_t lock_stateid;
157 u32 lock_seqid;
158 } old;
159 } v;
161 /* response */
162 union {
163 struct {
164 stateid_t stateid;
165 } ok;
166 struct nfsd4_lock_denied denied;
167 } u;
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
185 struct nfsd4_lockt {
186 u32 lt_type;
187 clientid_t lt_clientid;
188 struct xdr_netobj lt_owner;
189 u64 lt_offset;
190 u64 lt_length;
191 struct nfs4_stateowner * lt_stateowner;
192 struct nfsd4_lock_denied lt_denied;
196 struct nfsd4_locku {
197 u32 lu_type;
198 u32 lu_seqid;
199 stateid_t lu_stateid;
200 u64 lu_offset;
201 u64 lu_length;
202 struct nfs4_stateowner *lu_stateowner;
206 struct nfsd4_lookup {
207 u32 lo_len; /* request */
208 char * lo_name; /* request */
211 struct nfsd4_putfh {
212 u32 pf_fhlen; /* request */
213 char *pf_fhval; /* request */
216 struct nfsd4_open {
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
240 #define op_verf verf
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;
251 u32 od_seqid;
252 u32 od_share_access;
253 u32 od_share_deny;
254 struct nfs4_stateowner *od_stateowner;
258 struct nfsd4_read {
259 stateid_t rd_stateid; /* request */
260 u64 rd_offset; /* request */
261 u32 rd_length; /* request */
262 int rd_vlen;
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;
279 __be32 * buffer;
280 int buflen;
281 __be32 * offset;
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 struct nfsd4_saved_compoundargs {
346 __be32 *p;
347 __be32 *end;
348 int pagelen;
349 struct page **pagelist;
352 struct nfsd4_test_stateid {
353 __be32 ts_num_ids;
354 bool ts_has_session;
355 struct nfsd4_compoundargs *ts_saved_args;
356 struct nfsd4_saved_compoundargs ts_savedp;
359 struct nfsd4_free_stateid {
360 stateid_t fr_stateid; /* request */
361 __be32 fr_status; /* response */
364 /* also used for NVERIFY */
365 struct nfsd4_verify {
366 u32 ve_bmval[3]; /* request */
367 u32 ve_attrlen; /* request */
368 char * ve_attrval; /* request */
371 struct nfsd4_write {
372 stateid_t wr_stateid; /* request */
373 u64 wr_offset; /* request */
374 u32 wr_stable_how; /* request */
375 u32 wr_buflen; /* request */
376 int wr_vlen;
378 u32 wr_bytes_written; /* response */
379 u32 wr_how_written; /* response */
380 nfs4_verifier wr_verifier; /* response */
383 struct nfsd4_exchange_id {
384 nfs4_verifier verifier;
385 struct xdr_netobj clname;
386 u32 flags;
387 clientid_t clientid;
388 u32 seqid;
389 int spa_how;
392 struct nfsd4_sequence {
393 struct nfs4_sessionid sessionid; /* request/response */
394 u32 seqid; /* request/response */
395 u32 slotid; /* request/response */
396 u32 maxslots; /* request/response */
397 u32 cachethis; /* request */
398 #if 0
399 u32 target_maxslots; /* response */
400 #endif /* not yet */
401 u32 status_flags; /* response */
404 struct nfsd4_destroy_session {
405 struct nfs4_sessionid sessionid;
408 struct nfsd4_reclaim_complete {
409 u32 rca_one_fs;
412 struct nfsd4_op {
413 int opnum;
414 __be32 status;
415 union {
416 struct nfsd4_access access;
417 struct nfsd4_close close;
418 struct nfsd4_commit commit;
419 struct nfsd4_create create;
420 struct nfsd4_delegreturn delegreturn;
421 struct nfsd4_getattr getattr;
422 struct svc_fh * getfh;
423 struct nfsd4_link link;
424 struct nfsd4_lock lock;
425 struct nfsd4_lockt lockt;
426 struct nfsd4_locku locku;
427 struct nfsd4_lookup lookup;
428 struct nfsd4_verify nverify;
429 struct nfsd4_open open;
430 struct nfsd4_open_confirm open_confirm;
431 struct nfsd4_open_downgrade open_downgrade;
432 struct nfsd4_putfh putfh;
433 struct nfsd4_read read;
434 struct nfsd4_readdir readdir;
435 struct nfsd4_readlink readlink;
436 struct nfsd4_remove remove;
437 struct nfsd4_rename rename;
438 clientid_t renew;
439 struct nfsd4_secinfo secinfo;
440 struct nfsd4_setattr setattr;
441 struct nfsd4_setclientid setclientid;
442 struct nfsd4_setclientid_confirm setclientid_confirm;
443 struct nfsd4_verify verify;
444 struct nfsd4_write write;
445 struct nfsd4_release_lockowner release_lockowner;
447 /* NFSv4.1 */
448 struct nfsd4_exchange_id exchange_id;
449 struct nfsd4_bind_conn_to_session bind_conn_to_session;
450 struct nfsd4_create_session create_session;
451 struct nfsd4_destroy_session destroy_session;
452 struct nfsd4_sequence sequence;
453 struct nfsd4_reclaim_complete reclaim_complete;
454 struct nfsd4_test_stateid test_stateid;
455 struct nfsd4_free_stateid free_stateid;
456 } u;
457 struct nfs4_replay * replay;
460 bool nfsd4_cache_this_op(struct nfsd4_op *);
462 struct nfsd4_compoundargs {
463 /* scratch variables for XDR decode */
464 __be32 * p;
465 __be32 * end;
466 struct page ** pagelist;
467 int pagelen;
468 __be32 tmp[8];
469 __be32 * tmpp;
470 struct tmpbuf {
471 struct tmpbuf *next;
472 void (*release)(const void *);
473 void *buf;
474 } *to_free;
476 struct svc_rqst *rqstp;
478 u32 taglen;
479 char * tag;
480 u32 minorversion;
481 u32 opcnt;
482 struct nfsd4_op *ops;
483 struct nfsd4_op iops[8];
484 int cachetype;
487 struct nfsd4_compoundres {
488 /* scratch variables for XDR encode */
489 __be32 * p;
490 __be32 * end;
491 struct xdr_buf * xbuf;
492 struct svc_rqst * rqstp;
494 u32 taglen;
495 char * tag;
496 u32 opcnt;
497 __be32 * tagp; /* tag, opcount encode location */
498 struct nfsd4_compound_state cstate;
501 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
503 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
504 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
507 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
509 return !resp->cstate.slot->sl_cachethis || nfsd4_is_solo_sequence(resp);
512 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
514 static inline void
515 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
517 BUG_ON(!fhp->fh_pre_saved);
518 cinfo->atomic = fhp->fh_post_saved;
519 cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
521 cinfo->before_change = fhp->fh_pre_change;
522 cinfo->after_change = fhp->fh_post_change;
523 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
524 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
525 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
526 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
530 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
531 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
532 struct nfsd4_compoundargs *);
533 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
534 struct nfsd4_compoundres *);
535 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
536 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
537 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
538 struct dentry *dentry, __be32 *buffer, int *countp,
539 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
540 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
541 struct nfsd4_compound_state *,
542 struct nfsd4_setclientid *setclid);
543 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
544 struct nfsd4_compound_state *,
545 struct nfsd4_setclientid_confirm *setclientid_confirm);
546 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
547 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
548 struct nfsd4_sequence *seq);
549 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
550 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
551 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
552 extern __be32 nfsd4_create_session(struct svc_rqst *,
553 struct nfsd4_compound_state *,
554 struct nfsd4_create_session *);
555 extern __be32 nfsd4_sequence(struct svc_rqst *,
556 struct nfsd4_compound_state *,
557 struct nfsd4_sequence *);
558 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
559 struct nfsd4_compound_state *,
560 struct nfsd4_destroy_session *);
561 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
562 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
563 struct nfsd4_open *open);
564 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
565 struct svc_fh *current_fh, struct nfsd4_open *open);
566 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
567 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
568 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
569 struct nfsd4_compound_state *,
570 struct nfsd4_close *close);
571 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
572 struct nfsd4_compound_state *,
573 struct nfsd4_open_downgrade *od);
574 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
575 struct nfsd4_lock *lock);
576 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
577 struct nfsd4_compound_state *,
578 struct nfsd4_lockt *lockt);
579 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
580 struct nfsd4_compound_state *,
581 struct nfsd4_locku *locku);
582 extern __be32
583 nfsd4_release_lockowner(struct svc_rqst *rqstp,
584 struct nfsd4_compound_state *,
585 struct nfsd4_release_lockowner *rlockowner);
586 extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp);
587 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
588 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
589 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
590 struct nfsd4_compound_state *, clientid_t *clid);
591 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
592 struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid);
593 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
594 struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid);
595 #endif
598 * Local variables:
599 * c-basic-offset: 8
600 * End: