xref: /original-bsd/sys/nfs/nfsm_subs.h (revision 2bd07fe6)
1 /*
2  * Copyright (c) 1989 The Regents of the University of California.
3  * 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 are permitted
9  * provided that the above copyright notice and this paragraph are
10  * duplicated in all such forms and that any documentation,
11  * advertising materials, and other materials related to such
12  * distribution and use acknowledge that the software was developed
13  * by the University of California, Berkeley.  The name of the
14  * University may not be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
19  *
20  *	@(#)nfsm_subs.h	7.6 (Berkeley) 02/16/90
21  */
22 
23 /*
24  * These macros do strange and peculiar things to mbuf chains for
25  * the assistance of the nfs code. To attempt to use them for any
26  * other purpose will be dangerous. (they make weird assumptions)
27  */
28 
29 /*
30  * First define what the actual subs. return
31  */
32 extern struct mbuf *nfsm_reqh();
33 extern struct vnode *nfs_fhtovp();
34 
35 /*
36  * To try and deal with different variants of mbuf.h, I have used the
37  * following defs. If M_HASCL is not defined in an older the 4.4bsd mbuf.h,
38  * you will have to use a different ifdef
39  */
40 #ifdef M_HASCL
41 #define	NFSMCLGET(m, w)	MCLGET(m)
42 #define	NFSMGETHDR(m)	MGET(m, M_WAIT, MT_DATA)
43 #define	MHLEN		MLEN
44 #define	NFSMINOFF(m) \
45 		if (M_HASCL(m)) \
46 			(m)->m_off = ((int)MTOCL(m))-(int)(m); \
47 		else \
48 			(m)->m_off = MMINOFF
49 #define	NFSMADV(m, s)	(m)->m_off += (s)
50 #define	NFSMSIZ(m)	((M_HASCL(m))?MCLBYTES:MLEN)
51 #define	m_nextpkt	m_act
52 #define	NFSMCOPY(m, o, l, w)	m_copy((m), (o), (l))
53 #else
54 #define	M_HASCL(m)	((m)->m_flags & M_EXT)
55 #define	NFSMCLGET	MCLGET
56 #define	NFSMGETHDR(m) \
57 		MGETHDR(m, M_WAIT, MT_DATA); \
58 		(m)->m_pkthdr.len = 0; \
59 		(m)->m_pkthdr.rcvif = (struct ifnet *)0
60 #define	NFSMINOFF(m) \
61 		if (M_HASCL(m)) \
62 			(m)->m_data = (m)->m_ext.ext_buf; \
63 		else \
64 			(m)->m_data = (m)->m_dat
65 #define	NFSMADV(m, s)	(m)->m_data += (s)
66 #define	NFSMSIZ(m)	((M_HASCL(m))?MCLBYTES: \
67 				(((m)->m_flags & M_PKTHDR)?MHLEN:MLEN))
68 #define	NFSMCOPY	m_copym
69 #endif
70 
71 #ifndef MCLBYTES
72 #define	MCLBYTES	CLBYTES
73 #endif
74 
75 #ifndef MT_CONTROL
76 #define	MT_CONTROL	MT_RIGHTS
77 #endif
78 
79 /*
80  * Now for the macros that do the simple stuff and call the functions
81  * for the hard stuff.
82  * These macros use several vars. declared in nfsm_reqhead and these
83  * vars. must not be used elsewhere unless you are careful not to corrupt
84  * them. The vars. starting with pN and tN (N=1,2,3,..) are temporaries
85  * that may be used so long as the value is not expected to retained
86  * after a macro.
87  * I know, this is kind of dorkey, but it makes the actual op functions
88  * fairly clean and deals with the mess caused by the xdr discriminating
89  * unions.
90  */
91 
92 #ifndef lint
93 #define	nfsm_build(a,c,s) \
94 		t1 = NFSMSIZ(mb); \
95 		if ((s) > (t1-mb->m_len)) { \
96 			MGET(mb2, M_WAIT, MT_DATA); \
97 			if ((s) > MLEN) \
98 				panic("build > MLEN"); \
99 			mb->m_next = mb2; \
100 			mb = mb2; \
101 			mb->m_len = 0; \
102 			bpos = mtod(mb, caddr_t); \
103 		} \
104 		(a) = (c)(bpos); \
105 		mb->m_len += (s); \
106 		bpos += (s)
107 #else /* lint */
108 #define	nfsm_build(a,c,s) \
109 		t1 = NFSMSIZ(mb); \
110 		if ((s) > (t1-mb->m_len)) { \
111 			MGET(mb2, M_WAIT, MT_DATA); \
112 			mb->m_next = mb2; \
113 			mb = mb2; \
114 			mb->m_len = 0; \
115 			bpos = mtod(mb, caddr_t); \
116 		} \
117 		(a) = (c)(bpos); \
118 		mb->m_len += (s); \
119 		bpos += (s)
120 #endif /* lint */
121 
122 #define	nfsm_disect(a,c,s) \
123 		t1 = mtod(md, caddr_t)+md->m_len-dpos; \
124 		if (t1 >= (s)) { \
125 			(a) = (c)(dpos); \
126 			dpos += (s); \
127 		} else if (error = nfsm_disct(&md, &dpos, (s), t1, TRUE, &cp2)) { \
128 			m_freem(mrep); \
129 			goto nfsmout; \
130 		} else { \
131 			(a) = (c)cp2; \
132 		}
133 
134 #define	nfsm_disecton(a,c,s) \
135 		t1 = mtod(md, caddr_t)+md->m_len-dpos; \
136 		if (t1 >= (s)) { \
137 			(a) = (c)(dpos); \
138 			dpos += (s); \
139 		} else if (error = nfsm_disct(&md, &dpos, (s), t1, FALSE, &cp2)) { \
140 			m_freem(mrep); \
141 			goto nfsmout; \
142 		} else { \
143 			(a) = (c)cp2; \
144 		}
145 
146 #define nfsm_fhtom(v) \
147 		nfsm_build(cp,caddr_t,NFSX_FH); \
148 		bcopy((caddr_t)&(VTONFS(v)->n_fh), cp, NFSX_FH)
149 
150 #define nfsm_srvfhtom(f) \
151 		nfsm_build(cp,caddr_t,NFSX_FH); \
152 		bcopy((caddr_t)(f), cp, NFSX_FH)
153 
154 #define nfsm_mtofh(d,v) \
155 		{ struct nfsnode *np; nfsv2fh_t *fhp; \
156 		nfsm_disect(fhp,nfsv2fh_t *,NFSX_FH); \
157 		if (error = nfs_nget((d)->v_mount, fhp, &np)) { \
158 			m_freem(mrep); \
159 			goto nfsmout; \
160 		} \
161 		(v) = NFSTOV(np); \
162 		nfsm_loadattr(v, (struct vattr *)0); \
163 		}
164 
165 #define	nfsm_loadattr(v,a) \
166 		{ struct vnode *tvp = (v); \
167 		if (error = nfs_loadattrcache(&tvp, &md, &dpos, (a))) { \
168 			m_freem(mrep); \
169 			goto nfsmout; \
170 		} \
171 		(v) = tvp; }
172 
173 #define	nfsm_strsiz(s,m) \
174 		nfsm_disect(p,u_long *,NFSX_UNSIGNED); \
175 		if (((s) = fxdr_unsigned(long,*p)) > (m)) { \
176 			m_freem(mrep); \
177 			error = EBADRPC; \
178 			goto nfsmout; \
179 		}
180 
181 #define	nfsm_srvstrsiz(s,m) \
182 		nfsm_disect(p,u_long *,NFSX_UNSIGNED); \
183 		if (((s) = fxdr_unsigned(long,*p)) > (m) || (s) <= 0) { \
184 			error = EBADRPC; \
185 			nfsm_reply(0); \
186 		}
187 
188 #define nfsm_mtouio(p,s) \
189 		if ((s) > 0 && \
190 		   (error = nfsm_mbuftouio(&md,(p),(s),&dpos))) { \
191 			m_freem(mrep); \
192 			goto nfsmout; \
193 		}
194 
195 #define nfsm_uiotom(p,s) \
196 		if (error = nfsm_uiotombuf((p),&mb,(s),&bpos)) { \
197 			m_freem(mreq); \
198 			goto nfsmout; \
199 		}
200 
201 #define	nfsm_reqhead(a,c,s) \
202 		if ((mreq = nfsm_reqh(nfs_prog,nfs_vers,(a),(c),(s),&bpos,&mb,&xid)) == NULL) { \
203 			error = ENOBUFS; \
204 			goto nfsmout; \
205 		}
206 
207 #define nfsm_reqdone	m_freem(mrep); \
208 		nfsmout:
209 
210 #define nfsm_rndup(a)	(((a)+3)&(~0x3))
211 
212 #define	nfsm_request(v, t)	\
213 		if (error = nfs_request((v), mreq, xid, 5*(t), \
214 		   (v)->v_mount, &mrep, &md, &dpos)) \
215 			goto nfsmout
216 
217 #define	nfsm_strtom(a,s,m) \
218 		if ((s) > (m)) { \
219 			m_freem(mreq); \
220 			error = ENAMETOOLONG; \
221 			goto nfsmout; \
222 		} \
223 		t2 = nfsm_rndup(s)+NFSX_UNSIGNED; \
224 		if(t2<=(NFSMSIZ(mb)-mb->m_len)){ \
225 			nfsm_build(p,u_long *,t2); \
226 			*p++ = txdr_unsigned(s); \
227 			*(p+((t2>>2)-2)) = 0; \
228 			bcopy((caddr_t)(a), (caddr_t)p, (s)); \
229 		} else if (error = nfsm_strtmbuf(&mb, &bpos, (a), (s))) { \
230 			m_freem(mreq); \
231 			goto nfsmout; \
232 		}
233 
234 #define	nfsm_srverr \
235 		{ \
236 			m_freem(mrep); \
237 			return(ENOBUFS); \
238 		}
239 
240 #define	nfsm_srvdone \
241 		nfsmout: \
242 		return(error)
243 
244 #ifndef lint
245 #define	nfsm_reply(s) \
246 		{ \
247 		*repstat = error; \
248 		if (error) \
249 			nfs_rephead(0, xid, error, mrq, &mb, &bpos); \
250 		else \
251 			nfs_rephead((s), xid, error, mrq, &mb, &bpos); \
252 		m_freem(mrep); \
253 		mreq = *mrq; \
254 		if (error) \
255 			return(0); \
256 		}
257 #else	/* lint */
258 #define	nfsm_reply(s) \
259 		{ \
260 		*repstat = error; \
261 		if (error) \
262 			nfs_rephead(0, xid, error, mrq, &mb, &bpos); \
263 		else \
264 			nfs_rephead((s), xid, error, mrq, &mb, &bpos); \
265 		m_freem(mrep); \
266 		mreq = *mrq; \
267 		mrep = mreq; \
268 		if (error) \
269 			return(0); \
270 		}
271 #endif	/* lint */
272 
273 #define	nfsm_adv(s) \
274 		t1 = mtod(md, caddr_t)+md->m_len-dpos; \
275 		if (t1 >= (s)) { \
276 			dpos += (s); \
277 		} else if (error = nfs_adv(&md, &dpos, (s), t1)) { \
278 			m_freem(mrep); \
279 			goto nfsmout; \
280 		}
281 
282 #define nfsm_srvmtofh(f) \
283 		nfsm_disecton(p, u_long *, NFSX_FH); \
284 		bcopy((caddr_t)p, (caddr_t)f, NFSX_FH)
285 
286 #define	nfsm_clget \
287 		if (bp >= be) { \
288 			MGET(mp, M_WAIT, MT_DATA); \
289 			NFSMCLGET(mp, M_WAIT); \
290 			mp->m_len = NFSMSIZ(mp); \
291 			if (mp3 == NULL) \
292 				mp3 = mp2 = mp; \
293 			else { \
294 				mp2->m_next = mp; \
295 				mp2 = mp; \
296 			} \
297 			bp = mtod(mp, caddr_t); \
298 			be = bp+mp->m_len; \
299 		} \
300 		p = (u_long *)bp
301 
302 #define	nfsm_srvfillattr \
303 	fp->fa_type = vtonfs_type(vap->va_type); \
304 	fp->fa_mode = vtonfs_mode(vap->va_type, vap->va_mode); \
305 	fp->fa_nlink = txdr_unsigned(vap->va_nlink); \
306 	fp->fa_uid = txdr_unsigned(vap->va_uid); \
307 	fp->fa_gid = txdr_unsigned(vap->va_gid); \
308 	fp->fa_size = txdr_unsigned(vap->va_size); \
309 	fp->fa_blocksize = txdr_unsigned(vap->va_blocksize); \
310 	fp->fa_rdev = txdr_unsigned(vap->va_rdev); \
311 	fp->fa_blocks = txdr_unsigned(vap->va_bytes / vap->va_blocksize); \
312 	fp->fa_fsid = txdr_unsigned(vap->va_fsid); \
313 	fp->fa_fileid = txdr_unsigned(vap->va_fileid); \
314 	fp->fa_atime.tv_sec = txdr_unsigned(vap->va_atime.tv_sec); \
315 	fp->fa_atime.tv_usec = txdr_unsigned(vap->va_flags); \
316 	txdr_time(&vap->va_mtime, &fp->fa_mtime); \
317 	fp->fa_ctime.tv_sec = txdr_unsigned(vap->va_ctime.tv_sec); \
318 	fp->fa_ctime.tv_usec = txdr_unsigned(vap->va_gen)
319 
320