2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2001-2003
5 * Fraunhofer Institute for Open Communication Systems (FhG Fokus).
8 * Author: Harti Brandt <harti@freebsd.org>
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
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
33 * Customisation of the SSCOP code to ng_sscop.
36 #include <sys/param.h>
37 #include <sys/types.h>
38 #include <sys/kernel.h>
40 #include <sys/mutex.h>
42 #include <sys/queue.h>
43 #include <sys/systm.h>
44 #include <sys/malloc.h>
45 #include <netgraph/ng_message.h>
46 #include <netgraph/netgraph.h>
47 #include <machine/stdarg.h>
49 #include <netnatm/saal/sscopdef.h>
52 * Allocate zeroed or non-zeroed memory of some size and cast it.
53 * Return NULL on failure.
58 MALLOC_DECLARE(M_NG_SSCOP); \
63 #define MEMZALLOC(PTR, CAST, SIZE) \
64 ((PTR) = (CAST)malloc((SIZE), M_NG_SSCOP, M_NOWAIT | M_ZERO))
65 #define MEMFREE(PTR) \
66 free((PTR), M_NG_SSCOP)
68 #define MSG_ALLOC(PTR) \
69 MEMZALLOC(PTR, struct sscop_msg *, sizeof(struct sscop_msg))
70 #define MSG_FREE(PTR) \
73 #define SIG_ALLOC(PTR) \
74 MEMZALLOC(PTR, struct sscop_sig *, sizeof(struct sscop_sig))
75 #define SIG_FREE(PTR) \
81 MALLOC_DEFINE(M_NG_SSCOP_INS, "sscop_ins", "SSCOP instances"); \
82 MALLOC_DEFINE(M_NG_SSCOP_MSG, "sscop_msg", "SSCOP buffers"); \
83 MALLOC_DEFINE(M_NG_SSCOP_SIG, "sscop_sig", "SSCOP signals"); \
88 #define MEMZALLOC(PTR, CAST, SIZE) \
89 ((PTR) = (CAST)malloc((SIZE), M_NG_SSCOP_INS, M_NOWAIT | M_ZERO))
90 #define MEMFREE(PTR) \
91 free((PTR), M_NG_SSCOP_INS)
93 #define MSG_ALLOC(PTR) \
94 ((PTR) = malloc(sizeof(struct sscop_msg), \
95 M_NG_SSCOP_MSG, M_NOWAIT | M_ZERO))
96 #define MSG_FREE(PTR) \
97 free((PTR), M_NG_SSCOP_MSG)
99 #define SIG_ALLOC(PTR) \
100 ((PTR) = malloc(sizeof(struct sscop_sig), \
101 M_NG_SSCOP_SIG, M_NOWAIT | M_ZERO))
102 #define SIG_FREE(PTR) \
103 free((PTR), M_NG_SSCOP_SIG)
110 typedef struct callout sscop_timer_t;
111 #define TIMER_INIT(S, T) ng_callout_init(&(S)->t_##T)
112 #define TIMER_STOP(S,T) do { \
113 ng_uncallout(&(S)->t_##T, (S)->aarg); \
115 #define TIMER_RESTART(S, T) do { \
117 ng_callout(&(S)->t_##T, (S)->aarg, NULL, \
118 hz * (S)->timer##T / 1000, T##_func, (S), 0); \
120 #define TIMER_ISACT(S, T) (callout_pending(&(S)->t_##T))
123 * This assumes, that the user argument is the node pointer.
125 #define TIMER_FUNC(T,N) \
127 T##_func(node_p node, hook_p hook, void *arg1, int arg2) \
129 struct sscop *sscop = arg1; \
131 VERBOSE(sscop, SSCOP_DBG_TIMER, (sscop, sscop->aarg, \
132 "timer_" #T " expired")); \
133 sscop_signal(sscop, SIG_T_##N, NULL); \
140 typedef TAILQ_ENTRY(sscop_msg) sscop_msgq_link_t;
141 typedef TAILQ_HEAD(sscop_msgq, sscop_msg) sscop_msgq_head_t;
142 #define MSGQ_EMPTY(Q) TAILQ_EMPTY(Q)
143 #define MSGQ_INIT(Q) TAILQ_INIT(Q)
144 #define MSGQ_FOREACH(P, Q) TAILQ_FOREACH(P, Q, link)
145 #define MSGQ_REMOVE(Q, M) TAILQ_REMOVE(Q, M, link)
146 #define MSGQ_INSERT_BEFORE(B, M) TAILQ_INSERT_BEFORE(B, M, link)
147 #define MSGQ_APPEND(Q, M) TAILQ_INSERT_TAIL(Q, M, link)
148 #define MSGQ_PEEK(Q) TAILQ_FIRST((Q))
150 #define MSGQ_GET(Q) ng_sscop_msgq_get((Q))
152 #define DECL_MSGQ_GET \
153 static __inline struct sscop_msg * \
154 ng_sscop_msgq_get(struct sscop_msgq *q) \
156 struct sscop_msg *m; \
158 m = TAILQ_FIRST(q); \
160 TAILQ_REMOVE(q, m, link); \
164 #define MSGQ_CLEAR(Q) \
166 struct sscop_msg *_m1, *_m2; \
168 _m1 = TAILQ_FIRST(Q); \
169 while (_m1 != NULL) { \
170 _m2 = TAILQ_NEXT(_m1, link); \
171 SSCOP_MSG_FREE(_m1); \
180 typedef TAILQ_ENTRY(sscop_sig) sscop_sigq_link_t;
181 typedef TAILQ_HEAD(sscop_sigq, sscop_sig) sscop_sigq_head_t;
182 #define SIGQ_INIT(Q) TAILQ_INIT(Q)
183 #define SIGQ_APPEND(Q, S) TAILQ_INSERT_TAIL(Q, S, link)
184 #define SIGQ_EMPTY(Q) TAILQ_EMPTY(Q)
186 #define SIGQ_GET(Q) ng_sscop_sigq_get((Q))
187 #define DECL_SIGQ_GET \
188 static __inline struct sscop_sig * \
189 ng_sscop_sigq_get(struct sscop_sigq *q) \
191 struct sscop_sig *s; \
193 s = TAILQ_FIRST(q); \
195 TAILQ_REMOVE(q, s, link); \
199 #define SIGQ_MOVE(F, T) \
201 struct sscop_sig *_s; \
203 while (!TAILQ_EMPTY(F)) { \
204 _s = TAILQ_FIRST(F); \
205 TAILQ_REMOVE(F, _s, link); \
206 TAILQ_INSERT_TAIL(T, _s, link); \
210 #define SIGQ_PREPEND(F, T) \
212 struct sscop_sig *_s; \
214 while (!TAILQ_EMPTY(F)) { \
215 _s = TAILQ_LAST(F, sscop_sigq); \
216 TAILQ_REMOVE(F, _s, link); \
217 TAILQ_INSERT_HEAD(T, _s, link); \
221 #define SIGQ_CLEAR(Q) \
223 struct sscop_sig *_s1, *_s2; \
225 _s1 = TAILQ_FIRST(Q); \
226 while (_s1 != NULL) { \
227 _s2 = TAILQ_NEXT(_s1, link); \
228 SSCOP_MSG_FREE(_s1->msg); \
238 #define MBUF_FREE(M) do { if ((M)) m_freem((M)); } while(0)
239 #define MBUF_DUP(M) m_copypacket((M), M_NOWAIT)
240 #define MBUF_LEN(M) ((size_t)(M)->m_pkthdr.len)
243 * Return the i-th word counted from the end of the buffer.
244 * i=-1 will return the last 32bit word, i=-2 the 2nd last.
245 * Assumes that there is enough space.
247 #define MBUF_TRAIL32(M ,I) ng_sscop_mbuf_trail32((M), (I))
249 static uint32_t __inline
250 ng_sscop_mbuf_trail32(const struct mbuf *m, int i)
254 m_copydata(m, m->m_pkthdr.len + 4 * i, 4, (caddr_t)&w);
259 * Strip 32bit value from the end
261 #define MBUF_STRIP32(M) ng_sscop_mbuf_strip32((M))
263 static uint32_t __inline
264 ng_sscop_mbuf_strip32(struct mbuf *m)
268 m_copydata(m, m->m_pkthdr.len - 4, 4, (caddr_t)&w);
273 #define MBUF_GET32(M) ng_sscop_mbuf_get32((M))
275 static uint32_t __inline
276 ng_sscop_mbuf_get32(struct mbuf *m)
280 m_copydata(m, 0, 4, (caddr_t)&w);
286 * Append a 32bit value to an mbuf. Failures are ignored.
288 #define MBUF_APPEND32(M, W) \
293 m_copyback((M), (M)->m_pkthdr.len, 4, (caddr_t)&_w); \
297 * Pad a message to a multiple of four byte and return the amount of padding
298 * Failures are ignored.
300 #define MBUF_PAD4(M) ng_sscop_mbuf_pad4((M))
302 static u_int __inline
303 ng_sscop_mbuf_pad4(struct mbuf *m)
305 static u_char pad[4] = { 0, 0, 0, 0 };
306 int len = m->m_pkthdr.len;
307 int npad = 3 - ((len + 3) & 3);
310 m_copyback(m, len, npad, (caddr_t)pad);
314 #define MBUF_UNPAD(M, P) do { if( (P) > 0) m_adj((M), -(P)); } while (0)
317 * Allocate a message that will probably hold N bytes.
319 #define MBUF_ALLOC(N) ng_sscop_mbuf_alloc((N))
321 #define DECL_MBUF_ALLOC \
322 static __inline struct mbuf * \
323 ng_sscop_mbuf_alloc(size_t n) \
327 MGETHDR(m, M_NOWAIT, MT_DATA); \
330 m->m_pkthdr.len = 0; \
332 if (!(MCLGET(m, M_NOWAIT))){ \
342 #define ASSERT(X) KASSERT(X, (#X))