2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2000, 2001 Boris Popov
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the author nor the names of any co-contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/sysctl.h>
38 #include <sys/endian.h>
39 #include <sys/errno.h>
40 #include <sys/malloc.h>
42 #include <sys/module.h>
45 #include <sys/mchain.h>
47 FEATURE(libmchain, "mchain library");
49 MODULE_VERSION(libmchain, 1);
51 #define MBERROR(format, ...) printf("%s(%d): "format, __func__ , \
52 __LINE__ , ## __VA_ARGS__)
54 #define MBPANIC(format, ...) printf("%s(%d): "format, __func__ , \
55 __LINE__ , ## __VA_ARGS__)
58 * Various helper functions
61 mb_init(struct mbchain *mbp)
65 m = m_gethdr(M_WAITOK, MT_DATA);
72 mb_initm(struct mbchain *mbp, struct mbuf *m)
74 bzero(mbp, sizeof(*mbp));
75 mbp->mb_top = mbp->mb_cur = m;
76 mbp->mb_mleft = M_TRAILINGSPACE(m);
80 mb_done(struct mbchain *mbp)
89 mb_detach(struct mbchain *mbp)
99 mb_fixhdr(struct mbchain *mbp)
101 return (mbp->mb_top->m_pkthdr.len = m_fixhdr(mbp->mb_top));
105 * Check if object of size 'size' fit to the current position and
106 * allocate new mbuf if not. Advance pointers and increase length of mbuf(s).
107 * Return pointer to the object placeholder or NULL if any error occurred.
108 * Note: size should be <= MLEN
111 mb_reserve(struct mbchain *mbp, int size)
117 panic("mb_reserve: size = %d\n", size);
119 if (mbp->mb_mleft < size) {
120 mn = m_get(M_WAITOK, MT_DATA);
121 mbp->mb_cur = m->m_next = mn;
124 mbp->mb_mleft = M_TRAILINGSPACE(m);
126 mbp->mb_mleft -= size;
127 mbp->mb_count += size;
128 bpos = mtod(m, caddr_t) + m->m_len;
134 mb_put_padbyte(struct mbchain *mbp)
139 dst = mtod(mbp->mb_cur, caddr_t) + mbp->mb_cur->m_len;
141 /* Only add padding if address is odd */
142 if ((unsigned long)dst & 1)
143 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
149 mb_put_uint8(struct mbchain *mbp, uint8_t x)
151 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
155 mb_put_uint16be(struct mbchain *mbp, uint16_t x)
158 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
162 mb_put_uint16le(struct mbchain *mbp, uint16_t x)
165 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
169 mb_put_uint32be(struct mbchain *mbp, uint32_t x)
172 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
176 mb_put_uint32le(struct mbchain *mbp, uint32_t x)
179 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
183 mb_put_int64be(struct mbchain *mbp, int64_t x)
186 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
190 mb_put_int64le(struct mbchain *mbp, int64_t x)
193 return (mb_put_mem(mbp, (caddr_t)&x, sizeof(x), MB_MSYSTEM));
197 mb_put_mem(struct mbchain *mbp, c_caddr_t source, int size, int type)
202 int cplen, error, mleft, count;
203 size_t srclen, dstlen;
206 mleft = mbp->mb_mleft;
210 if (m->m_next == NULL)
211 m = m_getm(m, size, M_WAITOK, MT_DATA);
214 mleft = M_TRAILINGSPACE(m);
217 cplen = mleft > size ? size : mleft;
218 srclen = dstlen = cplen;
219 dst = mtod(m, caddr_t) + m->m_len;
224 error = mbp->mb_copy(mbp, source, dst, &srclen, &dstlen);
229 for (src = source, count = cplen; count; count--)
233 bcopy(source, dst, cplen);
236 error = copyin(source, dst, cplen);
248 mbp->mb_count += dstlen;
251 mbp->mb_mleft = mleft;
256 mb_put_mbuf(struct mbchain *mbp, struct mbuf *m)
258 mbp->mb_cur->m_next = m;
260 mbp->mb_count += m->m_len;
261 if (m->m_next == NULL)
265 mbp->mb_mleft = M_TRAILINGSPACE(m);
271 * copies a uio scatter/gather list to an mbuf chain.
274 mb_put_uio(struct mbchain *mbp, struct uio *uiop, int size)
279 mtype = (uiop->uio_segflg == UIO_SYSSPACE) ? MB_MSYSTEM : MB_MUSER;
281 while (size > 0 && uiop->uio_resid) {
282 if (uiop->uio_iovcnt <= 0 || uiop->uio_iov == NULL)
284 left = uiop->uio_iov->iov_len;
292 error = mb_put_mem(mbp, uiop->uio_iov->iov_base, left, mtype);
295 uiop->uio_offset += left;
296 uiop->uio_resid -= left;
297 uiop->uio_iov->iov_base =
298 (char *)uiop->uio_iov->iov_base + left;
299 uiop->uio_iov->iov_len -= left;
306 * Routines for fetching data from an mbuf chain
309 md_init(struct mdchain *mdp)
313 m = m_gethdr(M_WAITOK, MT_DATA);
320 md_initm(struct mdchain *mdp, struct mbuf *m)
322 bzero(mdp, sizeof(*mdp));
323 mdp->md_top = mdp->md_cur = m;
324 mdp->md_pos = mtod(m, u_char*);
328 md_done(struct mdchain *mdp)
331 m_freem(mdp->md_top);
337 * Append a separate mbuf chain. It is caller responsibility to prevent
338 * multiple calls to fetch/record routines.
341 md_append_record(struct mdchain *mdp, struct mbuf *top)
345 if (mdp->md_top == NULL) {
353 top->m_nextpkt = NULL;
358 * Put next record in place of existing
361 md_next_record(struct mdchain *mdp)
365 if (mdp->md_top == NULL)
367 m = mdp->md_top->m_nextpkt;
376 md_get_uint8(struct mdchain *mdp, uint8_t *x)
378 return (md_get_mem(mdp, x, 1, MB_MINLINE));
382 md_get_uint16(struct mdchain *mdp, uint16_t *x)
384 return (md_get_mem(mdp, (caddr_t)x, 2, MB_MINLINE));
388 md_get_uint16le(struct mdchain *mdp, uint16_t *x)
391 int error = md_get_uint16(mdp, &v);
399 md_get_uint16be(struct mdchain *mdp, uint16_t *x)
402 int error = md_get_uint16(mdp, &v);
410 md_get_uint32(struct mdchain *mdp, uint32_t *x)
412 return (md_get_mem(mdp, (caddr_t)x, 4, MB_MINLINE));
416 md_get_uint32be(struct mdchain *mdp, uint32_t *x)
421 error = md_get_uint32(mdp, &v);
428 md_get_uint32le(struct mdchain *mdp, uint32_t *x)
433 error = md_get_uint32(mdp, &v);
440 md_get_int64(struct mdchain *mdp, int64_t *x)
442 return (md_get_mem(mdp, (caddr_t)x, 8, MB_MINLINE));
446 md_get_int64be(struct mdchain *mdp, int64_t *x)
451 error = md_get_int64(mdp, &v);
458 md_get_int64le(struct mdchain *mdp, int64_t *x)
463 error = md_get_int64(mdp, &v);
470 md_get_mem(struct mdchain *mdp, caddr_t target, int size, int type)
472 struct mbuf *m = mdp->md_cur;
479 MBERROR("incomplete copy\n");
483 count = mtod(m, u_char*) + m->m_len - s;
485 mdp->md_cur = m = m->m_next;
487 s = mdp->md_pos = mtod(m, caddr_t);
493 mdp->md_pos += count;
498 error = copyout(s, target, count);
503 bcopy(s, target, count);
516 md_get_mbuf(struct mdchain *mdp, int size, struct mbuf **ret)
518 struct mbuf *m = mdp->md_cur, *rm;
520 rm = m_copym(m, mdp->md_pos - mtod(m, u_char*), size, M_WAITOK);
521 md_get_mem(mdp, NULL, size, MB_MZERO);
527 md_get_uio(struct mdchain *mdp, struct uio *uiop, int size)
533 mtype = (uiop->uio_segflg == UIO_SYSSPACE) ? MB_MSYSTEM : MB_MUSER;
534 while (size > 0 && uiop->uio_resid) {
535 if (uiop->uio_iovcnt <= 0 || uiop->uio_iov == NULL)
537 left = uiop->uio_iov->iov_len;
543 uiocp = uiop->uio_iov->iov_base;
546 error = md_get_mem(mdp, uiocp, left, mtype);
549 uiop->uio_offset += left;
550 uiop->uio_resid -= left;
551 uiop->uio_iov->iov_base =
552 (char *)uiop->uio_iov->iov_base + left;
553 uiop->uio_iov->iov_len -= left;