Linux 3.12.5
[linux/fpc-iii.git] / fs / nfsd / xdr4.h
blobb3ed6446ed8e9a420fedfc2ccbe861c5b46664ed
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_SEC_LABEL_LEN 2048
44 #define NFSD4_MAX_TAGLEN 128
45 #define XDR_LEN(n) (((n) + 3) & ~3)
47 #define CURRENT_STATE_ID_FLAG (1<<0)
48 #define SAVED_STATE_ID_FLAG (1<<1)
50 #define SET_STATE_ID(c, f) ((c)->sid_flags |= (f))
51 #define HAS_STATE_ID(c, f) ((c)->sid_flags & (f))
52 #define CLEAR_STATE_ID(c, f) ((c)->sid_flags &= ~(f))
54 struct nfsd4_compound_state {
55 struct svc_fh current_fh;
56 struct svc_fh save_fh;
57 struct nfs4_stateowner *replay_owner;
58 /* For sessions DRC */
59 struct nfsd4_session *session;
60 struct nfsd4_slot *slot;
61 __be32 *datap;
62 size_t iovlen;
63 u32 minorversion;
64 __be32 status;
65 stateid_t current_stateid;
66 stateid_t save_stateid;
67 /* to indicate current and saved state id presents */
68 u32 sid_flags;
71 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
73 return cs->slot != NULL;
76 struct nfsd4_change_info {
77 u32 atomic;
78 bool change_supported;
79 u32 before_ctime_sec;
80 u32 before_ctime_nsec;
81 u64 before_change;
82 u32 after_ctime_sec;
83 u32 after_ctime_nsec;
84 u64 after_change;
87 struct nfsd4_access {
88 u32 ac_req_access; /* request */
89 u32 ac_supported; /* response */
90 u32 ac_resp_access; /* response */
93 struct nfsd4_close {
94 u32 cl_seqid; /* request */
95 stateid_t cl_stateid; /* request+response */
98 struct nfsd4_commit {
99 u64 co_offset; /* request */
100 u32 co_count; /* request */
101 nfs4_verifier co_verf; /* response */
104 struct nfsd4_create {
105 u32 cr_namelen; /* request */
106 char * cr_name; /* request */
107 u32 cr_type; /* request */
108 union { /* request */
109 struct {
110 u32 namelen;
111 char *name;
112 } link; /* NF4LNK */
113 struct {
114 u32 specdata1;
115 u32 specdata2;
116 } dev; /* NF4BLK, NF4CHR */
117 } u;
118 u32 cr_bmval[3]; /* request */
119 struct iattr cr_iattr; /* request */
120 struct nfsd4_change_info cr_cinfo; /* response */
121 struct nfs4_acl *cr_acl;
122 struct xdr_netobj cr_label;
124 #define cr_linklen u.link.namelen
125 #define cr_linkname u.link.name
126 #define cr_specdata1 u.dev.specdata1
127 #define cr_specdata2 u.dev.specdata2
129 struct nfsd4_delegreturn {
130 stateid_t dr_stateid;
133 struct nfsd4_getattr {
134 u32 ga_bmval[3]; /* request */
135 struct svc_fh *ga_fhp; /* response */
138 struct nfsd4_link {
139 u32 li_namelen; /* request */
140 char * li_name; /* request */
141 struct nfsd4_change_info li_cinfo; /* response */
144 struct nfsd4_lock_denied {
145 clientid_t ld_clientid;
146 struct xdr_netobj ld_owner;
147 u64 ld_start;
148 u64 ld_length;
149 u32 ld_type;
152 struct nfsd4_lock {
153 /* request */
154 u32 lk_type;
155 u32 lk_reclaim; /* boolean */
156 u64 lk_offset;
157 u64 lk_length;
158 u32 lk_is_new;
159 union {
160 struct {
161 u32 open_seqid;
162 stateid_t open_stateid;
163 u32 lock_seqid;
164 clientid_t clientid;
165 struct xdr_netobj owner;
166 } new;
167 struct {
168 stateid_t lock_stateid;
169 u32 lock_seqid;
170 } old;
171 } v;
173 /* response */
174 union {
175 struct {
176 stateid_t stateid;
177 } ok;
178 struct nfsd4_lock_denied denied;
179 } u;
181 #define lk_new_open_seqid v.new.open_seqid
182 #define lk_new_open_stateid v.new.open_stateid
183 #define lk_new_lock_seqid v.new.lock_seqid
184 #define lk_new_clientid v.new.clientid
185 #define lk_new_owner v.new.owner
186 #define lk_old_lock_stateid v.old.lock_stateid
187 #define lk_old_lock_seqid v.old.lock_seqid
189 #define lk_resp_stateid u.ok.stateid
190 #define lk_denied u.denied
193 struct nfsd4_lockt {
194 u32 lt_type;
195 clientid_t lt_clientid;
196 struct xdr_netobj lt_owner;
197 u64 lt_offset;
198 u64 lt_length;
199 struct nfsd4_lock_denied lt_denied;
203 struct nfsd4_locku {
204 u32 lu_type;
205 u32 lu_seqid;
206 stateid_t lu_stateid;
207 u64 lu_offset;
208 u64 lu_length;
212 struct nfsd4_lookup {
213 u32 lo_len; /* request */
214 char * lo_name; /* request */
217 struct nfsd4_putfh {
218 u32 pf_fhlen; /* request */
219 char *pf_fhval; /* request */
222 struct nfsd4_open {
223 u32 op_claim_type; /* request */
224 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
225 u32 op_delegate_type; /* request - CLAIM_PREV only */
226 stateid_t op_delegate_stateid; /* request - response */
227 u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */
228 u32 op_create; /* request */
229 u32 op_createmode; /* request */
230 u32 op_bmval[3]; /* request */
231 struct iattr iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
232 nfs4_verifier op_verf __attribute__((aligned(32)));
233 /* EXCLUSIVE4 */
234 clientid_t op_clientid; /* request */
235 struct xdr_netobj op_owner; /* request */
236 u32 op_seqid; /* request */
237 u32 op_share_access; /* request */
238 u32 op_share_deny; /* request */
239 u32 op_deleg_want; /* request */
240 stateid_t op_stateid; /* response */
241 __be32 op_xdr_error; /* see nfsd4_open_omfg() */
242 u32 op_recall; /* recall */
243 struct nfsd4_change_info op_cinfo; /* response */
244 u32 op_rflags; /* response */
245 bool op_truncate; /* used during processing */
246 bool op_created; /* used during processing */
247 struct nfs4_openowner *op_openowner; /* used during processing */
248 struct nfs4_file *op_file; /* used during processing */
249 struct nfs4_ol_stateid *op_stp; /* used during processing */
250 struct nfs4_acl *op_acl;
251 struct xdr_netobj op_label;
253 #define op_iattr iattr
255 struct nfsd4_open_confirm {
256 stateid_t oc_req_stateid /* request */;
257 u32 oc_seqid /* request */;
258 stateid_t oc_resp_stateid /* response */;
261 struct nfsd4_open_downgrade {
262 stateid_t od_stateid;
263 u32 od_seqid;
264 u32 od_share_access; /* request */
265 u32 od_deleg_want; /* request */
266 u32 od_share_deny; /* request */
270 struct nfsd4_read {
271 stateid_t rd_stateid; /* request */
272 u64 rd_offset; /* request */
273 u32 rd_length; /* request */
274 int rd_vlen;
275 struct file *rd_filp;
277 struct svc_rqst *rd_rqstp; /* response */
278 struct svc_fh * rd_fhp; /* response */
281 struct nfsd4_readdir {
282 u64 rd_cookie; /* request */
283 nfs4_verifier rd_verf; /* request */
284 u32 rd_dircount; /* request */
285 u32 rd_maxcount; /* request */
286 u32 rd_bmval[3]; /* request */
287 struct svc_rqst *rd_rqstp; /* response */
288 struct svc_fh * rd_fhp; /* response */
290 struct readdir_cd common;
291 __be32 * buffer;
292 int buflen;
293 __be32 * offset;
296 struct nfsd4_release_lockowner {
297 clientid_t rl_clientid;
298 struct xdr_netobj rl_owner;
300 struct nfsd4_readlink {
301 struct svc_rqst *rl_rqstp; /* request */
302 struct svc_fh * rl_fhp; /* request */
305 struct nfsd4_remove {
306 u32 rm_namelen; /* request */
307 char * rm_name; /* request */
308 struct nfsd4_change_info rm_cinfo; /* response */
311 struct nfsd4_rename {
312 u32 rn_snamelen; /* request */
313 char * rn_sname; /* request */
314 u32 rn_tnamelen; /* request */
315 char * rn_tname; /* request */
316 struct nfsd4_change_info rn_sinfo; /* response */
317 struct nfsd4_change_info rn_tinfo; /* response */
320 struct nfsd4_secinfo {
321 u32 si_namelen; /* request */
322 char *si_name; /* request */
323 struct svc_export *si_exp; /* response */
326 struct nfsd4_secinfo_no_name {
327 u32 sin_style; /* request */
328 struct svc_export *sin_exp; /* response */
331 struct nfsd4_setattr {
332 stateid_t sa_stateid; /* request */
333 u32 sa_bmval[3]; /* request */
334 struct iattr sa_iattr; /* request */
335 struct nfs4_acl *sa_acl;
336 struct xdr_netobj sa_label;
339 struct nfsd4_setclientid {
340 nfs4_verifier se_verf; /* request */
341 struct xdr_netobj se_name;
342 u32 se_callback_prog; /* request */
343 u32 se_callback_netid_len; /* request */
344 char * se_callback_netid_val; /* request */
345 u32 se_callback_addr_len; /* request */
346 char * se_callback_addr_val; /* request */
347 u32 se_callback_ident; /* request */
348 clientid_t se_clientid; /* response */
349 nfs4_verifier se_confirm; /* response */
352 struct nfsd4_setclientid_confirm {
353 clientid_t sc_clientid;
354 nfs4_verifier sc_confirm;
357 struct nfsd4_saved_compoundargs {
358 __be32 *p;
359 __be32 *end;
360 int pagelen;
361 struct page **pagelist;
364 struct nfsd4_test_stateid_id {
365 __be32 ts_id_status;
366 stateid_t ts_id_stateid;
367 struct list_head ts_id_list;
370 struct nfsd4_test_stateid {
371 u32 ts_num_ids;
372 struct list_head ts_stateid_list;
375 struct nfsd4_free_stateid {
376 stateid_t fr_stateid; /* request */
377 __be32 fr_status; /* response */
380 /* also used for NVERIFY */
381 struct nfsd4_verify {
382 u32 ve_bmval[3]; /* request */
383 u32 ve_attrlen; /* request */
384 char * ve_attrval; /* request */
387 struct nfsd4_write {
388 stateid_t wr_stateid; /* request */
389 u64 wr_offset; /* request */
390 u32 wr_stable_how; /* request */
391 u32 wr_buflen; /* request */
392 struct kvec wr_head;
393 struct page ** wr_pagelist; /* request */
395 u32 wr_bytes_written; /* response */
396 u32 wr_how_written; /* response */
397 nfs4_verifier wr_verifier; /* response */
400 struct nfsd4_exchange_id {
401 nfs4_verifier verifier;
402 struct xdr_netobj clname;
403 u32 flags;
404 clientid_t clientid;
405 u32 seqid;
406 int spa_how;
409 struct nfsd4_sequence {
410 struct nfs4_sessionid sessionid; /* request/response */
411 u32 seqid; /* request/response */
412 u32 slotid; /* request/response */
413 u32 maxslots; /* request/response */
414 u32 cachethis; /* request */
415 #if 0
416 u32 target_maxslots; /* response */
417 #endif /* not yet */
418 u32 status_flags; /* response */
421 struct nfsd4_destroy_session {
422 struct nfs4_sessionid sessionid;
425 struct nfsd4_destroy_clientid {
426 clientid_t clientid;
429 struct nfsd4_reclaim_complete {
430 u32 rca_one_fs;
433 struct nfsd4_op {
434 int opnum;
435 __be32 status;
436 union {
437 struct nfsd4_access access;
438 struct nfsd4_close close;
439 struct nfsd4_commit commit;
440 struct nfsd4_create create;
441 struct nfsd4_delegreturn delegreturn;
442 struct nfsd4_getattr getattr;
443 struct svc_fh * getfh;
444 struct nfsd4_link link;
445 struct nfsd4_lock lock;
446 struct nfsd4_lockt lockt;
447 struct nfsd4_locku locku;
448 struct nfsd4_lookup lookup;
449 struct nfsd4_verify nverify;
450 struct nfsd4_open open;
451 struct nfsd4_open_confirm open_confirm;
452 struct nfsd4_open_downgrade open_downgrade;
453 struct nfsd4_putfh putfh;
454 struct nfsd4_read read;
455 struct nfsd4_readdir readdir;
456 struct nfsd4_readlink readlink;
457 struct nfsd4_remove remove;
458 struct nfsd4_rename rename;
459 clientid_t renew;
460 struct nfsd4_secinfo secinfo;
461 struct nfsd4_setattr setattr;
462 struct nfsd4_setclientid setclientid;
463 struct nfsd4_setclientid_confirm setclientid_confirm;
464 struct nfsd4_verify verify;
465 struct nfsd4_write write;
466 struct nfsd4_release_lockowner release_lockowner;
468 /* NFSv4.1 */
469 struct nfsd4_exchange_id exchange_id;
470 struct nfsd4_backchannel_ctl backchannel_ctl;
471 struct nfsd4_bind_conn_to_session bind_conn_to_session;
472 struct nfsd4_create_session create_session;
473 struct nfsd4_destroy_session destroy_session;
474 struct nfsd4_sequence sequence;
475 struct nfsd4_reclaim_complete reclaim_complete;
476 struct nfsd4_test_stateid test_stateid;
477 struct nfsd4_free_stateid free_stateid;
478 } u;
479 struct nfs4_replay * replay;
482 bool nfsd4_cache_this_op(struct nfsd4_op *);
484 struct nfsd4_compoundargs {
485 /* scratch variables for XDR decode */
486 __be32 * p;
487 __be32 * end;
488 struct page ** pagelist;
489 int pagelen;
490 __be32 tmp[8];
491 __be32 * tmpp;
492 struct tmpbuf {
493 struct tmpbuf *next;
494 void (*release)(const void *);
495 void *buf;
496 } *to_free;
498 struct svc_rqst *rqstp;
500 u32 taglen;
501 char * tag;
502 u32 minorversion;
503 u32 opcnt;
504 struct nfsd4_op *ops;
505 struct nfsd4_op iops[8];
506 int cachetype;
509 struct nfsd4_compoundres {
510 /* scratch variables for XDR encode */
511 __be32 * p;
512 __be32 * end;
513 struct xdr_buf * xbuf;
514 struct svc_rqst * rqstp;
516 u32 taglen;
517 char * tag;
518 u32 opcnt;
519 __be32 * tagp; /* tag, opcount encode location */
520 struct nfsd4_compound_state cstate;
523 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
525 struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
526 return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
529 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
531 return !(resp->cstate.slot->sl_flags & NFSD4_SLOT_CACHETHIS)
532 || nfsd4_is_solo_sequence(resp);
535 static inline bool nfsd4_last_compound_op(struct svc_rqst *rqstp)
537 struct nfsd4_compoundres *resp = rqstp->rq_resp;
538 struct nfsd4_compoundargs *argp = rqstp->rq_argp;
540 return argp->opcnt == resp->opcnt;
543 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
545 static inline void
546 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
548 BUG_ON(!fhp->fh_pre_saved);
549 cinfo->atomic = fhp->fh_post_saved;
550 cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
552 cinfo->before_change = fhp->fh_pre_change;
553 cinfo->after_change = fhp->fh_post_change;
554 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
555 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
556 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
557 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
561 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
562 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
563 struct nfsd4_compoundargs *);
564 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
565 struct nfsd4_compoundres *);
566 __be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
567 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
568 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
569 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
570 struct dentry *dentry, __be32 **buffer, int countp,
571 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
572 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
573 struct nfsd4_compound_state *,
574 struct nfsd4_setclientid *setclid);
575 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
576 struct nfsd4_compound_state *,
577 struct nfsd4_setclientid_confirm *setclientid_confirm);
578 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
579 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
580 struct nfsd4_sequence *seq);
581 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
582 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
583 extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_backchannel_ctl *);
584 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
585 extern __be32 nfsd4_create_session(struct svc_rqst *,
586 struct nfsd4_compound_state *,
587 struct nfsd4_create_session *);
588 extern __be32 nfsd4_sequence(struct svc_rqst *,
589 struct nfsd4_compound_state *,
590 struct nfsd4_sequence *);
591 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
592 struct nfsd4_compound_state *,
593 struct nfsd4_destroy_session *);
594 extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_destroy_clientid *);
595 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
596 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
597 struct nfsd4_open *open, struct nfsd_net *nn);
598 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
599 struct svc_fh *current_fh, struct nfsd4_open *open);
600 extern void nfsd4_cleanup_open_state(struct nfsd4_open *open, __be32 status);
601 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
602 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
603 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
604 struct nfsd4_compound_state *,
605 struct nfsd4_close *close);
606 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
607 struct nfsd4_compound_state *,
608 struct nfsd4_open_downgrade *od);
609 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
610 struct nfsd4_lock *lock);
611 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
612 struct nfsd4_compound_state *,
613 struct nfsd4_lockt *lockt);
614 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
615 struct nfsd4_compound_state *,
616 struct nfsd4_locku *locku);
617 extern __be32
618 nfsd4_release_lockowner(struct svc_rqst *rqstp,
619 struct nfsd4_compound_state *,
620 struct nfsd4_release_lockowner *rlockowner);
621 extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp);
622 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
623 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
624 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
625 struct nfsd4_compound_state *, clientid_t *clid);
626 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
627 struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid);
628 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
629 struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid);
630 extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
631 #endif
634 * Local variables:
635 * c-basic-offset: 8
636 * End: