1 /* 2 * ng_eiface.c 3 * 4 * Copyright (c) 1999-2000, Vitaly V Belekhov 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice unmodified, this list of conditions, and the following 12 * disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $Id: ng_eiface.c,v 1.14 2000/03/15 12:28:44 vitaly Exp $ 30 * $FreeBSD: src/sys/netgraph/ng_eiface.c,v 1.4.2.5 2002/12/17 21:47:48 julian Exp $ 31 * $DragonFly: src/sys/netgraph/eiface/ng_eiface.c,v 1.12 2006/12/22 23:44:57 swildner Exp $ 32 */ 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/errno.h> 37 #include <sys/kernel.h> 38 #include <sys/malloc.h> 39 #include <sys/mbuf.h> 40 #include <sys/errno.h> 41 #include <sys/sockio.h> 42 #include <sys/socket.h> 43 #include <sys/syslog.h> 44 #include <sys/serialize.h> 45 #include <sys/thread2.h> 46 47 #include <net/if.h> 48 #include <net/if_types.h> 49 #include <net/netisr.h> 50 51 52 #include <netgraph/ng_message.h> 53 #include <netgraph/netgraph.h> 54 #include <netgraph/ng_parse.h> 55 #include "ng_eiface.h" 56 57 #include <net/bpf.h> 58 #include <net/ethernet.h> 59 #include <net/if_arp.h> 60 61 static const struct ng_parse_struct_field ng_eiface_par_fields[] 62 = NG_EIFACE_PAR_FIELDS; 63 64 static const struct ng_parse_type ng_eiface_par_type = { 65 &ng_parse_struct_type, 66 &ng_eiface_par_fields 67 }; 68 69 static const struct ng_cmdlist ng_eiface_cmdlist[] = { 70 { 71 NGM_EIFACE_COOKIE, 72 NGM_EIFACE_SET, 73 "set", 74 &ng_eiface_par_type, 75 NULL 76 }, 77 { 0 } 78 }; 79 80 /* Node private data */ 81 struct ng_eiface_private { 82 struct arpcom arpcom; /* per-interface network data */ 83 struct ifnet *ifp; /* This interface */ 84 node_p node; /* Our netgraph node */ 85 hook_p ether; /* Hook for ethernet stream */ 86 struct private *next; /* When hung on the free list */ 87 }; 88 typedef struct ng_eiface_private *priv_p; 89 90 /* Interface methods */ 91 static void ng_eiface_init(void *xsc); 92 static void ng_eiface_start(struct ifnet *ifp); 93 static int ng_eiface_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data); 94 #ifdef DEBUG 95 static void ng_eiface_print_ioctl(struct ifnet *ifp, int cmd, caddr_t data); 96 #endif 97 98 /* Netgraph methods */ 99 static ng_constructor_t ng_eiface_constructor; 100 static ng_rcvmsg_t ng_eiface_rcvmsg; 101 static ng_shutdown_t ng_eiface_rmnode; 102 static ng_newhook_t ng_eiface_newhook; 103 static ng_rcvdata_t ng_eiface_rcvdata; 104 static ng_connect_t ng_eiface_connect; 105 static ng_disconnect_t ng_eiface_disconnect; 106 107 /* Node type descriptor */ 108 static struct ng_type typestruct = { 109 NG_VERSION, 110 NG_EIFACE_NODE_TYPE, 111 NULL, 112 ng_eiface_constructor, 113 ng_eiface_rcvmsg, 114 ng_eiface_rmnode, 115 ng_eiface_newhook, 116 NULL, 117 ng_eiface_connect, 118 ng_eiface_rcvdata, 119 ng_eiface_rcvdata, 120 ng_eiface_disconnect, 121 ng_eiface_cmdlist 122 }; 123 NETGRAPH_INIT(eiface, &typestruct); 124 125 static char ng_eiface_ifname[] = NG_EIFACE_EIFACE_NAME; 126 static int ng_eiface_next_unit; 127 128 /************************************************************************ 129 INTERFACE STUFF 130 ************************************************************************/ 131 132 /* 133 * Process an ioctl for the virtual interface 134 */ 135 static int 136 ng_eiface_ioctl(struct ifnet *ifp, u_long command, caddr_t data) 137 { 138 struct ifreq *const ifr = (struct ifreq *) data; 139 int error = 0; 140 141 #ifdef DEBUG 142 ng_eiface_print_ioctl(ifp, command, data); 143 #endif 144 crit_enter(); 145 switch (command) { 146 147 /* These two are mostly handled at a higher layer */ 148 case SIOCSIFADDR: 149 error = ether_ioctl(ifp, command, data); 150 break; 151 case SIOCGIFADDR: 152 break; 153 154 /* Set flags */ 155 case SIOCSIFFLAGS: 156 /* 157 * If the interface is marked up and stopped, then start it. 158 * If it is marked down and running, then stop it. 159 */ 160 if (ifr->ifr_flags & IFF_UP) { 161 if (!(ifp->if_flags & IFF_RUNNING)) { 162 ifp->if_flags &= ~(IFF_OACTIVE); 163 ifp->if_flags |= IFF_RUNNING; 164 } 165 } else { 166 if (ifp->if_flags & IFF_RUNNING) 167 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE); 168 } 169 break; 170 171 /* Set the interface MTU */ 172 case SIOCSIFMTU: 173 if (ifr->ifr_mtu > NG_EIFACE_MTU_MAX 174 || ifr->ifr_mtu < NG_EIFACE_MTU_MIN) 175 error = EINVAL; 176 else 177 ifp->if_mtu = ifr->ifr_mtu; 178 break; 179 180 /* Stuff that's not supported */ 181 case SIOCADDMULTI: 182 case SIOCDELMULTI: 183 error = 0; 184 break; 185 case SIOCSIFPHYS: 186 error = EOPNOTSUPP; 187 break; 188 189 default: 190 error = EINVAL; 191 break; 192 } 193 crit_exit(); 194 return (error); 195 } 196 197 static void 198 ng_eiface_init(void *xsc) 199 { 200 priv_p sc = xsc; 201 struct ifnet *ifp = sc->ifp; 202 203 crit_enter(); 204 205 ifp->if_flags |= IFF_RUNNING; 206 ifp->if_flags &= ~IFF_OACTIVE; 207 208 crit_exit(); 209 210 } 211 212 /* 213 * This routine is called to deliver a packet out the interface. 214 * We simply relay the packet to 215 * the ether hook, if it is connected. 216 */ 217 218 static void 219 ng_eiface_start(struct ifnet *ifp) 220 { 221 const priv_p priv = (priv_p) ifp->if_softc; 222 meta_p meta = NULL; 223 int len, error = 0; 224 struct mbuf *m; 225 226 /* Check interface flags */ 227 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING)) != (IFF_UP|IFF_RUNNING)) 228 return; 229 230 /* Don't do anything if output is active */ 231 if( ifp->if_flags & IFF_OACTIVE ) 232 return; 233 234 ifp->if_flags |= IFF_OACTIVE; 235 236 /* 237 * Grab a packet to transmit. 238 */ 239 IF_DEQUEUE(&ifp->if_snd, m); 240 241 /* If there's nothing to send, return. */ 242 if(m == NULL) 243 { 244 ifp->if_flags &= ~IFF_OACTIVE; 245 return; 246 } 247 248 BPF_MTAP(ifp, m); 249 250 /* Copy length before the mbuf gets invalidated */ 251 len = m->m_pkthdr.len; 252 253 /* Send packet; if hook is not connected, mbuf will get freed. */ 254 NG_SEND_DATA(error, priv->ether, m, meta); 255 256 /* Update stats */ 257 if (error == 0) { 258 ifp->if_obytes += len; 259 ifp->if_opackets++; 260 } 261 262 ifp->if_flags &= ~IFF_OACTIVE; 263 264 return; 265 } 266 267 #ifdef DEBUG 268 /* 269 * Display an ioctl to the virtual interface 270 */ 271 272 static void 273 ng_eiface_print_ioctl(struct ifnet *ifp, int command, caddr_t data) 274 { 275 char *str; 276 277 switch (command & IOC_DIRMASK) { 278 case IOC_VOID: 279 str = "IO"; 280 break; 281 case IOC_OUT: 282 str = "IOR"; 283 break; 284 case IOC_IN: 285 str = "IOW"; 286 break; 287 case IOC_INOUT: 288 str = "IORW"; 289 break; 290 default: 291 str = "IO??"; 292 } 293 log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n", 294 ifp->if_xname, 295 str, 296 IOCGROUP(command), 297 command & 0xff, 298 IOCPARM_LEN(command)); 299 } 300 #endif /* DEBUG */ 301 302 /************************************************************************ 303 NETGRAPH NODE STUFF 304 ************************************************************************/ 305 306 /* 307 * Constructor for a node 308 */ 309 static int 310 ng_eiface_constructor(node_p *nodep) 311 { 312 struct ifnet *ifp; 313 node_p node; 314 priv_p priv; 315 int error = 0; 316 317 /* Allocate node and interface private structures */ 318 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_WAITOK); 319 if (priv == NULL) 320 return (ENOMEM); 321 bzero(priv, sizeof(*priv)); 322 323 ifp = &(priv->arpcom.ac_if); 324 325 /* Link them together */ 326 ifp->if_softc = priv; 327 priv->ifp = ifp; 328 329 /* Call generic node constructor */ 330 if ((error = ng_make_node_common(&typestruct, nodep))) { 331 FREE(priv, M_NETGRAPH); 332 return (error); 333 } 334 node = *nodep; 335 336 /* Link together node and private info */ 337 node->private = priv; 338 priv->node = node; 339 340 /* Initialize interface structure */ 341 if_initname(ifp, ng_eiface_ifname, ng_eiface_next_unit++); 342 ifp->if_init = ng_eiface_init; 343 ifp->if_start = ng_eiface_start; 344 ifp->if_ioctl = ng_eiface_ioctl; 345 ifp->if_watchdog = NULL; 346 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN; 347 ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST); 348 349 TAILQ_INIT(&ifp->if_addrhead); 350 351 /* Give this node name * 352 bzero(ifname, sizeof(ifname)); 353 ksprintf(ifname, "if%s", ifp->if_xname); 354 ng_name_node(node, ifname); 355 */ 356 357 /* Attach the interface */ 358 ether_ifattach(ifp, priv->arpcom.ac_enaddr, NULL); 359 360 /* Done */ 361 return (0); 362 } 363 364 /* 365 * Give our ok for a hook to be added 366 */ 367 static int 368 ng_eiface_newhook(node_p node, hook_p hook, const char *name) 369 { 370 priv_p priv = node->private; 371 372 if (strcmp(name, NG_EIFACE_HOOK_ETHER)) 373 return (EPFNOSUPPORT); 374 if (priv->ether != NULL) 375 return (EISCONN); 376 priv->ether = hook; 377 hook->private = &priv->ether; 378 379 return (0); 380 } 381 382 /* 383 * Receive a control message 384 */ 385 static int 386 ng_eiface_rcvmsg(node_p node, struct ng_mesg *msg, 387 const char *retaddr, struct ng_mesg **rptr) 388 { 389 const priv_p priv = node->private; 390 struct ifnet *const ifp = priv->ifp; 391 struct ng_mesg *resp = NULL; 392 int error = 0; 393 394 switch (msg->header.typecookie) { 395 case NGM_EIFACE_COOKIE: 396 switch (msg->header.cmd) { 397 398 case NGM_EIFACE_SET: 399 { 400 struct ng_eiface_par *eaddr; 401 402 if (msg->header.arglen != sizeof(struct ng_eiface_par)) 403 { 404 error = EINVAL; 405 break; 406 } 407 eaddr = (struct ng_eiface_par *)(msg->data); 408 409 priv->arpcom.ac_enaddr[0] = eaddr->oct0; 410 priv->arpcom.ac_enaddr[1] = eaddr->oct1; 411 priv->arpcom.ac_enaddr[2] = eaddr->oct2; 412 priv->arpcom.ac_enaddr[3] = eaddr->oct3; 413 priv->arpcom.ac_enaddr[4] = eaddr->oct4; 414 priv->arpcom.ac_enaddr[5] = eaddr->oct5; 415 416 break; 417 } 418 419 case NGM_EIFACE_GET_IFNAME: 420 { 421 struct ng_eiface_ifname *arg; 422 423 NG_MKRESPONSE(resp, msg, sizeof(*arg), M_NOWAIT); 424 if (resp == NULL) { 425 error = ENOMEM; 426 break; 427 } 428 arg = (struct ng_eiface_ifname *) resp->data; 429 ksprintf(arg->ngif_name, 430 "%s", ifp->if_xname); /* XXX: strings */ 431 break; 432 } 433 434 case NGM_EIFACE_GET_IFADDRS: 435 { 436 struct ifaddr *ifa; 437 caddr_t ptr; 438 int buflen; 439 440 #define SA_SIZE(s) ((s)->sa_len<sizeof(*(s))? sizeof(*(s)):(s)->sa_len) 441 442 /* Determine size of response and allocate it */ 443 buflen = 0; 444 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) 445 buflen += SA_SIZE(ifa->ifa_addr); 446 NG_MKRESPONSE(resp, msg, buflen, M_NOWAIT); 447 if (resp == NULL) { 448 error = ENOMEM; 449 break; 450 } 451 452 /* Add addresses */ 453 ptr = resp->data; 454 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) { 455 const int len = SA_SIZE(ifa->ifa_addr); 456 457 if (buflen < len) { 458 log(LOG_ERR, "%s: len changed?\n", 459 ifp->if_xname); 460 break; 461 } 462 bcopy(ifa->ifa_addr, ptr, len); 463 ptr += len; 464 buflen -= len; 465 } 466 break; 467 #undef SA_SIZE 468 } 469 470 default: 471 error = EINVAL; 472 break; 473 } 474 break; 475 default: 476 error = EINVAL; 477 break; 478 } 479 if (rptr) 480 *rptr = resp; 481 else if (resp) 482 FREE(resp, M_NETGRAPH); 483 FREE(msg, M_NETGRAPH); 484 return (error); 485 } 486 487 /* 488 * Recive data from a hook. Pass the packet to the ether_input routine. 489 */ 490 static int 491 ng_eiface_rcvdata(hook_p hook, struct mbuf *m, meta_p meta) 492 { 493 const priv_p priv = hook->node->private; 494 struct ifnet *const ifp = priv->ifp; 495 int error = 0; 496 struct ether_header *eh; 497 u_short ether_type; 498 499 /* Meta-data is end its life here... */ 500 NG_FREE_META(meta); 501 502 if (m == NULL) 503 { 504 kprintf("ng_eiface: mbuf is null.\n"); 505 return (EINVAL); 506 } 507 508 lwkt_serialize_enter(ifp->if_serializer); 509 if ( !(ifp->if_flags & IFF_UP) ) { 510 lwkt_serialize_exit(ifp->if_serializer); 511 return (ENETDOWN); 512 } 513 514 /* Note receiving interface */ 515 m->m_pkthdr.rcvif = ifp; 516 517 /* Update interface stats */ 518 ifp->if_ipackets++; 519 520 BPF_MTAP(ifp, m); 521 522 ifp->if_input(ifp, m); 523 lwkt_serialize_exit(ifp->if_serializer); 524 525 /* Done */ 526 return (error); 527 } 528 529 /* 530 * Because the BSD networking code doesn't support the removal of 531 * networking interfaces, iface nodes (once created) are persistent. 532 * So this method breaks all connections and marks the interface 533 * down, but does not remove the node. 534 */ 535 static int 536 ng_eiface_rmnode(node_p node) 537 { 538 const priv_p priv = node->private; 539 struct ifnet *const ifp = priv->ifp; 540 541 ng_cutlinks(node); 542 node->flags &= ~NG_INVALID; 543 lwkt_serialize_enter(ifp->if_serializer); 544 ifp->if_flags &= ~(IFF_UP | IFF_RUNNING | IFF_OACTIVE); 545 lwkt_serialize_exit(ifp->if_serializer); 546 return (0); 547 } 548 549 550 /* 551 * This is called once we've already connected a new hook to the other node. 552 * It gives us a chance to balk at the last minute. 553 */ 554 static int 555 ng_eiface_connect(hook_p hook) 556 { 557 /* be really amiable and just say "YUP that's OK by me! " */ 558 return (0); 559 } 560 561 /* 562 * Hook disconnection 563 */ 564 static int 565 ng_eiface_disconnect(hook_p hook) 566 { 567 const priv_p priv = hook->node->private; 568 569 priv->ether = NULL; 570 return (0); 571 } 572