1 /*- 2 * 3 * Copyright (c) 1999-2001, Vitaly V Belekhov 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice unmodified, this list of conditions, and the following 11 * disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #include <sys/param.h> 32 #include <sys/eventhandler.h> 33 #include <sys/systm.h> 34 #include <sys/errno.h> 35 #include <sys/kernel.h> 36 #include <sys/malloc.h> 37 #include <sys/mbuf.h> 38 #include <sys/errno.h> 39 #include <sys/proc.h> 40 #include <sys/sockio.h> 41 #include <sys/socket.h> 42 #include <sys/syslog.h> 43 44 #include <net/if.h> 45 #include <net/if_var.h> 46 #include <net/if_media.h> 47 #include <net/if_types.h> 48 #include <net/netisr.h> 49 #include <net/route.h> 50 #include <net/vnet.h> 51 52 #include <netgraph/ng_message.h> 53 #include <netgraph/netgraph.h> 54 #include <netgraph/ng_parse.h> 55 #include <netgraph/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_cmdlist ng_eiface_cmdlist[] = { 62 { 63 NGM_EIFACE_COOKIE, 64 NGM_EIFACE_GET_IFNAME, 65 "getifname", 66 NULL, 67 &ng_parse_string_type 68 }, 69 { 70 NGM_EIFACE_COOKIE, 71 NGM_EIFACE_SET, 72 "set", 73 &ng_parse_enaddr_type, 74 NULL 75 }, 76 { 0 } 77 }; 78 79 /* Node private data */ 80 struct ng_eiface_private { 81 struct ifnet *ifp; /* per-interface network data */ 82 struct ifmedia media; /* (fake) media information */ 83 int link_status; /* fake */ 84 int unit; /* Interface unit number */ 85 node_p node; /* Our netgraph node */ 86 hook_p ether; /* Hook for ethernet stream */ 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 int ng_eiface_mod_event(module_t, int, void *); 100 static ng_constructor_t ng_eiface_constructor; 101 static ng_rcvmsg_t ng_eiface_rcvmsg; 102 static ng_shutdown_t ng_eiface_rmnode; 103 static ng_newhook_t ng_eiface_newhook; 104 static ng_rcvdata_t ng_eiface_rcvdata; 105 static ng_disconnect_t ng_eiface_disconnect; 106 107 /* Node type descriptor */ 108 static struct ng_type typestruct = { 109 .version = NG_ABI_VERSION, 110 .name = NG_EIFACE_NODE_TYPE, 111 .mod_event = ng_eiface_mod_event, 112 .constructor = ng_eiface_constructor, 113 .rcvmsg = ng_eiface_rcvmsg, 114 .shutdown = ng_eiface_rmnode, 115 .newhook = ng_eiface_newhook, 116 .rcvdata = ng_eiface_rcvdata, 117 .disconnect = ng_eiface_disconnect, 118 .cmdlist = ng_eiface_cmdlist 119 }; 120 NETGRAPH_INIT(eiface, &typestruct); 121 122 static VNET_DEFINE(struct unrhdr *, ng_eiface_unit); 123 #define V_ng_eiface_unit VNET(ng_eiface_unit) 124 125 /************************************************************************ 126 INTERFACE STUFF 127 ************************************************************************/ 128 129 /* 130 * Process an ioctl for the virtual interface 131 */ 132 static int 133 ng_eiface_ioctl(struct ifnet *ifp, u_long command, caddr_t data) 134 { 135 const priv_p priv = (priv_p)ifp->if_softc; 136 struct ifreq *const ifr = (struct ifreq *)data; 137 int error = 0; 138 139 #ifdef DEBUG 140 ng_eiface_print_ioctl(ifp, command, data); 141 #endif 142 switch (command) { 143 144 /* These two are mostly handled at a higher layer */ 145 case SIOCSIFADDR: 146 error = ether_ioctl(ifp, command, data); 147 break; 148 case SIOCGIFADDR: 149 break; 150 151 /* Set flags */ 152 case SIOCSIFFLAGS: 153 /* 154 * If the interface is marked up and stopped, then start it. 155 * If it is marked down and running, then stop it. 156 */ 157 if (ifp->if_flags & IFF_UP) { 158 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING)) { 159 ifp->if_drv_flags &= ~(IFF_DRV_OACTIVE); 160 ifp->if_drv_flags |= IFF_DRV_RUNNING; 161 } 162 } else { 163 if (ifp->if_drv_flags & IFF_DRV_RUNNING) 164 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | 165 IFF_DRV_OACTIVE); 166 } 167 break; 168 169 /* Set the interface MTU */ 170 case SIOCSIFMTU: 171 if (ifr->ifr_mtu > NG_EIFACE_MTU_MAX || 172 ifr->ifr_mtu < NG_EIFACE_MTU_MIN) 173 error = EINVAL; 174 else 175 ifp->if_mtu = ifr->ifr_mtu; 176 break; 177 178 /* (Fake) media type manipulation */ 179 case SIOCSIFMEDIA: 180 case SIOCGIFMEDIA: 181 error = ifmedia_ioctl(ifp, ifr, &priv->media, command); 182 break; 183 184 /* Stuff that's not supported */ 185 case SIOCADDMULTI: 186 case SIOCDELMULTI: 187 error = 0; 188 break; 189 case SIOCSIFPHYS: 190 error = EOPNOTSUPP; 191 break; 192 193 default: 194 error = EINVAL; 195 break; 196 } 197 return (error); 198 } 199 200 static void 201 ng_eiface_init(void *xsc) 202 { 203 priv_p sc = xsc; 204 struct ifnet *ifp = sc->ifp; 205 206 ifp->if_drv_flags |= IFF_DRV_RUNNING; 207 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE; 208 } 209 210 /* 211 * We simply relay the packet to the "ether" hook, if it is connected. 212 * We have been through the netgraph locking and are guaranteed to 213 * be the only code running in this node at this time. 214 */ 215 static void 216 ng_eiface_start2(node_p node, hook_p hook, void *arg1, int arg2) 217 { 218 struct ifnet *ifp = arg1; 219 const priv_p priv = (priv_p)ifp->if_softc; 220 int error = 0; 221 struct mbuf *m; 222 223 /* Check interface flags */ 224 225 if (!((ifp->if_flags & IFF_UP) && 226 (ifp->if_drv_flags & IFF_DRV_RUNNING))) 227 return; 228 229 for (;;) { 230 /* 231 * Grab a packet to transmit. 232 */ 233 IF_DEQUEUE(&ifp->if_snd, m); 234 235 /* If there's nothing to send, break. */ 236 if (m == NULL) 237 break; 238 239 /* 240 * Berkeley packet filter. 241 * Pass packet to bpf if there is a listener. 242 * XXX is this safe? locking? 243 */ 244 BPF_MTAP(ifp, m); 245 246 if (ifp->if_flags & IFF_MONITOR) { 247 ifp->if_ipackets++; 248 m_freem(m); 249 continue; 250 } 251 252 /* 253 * Send packet; if hook is not connected, mbuf will get 254 * freed. 255 */ 256 NG_OUTBOUND_THREAD_REF(); 257 NG_SEND_DATA_ONLY(error, priv->ether, m); 258 NG_OUTBOUND_THREAD_UNREF(); 259 260 /* Update stats */ 261 if (error == 0) 262 ifp->if_opackets++; 263 else 264 ifp->if_oerrors++; 265 } 266 267 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE; 268 269 return; 270 } 271 272 /* 273 * This routine is called to deliver a packet out the interface. 274 * We simply queue the netgraph version to be called when netgraph locking 275 * allows it to happen. 276 * Until we know what the rest of the networking code is doing for 277 * locking, we don't know how we will interact with it. 278 * Take comfort from the fact that the ifnet struct is part of our 279 * private info and can't go away while we are queued. 280 * [Though we don't know it is still there now....] 281 * it is possible we don't gain anything from this because 282 * we would like to get the mbuf and queue it as data 283 * somehow, but we can't and if we did would we solve anything? 284 */ 285 static void 286 ng_eiface_start(struct ifnet *ifp) 287 { 288 const priv_p priv = (priv_p)ifp->if_softc; 289 290 /* Don't do anything if output is active */ 291 if (ifp->if_drv_flags & IFF_DRV_OACTIVE) 292 return; 293 294 ifp->if_drv_flags |= IFF_DRV_OACTIVE; 295 296 if (ng_send_fn(priv->node, NULL, &ng_eiface_start2, ifp, 0) != 0) 297 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE; 298 } 299 300 #ifdef DEBUG 301 /* 302 * Display an ioctl to the virtual interface 303 */ 304 305 static void 306 ng_eiface_print_ioctl(struct ifnet *ifp, int command, caddr_t data) 307 { 308 char *str; 309 310 switch (command & IOC_DIRMASK) { 311 case IOC_VOID: 312 str = "IO"; 313 break; 314 case IOC_OUT: 315 str = "IOR"; 316 break; 317 case IOC_IN: 318 str = "IOW"; 319 break; 320 case IOC_INOUT: 321 str = "IORW"; 322 break; 323 default: 324 str = "IO??"; 325 } 326 log(LOG_DEBUG, "%s: %s('%c', %d, char[%d])\n", 327 ifp->if_xname, 328 str, 329 IOCGROUP(command), 330 command & 0xff, 331 IOCPARM_LEN(command)); 332 } 333 #endif /* DEBUG */ 334 335 /* 336 * ifmedia stuff 337 */ 338 static int 339 ng_eiface_mediachange(struct ifnet *ifp) 340 { 341 const priv_p priv = (priv_p)ifp->if_softc; 342 struct ifmedia *ifm = &priv->media; 343 344 if (IFM_TYPE(ifm->ifm_media) != IFM_ETHER) 345 return (EINVAL); 346 if (IFM_SUBTYPE(ifm->ifm_media) == IFM_AUTO) 347 ifp->if_baudrate = ifmedia_baudrate(IFM_ETHER | IFM_1000_T); 348 else 349 ifp->if_baudrate = ifmedia_baudrate(ifm->ifm_media); 350 351 return (0); 352 } 353 354 static void 355 ng_eiface_mediastatus(struct ifnet *ifp, struct ifmediareq *ifmr) 356 { 357 const priv_p priv = (priv_p)ifp->if_softc; 358 struct ifmedia *ifm = &priv->media; 359 360 if (ifm->ifm_cur->ifm_media == (IFM_ETHER | IFM_AUTO) && 361 (priv->link_status & IFM_ACTIVE)) 362 ifmr->ifm_active = IFM_ETHER | IFM_1000_T | IFM_FDX; 363 else 364 ifmr->ifm_active = ifm->ifm_cur->ifm_media; 365 ifmr->ifm_status = priv->link_status; 366 367 return; 368 } 369 370 /************************************************************************ 371 NETGRAPH NODE STUFF 372 ************************************************************************/ 373 374 /* 375 * Constructor for a node 376 */ 377 static int 378 ng_eiface_constructor(node_p node) 379 { 380 struct ifnet *ifp; 381 priv_p priv; 382 u_char eaddr[6] = {0,0,0,0,0,0}; 383 384 /* Allocate node and interface private structures */ 385 priv = malloc(sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO); 386 387 ifp = priv->ifp = if_alloc(IFT_ETHER); 388 if (ifp == NULL) { 389 free(priv, M_NETGRAPH); 390 return (ENOSPC); 391 } 392 393 /* Link them together */ 394 ifp->if_softc = priv; 395 396 /* Get an interface unit number */ 397 priv->unit = alloc_unr(V_ng_eiface_unit); 398 399 /* Link together node and private info */ 400 NG_NODE_SET_PRIVATE(node, priv); 401 priv->node = node; 402 403 /* Initialize interface structure */ 404 if_initname(ifp, NG_EIFACE_EIFACE_NAME, priv->unit); 405 ifp->if_init = ng_eiface_init; 406 ifp->if_output = ether_output; 407 ifp->if_start = ng_eiface_start; 408 ifp->if_ioctl = ng_eiface_ioctl; 409 ifp->if_snd.ifq_maxlen = ifqmaxlen; 410 ifp->if_flags = (IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST); 411 ifp->if_capabilities = IFCAP_VLAN_MTU | IFCAP_JUMBO_MTU; 412 ifp->if_capenable = IFCAP_VLAN_MTU | IFCAP_JUMBO_MTU; 413 ifmedia_init(&priv->media, 0, ng_eiface_mediachange, 414 ng_eiface_mediastatus); 415 ifmedia_add(&priv->media, IFM_ETHER | IFM_10_T, 0, NULL); 416 ifmedia_add(&priv->media, IFM_ETHER | IFM_10_T | IFM_FDX, 0, NULL); 417 ifmedia_add(&priv->media, IFM_ETHER | IFM_100_TX, 0, NULL); 418 ifmedia_add(&priv->media, IFM_ETHER | IFM_100_TX | IFM_FDX, 0, NULL); 419 ifmedia_add(&priv->media, IFM_ETHER | IFM_1000_T, 0, NULL); 420 ifmedia_add(&priv->media, IFM_ETHER | IFM_1000_T | IFM_FDX, 0, NULL); 421 ifmedia_add(&priv->media, IFM_ETHER | IFM_10G_T | IFM_FDX, 0, NULL); 422 ifmedia_add(&priv->media, IFM_ETHER | IFM_AUTO, 0, NULL); 423 ifmedia_set(&priv->media, IFM_ETHER | IFM_AUTO); 424 priv->link_status = IFM_AVALID; 425 426 /* Give this node the same name as the interface (if possible) */ 427 if (ng_name_node(node, ifp->if_xname) != 0) 428 log(LOG_WARNING, "%s: can't acquire netgraph name\n", 429 ifp->if_xname); 430 431 /* Attach the interface */ 432 ether_ifattach(ifp, eaddr); 433 ifp->if_baudrate = ifmedia_baudrate(IFM_ETHER | IFM_1000_T); 434 435 /* Done */ 436 return (0); 437 } 438 439 /* 440 * Give our ok for a hook to be added 441 */ 442 static int 443 ng_eiface_newhook(node_p node, hook_p hook, const char *name) 444 { 445 priv_p priv = NG_NODE_PRIVATE(node); 446 struct ifnet *ifp = priv->ifp; 447 448 if (strcmp(name, NG_EIFACE_HOOK_ETHER)) 449 return (EPFNOSUPPORT); 450 if (priv->ether != NULL) 451 return (EISCONN); 452 priv->ether = hook; 453 NG_HOOK_SET_PRIVATE(hook, &priv->ether); 454 NG_HOOK_SET_TO_INBOUND(hook); 455 456 priv->link_status |= IFM_ACTIVE; 457 CURVNET_SET_QUIET(ifp->if_vnet); 458 if_link_state_change(ifp, LINK_STATE_UP); 459 CURVNET_RESTORE(); 460 461 return (0); 462 } 463 464 /* 465 * Receive a control message 466 */ 467 static int 468 ng_eiface_rcvmsg(node_p node, item_p item, hook_p lasthook) 469 { 470 const priv_p priv = NG_NODE_PRIVATE(node); 471 struct ifnet *const ifp = priv->ifp; 472 struct ng_mesg *resp = NULL; 473 int error = 0; 474 struct ng_mesg *msg; 475 476 NGI_GET_MSG(item, msg); 477 switch (msg->header.typecookie) { 478 case NGM_EIFACE_COOKIE: 479 switch (msg->header.cmd) { 480 481 case NGM_EIFACE_SET: 482 { 483 if (msg->header.arglen != ETHER_ADDR_LEN) { 484 error = EINVAL; 485 break; 486 } 487 error = if_setlladdr(priv->ifp, 488 (u_char *)msg->data, ETHER_ADDR_LEN); 489 EVENTHANDLER_INVOKE(iflladdr_event, priv->ifp); 490 break; 491 } 492 493 case NGM_EIFACE_GET_IFNAME: 494 NG_MKRESPONSE(resp, msg, IFNAMSIZ, M_NOWAIT); 495 if (resp == NULL) { 496 error = ENOMEM; 497 break; 498 } 499 strlcpy(resp->data, ifp->if_xname, IFNAMSIZ); 500 break; 501 502 case NGM_EIFACE_GET_IFADDRS: 503 { 504 struct ifaddr *ifa; 505 caddr_t ptr; 506 int buflen; 507 508 /* Determine size of response and allocate it */ 509 buflen = 0; 510 if_addr_rlock(ifp); 511 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) 512 buflen += SA_SIZE(ifa->ifa_addr); 513 NG_MKRESPONSE(resp, msg, buflen, M_NOWAIT); 514 if (resp == NULL) { 515 if_addr_runlock(ifp); 516 error = ENOMEM; 517 break; 518 } 519 520 /* Add addresses */ 521 ptr = resp->data; 522 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) { 523 const int len = SA_SIZE(ifa->ifa_addr); 524 525 if (buflen < len) { 526 log(LOG_ERR, "%s: len changed?\n", 527 ifp->if_xname); 528 break; 529 } 530 bcopy(ifa->ifa_addr, ptr, len); 531 ptr += len; 532 buflen -= len; 533 } 534 if_addr_runlock(ifp); 535 break; 536 } 537 538 default: 539 error = EINVAL; 540 break; 541 } /* end of inner switch() */ 542 break; 543 case NGM_FLOW_COOKIE: 544 CURVNET_SET_QUIET(ifp->if_vnet); 545 switch (msg->header.cmd) { 546 case NGM_LINK_IS_UP: 547 priv->link_status |= IFM_ACTIVE; 548 if_link_state_change(ifp, LINK_STATE_UP); 549 break; 550 case NGM_LINK_IS_DOWN: 551 priv->link_status &= ~IFM_ACTIVE; 552 if_link_state_change(ifp, LINK_STATE_DOWN); 553 break; 554 default: 555 break; 556 } 557 CURVNET_RESTORE(); 558 break; 559 default: 560 error = EINVAL; 561 break; 562 } 563 NG_RESPOND_MSG(error, node, item, resp); 564 NG_FREE_MSG(msg); 565 return (error); 566 } 567 568 /* 569 * Receive data from a hook. Pass the packet to the ether_input routine. 570 */ 571 static int 572 ng_eiface_rcvdata(hook_p hook, item_p item) 573 { 574 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook)); 575 struct ifnet *const ifp = priv->ifp; 576 struct mbuf *m; 577 578 NGI_GET_M(item, m); 579 NG_FREE_ITEM(item); 580 581 if (!((ifp->if_flags & IFF_UP) && 582 (ifp->if_drv_flags & IFF_DRV_RUNNING))) { 583 NG_FREE_M(m); 584 return (ENETDOWN); 585 } 586 587 if (m->m_len < ETHER_HDR_LEN) { 588 m = m_pullup(m, ETHER_HDR_LEN); 589 if (m == NULL) 590 return (EINVAL); 591 } 592 593 /* Note receiving interface */ 594 m->m_pkthdr.rcvif = ifp; 595 596 /* Update interface stats */ 597 ifp->if_ipackets++; 598 599 (*ifp->if_input)(ifp, m); 600 601 /* Done */ 602 return (0); 603 } 604 605 /* 606 * Shutdown processing. 607 */ 608 static int 609 ng_eiface_rmnode(node_p node) 610 { 611 const priv_p priv = NG_NODE_PRIVATE(node); 612 struct ifnet *const ifp = priv->ifp; 613 614 /* 615 * the ifnet may be in a different vnet than the netgraph node, 616 * hence we have to change the current vnet context here. 617 */ 618 CURVNET_SET_QUIET(ifp->if_vnet); 619 ifmedia_removeall(&priv->media); 620 ether_ifdetach(ifp); 621 if_free(ifp); 622 CURVNET_RESTORE(); 623 free_unr(V_ng_eiface_unit, priv->unit); 624 free(priv, M_NETGRAPH); 625 NG_NODE_SET_PRIVATE(node, NULL); 626 NG_NODE_UNREF(node); 627 return (0); 628 } 629 630 /* 631 * Hook disconnection 632 */ 633 static int 634 ng_eiface_disconnect(hook_p hook) 635 { 636 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook)); 637 638 priv->ether = NULL; 639 priv->link_status &= ~IFM_ACTIVE; 640 CURVNET_SET_QUIET(priv->ifp->if_vnet); 641 if_link_state_change(priv->ifp, LINK_STATE_DOWN); 642 CURVNET_RESTORE(); 643 return (0); 644 } 645 646 /* 647 * Handle loading and unloading for this node type. 648 */ 649 static int 650 ng_eiface_mod_event(module_t mod, int event, void *data) 651 { 652 int error = 0; 653 654 switch (event) { 655 case MOD_LOAD: 656 case MOD_UNLOAD: 657 break; 658 default: 659 error = EOPNOTSUPP; 660 break; 661 } 662 return (error); 663 } 664 665 static void 666 vnet_ng_eiface_init(const void *unused) 667 { 668 669 V_ng_eiface_unit = new_unrhdr(0, 0xffff, NULL); 670 } 671 VNET_SYSINIT(vnet_ng_eiface_init, SI_SUB_PSEUDO, SI_ORDER_ANY, 672 vnet_ng_eiface_init, NULL); 673 674 static void 675 vnet_ng_eiface_uninit(const void *unused) 676 { 677 678 delete_unrhdr(V_ng_eiface_unit); 679 } 680 VNET_SYSUNINIT(vnet_ng_eiface_uninit, SI_SUB_PSEUDO, SI_ORDER_ANY, 681 vnet_ng_eiface_uninit, NULL); 682