ng_gif.c revision 183550
1/* 2 * ng_gif.c 3 */ 4 5/*- 6 * Copyright 2001 The Aerospace Corporation. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions, and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions, and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. The name of The Aerospace Corporation may not be used to endorse or 18 * promote products derived from this software. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AEROSPACE CORPORATION ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AEROSPACE CORPORATION BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * 33 * Copyright (c) 1996-2000 Whistle Communications, Inc. 34 * All rights reserved. 35 * 36 * Subject to the following obligations and disclaimer of warranty, use and 37 * redistribution of this software, in source or object code forms, with or 38 * without modifications are expressly permitted by Whistle Communications; 39 * provided, however, that: 40 * 1. Any and all reproductions of the source or object code must include the 41 * copyright notice above and the following disclaimer of warranties; and 42 * 2. No rights are granted, in any manner or form, to use Whistle 43 * Communications, Inc. trademarks, including the mark "WHISTLE 44 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as 45 * such appears in the above copyright notice or in the software. 46 * 47 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 48 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 49 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 50 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 51 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 52 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 53 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 54 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 55 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 56 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 57 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 58 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 59 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 62 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 63 * OF SUCH DAMAGE. 64 * 65 * $FreeBSD: head/sys/netgraph/ng_gif.c 183550 2008-10-02 15:37:58Z zec $ 66 */ 67 68/* 69 * ng_gif(4) netgraph node type 70 */ 71 72#include <sys/param.h> 73#include <sys/systm.h> 74#include <sys/kernel.h> 75#include <sys/malloc.h> 76#include <sys/mbuf.h> 77#include <sys/errno.h> 78#include <sys/syslog.h> 79#include <sys/socket.h> 80#include <sys/vimage.h> 81 82#include <net/if.h> 83#include <net/route.h> 84#include <net/if_types.h> 85#include <net/if_var.h> 86#include <net/if_gif.h> 87 88#include <netgraph/ng_message.h> 89#include <netgraph/netgraph.h> 90#include <netgraph/ng_parse.h> 91#include <netgraph/ng_gif.h> 92 93#define IFP2NG(ifp) ((struct ng_node *)((struct gif_softc *)(ifp->if_softc))->gif_netgraph) 94#define IFP2NG_SET(ifp, val) (((struct gif_softc *)(ifp->if_softc))->gif_netgraph = (val)) 95 96/* Per-node private data */ 97struct private { 98 struct ifnet *ifp; /* associated interface */ 99 hook_p lower; /* lower OR orphan hook connection */ 100 u_char lowerOrphan; /* whether lower is lower or orphan */ 101}; 102typedef struct private *priv_p; 103 104/* Functional hooks called from if_gif.c */ 105static void ng_gif_input(struct ifnet *ifp, struct mbuf **mp, int af); 106static void ng_gif_input_orphan(struct ifnet *ifp, struct mbuf *m, int af); 107static void ng_gif_attach(struct ifnet *ifp); 108static void ng_gif_detach(struct ifnet *ifp); 109 110/* Other functions */ 111static void ng_gif_input2(node_p node, struct mbuf **mp, int af); 112static int ng_gif_glue_af(struct mbuf **mp, int af); 113static int ng_gif_rcv_lower(node_p node, struct mbuf *m); 114 115/* Netgraph node methods */ 116static ng_constructor_t ng_gif_constructor; 117static ng_rcvmsg_t ng_gif_rcvmsg; 118static ng_shutdown_t ng_gif_shutdown; 119static ng_newhook_t ng_gif_newhook; 120static ng_connect_t ng_gif_connect; 121static ng_rcvdata_t ng_gif_rcvdata; 122static ng_disconnect_t ng_gif_disconnect; 123static int ng_gif_mod_event(module_t mod, int event, void *data); 124 125/* List of commands and how to convert arguments to/from ASCII */ 126static const struct ng_cmdlist ng_gif_cmdlist[] = { 127 { 128 NGM_GIF_COOKIE, 129 NGM_GIF_GET_IFNAME, 130 "getifname", 131 NULL, 132 &ng_parse_string_type 133 }, 134 { 135 NGM_GIF_COOKIE, 136 NGM_GIF_GET_IFINDEX, 137 "getifindex", 138 NULL, 139 &ng_parse_int32_type 140 }, 141 { 0 } 142}; 143 144static struct ng_type ng_gif_typestruct = { 145 .version = NG_ABI_VERSION, 146 .name = NG_GIF_NODE_TYPE, 147 .mod_event = ng_gif_mod_event, 148 .constructor = ng_gif_constructor, 149 .rcvmsg = ng_gif_rcvmsg, 150 .shutdown = ng_gif_shutdown, 151 .newhook = ng_gif_newhook, 152 .connect = ng_gif_connect, 153 .rcvdata = ng_gif_rcvdata, 154 .disconnect = ng_gif_disconnect, 155 .cmdlist = ng_gif_cmdlist, 156}; 157MODULE_DEPEND(ng_gif, if_gif, 1,1,1); 158NETGRAPH_INIT(gif, &ng_gif_typestruct); 159 160/****************************************************************** 161 GIF FUNCTION HOOKS 162******************************************************************/ 163 164/* 165 * Handle a packet that has come in on an interface. We get to 166 * look at it here before any upper layer protocols do. 167 * 168 * NOTE: this function will get called at splimp() 169 */ 170static void 171ng_gif_input(struct ifnet *ifp, struct mbuf **mp, int af) 172{ 173 const node_p node = IFP2NG(ifp); 174 const priv_p priv = NG_NODE_PRIVATE(node); 175 176 /* If "lower" hook not connected, let packet continue */ 177 if (priv->lower == NULL || priv->lowerOrphan) 178 return; 179 ng_gif_input2(node, mp, af); 180} 181 182/* 183 * Handle a packet that has come in on an interface, and which 184 * does not match any of our known protocols (an ``orphan''). 185 * 186 * NOTE: this function will get called at splimp() 187 */ 188static void 189ng_gif_input_orphan(struct ifnet *ifp, struct mbuf *m, int af) 190{ 191 const node_p node = IFP2NG(ifp); 192 const priv_p priv = NG_NODE_PRIVATE(node); 193 194 /* If "orphan" hook not connected, let packet continue */ 195 if (priv->lower == NULL || !priv->lowerOrphan) { 196 m_freem(m); 197 return; 198 } 199 ng_gif_input2(node, &m, af); 200 if (m != NULL) 201 m_freem(m); 202} 203 204/* 205 * Handle a packet that has come in on a gif interface. 206 * Attach the address family to the mbuf for later use. 207 * 208 * NOTE: this function will get called at splimp() 209 */ 210static void 211ng_gif_input2(node_p node, struct mbuf **mp, int af) 212{ 213 const priv_p priv = NG_NODE_PRIVATE(node); 214 int error; 215 216 /* Glue address family on */ 217 if ((error = ng_gif_glue_af(mp, af)) != 0) 218 return; 219 220 /* Send out lower/orphan hook */ 221 NG_SEND_DATA_ONLY(error, priv->lower, *mp); 222 *mp = NULL; 223} 224 225/* 226 * A new gif interface has been attached. 227 * Create a new node for it, etc. 228 */ 229static void 230ng_gif_attach(struct ifnet *ifp) 231{ 232 priv_p priv; 233 node_p node; 234 235 /* Create node */ 236 KASSERT(!IFP2NG(ifp), ("%s: node already exists?", __func__)); 237 if (ng_make_node_common(&ng_gif_typestruct, &node) != 0) { 238 log(LOG_ERR, "%s: can't %s for %s\n", 239 __func__, "create node", ifp->if_xname); 240 return; 241 } 242 243 /* Allocate private data */ 244 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO); 245 if (priv == NULL) { 246 log(LOG_ERR, "%s: can't %s for %s\n", 247 __func__, "allocate memory", ifp->if_xname); 248 NG_NODE_UNREF(node); 249 return; 250 } 251 NG_NODE_SET_PRIVATE(node, priv); 252 priv->ifp = ifp; 253 IFP2NG_SET(ifp, node); 254 255 /* Try to give the node the same name as the interface */ 256 if (ng_name_node(node, ifp->if_xname) != 0) { 257 log(LOG_WARNING, "%s: can't name node %s\n", 258 __func__, ifp->if_xname); 259 } 260} 261 262/* 263 * An interface is being detached. 264 * REALLY Destroy its node. 265 */ 266static void 267ng_gif_detach(struct ifnet *ifp) 268{ 269 const node_p node = IFP2NG(ifp); 270 priv_p priv; 271 272 if (node == NULL) /* no node (why not?), ignore */ 273 return; 274 priv = NG_NODE_PRIVATE(node); 275 NG_NODE_REALLY_DIE(node); /* Force real removal of node */ 276 /* 277 * We can't assume the ifnet is still around when we run shutdown 278 * So zap it now. XXX We HOPE that anything running at this time 279 * handles it (as it should in the non netgraph case). 280 */ 281 IFP2NG_SET(ifp, NULL); 282 priv->ifp = NULL; /* XXX race if interrupted an output packet */ 283 ng_rmnode_self(node); /* remove all netgraph parts */ 284} 285 286/* 287 * Optimization for gluing the address family onto 288 * the front of an incoming packet. 289 */ 290static int 291ng_gif_glue_af(struct mbuf **mp, int af) 292{ 293 struct mbuf *m = *mp; 294 int error = 0; 295 sa_family_t tmp_af; 296 297 tmp_af = (sa_family_t) af; 298 299 /* 300 * XXX: should try to bring back some of the optimizations from 301 * ng_ether.c 302 */ 303 304 /* 305 * Doing anything more is likely to get more 306 * expensive than it's worth.. 307 * it's probable that everything else is in one 308 * big lump. The next node will do an m_pullup() 309 * for exactly the amount of data it needs and 310 * hopefully everything after that will not 311 * need one. So let's just use M_PREPEND. 312 */ 313 M_PREPEND(m, sizeof (tmp_af), M_DONTWAIT); 314 if (m == NULL) { 315 error = ENOBUFS; 316 goto done; 317 } 318 319#if 0 320copy: 321#endif 322 /* Copy header and return (possibly new) mbuf */ 323 *mtod(m, sa_family_t *) = tmp_af; 324#if 0 325 bcopy((caddr_t)&tmp_af, mtod(m, sa_family_t *), sizeof(tmp_af)); 326#endif 327done: 328 *mp = m; 329 return error; 330} 331 332/****************************************************************** 333 NETGRAPH NODE METHODS 334******************************************************************/ 335 336/* 337 * It is not possible or allowable to create a node of this type. 338 * Nodes get created when the interface is attached (or, when 339 * this node type's KLD is loaded). 340 */ 341static int 342ng_gif_constructor(node_p node) 343{ 344 return (EINVAL); 345} 346 347/* 348 * Check for attaching a new hook. 349 */ 350static int 351ng_gif_newhook(node_p node, hook_p hook, const char *name) 352{ 353 const priv_p priv = NG_NODE_PRIVATE(node); 354 u_char orphan = priv->lowerOrphan; 355 hook_p *hookptr; 356 357 /* Divert hook is an alias for lower */ 358 if (strcmp(name, NG_GIF_HOOK_DIVERT) == 0) 359 name = NG_GIF_HOOK_LOWER; 360 361 /* Which hook? */ 362 if (strcmp(name, NG_GIF_HOOK_LOWER) == 0) { 363 hookptr = &priv->lower; 364 orphan = 0; 365 } else if (strcmp(name, NG_GIF_HOOK_ORPHAN) == 0) { 366 hookptr = &priv->lower; 367 orphan = 1; 368 } else 369 return (EINVAL); 370 371 /* Check if already connected (shouldn't be, but doesn't hurt) */ 372 if (*hookptr != NULL) 373 return (EISCONN); 374 375 /* OK */ 376 *hookptr = hook; 377 priv->lowerOrphan = orphan; 378 return (0); 379} 380 381/* 382 * Hooks are attached, adjust to force queueing. 383 * We don't really care which hook it is. 384 * they should all be queuing for outgoing data. 385 */ 386static int 387ng_gif_connect(hook_p hook) 388{ 389 NG_HOOK_FORCE_QUEUE(NG_HOOK_PEER(hook)); 390 return (0); 391} 392 393/* 394 * Receive an incoming control message. 395 */ 396static int 397ng_gif_rcvmsg(node_p node, item_p item, hook_p lasthook) 398{ 399 const priv_p priv = NG_NODE_PRIVATE(node); 400 struct ng_mesg *resp = NULL; 401 int error = 0; 402 struct ng_mesg *msg; 403 404 NGI_GET_MSG(item, msg); 405 switch (msg->header.typecookie) { 406 case NGM_GIF_COOKIE: 407 switch (msg->header.cmd) { 408 case NGM_GIF_GET_IFNAME: 409 NG_MKRESPONSE(resp, msg, IFNAMSIZ, M_NOWAIT); 410 if (resp == NULL) { 411 error = ENOMEM; 412 break; 413 } 414 strlcpy(resp->data, priv->ifp->if_xname, IFNAMSIZ); 415 break; 416 case NGM_GIF_GET_IFINDEX: 417 NG_MKRESPONSE(resp, msg, sizeof(u_int32_t), M_NOWAIT); 418 if (resp == NULL) { 419 error = ENOMEM; 420 break; 421 } 422 *((u_int32_t *)resp->data) = priv->ifp->if_index; 423 break; 424 default: 425 error = EINVAL; 426 break; 427 } 428 break; 429 default: 430 error = EINVAL; 431 break; 432 } 433 NG_RESPOND_MSG(error, node, item, resp); 434 NG_FREE_MSG(msg); 435 return (error); 436} 437 438/* 439 * Receive data on a hook. 440 */ 441static int 442ng_gif_rcvdata(hook_p hook, item_p item) 443{ 444 const node_p node = NG_HOOK_NODE(hook); 445 const priv_p priv = NG_NODE_PRIVATE(node); 446 struct mbuf *m; 447 448 NGI_GET_M(item, m); 449 NG_FREE_ITEM(item); 450 451 if (hook == priv->lower) 452 return ng_gif_rcv_lower(node, m); 453 panic("%s: weird hook", __func__); 454} 455 456/* 457 * Handle an mbuf received on the "lower" hook. 458 */ 459static int 460ng_gif_rcv_lower(node_p node, struct mbuf *m) 461{ 462 struct sockaddr dst; 463 const priv_p priv = NG_NODE_PRIVATE(node); 464 465 bzero(&dst, sizeof(dst)); 466 467 /* Make sure header is fully pulled up */ 468 if (m->m_pkthdr.len < sizeof(sa_family_t)) { 469 NG_FREE_M(m); 470 return (EINVAL); 471 } 472 if (m->m_len < sizeof(sa_family_t) 473 && (m = m_pullup(m, sizeof(sa_family_t))) == NULL) { 474 return (ENOBUFS); 475 } 476 477 dst.sa_family = *mtod(m, sa_family_t *); 478 m_adj(m, sizeof(sa_family_t)); 479 480 /* Send it on its way */ 481 /* 482 * XXX: gif_output only uses dst for the family and passes the 483 * fourth argument (rt) to in{,6}_gif_output which ignore it. 484 * If this changes ng_gif will probably break. 485 */ 486 return gif_output(priv->ifp, m, &dst, NULL); 487} 488 489/* 490 * Shutdown node. This resets the node but does not remove it 491 * unless the REALLY_DIE flag is set. 492 */ 493static int 494ng_gif_shutdown(node_p node) 495{ 496 const priv_p priv = NG_NODE_PRIVATE(node); 497 498 if (node->nd_flags & NGF_REALLY_DIE) { 499 /* 500 * WE came here because the gif interface is being destroyed, 501 * so stop being persistant. 502 * Actually undo all the things we did on creation. 503 * Assume the ifp has already been freed. 504 */ 505 NG_NODE_SET_PRIVATE(node, NULL); 506 FREE(priv, M_NETGRAPH); 507 NG_NODE_UNREF(node); /* free node itself */ 508 return (0); 509 } 510 NG_NODE_REVIVE(node); /* Signal ng_rmnode we are persisant */ 511 return (0); 512} 513 514/* 515 * Hook disconnection. 516 */ 517static int 518ng_gif_disconnect(hook_p hook) 519{ 520 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook)); 521 522 if (hook == priv->lower) { 523 priv->lower = NULL; 524 priv->lowerOrphan = 0; 525 } else 526 panic("%s: weird hook", __func__); 527 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0) 528 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))) 529 ng_rmnode_self(NG_HOOK_NODE(hook)); /* reset node */ 530 531 return (0); 532} 533 534/****************************************************************** 535 INITIALIZATION 536******************************************************************/ 537 538/* 539 * Handle loading and unloading for this node type. 540 */ 541static int 542ng_gif_mod_event(module_t mod, int event, void *data) 543{ 544 VNET_ITERATOR_DECL(vnet_iter); 545 struct ifnet *ifp; 546 int error = 0; 547 int s; 548 549 s = splnet(); 550 switch (event) { 551 case MOD_LOAD: 552 553 /* Register function hooks */ 554 if (ng_gif_attach_p != NULL) { 555 error = EEXIST; 556 break; 557 } 558 ng_gif_attach_p = ng_gif_attach; 559 ng_gif_detach_p = ng_gif_detach; 560 ng_gif_input_p = ng_gif_input; 561 ng_gif_input_orphan_p = ng_gif_input_orphan; 562 563 /* Create nodes for any already-existing gif interfaces */ 564 IFNET_RLOCK(); 565 VNET_LIST_RLOCK(); 566 VNET_FOREACH(vnet_iter) { 567 CURVNET_SET_QUIET(vnet_iter); /* XXX revisit quiet */ 568 INIT_VNET_NET(curvnet); 569 TAILQ_FOREACH(ifp, &V_ifnet, if_link) { 570 if (ifp->if_type == IFT_GIF) 571 ng_gif_attach(ifp); 572 } 573 CURVNET_RESTORE(); 574 } 575 VNET_LIST_RUNLOCK(); 576 IFNET_RUNLOCK(); 577 break; 578 579 case MOD_UNLOAD: 580 581 /* 582 * Note that the base code won't try to unload us until 583 * all nodes have been removed, and that can't happen 584 * until all gif interfaces are destroyed. In any 585 * case, we know there are no nodes left if the action 586 * is MOD_UNLOAD, so there's no need to detach any nodes. 587 * 588 * XXX: what about manual unloads?!? 589 */ 590 591 /* Unregister function hooks */ 592 ng_gif_attach_p = NULL; 593 ng_gif_detach_p = NULL; 594 ng_gif_input_p = NULL; 595 ng_gif_input_orphan_p = NULL; 596 break; 597 598 default: 599 error = EOPNOTSUPP; 600 break; 601 } 602 splx(s); 603 return (error); 604} 605 606