ng_UI.c revision 70700
152419Sjulian 252419Sjulian/* 352419Sjulian * ng_UI.c 452419Sjulian * 552419Sjulian * Copyright (c) 1996-1999 Whistle Communications, Inc. 652419Sjulian * All rights reserved. 752419Sjulian * 852419Sjulian * Subject to the following obligations and disclaimer of warranty, use and 952419Sjulian * redistribution of this software, in source or object code forms, with or 1052419Sjulian * without modifications are expressly permitted by Whistle Communications; 1152419Sjulian * provided, however, that: 1252419Sjulian * 1. Any and all reproductions of the source or object code must include the 1352419Sjulian * copyright notice above and the following disclaimer of warranties; and 1452419Sjulian * 2. No rights are granted, in any manner or form, to use Whistle 1552419Sjulian * Communications, Inc. trademarks, including the mark "WHISTLE 1652419Sjulian * COMMUNICATIONS" on advertising, endorsements, or otherwise except as 1752419Sjulian * such appears in the above copyright notice or in the software. 1852419Sjulian * 1952419Sjulian * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 2052419Sjulian * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 2152419Sjulian * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 2252419Sjulian * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 2352419Sjulian * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 2452419Sjulian * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 2552419Sjulian * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 2652419Sjulian * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 2752419Sjulian * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 2852419Sjulian * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 2952419Sjulian * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 3052419Sjulian * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 3152419Sjulian * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 3252419Sjulian * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3352419Sjulian * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 3452419Sjulian * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 3552419Sjulian * OF SUCH DAMAGE. 3652419Sjulian * 3767506Sjulian * Author: Julian Elischer <julian@freebsd.org> 3852419Sjulian * 3952419Sjulian * $FreeBSD: head/sys/netgraph/ng_UI.c 70700 2001-01-06 00:46:47Z julian $ 4052752Sjulian * $Whistle: ng_UI.c,v 1.14 1999/11/01 09:24:51 julian Exp $ 4152419Sjulian */ 4252419Sjulian 4352419Sjulian#include <sys/param.h> 4452419Sjulian#include <sys/systm.h> 4552419Sjulian#include <sys/errno.h> 4652419Sjulian#include <sys/kernel.h> 4752419Sjulian#include <sys/malloc.h> 4852419Sjulian#include <sys/mbuf.h> 4952419Sjulian#include <sys/errno.h> 5052419Sjulian 5152419Sjulian 5252419Sjulian#include <netgraph/ng_message.h> 5352419Sjulian#include <netgraph/netgraph.h> 5452419Sjulian#include <netgraph/ng_UI.h> 5552419Sjulian 5652419Sjulian/* 5752419Sjulian * DEFINITIONS 5852419Sjulian */ 5952419Sjulian 6052419Sjulian/* Everything, starting with sdlc on has defined UI as 0x03 */ 6152419Sjulian#define HDLC_UI 0x03 6252419Sjulian 6352419Sjulian/* Node private data */ 6453393Sarchiestruct ng_UI_private { 6552419Sjulian hook_p downlink; 6652419Sjulian hook_p uplink; 6752419Sjulian}; 6853393Sarchietypedef struct ng_UI_private *priv_p; 6952419Sjulian 7052419Sjulian/* Netgraph node methods */ 7152752Sjulianstatic ng_constructor_t ng_UI_constructor; 7252752Sjulianstatic ng_rcvmsg_t ng_UI_rcvmsg; 7370700Sjulianstatic ng_shutdown_t ng_UI_shutdown; 7452752Sjulianstatic ng_newhook_t ng_UI_newhook; 7552752Sjulianstatic ng_rcvdata_t ng_UI_rcvdata; 7652752Sjulianstatic ng_disconnect_t ng_UI_disconnect; 7752419Sjulian 7852419Sjulian/* Node type descriptor */ 7952419Sjulianstatic struct ng_type typestruct = { 8070159Sjulian NG_ABI_VERSION, 8152419Sjulian NG_UI_NODE_TYPE, 8252419Sjulian NULL, 8352419Sjulian ng_UI_constructor, 8452419Sjulian ng_UI_rcvmsg, 8570700Sjulian ng_UI_shutdown, 8652419Sjulian ng_UI_newhook, 8752419Sjulian NULL, 8852419Sjulian NULL, 8952419Sjulian ng_UI_rcvdata, 9053913Sarchie ng_UI_disconnect, 9153913Sarchie NULL 9252419Sjulian}; 9352419SjulianNETGRAPH_INIT(UI, &typestruct); 9452419Sjulian 9552419Sjulian/************************************************************************ 9652419Sjulian NETGRAPH NODE STUFF 9752419Sjulian ************************************************************************/ 9852419Sjulian 9952419Sjulian/* 10052419Sjulian * Create a newborn node. We start with an implicit reference. 10152419Sjulian */ 10252419Sjulian 10352419Sjulianstatic int 10470700Sjulianng_UI_constructor(node_p nodep) 10552419Sjulian{ 10652419Sjulian priv_p priv; 10752419Sjulian 10852419Sjulian /* Allocate private structure */ 10968876Sdwmalone MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO); 11070700Sjulian if (priv == NULL) { 11152419Sjulian return (ENOMEM); 11252419Sjulian } 11370700Sjulian nodep->private = priv; 11452419Sjulian return (0); 11552419Sjulian} 11652419Sjulian 11752419Sjulian/* 11852419Sjulian * Give our ok for a hook to be added 11952419Sjulian */ 12052419Sjulianstatic int 12152419Sjulianng_UI_newhook(node_p node, hook_p hook, const char *name) 12252419Sjulian{ 12352419Sjulian const priv_p priv = node->private; 12452419Sjulian 12552419Sjulian if (!strcmp(name, NG_UI_HOOK_DOWNSTREAM)) { 12652419Sjulian if (priv->downlink) 12752419Sjulian return (EISCONN); 12852419Sjulian priv->downlink = hook; 12952419Sjulian } else if (!strcmp(name, NG_UI_HOOK_UPSTREAM)) { 13052419Sjulian if (priv->uplink) 13152419Sjulian return (EISCONN); 13252419Sjulian priv->uplink = hook; 13352419Sjulian } else 13452419Sjulian return (EINVAL); 13552419Sjulian return (0); 13652419Sjulian} 13752419Sjulian 13852419Sjulian/* 13952419Sjulian * Receive a control message 14052419Sjulian */ 14152419Sjulianstatic int 14270700Sjulianng_UI_rcvmsg(node_p node, item_p item, hook_p lasthook) 14352419Sjulian{ 14470700Sjulian int error; 14569922Sjulian const priv_p priv = node->private; 14670700Sjulian struct ng_mesg *msg; 14769922Sjulian 14870700Sjulian msg = NGI_MSG(item); /* only peeking */ 14969922Sjulian if ((msg->header.typecookie == NGM_FLOW_COOKIE) && lasthook) { 15069922Sjulian if (lasthook == priv->downlink) { 15169922Sjulian if (priv->uplink) { 15270700Sjulian NG_FWD_MSG_HOOK(error, node, item, 15370700Sjulian priv->uplink, 0); 15470700Sjulian return (error); 15569922Sjulian } 15669922Sjulian } else { 15769922Sjulian if (priv->downlink) { 15870700Sjulian NG_FWD_MSG_HOOK(error, node, item, 15970700Sjulian priv->downlink, 0); 16070700Sjulian return (error); 16169922Sjulian } 16269922Sjulian } 16369922Sjulian } 16469922Sjulian 16570700Sjulian NG_FREE_MSG(msg); 16652419Sjulian return (EINVAL); 16752419Sjulian} 16852419Sjulian 16952419Sjulian#define MAX_ENCAPS_HDR 1 17052419Sjulian#define ERROUT(x) do { error = (x); goto done; } while (0) 17152419Sjulian 17252419Sjulian/* 17352419Sjulian * Receive a data frame 17452419Sjulian */ 17552419Sjulianstatic int 17670700Sjulianng_UI_rcvdata(hook_p hook, item_p item) 17752419Sjulian{ 17852419Sjulian const node_p node = hook->node; 17952419Sjulian const priv_p priv = node->private; 18070700Sjulian struct mbuf *m; 18152419Sjulian int error = 0; 18252419Sjulian 18370700Sjulian NGI_GET_M(item, m); 18452419Sjulian if (hook == priv->downlink) { 18552419Sjulian u_char *start, *ptr; 18652419Sjulian 18752539Sjulian if (!m || (m->m_len < MAX_ENCAPS_HDR 18852539Sjulian && !(m = m_pullup(m, MAX_ENCAPS_HDR)))) 18952419Sjulian ERROUT(ENOBUFS); 19052419Sjulian ptr = start = mtod(m, u_char *); 19152419Sjulian 19252419Sjulian /* Must be UI frame */ 19352419Sjulian if (*ptr++ != HDLC_UI) 19452419Sjulian ERROUT(0); 19552419Sjulian 19652419Sjulian m_adj(m, ptr - start); 19770700Sjulian NG_FWD_NEW_DATA(error, item, priv->uplink, m); /* m -> NULL */ 19852419Sjulian } else if (hook == priv->uplink) { 19952419Sjulian M_PREPEND(m, 1, M_DONTWAIT); /* Prepend IP NLPID */ 20052419Sjulian if (!m) 20152419Sjulian ERROUT(ENOBUFS); 20252419Sjulian mtod(m, u_char *)[0] = HDLC_UI; 20370700Sjulian NG_FWD_NEW_DATA(error, item, priv->downlink, m); /* m -> NULL */ 20452419Sjulian } else 20552419Sjulian panic(__FUNCTION__); 20652419Sjulian 20752419Sjuliandone: 20870700Sjulian NG_FREE_M(m); /* does nothing if m == NULL */ 20970700Sjulian if (item) 21070700Sjulian NG_FREE_ITEM(item); 21152419Sjulian return (error); 21252419Sjulian} 21352419Sjulian 21452419Sjulian/* 21552419Sjulian * Shutdown node 21652419Sjulian */ 21752419Sjulianstatic int 21870700Sjulianng_UI_shutdown(node_p node) 21952419Sjulian{ 22052419Sjulian const priv_p priv = node->private; 22152419Sjulian 22252419Sjulian /* Take down netgraph node */ 22352419Sjulian FREE(priv, M_NETGRAPH); 22452419Sjulian node->private = NULL; 22552419Sjulian ng_unref(node); 22652419Sjulian return (0); 22752419Sjulian} 22852419Sjulian 22952419Sjulian/* 23052419Sjulian * Hook disconnection 23152419Sjulian */ 23252419Sjulianstatic int 23352419Sjulianng_UI_disconnect(hook_p hook) 23452419Sjulian{ 23552419Sjulian const priv_p priv = hook->node->private; 23652419Sjulian 23770700Sjulian if (hook == priv->downlink) 23852419Sjulian priv->downlink = NULL; 23952419Sjulian else if (hook == priv->uplink) 24052419Sjulian priv->uplink = NULL; 24152419Sjulian else 24252419Sjulian panic(__FUNCTION__); 24370700Sjulian /* 24470700Sjulian * If we are not already shutting down, 24570700Sjulian * and we have no more hooks, then DO shut down. 24670700Sjulian */ 24770700Sjulian if ((hook->node->numhooks == 0) 24870700Sjulian && ((hook->node->flags & NG_INVALID) == 0)) { 24970700Sjulian ng_rmnode_self(hook->node); 25070700Sjulian } 25152419Sjulian return (0); 25252419Sjulian} 25352419Sjulian 254