]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - fs/nfsd/xdr4.h
nfsd4: drop most stateowner refcounting
[karo-tx-linux.git] / fs / nfsd / xdr4.h
1 /*
2  *  Server-side types for NFSv4.
3  *
4  *  Copyright (c) 2002 The Regents of the University of Michigan.
5  *  All rights reserved.
6  *
7  *  Kendrick Smith <kmsmith@umich.edu>
8  *  Andy Adamson   <andros@umich.edu>
9  *
10  *  Redistribution and use in source and binary forms, with or without
11  *  modification, are permitted provided that the following conditions
12  *  are met:
13  *
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.
22  *
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.
34  *
35  */
36
37 #ifndef _LINUX_NFSD_XDR4_H
38 #define _LINUX_NFSD_XDR4_H
39
40 #include "state.h"
41 #include "nfsd.h"
42
43 #define NFSD4_MAX_TAGLEN        128
44 #define XDR_LEN(n)                     (((n) + 3) & ~3)
45
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;
57 };
58
59 static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
60 {
61         return cs->slot != NULL;
62 }
63
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;
73 };
74
75 struct nfsd4_access {
76         u32             ac_req_access;      /* request */
77         u32             ac_supported;       /* response */
78         u32             ac_resp_access;     /* response */
79 };
80
81 struct nfsd4_close {
82         u32             cl_seqid;           /* request */
83         stateid_t       cl_stateid;         /* request+response */
84 };
85
86 struct nfsd4_commit {
87         u64             co_offset;          /* request */
88         u32             co_count;           /* request */
89         nfs4_verifier   co_verf;            /* response */
90 };
91
92 struct nfsd4_create {
93         u32             cr_namelen;         /* request */
94         char *          cr_name;            /* request */
95         u32             cr_type;            /* request */
96         union {                             /* request */
97                 struct {
98                         u32 namelen;
99                         char *name;
100                 } link;   /* NF4LNK */
101                 struct {
102                         u32 specdata1;
103                         u32 specdata2;
104                 } dev;    /* NF4BLK, NF4CHR */
105         } u;
106         u32             cr_bmval[3];        /* request */
107         struct iattr    cr_iattr;           /* request */
108         struct nfsd4_change_info  cr_cinfo; /* response */
109         struct nfs4_acl *cr_acl;
110 };
111 #define cr_linklen      u.link.namelen
112 #define cr_linkname     u.link.name
113 #define cr_specdata1    u.dev.specdata1
114 #define cr_specdata2    u.dev.specdata2
115
116 struct nfsd4_delegreturn {
117         stateid_t       dr_stateid;
118 };
119
120 struct nfsd4_getattr {
121         u32             ga_bmval[3];        /* request */
122         struct svc_fh   *ga_fhp;            /* response */
123 };
124
125 struct nfsd4_link {
126         u32             li_namelen;         /* request */
127         char *          li_name;            /* request */
128         struct nfsd4_change_info  li_cinfo; /* response */
129 };
130
131 struct nfsd4_lock_denied {
132         clientid_t      ld_clientid;
133         struct xdr_netobj       ld_owner;
134         u64             ld_start;
135         u64             ld_length;
136         u32             ld_type;
137 };
138
139 struct nfsd4_lock {
140         /* request */
141         u32             lk_type;
142         u32             lk_reclaim;         /* boolean */
143         u64             lk_offset;
144         u64             lk_length;
145         u32             lk_is_new;
146         union {
147                 struct {
148                         u32             open_seqid;
149                         stateid_t       open_stateid;
150                         u32             lock_seqid;
151                         clientid_t      clientid;
152                         struct xdr_netobj owner;
153                 } new;
154                 struct {
155                         stateid_t       lock_stateid;
156                         u32             lock_seqid;
157                 } old;
158         } v;
159
160         /* response */
161         union {
162                 struct {
163                         stateid_t               stateid;
164                 } ok;
165                 struct nfsd4_lock_denied        denied;
166         } u;
167 };
168 #define lk_new_open_seqid       v.new.open_seqid
169 #define lk_new_open_stateid     v.new.open_stateid
170 #define lk_new_lock_seqid       v.new.lock_seqid
171 #define lk_new_clientid         v.new.clientid
172 #define lk_new_owner            v.new.owner
173 #define lk_old_lock_stateid     v.old.lock_stateid
174 #define lk_old_lock_seqid       v.old.lock_seqid
175
176 #define lk_rflags       u.ok.rflags
177 #define lk_resp_stateid u.ok.stateid
178 #define lk_denied       u.denied
179
180
181 struct nfsd4_lockt {
182         u32                             lt_type;
183         clientid_t                      lt_clientid;
184         struct xdr_netobj               lt_owner;
185         u64                             lt_offset;
186         u64                             lt_length;
187         struct nfs4_stateowner *        lt_stateowner;
188         struct nfsd4_lock_denied        lt_denied;
189 };
190
191  
192 struct nfsd4_locku {
193         u32             lu_type;
194         u32             lu_seqid;
195         stateid_t       lu_stateid;
196         u64             lu_offset;
197         u64             lu_length;
198 };
199
200
201 struct nfsd4_lookup {
202         u32             lo_len;             /* request */
203         char *          lo_name;            /* request */
204 };
205
206 struct nfsd4_putfh {
207         u32             pf_fhlen;           /* request */
208         char            *pf_fhval;          /* request */
209 };
210
211 struct nfsd4_open {
212         u32             op_claim_type;      /* request */
213         struct xdr_netobj op_fname;         /* request - everything but CLAIM_PREV */
214         u32             op_delegate_type;   /* request - CLAIM_PREV only */
215         stateid_t       op_delegate_stateid; /* request - response */
216         u32             op_create;          /* request */
217         u32             op_createmode;      /* request */
218         u32             op_bmval[3];        /* request */
219         struct iattr    iattr;              /* UNCHECKED4, GUARDED4, EXCLUSIVE4_1 */
220         nfs4_verifier   verf;               /* EXCLUSIVE4 */
221         clientid_t      op_clientid;        /* request */
222         struct xdr_netobj op_owner;           /* request */
223         u32             op_seqid;           /* request */
224         u32             op_share_access;    /* request */
225         u32             op_share_deny;      /* request */
226         stateid_t       op_stateid;         /* response */
227         u32             op_recall;          /* recall */
228         struct nfsd4_change_info  op_cinfo; /* response */
229         u32             op_rflags;          /* response */
230         int             op_truncate;        /* used during processing */
231         struct nfs4_stateowner *op_stateowner; /* used during processing */
232         struct nfs4_acl *op_acl;
233 };
234 #define op_iattr        iattr
235 #define op_verf         verf
236
237 struct nfsd4_open_confirm {
238         stateid_t       oc_req_stateid          /* request */;
239         u32             oc_seqid                /* request */;
240         stateid_t       oc_resp_stateid         /* response */;
241 };
242
243 struct nfsd4_open_downgrade {
244         stateid_t       od_stateid;
245         u32             od_seqid;
246         u32             od_share_access;
247         u32             od_share_deny;
248 };
249
250
251 struct nfsd4_read {
252         stateid_t       rd_stateid;         /* request */
253         u64             rd_offset;          /* request */
254         u32             rd_length;          /* request */
255         int             rd_vlen;
256         struct file     *rd_filp;
257         
258         struct svc_rqst *rd_rqstp;          /* response */
259         struct svc_fh * rd_fhp;             /* response */
260 };
261
262 struct nfsd4_readdir {
263         u64             rd_cookie;          /* request */
264         nfs4_verifier   rd_verf;            /* request */
265         u32             rd_dircount;        /* request */
266         u32             rd_maxcount;        /* request */
267         u32             rd_bmval[3];        /* request */
268         struct svc_rqst *rd_rqstp;          /* response */
269         struct svc_fh * rd_fhp;             /* response */
270
271         struct readdir_cd       common;
272         __be32 *                buffer;
273         int                     buflen;
274         __be32 *                offset;
275 };
276
277 struct nfsd4_release_lockowner {
278         clientid_t        rl_clientid;
279         struct xdr_netobj rl_owner;
280 };
281 struct nfsd4_readlink {
282         struct svc_rqst *rl_rqstp;          /* request */
283         struct svc_fh * rl_fhp;             /* request */
284 };
285
286 struct nfsd4_remove {
287         u32             rm_namelen;         /* request */
288         char *          rm_name;            /* request */
289         struct nfsd4_change_info  rm_cinfo; /* response */
290 };
291
292 struct nfsd4_rename {
293         u32             rn_snamelen;        /* request */
294         char *          rn_sname;           /* request */
295         u32             rn_tnamelen;        /* request */
296         char *          rn_tname;           /* request */
297         struct nfsd4_change_info  rn_sinfo; /* response */
298         struct nfsd4_change_info  rn_tinfo; /* response */
299 };
300
301 struct nfsd4_secinfo {
302         u32 si_namelen;                                 /* request */
303         char *si_name;                                  /* request */
304         struct svc_export *si_exp;                      /* response */
305 };
306
307 struct nfsd4_secinfo_no_name {
308         u32 sin_style;                                  /* request */
309         struct svc_export *sin_exp;                     /* response */
310 };
311
312 struct nfsd4_setattr {
313         stateid_t       sa_stateid;         /* request */
314         u32             sa_bmval[3];        /* request */
315         struct iattr    sa_iattr;           /* request */
316         struct nfs4_acl *sa_acl;
317 };
318
319 struct nfsd4_setclientid {
320         nfs4_verifier   se_verf;            /* request */
321         u32             se_namelen;         /* request */
322         char *          se_name;            /* request */
323         u32             se_callback_prog;   /* request */
324         u32             se_callback_netid_len;  /* request */
325         char *          se_callback_netid_val;  /* request */
326         u32             se_callback_addr_len;   /* request */
327         char *          se_callback_addr_val;   /* request */
328         u32             se_callback_ident;  /* request */
329         clientid_t      se_clientid;        /* response */
330         nfs4_verifier   se_confirm;         /* response */
331 };
332
333 struct nfsd4_setclientid_confirm {
334         clientid_t      sc_clientid;
335         nfs4_verifier   sc_confirm;
336 };
337
338 struct nfsd4_saved_compoundargs {
339         __be32 *p;
340         __be32 *end;
341         int pagelen;
342         struct page **pagelist;
343 };
344
345 struct nfsd4_test_stateid {
346         __be32          ts_num_ids;
347         bool            ts_has_session;
348         struct nfsd4_compoundargs *ts_saved_args;
349         struct nfsd4_saved_compoundargs ts_savedp;
350 };
351
352 struct nfsd4_free_stateid {
353         stateid_t       fr_stateid;         /* request */
354         __be32          fr_status;          /* response */
355 };
356
357 /* also used for NVERIFY */
358 struct nfsd4_verify {
359         u32             ve_bmval[3];        /* request */
360         u32             ve_attrlen;         /* request */
361         char *          ve_attrval;         /* request */
362 };
363
364 struct nfsd4_write {
365         stateid_t       wr_stateid;         /* request */
366         u64             wr_offset;          /* request */
367         u32             wr_stable_how;      /* request */
368         u32             wr_buflen;          /* request */
369         int             wr_vlen;
370
371         u32             wr_bytes_written;   /* response */
372         u32             wr_how_written;     /* response */
373         nfs4_verifier   wr_verifier;        /* response */
374 };
375
376 struct nfsd4_exchange_id {
377         nfs4_verifier   verifier;
378         struct xdr_netobj clname;
379         u32             flags;
380         clientid_t      clientid;
381         u32             seqid;
382         int             spa_how;
383 };
384
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 */
391 #if 0
392         u32                     target_maxslots;        /* response */
393 #endif /* not yet */
394         u32                     status_flags;           /* response */
395 };
396
397 struct nfsd4_destroy_session {
398         struct nfs4_sessionid   sessionid;
399 };
400
401 struct nfsd4_reclaim_complete {
402         u32 rca_one_fs;
403 };
404
405 struct nfsd4_op {
406         int                                     opnum;
407         __be32                                  status;
408         union {
409                 struct nfsd4_access             access;
410                 struct nfsd4_close              close;
411                 struct nfsd4_commit             commit;
412                 struct nfsd4_create             create;
413                 struct nfsd4_delegreturn        delegreturn;
414                 struct nfsd4_getattr            getattr;
415                 struct svc_fh *                 getfh;
416                 struct nfsd4_link               link;
417                 struct nfsd4_lock               lock;
418                 struct nfsd4_lockt              lockt;
419                 struct nfsd4_locku              locku;
420                 struct nfsd4_lookup             lookup;
421                 struct nfsd4_verify             nverify;
422                 struct nfsd4_open               open;
423                 struct nfsd4_open_confirm       open_confirm;
424                 struct nfsd4_open_downgrade     open_downgrade;
425                 struct nfsd4_putfh              putfh;
426                 struct nfsd4_read               read;
427                 struct nfsd4_readdir            readdir;
428                 struct nfsd4_readlink           readlink;
429                 struct nfsd4_remove             remove;
430                 struct nfsd4_rename             rename;
431                 clientid_t                      renew;
432                 struct nfsd4_secinfo            secinfo;
433                 struct nfsd4_setattr            setattr;
434                 struct nfsd4_setclientid        setclientid;
435                 struct nfsd4_setclientid_confirm setclientid_confirm;
436                 struct nfsd4_verify             verify;
437                 struct nfsd4_write              write;
438                 struct nfsd4_release_lockowner  release_lockowner;
439
440                 /* NFSv4.1 */
441                 struct nfsd4_exchange_id        exchange_id;
442                 struct nfsd4_bind_conn_to_session bind_conn_to_session;
443                 struct nfsd4_create_session     create_session;
444                 struct nfsd4_destroy_session    destroy_session;
445                 struct nfsd4_sequence           sequence;
446                 struct nfsd4_reclaim_complete   reclaim_complete;
447                 struct nfsd4_test_stateid       test_stateid;
448                 struct nfsd4_free_stateid       free_stateid;
449         } u;
450         struct nfs4_replay *                    replay;
451 };
452
453 bool nfsd4_cache_this_op(struct nfsd4_op *);
454
455 struct nfsd4_compoundargs {
456         /* scratch variables for XDR decode */
457         __be32 *                        p;
458         __be32 *                        end;
459         struct page **                  pagelist;
460         int                             pagelen;
461         __be32                          tmp[8];
462         __be32 *                        tmpp;
463         struct tmpbuf {
464                 struct tmpbuf *next;
465                 void (*release)(const void *);
466                 void *buf;
467         }                               *to_free;
468
469         struct svc_rqst                 *rqstp;
470
471         u32                             taglen;
472         char *                          tag;
473         u32                             minorversion;
474         u32                             opcnt;
475         struct nfsd4_op                 *ops;
476         struct nfsd4_op                 iops[8];
477         int                             cachetype;
478 };
479
480 struct nfsd4_compoundres {
481         /* scratch variables for XDR encode */
482         __be32 *                        p;
483         __be32 *                        end;
484         struct xdr_buf *                xbuf;
485         struct svc_rqst *               rqstp;
486
487         u32                             taglen;
488         char *                          tag;
489         u32                             opcnt;
490         __be32 *                        tagp; /* tag, opcount encode location */
491         struct nfsd4_compound_state     cstate;
492 };
493
494 static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
495 {
496         struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
497         return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
498 }
499
500 static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
501 {
502         return !resp->cstate.slot->sl_cachethis || nfsd4_is_solo_sequence(resp);
503 }
504
505 #define NFS4_SVC_XDRSIZE                sizeof(struct nfsd4_compoundargs)
506
507 static inline void
508 set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
509 {
510         BUG_ON(!fhp->fh_pre_saved);
511         cinfo->atomic = fhp->fh_post_saved;
512         cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
513
514         cinfo->before_change = fhp->fh_pre_change;
515         cinfo->after_change = fhp->fh_post_change;
516         cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
517         cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
518         cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
519         cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
520
521 }
522
523 int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
524 int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
525                 struct nfsd4_compoundargs *);
526 int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
527                 struct nfsd4_compoundres *);
528 void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
529 void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
530 __be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
531                        struct dentry *dentry, __be32 *buffer, int *countp,
532                        u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
533 extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
534                 struct nfsd4_compound_state *,
535                 struct nfsd4_setclientid *setclid);
536 extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
537                 struct nfsd4_compound_state *,
538                 struct nfsd4_setclientid_confirm *setclientid_confirm);
539 extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
540 extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
541                 struct nfsd4_sequence *seq);
542 extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
543                 struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
544 extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
545 extern __be32 nfsd4_create_session(struct svc_rqst *,
546                 struct nfsd4_compound_state *,
547                 struct nfsd4_create_session *);
548 extern __be32 nfsd4_sequence(struct svc_rqst *,
549                 struct nfsd4_compound_state *,
550                 struct nfsd4_sequence *);
551 extern __be32 nfsd4_destroy_session(struct svc_rqst *,
552                 struct nfsd4_compound_state *,
553                 struct nfsd4_destroy_session *);
554 __be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
555 extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
556                 struct nfsd4_open *open);
557 extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
558                 struct svc_fh *current_fh, struct nfsd4_open *open);
559 extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
560                 struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
561 extern __be32 nfsd4_close(struct svc_rqst *rqstp,
562                 struct nfsd4_compound_state *,
563                 struct nfsd4_close *close);
564 extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
565                 struct nfsd4_compound_state *,
566                 struct nfsd4_open_downgrade *od);
567 extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
568                 struct nfsd4_lock *lock);
569 extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
570                 struct nfsd4_compound_state *,
571                 struct nfsd4_lockt *lockt);
572 extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
573                 struct nfsd4_compound_state *,
574                 struct nfsd4_locku *locku);
575 extern __be32
576 nfsd4_release_lockowner(struct svc_rqst *rqstp,
577                 struct nfsd4_compound_state *,
578                 struct nfsd4_release_lockowner *rlockowner);
579 extern int nfsd4_release_compoundargs(void *rq, __be32 *p, void *resp);
580 extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
581                 struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
582 extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
583                           struct nfsd4_compound_state *, clientid_t *clid);
584 extern __be32 nfsd4_test_stateid(struct svc_rqst *rqstp,
585                 struct nfsd4_compound_state *, struct nfsd4_test_stateid *test_stateid);
586 extern __be32 nfsd4_free_stateid(struct svc_rqst *rqstp,
587                 struct nfsd4_compound_state *, struct nfsd4_free_stateid *free_stateid);
588 #endif
589
590 /*
591  * Local variables:
592  *  c-basic-offset: 8
593  * End:
594  */