6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
9 * Subject to the following obligations and disclaimer of warranty, use and
10 * redistribution of this software, in source or object code forms, with or
11 * without modifications are expressly permitted by Whistle Communications;
12 * provided, however, that:
13 * 1. Any and all reproductions of the source or object code must include the
14 * copyright notice above and the following disclaimer of warranties; and
15 * 2. No rights are granted, in any manner or form, to use Whistle
16 * Communications, Inc. trademarks, including the mark "WHISTLE
17 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18 * such appears in the above copyright notice or in the software.
20 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
38 * Author: Julian Elischer <julian@freebsd.org>
40 * $FreeBSD: src/sys/netgraph/ng_UI.c,v 1.20 2005/01/07 01:45:39 imp Exp $
41 * $DragonFly: src/sys/netgraph7/ng_UI.c,v 1.2 2008/06/26 23:05:35 dillon Exp $
42 * $Whistle: ng_UI.c,v 1.14 1999/11/01 09:24:51 julian Exp $
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/errno.h>
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
51 #include <sys/errno.h>
54 #include "ng_message.h"
62 /* Everything, starting with sdlc on has defined UI as 0x03 */
65 /* Node private data */
66 struct ng_UI_private {
70 typedef struct ng_UI_private *priv_p;
72 /* Netgraph node methods */
73 static ng_constructor_t ng_UI_constructor;
74 static ng_rcvmsg_t ng_UI_rcvmsg;
75 static ng_shutdown_t ng_UI_shutdown;
76 static ng_newhook_t ng_UI_newhook;
77 static ng_rcvdata_t ng_UI_rcvdata;
78 static ng_disconnect_t ng_UI_disconnect;
80 /* Node type descriptor */
81 static struct ng_type typestruct = {
82 .version = NG_ABI_VERSION,
83 .name = NG_UI_NODE_TYPE,
84 .constructor = ng_UI_constructor,
85 .rcvmsg = ng_UI_rcvmsg,
86 .shutdown = ng_UI_shutdown,
87 .newhook = ng_UI_newhook,
88 .rcvdata = ng_UI_rcvdata,
89 .disconnect = ng_UI_disconnect,
91 NETGRAPH_INIT(UI, &typestruct);
93 /************************************************************************
95 ************************************************************************/
98 * Create a newborn node. We start with an implicit reference.
102 ng_UI_constructor(node_p node)
106 /* Allocate private structure */
107 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_WAITOK | M_NULLOK | M_ZERO);
111 NG_NODE_SET_PRIVATE(node, priv);
116 * Give our ok for a hook to be added
119 ng_UI_newhook(node_p node, hook_p hook, const char *name)
121 const priv_p priv = NG_NODE_PRIVATE(node);
123 if (!strcmp(name, NG_UI_HOOK_DOWNSTREAM)) {
126 priv->downlink = hook;
127 } else if (!strcmp(name, NG_UI_HOOK_UPSTREAM)) {
137 * Receive a control message
140 ng_UI_rcvmsg(node_p node, item_p item, hook_p lasthook)
143 const priv_p priv = NG_NODE_PRIVATE(node);
146 msg = NGI_MSG(item); /* only peeking */
147 if ((msg->header.typecookie == NGM_FLOW_COOKIE) && lasthook) {
148 if (lasthook == priv->downlink) {
150 NG_FWD_ITEM_HOOK(error, item, priv->uplink);
154 if (priv->downlink) {
155 NG_FWD_ITEM_HOOK(error, item, priv->downlink);
165 #define MAX_ENCAPS_HDR 1
166 #define ERROUT(x) do { error = (x); goto done; } while (0)
169 * Receive a data frame
172 ng_UI_rcvdata(hook_p hook, item_p item)
174 const node_p node = NG_HOOK_NODE(hook);
175 const priv_p priv = NG_NODE_PRIVATE(node);
180 if (hook == priv->downlink) {
183 if (m->m_len < MAX_ENCAPS_HDR
184 && !(m = m_pullup(m, MAX_ENCAPS_HDR)))
186 ptr = start = mtod(m, u_char *);
188 /* Must be UI frame */
189 if (*ptr++ != HDLC_UI)
192 m_adj(m, ptr - start);
193 NG_FWD_NEW_DATA(error, item, priv->uplink, m); /* m -> NULL */
194 } else if (hook == priv->uplink) {
195 M_PREPEND(m, 1, MB_DONTWAIT); /* Prepend IP NLPID */
198 mtod(m, u_char *)[0] = HDLC_UI;
199 NG_FWD_NEW_DATA(error, item, priv->downlink, m); /* m -> NULL */
204 NG_FREE_M(m); /* does nothing if m == NULL */
214 ng_UI_shutdown(node_p node)
216 const priv_p priv = NG_NODE_PRIVATE(node);
218 /* Take down netgraph node */
219 FREE(priv, M_NETGRAPH);
220 NG_NODE_SET_PRIVATE(node, NULL);
229 ng_UI_disconnect(hook_p hook)
231 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
233 if (hook == priv->downlink)
234 priv->downlink = NULL;
235 else if (hook == priv->uplink)
240 * If we are not already shutting down,
241 * and we have no more hooks, then DO shut down.
243 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
244 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))) {
245 ng_rmnode_self(NG_HOOK_NODE(hook));