xref: /freebsd/sys/xdr/xdr_mbuf.c (revision a9148abd9da5db2f1c682fb17bed791845fc41c9)
1 /*-
2  * Copyright (c) 2008 Isilon Inc http://www.isilon.com/
3  * Authors: Doug Rabson <dfr@rabson.org>
4  * Developed with Red Inc: Alfred Perlstein <alfred@freebsd.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30 
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/malloc.h>
34 #include <sys/mbuf.h>
35 
36 #include <rpc/types.h>
37 #include <rpc/xdr.h>
38 
39 static void xdrmbuf_destroy(XDR *);
40 static bool_t xdrmbuf_getlong(XDR *, long *);
41 static bool_t xdrmbuf_putlong(XDR *, const long *);
42 static bool_t xdrmbuf_getbytes(XDR *, char *, u_int);
43 static bool_t xdrmbuf_putbytes(XDR *, const char *, u_int);
44 /* XXX: w/64-bit pointers, u_int not enough! */
45 static u_int xdrmbuf_getpos(XDR *);
46 static bool_t xdrmbuf_setpos(XDR *, u_int);
47 static int32_t *xdrmbuf_inline(XDR *, u_int);
48 
49 static const struct	xdr_ops xdrmbuf_ops = {
50 	xdrmbuf_getlong,
51 	xdrmbuf_putlong,
52 	xdrmbuf_getbytes,
53 	xdrmbuf_putbytes,
54 	xdrmbuf_getpos,
55 	xdrmbuf_setpos,
56 	xdrmbuf_inline,
57 	xdrmbuf_destroy
58 };
59 
60 /*
61  * The procedure xdrmbuf_create initializes a stream descriptor for a
62  * mbuf.
63  */
64 void
65 xdrmbuf_create(XDR *xdrs, struct mbuf *m, enum xdr_op op)
66 {
67 
68 	xdrs->x_op = op;
69 	xdrs->x_ops = &xdrmbuf_ops;
70 	xdrs->x_base = (char *) m;
71 	if (op == XDR_ENCODE) {
72 		m = m_last(m);
73 		xdrs->x_private = m;
74 		xdrs->x_handy = m->m_len;
75 	} else {
76 		xdrs->x_private = m;
77 		xdrs->x_handy = 0;
78 	}
79 }
80 
81 void
82 xdrmbuf_append(XDR *xdrs, struct mbuf *madd)
83 {
84 	struct mbuf *m;
85 
86 	KASSERT(xdrs->x_ops == &xdrmbuf_ops && xdrs->x_op == XDR_ENCODE,
87 	    ("xdrmbuf_append: invalid XDR stream"));
88 
89 	if (m_length(madd, NULL) == 0) {
90 		m_freem(madd);
91 		return;
92 	}
93 
94 	m = (struct mbuf *) xdrs->x_private;
95 	m->m_next = madd;
96 
97 	m = m_last(madd);
98 	xdrs->x_private = m;
99 	xdrs->x_handy = m->m_len;
100 }
101 
102 struct mbuf *
103 xdrmbuf_getall(XDR *xdrs)
104 {
105 	struct mbuf *m0, *m;
106 
107 	KASSERT(xdrs->x_ops == &xdrmbuf_ops && xdrs->x_op == XDR_DECODE,
108 	    ("xdrmbuf_append: invalid XDR stream"));
109 
110 	m0 = (struct mbuf *) xdrs->x_base;
111 	m = (struct mbuf *) xdrs->x_private;
112 	if (m0 != m) {
113 		while (m0->m_next != m)
114 			m0 = m0->m_next;
115 		m0->m_next = NULL;
116 		xdrs->x_private = NULL;
117 	} else {
118 		xdrs->x_base = NULL;
119 		xdrs->x_private = NULL;
120 	}
121 
122 	m_adj(m, xdrs->x_handy);
123 	return (m);
124 }
125 
126 static void
127 xdrmbuf_destroy(XDR *xdrs)
128 {
129 
130 	if (xdrs->x_op == XDR_DECODE && xdrs->x_base) {
131 		m_freem((struct mbuf *) xdrs->x_base);
132 		xdrs->x_base = NULL;
133 		xdrs->x_private = NULL;
134 	}
135 }
136 
137 static bool_t
138 xdrmbuf_getlong(XDR *xdrs, long *lp)
139 {
140 	int32_t *p;
141 	int32_t t;
142 
143 	p = xdrmbuf_inline(xdrs, sizeof(int32_t));
144 	if (p) {
145 		t = *p;
146 	} else {
147 		xdrmbuf_getbytes(xdrs, (char *) &t, sizeof(int32_t));
148 	}
149 
150 	*lp = ntohl(t);
151 	return (TRUE);
152 }
153 
154 static bool_t
155 xdrmbuf_putlong(xdrs, lp)
156 	XDR *xdrs;
157 	const long *lp;
158 {
159 	int32_t *p;
160 	int32_t t = htonl(*lp);
161 
162 	p = xdrmbuf_inline(xdrs, sizeof(int32_t));
163 	if (p) {
164 		*p = t;
165 		return (TRUE);
166 	} else {
167 		return (xdrmbuf_putbytes(xdrs, (char *) &t, sizeof(int32_t)));
168 	}
169 }
170 
171 static bool_t
172 xdrmbuf_getbytes(XDR *xdrs, char *addr, u_int len)
173 {
174 	struct mbuf *m = (struct mbuf *) xdrs->x_private;
175 	size_t sz;
176 
177 	while (len > 0) {
178 		/*
179 		 * Make sure we haven't hit the end.
180 		 */
181 		if (!m) {
182 			return (FALSE);
183 		}
184 
185 		/*
186 		 * See how much we can get from this mbuf.
187 		 */
188 		sz = m->m_len - xdrs->x_handy;
189 		if (sz > len)
190 			sz = len;
191 		bcopy(mtod(m, const char *) + xdrs->x_handy, addr, sz);
192 
193 		addr += sz;
194 		xdrs->x_handy += sz;
195 		len -= sz;
196 
197 		if (xdrs->x_handy == m->m_len) {
198 			m = m->m_next;
199 			xdrs->x_private = (void *) m;
200 			xdrs->x_handy = 0;
201 		}
202 	}
203 
204 	return (TRUE);
205 }
206 
207 static bool_t
208 xdrmbuf_putbytes(XDR *xdrs, const char *addr, u_int len)
209 {
210 	struct mbuf *m = (struct mbuf *) xdrs->x_private;
211 	struct mbuf *n;
212 	size_t sz;
213 
214 	while (len > 0) {
215 		sz = M_TRAILINGSPACE(m) + (m->m_len - xdrs->x_handy);
216 		if (sz > len)
217 			sz = len;
218 		bcopy(addr, mtod(m, char *) + xdrs->x_handy, sz);
219 		addr += sz;
220 		xdrs->x_handy += sz;
221 		if (xdrs->x_handy > m->m_len)
222 			m->m_len = xdrs->x_handy;
223 		len -= sz;
224 
225 		if (xdrs->x_handy == m->m_len && M_TRAILINGSPACE(m) == 0) {
226 			if (!m->m_next) {
227 				MGET(n, M_TRYWAIT, m->m_type);
228 				if (m->m_flags & M_EXT)
229 					MCLGET(n, M_TRYWAIT);
230 				m->m_next = n;
231 			}
232 			m = m->m_next;
233 			xdrs->x_private = (void *) m;
234 			xdrs->x_handy = 0;
235 		}
236 	}
237 
238 	return (TRUE);
239 }
240 
241 static u_int
242 xdrmbuf_getpos(XDR *xdrs)
243 {
244 	struct mbuf *m0 = (struct mbuf *) xdrs->x_base;
245 	struct mbuf *m = (struct mbuf *) xdrs->x_private;
246 	u_int pos = 0;
247 
248 	while (m0 && m0 != m) {
249 		pos += m0->m_len;
250 		m0 = m0->m_next;
251 	}
252 	KASSERT(m0, ("Corrupted mbuf chain"));
253 
254 	return (pos + xdrs->x_handy);
255 }
256 
257 static bool_t
258 xdrmbuf_setpos(XDR *xdrs, u_int pos)
259 {
260 	struct mbuf *m = (struct mbuf *) xdrs->x_base;
261 
262 	while (m && pos > m->m_len) {
263 		pos -= m->m_len;
264 		m = m->m_next;
265 	}
266 	KASSERT(m, ("Corrupted mbuf chain"));
267 
268 	xdrs->x_private = (void *) m;
269 	xdrs->x_handy = pos;
270 
271 	return (TRUE);
272 }
273 
274 static int32_t *
275 xdrmbuf_inline(XDR *xdrs, u_int len)
276 {
277 	struct mbuf *m = (struct mbuf *) xdrs->x_private;
278 	size_t available;
279 	char *p;
280 
281 	if (xdrs->x_op == XDR_ENCODE) {
282 		available = M_TRAILINGSPACE(m) + (m->m_len - xdrs->x_handy);
283 	} else {
284 		available = m->m_len - xdrs->x_handy;
285 	}
286 
287 	if (available >= len) {
288 		p = mtod(m, char *) + xdrs->x_handy;
289 		if (((uintptr_t) p) & (sizeof(int32_t) - 1))
290 			return (0);
291 		xdrs->x_handy += len;
292 		if (xdrs->x_handy > m->m_len)
293 			m->m_len = xdrs->x_handy;
294 		return ((int32_t *) p);
295 	}
296 
297 	return (0);
298 }
299