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