Root/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
46struct 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
59static inline bool nfsd4_has_session(struct nfsd4_compound_state *cs)
60{
61    return cs->slot != NULL;
62}
63
64struct 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
75struct nfsd4_access {
76    u32 ac_req_access; /* request */
77    u32 ac_supported; /* response */
78    u32 ac_resp_access; /* response */
79};
80
81struct nfsd4_close {
82    u32 cl_seqid; /* request */
83    stateid_t cl_stateid; /* request+response */
84    struct nfs4_stateowner * cl_stateowner; /* response */
85};
86
87struct nfsd4_commit {
88    u64 co_offset; /* request */
89    u32 co_count; /* request */
90    nfs4_verifier co_verf; /* response */
91};
92
93struct 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;
111};
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
116
117struct nfsd4_delegreturn {
118    stateid_t dr_stateid;
119};
120
121struct nfsd4_getattr {
122    u32 ga_bmval[3]; /* request */
123    struct svc_fh *ga_fhp; /* response */
124};
125
126struct nfsd4_link {
127    u32 li_namelen; /* request */
128    char * li_name; /* request */
129    struct nfsd4_change_info li_cinfo; /* response */
130};
131
132struct 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;
138};
139
140struct 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;
160
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;
171};
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
179
180#define lk_rflags u.ok.rflags
181#define lk_resp_stateid u.ok.stateid
182#define lk_denied u.denied
183
184
185struct 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;
193};
194
195 
196struct 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;
203};
204
205
206struct nfsd4_lookup {
207    u32 lo_len; /* request */
208    char * lo_name; /* request */
209};
210
211struct nfsd4_putfh {
212    u32 pf_fhlen; /* request */
213    char *pf_fhval; /* request */
214};
215
216struct 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;
238};
239#define op_iattr iattr
240#define op_verf verf
241
242struct 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 */
247};
248
249struct 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;
255};
256
257
258struct 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;
264    
265    struct svc_rqst *rd_rqstp; /* response */
266    struct svc_fh * rd_fhp; /* response */
267};
268
269struct 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 */
277
278    struct readdir_cd common;
279    __be32 * buffer;
280    int buflen;
281    __be32 * offset;
282};
283
284struct nfsd4_release_lockowner {
285    clientid_t rl_clientid;
286    struct xdr_netobj rl_owner;
287};
288struct nfsd4_readlink {
289    struct svc_rqst *rl_rqstp; /* request */
290    struct svc_fh * rl_fhp; /* request */
291};
292
293struct nfsd4_remove {
294    u32 rm_namelen; /* request */
295    char * rm_name; /* request */
296    struct nfsd4_change_info rm_cinfo; /* response */
297};
298
299struct 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 */
306};
307
308struct nfsd4_secinfo {
309    u32 si_namelen; /* request */
310    char *si_name; /* request */
311    struct svc_export *si_exp; /* response */
312};
313
314struct nfsd4_secinfo_no_name {
315    u32 sin_style; /* request */
316    struct svc_export *sin_exp; /* response */
317};
318
319struct 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;
324};
325
326struct 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 */
338};
339
340struct nfsd4_setclientid_confirm {
341    clientid_t sc_clientid;
342    nfs4_verifier sc_confirm;
343};
344
345/* also used for NVERIFY */
346struct nfsd4_verify {
347    u32 ve_bmval[3]; /* request */
348    u32 ve_attrlen; /* request */
349    char * ve_attrval; /* request */
350};
351
352struct nfsd4_write {
353    stateid_t wr_stateid; /* request */
354    u64 wr_offset; /* request */
355    u32 wr_stable_how; /* request */
356    u32 wr_buflen; /* request */
357    int wr_vlen;
358
359    u32 wr_bytes_written; /* response */
360    u32 wr_how_written; /* response */
361    nfs4_verifier wr_verifier; /* response */
362};
363
364struct nfsd4_exchange_id {
365    nfs4_verifier verifier;
366    struct xdr_netobj clname;
367    u32 flags;
368    clientid_t clientid;
369    u32 seqid;
370    int spa_how;
371};
372
373struct nfsd4_sequence {
374    struct nfs4_sessionid sessionid; /* request/response */
375    u32 seqid; /* request/response */
376    u32 slotid; /* request/response */
377    u32 maxslots; /* request/response */
378    u32 cachethis; /* request */
379#if 0
380    u32 target_maxslots; /* response */
381#endif /* not yet */
382    u32 status_flags; /* response */
383};
384
385struct nfsd4_destroy_session {
386    struct nfs4_sessionid sessionid;
387};
388
389struct nfsd4_reclaim_complete {
390    u32 rca_one_fs;
391};
392
393struct nfsd4_op {
394    int opnum;
395    __be32 status;
396    union {
397        struct nfsd4_access access;
398        struct nfsd4_close close;
399        struct nfsd4_commit commit;
400        struct nfsd4_create create;
401        struct nfsd4_delegreturn delegreturn;
402        struct nfsd4_getattr getattr;
403        struct svc_fh * getfh;
404        struct nfsd4_link link;
405        struct nfsd4_lock lock;
406        struct nfsd4_lockt lockt;
407        struct nfsd4_locku locku;
408        struct nfsd4_lookup lookup;
409        struct nfsd4_verify nverify;
410        struct nfsd4_open open;
411        struct nfsd4_open_confirm open_confirm;
412        struct nfsd4_open_downgrade open_downgrade;
413        struct nfsd4_putfh putfh;
414        struct nfsd4_read read;
415        struct nfsd4_readdir readdir;
416        struct nfsd4_readlink readlink;
417        struct nfsd4_remove remove;
418        struct nfsd4_rename rename;
419        clientid_t renew;
420        struct nfsd4_secinfo secinfo;
421        struct nfsd4_setattr setattr;
422        struct nfsd4_setclientid setclientid;
423        struct nfsd4_setclientid_confirm setclientid_confirm;
424        struct nfsd4_verify verify;
425        struct nfsd4_write write;
426        struct nfsd4_release_lockowner release_lockowner;
427
428        /* NFSv4.1 */
429        struct nfsd4_exchange_id exchange_id;
430        struct nfsd4_bind_conn_to_session bind_conn_to_session;
431        struct nfsd4_create_session create_session;
432        struct nfsd4_destroy_session destroy_session;
433        struct nfsd4_sequence sequence;
434        struct nfsd4_reclaim_complete reclaim_complete;
435    } u;
436    struct nfs4_replay * replay;
437};
438
439struct nfsd4_compoundargs {
440    /* scratch variables for XDR decode */
441    __be32 * p;
442    __be32 * end;
443    struct page ** pagelist;
444    int pagelen;
445    __be32 tmp[8];
446    __be32 * tmpp;
447    struct tmpbuf {
448        struct tmpbuf *next;
449        void (*release)(const void *);
450        void *buf;
451    } *to_free;
452
453    struct svc_rqst *rqstp;
454
455    u32 taglen;
456    char * tag;
457    u32 minorversion;
458    u32 opcnt;
459    struct nfsd4_op *ops;
460    struct nfsd4_op iops[8];
461};
462
463struct nfsd4_compoundres {
464    /* scratch variables for XDR encode */
465    __be32 * p;
466    __be32 * end;
467    struct xdr_buf * xbuf;
468    struct svc_rqst * rqstp;
469
470    u32 taglen;
471    char * tag;
472    u32 opcnt;
473    __be32 * tagp; /* tag, opcount encode location */
474    struct nfsd4_compound_state cstate;
475};
476
477static inline bool nfsd4_is_solo_sequence(struct nfsd4_compoundres *resp)
478{
479    struct nfsd4_compoundargs *args = resp->rqstp->rq_argp;
480    return resp->opcnt == 1 && args->ops[0].opnum == OP_SEQUENCE;
481}
482
483static inline bool nfsd4_not_cached(struct nfsd4_compoundres *resp)
484{
485    return !resp->cstate.slot->sl_cachethis || nfsd4_is_solo_sequence(resp);
486}
487
488#define NFS4_SVC_XDRSIZE sizeof(struct nfsd4_compoundargs)
489
490static inline void
491set_change_info(struct nfsd4_change_info *cinfo, struct svc_fh *fhp)
492{
493    BUG_ON(!fhp->fh_pre_saved);
494    cinfo->atomic = fhp->fh_post_saved;
495    cinfo->change_supported = IS_I_VERSION(fhp->fh_dentry->d_inode);
496
497    cinfo->before_change = fhp->fh_pre_change;
498    cinfo->after_change = fhp->fh_post_change;
499    cinfo->before_ctime_sec = fhp->fh_pre_ctime.tv_sec;
500    cinfo->before_ctime_nsec = fhp->fh_pre_ctime.tv_nsec;
501    cinfo->after_ctime_sec = fhp->fh_post_attr.ctime.tv_sec;
502    cinfo->after_ctime_nsec = fhp->fh_post_attr.ctime.tv_nsec;
503
504}
505
506int nfs4svc_encode_voidres(struct svc_rqst *, __be32 *, void *);
507int nfs4svc_decode_compoundargs(struct svc_rqst *, __be32 *,
508        struct nfsd4_compoundargs *);
509int nfs4svc_encode_compoundres(struct svc_rqst *, __be32 *,
510        struct nfsd4_compoundres *);
511void nfsd4_encode_operation(struct nfsd4_compoundres *, struct nfsd4_op *);
512void nfsd4_encode_replay(struct nfsd4_compoundres *resp, struct nfsd4_op *op);
513__be32 nfsd4_encode_fattr(struct svc_fh *fhp, struct svc_export *exp,
514               struct dentry *dentry, __be32 *buffer, int *countp,
515               u32 *bmval, struct svc_rqst *, int ignore_crossmnt);
516extern __be32 nfsd4_setclientid(struct svc_rqst *rqstp,
517        struct nfsd4_compound_state *,
518        struct nfsd4_setclientid *setclid);
519extern __be32 nfsd4_setclientid_confirm(struct svc_rqst *rqstp,
520        struct nfsd4_compound_state *,
521        struct nfsd4_setclientid_confirm *setclientid_confirm);
522extern void nfsd4_store_cache_entry(struct nfsd4_compoundres *resp);
523extern __be32 nfsd4_replay_cache_entry(struct nfsd4_compoundres *resp,
524        struct nfsd4_sequence *seq);
525extern __be32 nfsd4_exchange_id(struct svc_rqst *rqstp,
526        struct nfsd4_compound_state *, struct nfsd4_exchange_id *);
527extern __be32 nfsd4_bind_conn_to_session(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_bind_conn_to_session *);
528extern __be32 nfsd4_create_session(struct svc_rqst *,
529        struct nfsd4_compound_state *,
530        struct nfsd4_create_session *);
531extern __be32 nfsd4_sequence(struct svc_rqst *,
532        struct nfsd4_compound_state *,
533        struct nfsd4_sequence *);
534extern __be32 nfsd4_destroy_session(struct svc_rqst *,
535        struct nfsd4_compound_state *,
536        struct nfsd4_destroy_session *);
537__be32 nfsd4_reclaim_complete(struct svc_rqst *, struct nfsd4_compound_state *, struct nfsd4_reclaim_complete *);
538extern __be32 nfsd4_process_open1(struct nfsd4_compound_state *,
539        struct nfsd4_open *open);
540extern __be32 nfsd4_process_open2(struct svc_rqst *rqstp,
541        struct svc_fh *current_fh, struct nfsd4_open *open);
542extern __be32 nfsd4_open_confirm(struct svc_rqst *rqstp,
543        struct nfsd4_compound_state *, struct nfsd4_open_confirm *oc);
544extern __be32 nfsd4_close(struct svc_rqst *rqstp,
545        struct nfsd4_compound_state *,
546        struct nfsd4_close *close);
547extern __be32 nfsd4_open_downgrade(struct svc_rqst *rqstp,
548        struct nfsd4_compound_state *,
549        struct nfsd4_open_downgrade *od);
550extern __be32 nfsd4_lock(struct svc_rqst *rqstp, struct nfsd4_compound_state *,
551        struct nfsd4_lock *lock);
552extern __be32 nfsd4_lockt(struct svc_rqst *rqstp,
553        struct nfsd4_compound_state *,
554        struct nfsd4_lockt *lockt);
555extern __be32 nfsd4_locku(struct svc_rqst *rqstp,
556        struct nfsd4_compound_state *,
557        struct nfsd4_locku *locku);
558extern __be32
559nfsd4_release_lockowner(struct svc_rqst *rqstp,
560        struct nfsd4_compound_state *,
561        struct nfsd4_release_lockowner *rlockowner);
562extern void nfsd4_release_compoundargs(struct nfsd4_compoundargs *);
563extern __be32 nfsd4_delegreturn(struct svc_rqst *rqstp,
564        struct nfsd4_compound_state *, struct nfsd4_delegreturn *dr);
565extern __be32 nfsd4_renew(struct svc_rqst *rqstp,
566              struct nfsd4_compound_state *, clientid_t *clid);
567#endif
568
569/*
570 * Local variables:
571 * c-basic-offset: 8
572 * End:
573 */
574

Archive Download this file



interactive