xref: /freebsd/usr.sbin/ppp/mbuf.h (revision b740c88bfb6453416926271c089262e7164dace3)
1 /*-
2  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
3  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
4  *                           Internet Initiative Japan, Inc (IIJ)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 struct mbuf {
32   size_t m_size;		/* size allocated (excluding header) */
33   u_short m_offset;		/* offset from header end to start position */
34   size_t m_len;			/* available byte count in buffer */
35   short m_type;			/* MB_* below */
36   struct mbuf *m_next;		/* link to next mbuf */
37   struct mbuf *m_nextpkt;	/* link to next packet */
38   unsigned long priv;		/* private data - holds HDLC escape count */
39   /* buffer space is malloc()d directly after the header */
40 };
41 
42 struct mqueue {
43   struct mbuf *top;
44   struct mbuf *last;
45   size_t len;
46 };
47 
48 #define MBUF_CTOP(bp) \
49 	((bp) ? (u_char *)((bp)+1) + (bp)->m_offset : (u_char *)bp)
50 
51 #define CONST_MBUF_CTOP(bp) \
52 	((bp) ? (const u_char *)((bp)+1) + (bp)->m_offset : (const u_char *)bp)
53 
54 #define MB_IPIN		0
55 #define MB_IPOUT	1
56 #define MB_IPV6IN	2
57 #define MB_IPV6OUT	3
58 #define MB_NATIN	4
59 #define MB_NATOUT	5
60 #define MB_MPIN		6
61 #define MB_MPOUT	7
62 #define MB_VJIN		8
63 #define MB_VJOUT	9
64 #define MB_ICOMPDIN	10
65 #define MB_ICOMPDOUT	11
66 #define MB_COMPDIN	12
67 #define MB_COMPDOUT	13
68 #define MB_LQRIN	14
69 #define MB_LQROUT	15
70 #define MB_ECHOIN	16
71 #define MB_ECHOOUT	17
72 #define MB_PROTOIN	18
73 #define MB_PROTOOUT	19
74 #define MB_ACFIN	20
75 #define MB_ACFOUT	21
76 #define MB_SYNCIN	22
77 #define MB_SYNCOUT	23
78 #define MB_HDLCIN	24
79 #define MB_HDLCOUT	25
80 #define MB_ASYNCIN	26
81 #define MB_ASYNCOUT	27
82 #define MB_CBCPIN	28
83 #define MB_CBCPOUT	29
84 #define MB_CHAPIN	30
85 #define MB_CHAPOUT	31
86 #define MB_PAPIN	32
87 #define MB_PAPOUT	33
88 #define MB_CCPIN	34
89 #define MB_CCPOUT	35
90 #define MB_IPCPIN	36
91 #define MB_IPCPOUT	37
92 #define MB_IPV6CPIN	38
93 #define MB_IPV6CPOUT	39
94 #define MB_LCPIN	40
95 #define MB_LCPOUT	41
96 #define MB_UNKNOWN	42
97 #define MB_MAX		MB_UNKNOWN
98 
99 #define M_MAXLEN	(4352 - sizeof(struct mbuf))	/* > HDLCSIZE */
100 
101 struct cmdargs;
102 
103 extern size_t m_length(struct mbuf *);
104 extern struct mbuf *m_get(size_t, int);
105 extern struct mbuf *m_free(struct mbuf *);
106 extern void m_freem(struct mbuf *);
107 extern void mbuf_Write(struct mbuf *, const void *, size_t);
108 extern struct mbuf *mbuf_Read(struct mbuf *, void *, size_t);
109 extern size_t mbuf_View(struct mbuf *, void *, size_t);
110 extern struct mbuf *m_prepend(struct mbuf *, const void *, size_t, u_short);
111 extern struct mbuf *m_adj(struct mbuf *, ssize_t);
112 extern struct mbuf *m_pullup(struct mbuf *);
113 extern void m_settype(struct mbuf *, int);
114 extern struct mbuf *m_append(struct mbuf *, const void *, size_t);
115 
116 extern int mbuf_Show(struct cmdargs const *);
117 
118 extern void m_enqueue(struct mqueue *, struct mbuf *);
119 extern struct mbuf *m_dequeue(struct mqueue *);
120