regulator: qcom_rpm: Fix FORCE_MODE_IS_2_BITS macro
[linux-2.6/btrfs-unstable.git] / fs / nfsd / xdr4.h
blob465e7799742a399fe07878af06db0b3f35bc35df
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 struct nfs4_client *clp;
59 /* For sessions DRC */
60 struct nfsd4_session *session;
61 struct nfsd4_slot *slot;
62 int data_offset;
63 size_t iovlen;
64 u32 minorversion;
65 __be32 status;
66 stateid_t current_stateid;
67 stateid_t save_stateid;
68 /* to indicate current and saved state id presents */
69 u32 sid_flags;
72 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
74 return cs->slot != NULL;
77 struct nfsd4_change_info {
78 u32 atomic;
79 bool change_supported;
80 u32 before_ctime_sec;
81 u32 before_ctime_nsec;
82 u64 before_change;
83 u32 after_ctime_sec;
84 u32 after_ctime_nsec;
85 u64 after_change;
88 struct nfsd4_access {
89 u32 ac_req_access; /* request */
90 u32 ac_supported; /* response */
91 u32 ac_resp_access; /* response */
94 struct nfsd4_close {
95 u32 cl_seqid; /* request */
96 stateid_t cl_stateid; /* request+response */
99 struct nfsd4_commit {
100 u64 co_offset; /* request */
101 u32 co_count; /* request */
102 nfs4_verifier co_verf; /* response */
105 struct nfsd4_create {
106 u32 cr_namelen; /* request */
107 char * cr_name; /* request */
108 u32 cr_type; /* request */
109 union { /* request */
110 struct {
111 u32 datalen;
112 char *data;
113 } link; /* NF4LNK */
114 struct {
115 u32 specdata1;
116 u32 specdata2;
117 } dev; /* NF4BLK, NF4CHR */
118 } u;
119 u32 cr_bmval[3]; /* request */
120 struct iattr cr_iattr; /* request */
121 struct nfsd4_change_info cr_cinfo; /* response */
122 struct nfs4_acl *cr_acl;
123 struct xdr_netobj cr_label;
125 #define cr_datalen u.link.datalen
126 #define cr_data u.link.data
127 #define cr_specdata1 u.dev.specdata1
128 #define cr_specdata2 u.dev.specdata2
130 struct nfsd4_delegreturn {
131 stateid_t dr_stateid;
134 struct nfsd4_getattr {
135 u32 ga_bmval[3]; /* request */
136 struct svc_fh *ga_fhp; /* response */
139 struct nfsd4_link {
140 u32 li_namelen; /* request */
141 char * li_name; /* request */
142 struct nfsd4_change_info li_cinfo; /* response */
145 struct nfsd4_lock_denied {
146 clientid_t ld_clientid;
147 struct xdr_netobj ld_owner;
148 u64 ld_start;
149 u64 ld_length;
150 u32 ld_type;
153 struct nfsd4_lock {
154 /* request */
155 u32 lk_type;
156 u32 lk_reclaim; /* boolean */
157 u64 lk_offset;
158 u64 lk_length;
159 u32 lk_is_new;
160 union {
161 struct {
162 u32 open_seqid;
163 stateid_t open_stateid;
164 u32 lock_seqid;
165 clientid_t clientid;
166 struct xdr_netobj owner;
167 } new;
168 struct {
169 stateid_t lock_stateid;
170 u32 lock_seqid;
171 } old;
172 } v;
174 /* response */
175 union {
176 struct {
177 stateid_t stateid;
178 } ok;
179 struct nfsd4_lock_denied denied;
180 } u;
182 #define lk_new_open_seqid v.new.open_seqid
183 #define lk_new_open_stateid v.new.open_stateid
184 #define lk_new_lock_seqid v.new.lock_seqid
185 #define lk_new_clientid v.new.clientid
186 #define lk_new_owner v.new.owner
187 #define lk_old_lock_stateid v.old.lock_stateid
188 #define lk_old_lock_seqid v.old.lock_seqid
190 #define lk_resp_stateid u.ok.stateid
191 #define lk_denied u.denied
194 struct nfsd4_lockt {
195 u32 lt_type;
196 clientid_t lt_clientid;
197 struct xdr_netobj lt_owner;
198 u64 lt_offset;
199 u64 lt_length;
200 struct nfsd4_lock_denied lt_denied;
204 struct nfsd4_locku {
205 u32 lu_type;
206 u32 lu_seqid;
207 stateid_t lu_stateid;
208 u64 lu_offset;
209 u64 lu_length;
213 struct nfsd4_lookup {
214 u32 lo_len; /* request */
215 char * lo_name; /* request */
218 struct nfsd4_putfh {
219 u32 pf_fhlen; /* request */
220 char *pf_fhval; /* request */
223 struct nfsd4_open {
224 u32 op_claim_type; /* request */
225 struct xdr_netobj op_fname; /* request - everything but CLAIM_PREV */
226 u32 op_delegate_type; /* request - CLAIM_PREV only */
227 stateid_t op_delegate_stateid; /* request - response */
228 u32 op_why_no_deleg; /* response - DELEG_NONE_EXT only */
229 u32 op_create; /* request */
230 u32 op_createmode; /* request */
231 u32 op_bmval[3]; /* request */
232 struct iattr op_iattr; /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
233 nfs4_verifier op_verf __attribute__((aligned(32)));
234 /* EXCLUSIVE4 */
235 clientid_t op_clientid; /* request */
236 struct xdr_netobj op_owner; /* request */
237 u32 op_seqid; /* request */
238 u32 op_share_access; /* request */
239 u32 op_share_deny; /* request */
240 u32 op_deleg_want; /* request */
241 stateid_t op_stateid; /* response */
242 __be32 op_xdr_error; /* see nfsd4_open_omfg() */
243 u32 op_recall; /* recall */
244 struct nfsd4_change_info op_cinfo; /* response */
245 u32 op_rflags; /* response */
246 bool op_truncate; /* used during processing */
247 bool op_created; /* used during processing */
248 struct nfs4_openowner *op_openowner; /* used during processing */
249 struct nfs4_file *op_file; /* used during processing */
250 struct nfs4_ol_stateid *op_stp; /* used during processing */
251 struct nfs4_acl *op_acl;
252 struct xdr_netobj op_label;
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 struct xdr_stream *xdr;
292 int cookie_offset;
295 struct nfsd4_release_lockowner {
296 clientid_t rl_clientid;
297 struct xdr_netobj rl_owner;
299 struct nfsd4_readlink {
300 struct svc_rqst *rl_rqstp; /* request */
301 struct svc_fh * rl_fhp; /* request */
304 struct nfsd4_remove {
305 u32 rm_namelen; /* request */
306 char * rm_name; /* request */
307 struct nfsd4_change_info rm_cinfo; /* response */
310 struct nfsd4_rename {
311 u32 rn_snamelen; /* request */
312 char * rn_sname; /* request */
313 u32 rn_tnamelen; /* request */
314 char * rn_tname; /* request */
315 struct nfsd4_change_info rn_sinfo; /* response */
316 struct nfsd4_change_info rn_tinfo; /* response */
319 struct nfsd4_secinfo {
320 u32 si_namelen; /* request */
321 char *si_name; /* request */
322 struct svc_export *si_exp; /* response */
325 struct nfsd4_secinfo_no_name {
326 u32 sin_style; /* request */
327 struct svc_export *sin_exp; /* response */
330 struct nfsd4_setattr {
331 stateid_t sa_stateid; /* request */
332 u32 sa_bmval[3]; /* request */
333 struct iattr sa_iattr; /* request */
334 struct nfs4_acl *sa_acl;
335 struct xdr_netobj sa_label;
338 struct nfsd4_setclientid {
339 nfs4_verifier se_verf; /* request */
340 struct xdr_netobj se_name;
341 u32 se_callback_prog; /* request */
342 u32 se_callback_netid_len; /* request */
343 char * se_callback_netid_val; /* request */
344 u32 se_callback_addr_len; /* request */
345 char * se_callback_addr_val; /* request */
346 u32 se_callback_ident; /* request */
347 clientid_t se_clientid; /* response */
348 nfs4_verifier se_confirm; /* response */
351 struct nfsd4_setclientid_confirm {
352 clientid_t sc_clientid;
353 nfs4_verifier sc_confirm;
356 struct nfsd4_saved_compoundargs {
357 __be32 *p;
358 __be32 *end;
359 int pagelen;
360 struct page **pagelist;
363 struct nfsd4_test_stateid_id {
364 __be32 ts_id_status;
365 stateid_t ts_id_stateid;
366 struct list_head ts_id_list;
369 struct nfsd4_test_stateid {
370 u32 ts_num_ids;
371 struct list_head ts_stateid_list;
374 struct nfsd4_free_stateid {
375 stateid_t fr_stateid; /* request */
378 /* also used for NVERIFY */
379 struct nfsd4_verify {
380 u32 ve_bmval[3]; /* request */
381 u32 ve_attrlen; /* request */
382 char * ve_attrval; /* request */
385 struct nfsd4_write {
386 stateid_t wr_stateid; /* request */
387 u64 wr_offset; /* request */
388 u32 wr_stable_how; /* request */
389 u32 wr_buflen; /* request */
390 struct kvec wr_head;
391 struct page ** wr_pagelist; /* request */
393 u32 wr_bytes_written; /* response */
394 u32 wr_how_written; /* response */
395 nfs4_verifier wr_verifier; /* response */
398 struct nfsd4_exchange_id {
399 nfs4_verifier verifier;
400 struct xdr_netobj clname;
401 u32 flags;
402 clientid_t clientid;
403 u32 seqid;
404 int spa_how;
407 struct nfsd4_sequence {
408 struct nfs4_sessionid sessionid; /* request/response */
409 u32 seqid; /* request/response */
410 u32 slotid; /* request/response */
411 u32 maxslots; /* request/response */
412 u32 cachethis; /* request */
413 #if 0
414 u32 target_maxslots; /* response */
415 #endif /* not yet */
416 u32 status_flags; /* response */
419 struct nfsd4_destroy_session {
420 struct nfs4_sessionid sessionid;
423 struct nfsd4_destroy_clientid {
424 clientid_t clientid;
427 struct nfsd4_reclaim_complete {
428 u32 rca_one_fs;
431 struct nfsd4_op {
432 int opnum;
433 __be32 status;
434 union {
435 struct nfsd4_access access;
436 struct nfsd4_close close;
437 struct nfsd4_commit commit;
438 struct nfsd4_create create;
439 struct nfsd4_delegreturn delegreturn;
440 struct nfsd4_getattr getattr;
441 struct svc_fh * getfh;
442 struct nfsd4_link link;
443 struct nfsd4_lock lock;
444 struct nfsd4_lockt lockt;
445 struct nfsd4_locku locku;
446 struct nfsd4_lookup lookup;
447 struct nfsd4_verify nverify;
448 struct nfsd4_open open;
449 struct nfsd4_open_confirm open_confirm;
450 struct nfsd4_open_downgrade open_downgrade;
451 struct nfsd4_putfh putfh;
452 struct nfsd4_read read;
453 struct nfsd4_readdir readdir;
454 struct nfsd4_readlink readlink;
455 struct nfsd4_remove remove;
456 struct nfsd4_rename rename;
457 clientid_t renew;
458 struct nfsd4_secinfo secinfo;
459 struct nfsd4_setattr setattr;
460 struct nfsd4_setclientid setclientid;
461 struct nfsd4_setclientid_confirm setclientid_confirm;
462 struct nfsd4_verify verify;
463 struct nfsd4_write write;
464 struct nfsd4_release_lockowner release_lockowner;
466 /* NFSv4.1 */
467 struct nfsd4_exchange_id exchange_id;
468 struct nfsd4_backchannel_ctl backchannel_ctl;
469 struct nfsd4_bind_conn_to_session bind_conn_to_session;
470 struct nfsd4_create_session create_session;
471 struct nfsd4_destroy_session destroy_session;
472 struct nfsd4_sequence sequence;
473 struct nfsd4_reclaim_complete reclaim_complete;
474 struct nfsd4_test_stateid test_stateid;
475 struct nfsd4_free_stateid free_stateid;
476 } u;
477 struct nfs4_replay * replay;
480 bool nfsd4_cache_this_op(struct nfsd4_op *);
483 * Memory needed just for the duration of processing one compound:
485 struct svcxdr_tmpbuf {
486 struct svcxdr_tmpbuf *next;
487 char buf[];
490 struct nfsd4_compoundargs {
491 /* scratch variables for XDR decode */
492 __be32 * p;
493 __be32 * end;
494 struct page ** pagelist;
495 int pagelen;
496 __be32 tmp[8];
497 __be32 * tmpp;
498 struct svcxdr_tmpbuf *to_free;
500 struct svc_rqst *rqstp;
502 u32 taglen;
503 char * tag;
504 u32 minorversion;
505 u32 opcnt;
506 struct nfsd4_op *ops;
507 struct nfsd4_op iops[8];
508 int cachetype;
511 struct nfsd4_compoundres {
512 /* scratch variables for XDR encode */
513 struct xdr_stream xdr;
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 int nfsd4_max_reply(struct svc_rqst *rqstp, struct nfsd4_op *op);
544 void warn_on_nonidempotent_op(struct nfsd4_op *op);
546 #define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
548 static inline void
549 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
551 BUG_ON(!fhp->fh_pre_saved);
552 cinfo->atomic = fhp->fh_post_saved;
553 cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
555 cinfo->before_change = fhp->fh_pre_change;
556 cinfo->after_change = fhp->fh_post_change;
557 cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
558 cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
559 cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
560 cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
564 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
565 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
566 struct nfsd4_compoundargs *);
567 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
568 struct nfsd4_compoundres *);
569 __be32 nfsd4_check_resp_size(struct nfsd4_compoundres *, u32);
570 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
571 void nfsd4_encode_replay(struct xdr_stream *xdr, struct nfsd4_op *op);
572 __be32 nfsd4_encode_fattr_to_buf(__be32 **p, int words,
573 struct svc_fh *fhp, struct svc_export *exp,
574 struct dentry *dentry,
575 u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
576 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
577 struct nfsd4_compound_state *,
578 struct nfsd4_setclientid *setclid);
579 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
580 struct nfsd4_compound_state *,
581 struct nfsd4_setclientid_confirm *setclientid_confirm);
582 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
583 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
584 extern __be32 nfsd4_backchannel_ctl(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_backchannel_ctl *);
585 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
586 extern __be32 nfsd4_create_session(struct svc_rqst *,
587 struct nfsd4_compound_state *,
588 struct nfsd4_create_session *);
589 extern __be32 nfsd4_sequence(struct svc_rqst *,
590 struct nfsd4_compound_state *,
591 struct nfsd4_sequence *);
592 extern void nfsd4_sequence_done(struct nfsd4_compoundres *resp);
593 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
594 struct nfsd4_compound_state *,
595 struct nfsd4_destroy_session *);
596 extern __be32 nfsd4_destroy_clientid(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_destroy_clientid *);
597 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
598 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
599 struct nfsd4_open *open, struct nfsd_net *nn);
600 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
601 struct svc_fh *current_fh, struct nfsd4_open *open);
602 extern void nfsd4_cstate_clear_replay(struct nfsd4_compound_state *cstate);
603 extern void nfsd4_cleanup_open_state(struct nfsd4_compound_state *cstate,
604 struct nfsd4_open *open, __be32 status);
605 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
606 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
607 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
608 struct nfsd4_compound_state *,
609 struct nfsd4_close *close);
610 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
611 struct nfsd4_compound_state *,
612 struct nfsd4_open_downgrade *od);
613 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
614 struct nfsd4_lock *lock);
615 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
616 struct nfsd4_compound_state *,
617 struct nfsd4_lockt *lockt);
618 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
619 struct nfsd4_compound_state *,
620 struct nfsd4_locku *locku);
621 extern __be32
622 nfsd4_release_lockowner(struct svc_rqst *rqstp,
623 struct nfsd4_compound_state *,
624 struct nfsd4_release_lockowner *rlockowner);
625 extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp);
626 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
627 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
628 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
629 struct nfsd4_compound_state *, clientid_t *clid);
630 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
631 struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid);
632 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
633 struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid);
634 extern void nfsd4_bump_seqid(struct nfsd4_compound_state *, __be32 nfserr);
636 #endif
639 * Local variables:
640 * c-basic-offset: 8
641 * End: