sys/netgraph/ng_sppp.c

   1 /*
   2  * ng_sppp.c Netgraph to Sppp module.
   3  */
   4
   5 /*-
   6  * Copyright (C) 2002-2004 Cronyx Engineering.
   7  * Copyright (C) 2002-2004 Roman Kurakin <rik@cronyx.ru>
   8  *
   9  * This software is distributed with NO WARRANTIES, not even the implied
  10  * warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Authors grant any other persons or organisations a permission to use,
  13  * modify and redistribute this software in source and binary forms,
  14  * as long as this message is kept with the software, all derivative
  15  * works or modified versions.
  16  *
  17  * Cronyx Id: ng_sppp.c,v 1.1.2.10 2004/03/01 15:17:21 rik Exp $
  18  */
  19 #include <sys/cdefs.h>
  20 #include <sys/param.h>
  21 #include <sys/systm.h>
  22 #include <sys/errno.h>
  23 #include <sys/kernel.h>
  24 #include <sys/malloc.h>
  25 #include <sys/mbuf.h>
  26 #include <sys/errno.h>
  27 #include <sys/sockio.h>
  28 #include <sys/socket.h>
  29 #include <sys/syslog.h>
  30 #include <sys/libkern.h>
  31
  32 #include <net/if.h>
  33 #include <net/if_var.h>
  34 #include <net/if_types.h>
  35 #include <net/bpf.h>
  36 #include <net/if_sppp.h>
  37
  38 #include <netinet/in.h>
  39
  40 #include <netgraph/ng_message.h>
  41 #include <netgraph/netgraph.h>
  42 #include <netgraph/ng_parse.h>
  43 #include <netgraph/ng_sppp.h>
  44
  45 #ifdef NG_SEPARATE_MALLOC
  46 static MALLOC_DEFINE(M_NETGRAPH_SPPP, "netgraph_sppp", "netgraph sppp node");
  47 #else
  48 #define M_NETGRAPH_SPPP M_NETGRAPH
  49 #endif
  50
  51 /* Node private data */
  52 struct ng_sppp_private {
  53         struct  ifnet *ifp;             /* Our interface */
  54         int     unit;                   /* Interface unit number */
  55         node_p  node;                   /* Our netgraph node */
  56         hook_p  hook;                   /* Hook */
  57 };
  58 typedef struct ng_sppp_private *priv_p;
  59
  60 /* Interface methods */
  61 static void     ng_sppp_start (struct ifnet *ifp);
  62 static int      ng_sppp_ioctl (struct ifnet *ifp, u_long cmd, caddr_t data);
  63
  64 /* Netgraph methods */
  65 static ng_constructor_t ng_sppp_constructor;
  66 static ng_rcvmsg_t      ng_sppp_rcvmsg;
  67 static ng_shutdown_t    ng_sppp_shutdown;
  68 static ng_newhook_t     ng_sppp_newhook;
  69 static ng_rcvdata_t     ng_sppp_rcvdata;
  70 static ng_disconnect_t  ng_sppp_disconnect;
  71
  72 /* List of commands and how to convert arguments to/from ASCII */
  73 static const struct ng_cmdlist ng_sppp_cmds[] = {
  74         {
  75           NGM_SPPP_COOKIE,
  76           NGM_SPPP_GET_IFNAME,
  77           "getifname",
  78           NULL,
  79           &ng_parse_string_type
  80         },
  81         { 0 }
  82 };
  83
  84 /* Node type descriptor */
  85 static struct ng_type typestruct = {
  86         .version =      NG_ABI_VERSION,
  87         .name =         NG_SPPP_NODE_TYPE,
  88         .constructor =  ng_sppp_constructor,
  89         .rcvmsg =       ng_sppp_rcvmsg,
  90         .shutdown =     ng_sppp_shutdown,
  91         .newhook =      ng_sppp_newhook,
  92         .rcvdata =      ng_sppp_rcvdata,
  93         .disconnect =   ng_sppp_disconnect,
  94         .cmdlist =      ng_sppp_cmds,
  95 };
  96 NETGRAPH_INIT(sppp, &typestruct);
  97
  98 MODULE_DEPEND (ng_sppp, sppp, 1, 1, 1);
  99
 100 /* We keep a bitmap indicating which unit numbers are free.
 101    Zero means the unit number is free, one means it's taken. */
 102 static unsigned char    *ng_sppp_units = NULL;
 103 static unsigned char    ng_sppp_units_len = 0;
 104 static unsigned char    ng_units_in_use = 0;
 105
 106 /*
 107  * Find the first free unit number for a new interface.
 108  * Increase the size of the unit bitmap as necessary.
 109  */
 110 static __inline void
 111 ng_sppp_get_unit (int *unit)
 112 {
 113         int index, bit;
 114         unsigned char mask;
 115
 116         for (index = 0; index < ng_sppp_units_len
 117             && ng_sppp_units[index] == 0xFF; index++);
 118         if (index == ng_sppp_units_len) {               /* extend array */
 119                 unsigned char *newarray;
 120                 int newlen;
 121
 122                 newlen = (2 * ng_sppp_units_len) + sizeof (*ng_sppp_units);
 123                 newarray = malloc (newlen * sizeof (*ng_sppp_units),
 124                     M_NETGRAPH_SPPP, M_WAITOK);
 125                 bcopy (ng_sppp_units, newarray,
 126                     ng_sppp_units_len * sizeof (*ng_sppp_units));
 127                 bzero (newarray + ng_sppp_units_len,
 128                     newlen - ng_sppp_units_len);
 129                 if (ng_sppp_units != NULL)
 130                         free (ng_sppp_units, M_NETGRAPH_SPPP);
 131                 ng_sppp_units = newarray;
 132                 ng_sppp_units_len = newlen;
 133         }
 134         mask = ng_sppp_units[index];
 135         for (bit = 0; (mask & 1) != 0; bit++)
 136                 mask >>= 1;
 137         KASSERT ((bit >= 0 && bit < NBBY),
 138             ("%s: word=%d bit=%d", __func__, ng_sppp_units[index], bit));
 139         ng_sppp_units[index] |= (1 << bit);
 140         *unit = (index * NBBY) + bit;
 141         ng_units_in_use++;
 142 }
 143
 144 /*
 145  * Free a no longer needed unit number.
 146  */
 147 static __inline void
 148 ng_sppp_free_unit (int unit)
 149 {
 150         int index, bit;
 151
 152         index = unit / NBBY;
 153         bit = unit % NBBY;
 154         KASSERT (index < ng_sppp_units_len,
 155             ("%s: unit=%d len=%d", __func__, unit, ng_sppp_units_len));
 156         KASSERT ((ng_sppp_units[index] & (1 << bit)) != 0,
 157             ("%s: unit=%d is free", __func__, unit));
 158         ng_sppp_units[index] &= ~(1 << bit);
 159
 160         ng_units_in_use--;
 161         if (ng_units_in_use == 0) {
 162                 free (ng_sppp_units, M_NETGRAPH_SPPP);
 163                 ng_sppp_units_len = 0;
 164                 ng_sppp_units = NULL;
 165         }
 166 }
 167
 168 /************************************************************************
 169                         INTERFACE STUFF
 170  ************************************************************************/
 171
 172 /*
 173  * Process an ioctl for the interface
 174  */
 175 static int
 176 ng_sppp_ioctl (struct ifnet *ifp, u_long command, caddr_t data)
 177 {
 178         int error = 0;
 179
 180         error = sppp_ioctl (ifp, command, data);
 181         if (error)
 182                 return error;
 183
 184         return error;
 185 }
 186
 187 /*
 188  * This routine should never be called
 189  */
 190
 191 static void
 192 ng_sppp_start (struct ifnet *ifp)
 193 {
 194         struct mbuf *m;
 195         int len, error = 0;
 196         priv_p priv = ifp->if_softc;
 197
 198         /* Check interface flags */
 199         /*
 200          * This has side effects. It is not good idea to stop sending if we
 201          * are not UP. If we are not running we still want to send LCP term
 202          * packets.
 203          */
 204 /*      if (!((ifp->if_flags & IFF_UP) && */
 205 /*          (ifp->if_drv_flags & IFF_DRV_RUNNING))) { */
 206 /*              return;*/
 207 /*      }*/
 208
 209         if (ifp->if_drv_flags & IFF_DRV_OACTIVE)
 210                 return;
 211
 212         if (!priv->hook)
 213                 return;
 214
 215         ifp->if_drv_flags |= IFF_DRV_OACTIVE;
 216
 217         while ((m = sppp_dequeue (ifp)) != NULL) {
 218                 BPF_MTAP (ifp, m);
 219                 len = m->m_pkthdr.len;
 220
 221                 NG_SEND_DATA_ONLY (error, priv->hook, m);
 222
 223                 if (error) {
 224                         ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
 225                         return;
 226                 }
 227         }
 228         ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
 229 }
 230
 231 /************************************************************************
 232                         NETGRAPH NODE STUFF
 233  ************************************************************************/
 234
 235 /*
 236  * Constructor for a node
 237  */
 238 static int
 239 ng_sppp_constructor (node_p node)
 240 {
 241         struct sppp *pp;
 242         struct ifnet *ifp;
 243         priv_p priv;
 244
 245         /* Allocate node and interface private structures */
 246         priv = malloc(sizeof(*priv), M_NETGRAPH_SPPP, M_WAITOK | M_ZERO);
 247
 248         ifp = if_alloc(IFT_PPP);
 249         if (ifp == NULL) {
 250                 free (priv, M_NETGRAPH_SPPP);
 251                 return (ENOSPC);
 252         }
 253         pp = IFP2SP(ifp);
 254
 255         /* Link them together */
 256         ifp->if_softc = priv;
 257         priv->ifp = ifp;
 258
 259         /* Get an interface unit number */
 260         ng_sppp_get_unit(&priv->unit);
 261
 262         /* Link together node and private info */
 263         NG_NODE_SET_PRIVATE (node, priv);
 264         priv->node = node;
 265
 266         /* Initialize interface structure */
 267         if_initname (SP2IFP(pp), NG_SPPP_IFACE_NAME, priv->unit);
 268         ifp->if_start = ng_sppp_start;
 269         ifp->if_ioctl = ng_sppp_ioctl;
 270         ifp->if_flags = (IFF_POINTOPOINT|IFF_MULTICAST);
 271
 272         /* Give this node the same name as the interface (if possible) */
 273         if (ng_name_node(node, SP2IFP(pp)->if_xname) != 0)
 274                 log (LOG_WARNING, "%s: can't acquire netgraph name\n",
 275                     SP2IFP(pp)->if_xname);
 276
 277         /* Attach the interface */
 278         sppp_attach (ifp);
 279         if_attach (ifp);
 280         bpfattach (ifp, DLT_NULL, sizeof(u_int32_t));
 281
 282         /* Done */
 283         return (0);
 284 }
 285
 286 /*
 287  * Give our ok for a hook to be added
 288  */
 289 static int
 290 ng_sppp_newhook (node_p node, hook_p hook, const char *name)
 291 {
 292         priv_p priv = NG_NODE_PRIVATE (node);
 293
 294         if (strcmp (name, NG_SPPP_HOOK_DOWNSTREAM) != 0)
 295                 return (EINVAL);
 296
 297         if (priv->hook)
 298                 return (EISCONN);
 299
 300         priv->hook = hook;
 301         NG_HOOK_SET_PRIVATE (hook, priv);
 302
 303         return (0);
 304 }
 305
 306 /*
 307  * Receive a control message
 308  */
 309 static int
 310 ng_sppp_rcvmsg (node_p node, item_p item, hook_p lasthook)
 311 {
 312         const priv_p priv = NG_NODE_PRIVATE (node);
 313         struct ng_mesg *msg = NULL;
 314         struct ng_mesg *resp = NULL;
 315         struct sppp *const pp = IFP2SP(priv->ifp);
 316         int error = 0;
 317
 318         NGI_GET_MSG (item, msg);
 319         switch (msg->header.typecookie) {
 320         case NGM_SPPP_COOKIE:
 321                 switch (msg->header.cmd) {
 322                 case NGM_SPPP_GET_IFNAME:
 323                         NG_MKRESPONSE (resp, msg, IFNAMSIZ, M_NOWAIT);
 324                         if (!resp) {
 325                                 error = ENOMEM;
 326                                 break;
 327                         }
 328                         strlcpy(resp->data, SP2IFP(pp)->if_xname, IFNAMSIZ);
 329                         break;
 330
 331                 default:
 332                         error = EINVAL;
 333                         break;
 334                 }
 335                 break;
 336         default:
 337                 error = EINVAL;
 338                 break;
 339         }
 340         NG_RESPOND_MSG (error, node, item, resp);
 341         NG_FREE_MSG (msg);
 342         return (error);
 343 }
 344
 345 /*
 346  * Recive data from a hook. Pass the packet to the correct input routine.
 347  */
 348 static int
 349 ng_sppp_rcvdata (hook_p hook, item_p item)
 350 {
 351         struct mbuf *m;
 352         const priv_p priv = NG_NODE_PRIVATE (NG_HOOK_NODE (hook));
 353         struct sppp *const pp = IFP2SP(priv->ifp);
 354
 355         NGI_GET_M (item, m);
 356         NG_FREE_ITEM (item);
 357         /* Sanity checks */
 358         KASSERT (m->m_flags & M_PKTHDR, ("%s: not pkthdr", __func__));
 359         if ((SP2IFP(pp)->if_flags & IFF_UP) == 0) {
 360                 NG_FREE_M (m);
 361                 return (ENETDOWN);
 362         }
 363
 364         /* Update interface stats */
 365         if_inc_counter(SP2IFP(pp), IFCOUNTER_IPACKETS, 1);
 366
 367         /* Note receiving interface */
 368         m->m_pkthdr.rcvif = SP2IFP(pp);
 369
 370         /* Berkeley packet filter */
 371         BPF_MTAP (SP2IFP(pp), m);
 372
 373         /* Send packet */
 374         sppp_input (SP2IFP(pp), m);
 375         return 0;
 376 }
 377
 378 /*
 379  * Shutdown and remove the node and its associated interface.
 380  */
 381 static int
 382 ng_sppp_shutdown (node_p node)
 383 {
 384         const priv_p priv = NG_NODE_PRIVATE(node);
 385         /* Detach from the packet filter list of interfaces. */
 386         bpfdetach (priv->ifp);
 387         sppp_detach (priv->ifp);
 388         if_detach (priv->ifp);
 389         if_free(priv->ifp);
 390         ng_sppp_free_unit (priv->unit);
 391         free (priv, M_NETGRAPH_SPPP);
 392         NG_NODE_SET_PRIVATE (node, NULL);
 393         NG_NODE_UNREF (node);
 394         return (0);
 395 }
 396
 397 /*
 398  * Hook disconnection.
 399  */
 400 static int
 401 ng_sppp_disconnect (hook_p hook)
 402 {
 403         const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
 404
 405         if (priv)
 406                 priv->hook = NULL;
 407
 408         return (0);
 409 }