4515aee5863782bf25a8ab5b825c1c1f1f659a32
[dragonfly.git] / sys / vfs / nfs / nfsm_subs.h
1 /*
2  * Copyright (c) 1989, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Rick Macklem at The University of Guelph.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)nfsm_subs.h 8.2 (Berkeley) 3/30/95
37  * $FreeBSD: src/sys/nfs/nfsm_subs.h,v 1.27.2.1 2000/10/28 16:27:27 dwmalone Exp $
38  * $DragonFly: src/sys/vfs/nfs/nfsm_subs.h,v 1.10 2008/09/17 21:44:25 dillon Exp $
39  */
40
41
42 #ifndef _NFS_NFSM_SUBS_H_
43 #define _NFS_NFSM_SUBS_H_
44
45 struct ucred;
46 struct vnode;
47
48 enum nfsm_state {
49         NFSM_STATE_SETUP,
50         NFSM_STATE_AUTH,
51         NFSM_STATE_TRY,
52         NFSM_STATE_WAITREPLY,
53         NFSM_STATE_PROCESSREPLY,
54         NFSM_STATE_DONE
55 };
56
57 typedef enum nfsm_state nfsm_state_t;
58
59
60 struct nfsm_info {
61         /*
62          * These fields are used by various nfsm_* functions during
63          * the construction or deconstruction of a RPC.
64          */
65         struct mbuf     *mb;
66         struct mbuf     *md;
67         struct mbuf     *mrep;
68         struct mbuf     *mreq;
69         caddr_t         bpos;
70         caddr_t         dpos;
71         int             v3;
72
73         /*
74          * These fields are used by the request processing state
75          * machine.  mreq, md, dpos, and mrep above are also used.
76          */
77         nfsm_state_t    state;
78         u_int32_t       procnum;
79         struct vnode    *vp;
80         struct thread   *td;
81         struct ucred    *cred;
82         struct nfsreq   *req;
83         int             error;
84 };
85
86 typedef struct nfsm_info *nfsm_info_t;
87
88 #define NULLOUT(nfsmexp)                                \
89         do { if ((nfsmexp) == NULL) {                   \
90                 error = EBADRPC; goto nfsmout; }        \
91         } while(0)
92
93 #define NEGATIVEOUT(nfsmexp)                            \
94         do { if ((nfsmexp) < 0) {                       \
95                 error = EBADRPC; goto nfsmout; }        \
96         } while(0)
97
98 #define NEGKEEPOUT(nfsmexp)                             \
99         do { if ((nfsmexp) < 0) {                       \
100                 goto nfsmout; }                         \
101         } while(0)
102
103 #define NEGREPLYOUT(nfsmexp)                            \
104         do {                                            \
105                 int rv = (nfsmexp);                     \
106                 if (rv < 0) {                           \
107                         if (rv == -2)                   \
108                                 nfsm_reply(&info, nfsd, slp, 0, &error); \
109                         goto nfsmout;                   \
110                 }                                       \
111         } while(0)
112
113 #define ERROROUT(nfsmexp)       if ((error = (nfsmexp)) != 0) goto nfsmout
114
115 /*
116  * These macros do strange and peculiar things to mbuf chains for
117  * the assistance of the nfs code. To attempt to use them for any
118  * other purpose will be dangerous. (they make weird assumptions)
119  */
120
121 /*
122  * First define what the actual subs. return
123  */
124 void    nfsm_reqhead(nfsm_info_t info, struct vnode *vp,
125                                 u_long procid, int hsiz);
126 struct mbuf *nfsm_rpchead (struct ucred *cr, int nmflag, int procid,
127                                 int auth_type, int auth_len, char *auth_str,
128                                 int verf_len, char *verf_str,
129                                 struct mbuf *mrest, int mrest_len,
130                                 struct mbuf **mbp, u_int32_t *xidp);
131 void    *nfsm_build(nfsm_info_t info, int bytes);
132 void    *nfsm_dissect(nfsm_info_t info, int bytes);
133 int     nfsm_fhtom(nfsm_info_t info, struct vnode *vp);
134 void    nfsm_srvfhtom(nfsm_info_t info, fhandle_t *fhp);
135 void    nfsm_srvpostop_fh(nfsm_info_t info, fhandle_t *fhp);
136 int nfsm_mtofh(nfsm_info_t info, struct vnode *dvp,
137                                 struct vnode **vpp, int *gotvpp);
138 int     nfsm_getfh(nfsm_info_t info, nfsfh_t **fhpp);
139 int     nfsm_loadattr(nfsm_info_t info, struct vnode *vp, struct vattr *vap);
140 int     nfsm_postop_attr(nfsm_info_t info, struct vnode *vp,
141                                 int *attrp, int lflags);
142 int     nfsm_wcc_data(nfsm_info_t info, struct vnode *vp, int *attrp);
143 void    nfsm_v3attrbuild(nfsm_info_t info, struct vattr *vap, int full);
144 int     nfsm_strsiz(nfsm_info_t info, int maxlen);
145 int     nfsm_srvstrsiz(nfsm_info_t info, int maxlen, int *errorp);
146 int     nfsm_srvnamesiz(nfsm_info_t info, int *errorp);
147 int     nfsm_mtouio(nfsm_info_t info, struct uio *uiop, int len);
148 int     nfsm_uiotom(nfsm_info_t info, struct uio *uiop, int len);
149 int     nfsm_request(nfsm_info_t info, struct vnode *vp, int procnum,
150                                 thread_t td, struct ucred *cred, int *errorp);
151 int     nfsm_strtom(nfsm_info_t info, const void *data, int len, int maxlen);
152 int     nfsm_reply(nfsm_info_t info, struct nfsrv_descript *nfsd,
153                                 struct nfssvc_sock *slp, int siz, int *errorp);
154 void    nfsm_writereply(nfsm_info_t info, struct nfsrv_descript *nfsd,
155                                 struct nfssvc_sock *slp, int error, int siz);
156 int     nfsm_adv(nfsm_info_t info, int len);
157 int     nfsm_srvmtofh(nfsm_info_t info, struct nfsrv_descript *nfsd,
158                                 fhandle_t *fhp, int *errorp);
159 void    *_nfsm_clget(nfsm_info_t info, struct mbuf *mp1, struct mbuf *mp2,
160                                 char *bp, char *be);
161 int     nfsm_srvsattr(nfsm_info_t info, struct vattr *vap);
162 int     nfsm_mbuftouio(struct mbuf **mrep, struct uio *uiop,
163                                 int siz, caddr_t *dpos);
164 int     nfsm_uiotombuf (struct uio *uiop, struct mbuf **mq,
165                                 int siz, caddr_t *bpos);
166 int     nfsm_disct(struct mbuf **mdp, caddr_t *dposp, int siz,
167                                 int left, caddr_t *cp2);
168 int     nfsm_strtmbuf (struct mbuf **, char **, const char *, long);
169 void    nfsm_adj(struct mbuf *mp, int len, int nul);
170 void    nfsm_srvwcc_data(nfsm_info_t info, struct nfsrv_descript *nfsd,
171                                 int before_ret, struct vattr *before_vap,
172                                 int after_ret, struct vattr *after_vap);
173 void    nfsm_srvpostop_attr(nfsm_info_t info, struct nfsrv_descript *nfsd,
174                                 int after_ret, struct vattr *after_vap);
175 void    nfsm_srvfattr(struct nfsrv_descript *nfsd, struct vattr *vap,
176                                 struct nfs_fattr *fp);
177
178 int     nfs_request (struct nfsm_info *, nfsm_state_t);
179
180 #define nfsm_clget(info, mp1, mp2, bp, be)      \
181         ((bp >= be) ? _nfsm_clget(info, mp1, mp2, bp, be) : (void *)bp)
182
183 #define nfsm_rndup(a)   (((a) + 3) & (~0x3))
184
185 #define NFSV3_WCCRATTR  0
186 #define NFSV3_WCCCHK    1
187
188 #endif