1 /* $KAME: uipc_mbuf2.c,v 1.31 2001/11/28 11:08:53 itojun Exp $ */
2 /* $NetBSD: uipc_mbuf.c,v 1.40 1999/04/01 00:23:25 thorpej Exp $ */
5 * Copyright (C) 1999 WIDE Project.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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. Neither the name of the project nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * Copyright (c) 1982, 1986, 1988, 1991, 1993
34 * The Regents of the University of California. All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60 * @(#)uipc_mbuf.c 8.4 (Berkeley) 2/14/95
63 #include <sys/cdefs.h>
64 __FBSDID("$FreeBSD$");
66 /*#define PULLDOWN_DEBUG*/
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/kernel.h>
72 #include <sys/malloc.h>
74 #include <sys/mutex.h>
76 #include <security/mac/mac_framework.h>
78 static MALLOC_DEFINE(M_PACKET_TAGS, MBUF_TAG_MEM_NAME,
79 "packet-attached information");
81 /* can't call it m_dup(), as freebsd[34] uses m_dup() with different arg */
82 static struct mbuf *m_dup1(struct mbuf *, int, int, int);
85 * ensure that [off, off + len) is contiguous on the mbuf chain "m".
86 * packet chain before "off" is kept untouched.
87 * if offp == NULL, the target will start at <retval, 0> on resulting chain.
88 * if offp != NULL, the target will start at <retval, *offp> on resulting chain.
90 * on error return (NULL return value), original "m" will be freed.
92 * XXX: M_TRAILINGSPACE/M_LEADINGSPACE only permitted on writable ext_buf.
95 m_pulldown(struct mbuf *m, int off, int len, int *offp)
101 /* check invalid arguments. */
103 panic("m == NULL in m_pulldown()");
104 if (len > MCLBYTES) {
106 return NULL; /* impossible */
109 #ifdef PULLDOWN_DEBUG
113 for (t = m; t; t = t->m_next)
114 printf(" %d", t->m_len);
119 while (n != NULL && off > 0) {
125 /* be sure to point non-empty mbuf */
126 while (n != NULL && n->m_len == 0)
130 return NULL; /* mbuf chain too short */
134 * The following comment is dated but still partially applies:
136 * XXX: This code is flawed because it considers a "writable" mbuf
137 * data region to require all of the following:
138 * (i) mbuf _has_ to have M_EXT set; if it is just a regular
139 * mbuf, it is still not considered "writable."
140 * (ii) since mbuf has M_EXT, the ext_type _has_ to be
141 * EXT_CLUSTER. Anything else makes it non-writable.
142 * (iii) M_WRITABLE() must evaluate true.
143 * Ideally, the requirement should only be (iii).
145 * If we're writable, we're sure we're writable, because the ref. count
146 * cannot increase from 1, as that would require possession of mbuf
147 * n by someone else (which is impossible). However, if we're _not_
148 * writable, we may eventually become writable )if the ref. count drops
149 * to 1), but we'll fail to notice it unless we re-evaluate
150 * M_WRITABLE(). For now, we only evaluate once at the beginning and
154 if ((n->m_flags & M_EXT) == 0 ||
155 (n->m_ext.ext_type == EXT_CLUSTER && M_WRITABLE(n)))
159 * the target data is on <n, off>.
160 * if we got enough data on the mbuf "n", we're done.
162 if ((off == 0 || offp) && len <= n->m_len - off && writable)
166 * when len <= n->m_len - off and off != 0, it is a special case.
167 * len bytes from <n, off> sits in single mbuf, but the caller does
168 * not like the starting position (off).
169 * chop the current mbuf into two pieces, set off to 0.
171 if (len <= n->m_len - off) {
172 o = m_dup1(n, off, n->m_len - off, M_NOWAIT);
175 return NULL; /* ENOBUFS */
178 o->m_next = n->m_next;
186 * we need to take hlen from <n, off> and tlen from <n->m_next, 0>,
187 * and construct contiguous mbuf with m_len == len.
188 * note that hlen + tlen == len, and tlen > 0.
190 hlen = n->m_len - off;
194 * ensure that we have enough trailing data on mbuf chain.
195 * if not, we can do nothing about the chain.
198 for (o = n->m_next; o != NULL; o = o->m_next)
200 if (hlen + olen < len) {
202 return NULL; /* mbuf chain too short */
207 * we need to use m_copydata() to get data from <n->m_next, 0>.
209 if ((off == 0 || offp) && M_TRAILINGSPACE(n) >= tlen
211 m_copydata(n->m_next, 0, tlen, mtod(n, caddr_t) + n->m_len);
213 m_adj(n->m_next, tlen);
216 if ((off == 0 || offp) && M_LEADINGSPACE(n->m_next) >= hlen
218 n->m_next->m_data -= hlen;
219 n->m_next->m_len += hlen;
220 bcopy(mtod(n, caddr_t) + off, mtod(n->m_next, caddr_t), hlen);
228 * now, we need to do the hard way. don't m_copy as there's no room
232 o = m_getcl(M_NOWAIT, m->m_type, 0);
234 o = m_get(M_NOWAIT, m->m_type);
237 return NULL; /* ENOBUFS */
239 /* get hlen from <n, off> into <o, 0> */
241 bcopy(mtod(n, caddr_t) + off, mtod(o, caddr_t), hlen);
243 /* get tlen from <n->m_next, 0> into <o, hlen> */
244 m_copydata(n->m_next, 0, tlen, mtod(o, caddr_t) + o->m_len);
246 m_adj(n->m_next, tlen);
247 o->m_next = n->m_next;
253 #ifdef PULLDOWN_DEBUG
257 for (t = m; t; t = t->m_next)
258 printf("%c%d", t == n ? '*' : ' ', t->m_len);
259 printf(" (off=%d)\n", off);
268 m_dup1(struct mbuf *m, int off, int len, int wait)
275 if (off == 0 && (m->m_flags & M_PKTHDR) != 0)
279 if (len >= MINCLSIZE) {
281 n = m_getcl(wait, m->m_type, M_PKTHDR);
283 n = m_getcl(wait, m->m_type, 0);
286 n = m_gethdr(wait, m->m_type);
288 n = m_get(wait, m->m_type);
291 return NULL; /* ENOBUFS */
293 if (copyhdr && !m_dup_pkthdr(n, m, wait)) {
297 m_copydata(m, off, len, mtod(n, caddr_t));
302 /* Free a packet tag. */
304 m_tag_free_default(struct m_tag *t)
307 if (t->m_tag_id == PACKET_TAG_MACLABEL)
308 mac_mbuf_tag_destroy(t);
310 free(t, M_PACKET_TAGS);
313 /* Get a packet tag structure along with specified data following. */
315 m_tag_alloc(uint32_t cookie, int type, int len, int wait)
319 MBUF_CHECKSLEEP(wait);
322 t = malloc(len + sizeof(struct m_tag), M_PACKET_TAGS, wait);
325 m_tag_setup(t, cookie, type, len);
326 t->m_tag_free = m_tag_free_default;
330 /* Unlink and free a packet tag. */
332 m_tag_delete(struct mbuf *m, struct m_tag *t)
335 KASSERT(m && t, ("m_tag_delete: null argument, m %p t %p", m, t));
340 /* Unlink and free a packet tag chain, starting from given tag. */
342 m_tag_delete_chain(struct mbuf *m, struct m_tag *t)
346 KASSERT(m, ("m_tag_delete_chain: null mbuf"));
350 p = SLIST_FIRST(&m->m_pkthdr.tags);
353 while ((q = SLIST_NEXT(p, m_tag_link)) != NULL)
359 * Strip off all tags that would normally vanish when
360 * passing through a network interface. Only persistent
361 * tags will exist after this; these are expected to remain
362 * so long as the mbuf chain exists, regardless of the
363 * path the mbufs take.
366 m_tag_delete_nonpersistent(struct mbuf *m)
370 SLIST_FOREACH_SAFE(p, &m->m_pkthdr.tags, m_tag_link, q)
371 if ((p->m_tag_id & MTAG_PERSISTENT) == 0)
375 /* Find a tag, starting from a given position. */
377 m_tag_locate(struct mbuf *m, uint32_t cookie, int type, struct m_tag *t)
381 KASSERT(m, ("m_tag_locate: null mbuf"));
383 p = SLIST_FIRST(&m->m_pkthdr.tags);
385 p = SLIST_NEXT(t, m_tag_link);
387 if (p->m_tag_cookie == cookie && p->m_tag_id == type)
389 p = SLIST_NEXT(p, m_tag_link);
394 /* Copy a single tag. */
396 m_tag_copy(struct m_tag *t, int how)
400 MBUF_CHECKSLEEP(how);
401 KASSERT(t, ("m_tag_copy: null tag"));
402 p = m_tag_alloc(t->m_tag_cookie, t->m_tag_id, t->m_tag_len, how);
407 * XXXMAC: we should probably pass off the initialization, and
408 * copying here? can we hide that PACKET_TAG_MACLABEL is
409 * special from the mbuf code?
411 if (t->m_tag_id == PACKET_TAG_MACLABEL) {
412 if (mac_mbuf_tag_init(p, how) != 0) {
416 mac_mbuf_tag_copy(t, p);
419 bcopy(t + 1, p + 1, t->m_tag_len); /* Copy the data */
424 * Copy two tag chains. The destination mbuf (to) loses any attached
425 * tags even if the operation fails. This should not be a problem, as
426 * m_tag_copy_chain() is typically called with a newly-allocated
430 m_tag_copy_chain(struct mbuf *to, const struct mbuf *from, int how)
432 struct m_tag *p, *t, *tprev = NULL;
434 MBUF_CHECKSLEEP(how);
436 ("m_tag_copy_chain: null argument, to %p from %p", to, from));
437 m_tag_delete_chain(to, NULL);
438 SLIST_FOREACH(p, &from->m_pkthdr.tags, m_tag_link) {
439 t = m_tag_copy(p, how);
441 m_tag_delete_chain(to, NULL);
445 SLIST_INSERT_HEAD(&to->m_pkthdr.tags, t, m_tag_link);
447 SLIST_INSERT_AFTER(tprev, t, m_tag_link);