1 2 /* 3 * ng_one2many.c 4 * 5 * Copyright (c) 2000 Whistle Communications, Inc. 6 * All rights reserved. 7 * 8 * Subject to the following obligations and disclaimer of warranty, use and 9 * redistribution of this software, in source or object code forms, with or 10 * without modifications are expressly permitted by Whistle Communications; 11 * provided, however, that: 12 * 1. Any and all reproductions of the source or object code must include the 13 * copyright notice above and the following disclaimer of warranties; and 14 * 2. No rights are granted, in any manner or form, to use Whistle 15 * Communications, Inc. trademarks, including the mark "WHISTLE 16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as 17 * such appears in the above copyright notice or in the software. 18 * 19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 35 * OF SUCH DAMAGE. 36 * 37 * Author: Archie Cobbs <archie@freebsd.org> 38 * 39 * $FreeBSD$ 40 */ 41 42 /* 43 * ng_one2many(4) netgraph node type 44 * 45 * Packets received on the "one" hook are sent out each of the 46 * "many" hooks in round-robin fashion. Packets received on any 47 * "many" hook are always delivered to the "one" hook. 48 */ 49 50 #include <sys/param.h> 51 #include <sys/systm.h> 52 #include <sys/kernel.h> 53 #include <sys/malloc.h> 54 #include <sys/ctype.h> 55 #include <sys/mbuf.h> 56 #include <sys/errno.h> 57 58 #include <netgraph/ng_message.h> 59 #include <netgraph/netgraph.h> 60 #include <netgraph/ng_parse.h> 61 #include <netgraph/ng_one2many.h> 62 63 /* Per-link private data */ 64 struct ng_one2many_link { 65 hook_p hook; /* netgraph hook */ 66 struct ng_one2many_link_stats stats; /* link stats */ 67 }; 68 69 /* Per-node private data */ 70 struct ng_one2many_private { 71 struct ng_one2many_config conf; /* node configuration */ 72 struct ng_one2many_link one; /* "one" hook */ 73 struct ng_one2many_link many[NG_ONE2MANY_MAX_LINKS]; 74 u_int16_t nextMany; /* next round-robin */ 75 u_int16_t numActiveMany; /* # active "many" */ 76 u_int16_t activeMany[NG_ONE2MANY_MAX_LINKS]; 77 }; 78 typedef struct ng_one2many_private *priv_p; 79 80 /* Netgraph node methods */ 81 static ng_constructor_t ng_one2many_constructor; 82 static ng_rcvmsg_t ng_one2many_rcvmsg; 83 static ng_shutdown_t ng_one2many_shutdown; 84 static ng_newhook_t ng_one2many_newhook; 85 static ng_rcvdata_t ng_one2many_rcvdata; 86 static ng_disconnect_t ng_one2many_disconnect; 87 88 /* Other functions */ 89 static void ng_one2many_update_many(priv_p priv); 90 91 /* Store each hook's link number in the private field */ 92 #define LINK_NUM(hook) (*(int16_t *)(&(hook)->private)) 93 94 /****************************************************************** 95 NETGRAPH PARSE TYPES 96 ******************************************************************/ 97 98 /* Parse type for struct ng_one2many_config */ 99 static const struct ng_parse_fixedarray_info 100 ng_one2many_enableLinks_array_type_info = { 101 &ng_parse_uint8_type, 102 NG_ONE2MANY_MAX_LINKS 103 }; 104 static const struct ng_parse_type ng_one2many_enableLinks_array_type = { 105 &ng_parse_fixedarray_type, 106 &ng_one2many_enableLinks_array_type_info, 107 }; 108 static const struct ng_parse_struct_info ng_one2many_config_type_info 109 = NG_ONE2MANY_CONFIG_TYPE_INFO(&ng_one2many_enableLinks_array_type); 110 static const struct ng_parse_type ng_one2many_config_type = { 111 &ng_parse_struct_type, 112 &ng_one2many_config_type_info, 113 }; 114 115 /* Parse type for struct ng_one2many_link_stats */ 116 static const struct ng_parse_struct_info 117 ng_one2many_link_stats_type_info = NG_ONE2MANY_LINK_STATS_TYPE_INFO; 118 static const struct ng_parse_type ng_one2many_link_stats_type = { 119 &ng_parse_struct_type, 120 &ng_one2many_link_stats_type_info 121 }; 122 123 /* List of commands and how to convert arguments to/from ASCII */ 124 static const struct ng_cmdlist ng_one2many_cmdlist[] = { 125 { 126 NGM_ONE2MANY_COOKIE, 127 NGM_ONE2MANY_SET_CONFIG, 128 "setconfig", 129 &ng_one2many_config_type, 130 NULL 131 }, 132 { 133 NGM_ONE2MANY_COOKIE, 134 NGM_ONE2MANY_GET_CONFIG, 135 "getconfig", 136 NULL, 137 &ng_one2many_config_type 138 }, 139 { 140 NGM_ONE2MANY_COOKIE, 141 NGM_ONE2MANY_GET_STATS, 142 "getstats", 143 &ng_parse_int32_type, 144 &ng_one2many_link_stats_type 145 }, 146 { 147 NGM_ONE2MANY_COOKIE, 148 NGM_ONE2MANY_CLR_STATS, 149 "clrstats", 150 &ng_parse_int32_type, 151 NULL, 152 }, 153 { 154 NGM_ONE2MANY_COOKIE, 155 NGM_ONE2MANY_GETCLR_STATS, 156 "getclrstats", 157 &ng_parse_int32_type, 158 &ng_one2many_link_stats_type 159 }, 160 { 0 } 161 }; 162 163 /* Node type descriptor */ 164 static struct ng_type ng_one2many_typestruct = { 165 NG_ABI_VERSION, 166 NG_ONE2MANY_NODE_TYPE, 167 NULL, 168 ng_one2many_constructor, 169 ng_one2many_rcvmsg, 170 ng_one2many_shutdown, 171 ng_one2many_newhook, 172 NULL, 173 NULL, 174 ng_one2many_rcvdata, 175 ng_one2many_disconnect, 176 ng_one2many_cmdlist, 177 }; 178 NETGRAPH_INIT(one2many, &ng_one2many_typestruct); 179 180 /****************************************************************** 181 NETGRAPH NODE METHODS 182 ******************************************************************/ 183 184 /* 185 * Node constructor 186 */ 187 static int 188 ng_one2many_constructor(node_p node) 189 { 190 priv_p priv; 191 192 /* Allocate and initialize private info */ 193 MALLOC(priv, priv_p, sizeof(*priv), M_NETGRAPH, M_NOWAIT | M_ZERO); 194 if (priv == NULL) 195 return (ENOMEM); 196 priv->conf.xmitAlg = NG_ONE2MANY_XMIT_ROUNDROBIN; 197 priv->conf.failAlg = NG_ONE2MANY_FAIL_MANUAL; 198 199 node->private = priv; 200 201 /* Done */ 202 return (0); 203 } 204 205 /* 206 * Method for attaching a new hook 207 */ 208 static int 209 ng_one2many_newhook(node_p node, hook_p hook, const char *name) 210 { 211 const priv_p priv = node->private; 212 struct ng_one2many_link *link; 213 int linkNum; 214 u_long i; 215 216 /* Which hook? */ 217 if (strncmp(name, NG_ONE2MANY_HOOK_MANY_PREFIX, 218 strlen(NG_ONE2MANY_HOOK_MANY_PREFIX)) == 0) { 219 const char *cp; 220 char *eptr; 221 222 cp = name + strlen(NG_ONE2MANY_HOOK_MANY_PREFIX); 223 if (!isdigit(*cp) || (cp[0] == '0' && cp[1] != '\0')) 224 return (EINVAL); 225 i = strtoul(cp, &eptr, 10); 226 if (*eptr != '\0' || i < 0 || i >= NG_ONE2MANY_MAX_LINKS) 227 return (EINVAL); 228 linkNum = (int)i; 229 link = &priv->many[linkNum]; 230 } else if (strcmp(name, NG_ONE2MANY_HOOK_ONE) == 0) { 231 linkNum = NG_ONE2MANY_ONE_LINKNUM; 232 link = &priv->one; 233 } else 234 return (EINVAL); 235 236 /* Is hook already connected? (should never happen) */ 237 if (link->hook != NULL) 238 return (EISCONN); 239 240 /* Setup private info for this link */ 241 LINK_NUM(hook) = linkNum; 242 link->hook = hook; 243 bzero(&link->stats, sizeof(link->stats)); 244 if (linkNum != NG_ONE2MANY_ONE_LINKNUM) { 245 priv->conf.enabledLinks[linkNum] = 1; /* auto-enable link */ 246 ng_one2many_update_many(priv); 247 } 248 249 /* Done */ 250 return (0); 251 } 252 253 /* 254 * Receive a control message 255 */ 256 static int 257 ng_one2many_rcvmsg(node_p node, item_p item, hook_p lasthook) 258 { 259 const priv_p priv = node->private; 260 struct ng_mesg *resp = NULL; 261 int error = 0; 262 struct ng_mesg *msg; 263 264 NGI_GET_MSG(item, msg); 265 switch (msg->header.typecookie) { 266 case NGM_ONE2MANY_COOKIE: 267 switch (msg->header.cmd) { 268 case NGM_ONE2MANY_SET_CONFIG: 269 { 270 struct ng_one2many_config *conf; 271 int i; 272 273 /* Check that new configuration is valid */ 274 if (msg->header.arglen != sizeof(*conf)) { 275 error = EINVAL; 276 break; 277 } 278 conf = (struct ng_one2many_config *)msg->data; 279 switch (conf->xmitAlg) { 280 case NG_ONE2MANY_XMIT_ROUNDROBIN: 281 break; 282 default: 283 error = EINVAL; 284 break; 285 } 286 switch (conf->failAlg) { 287 case NG_ONE2MANY_FAIL_MANUAL: 288 break; 289 default: 290 error = EINVAL; 291 break; 292 } 293 if (error != 0) 294 break; 295 296 /* Normalized many link enabled bits */ 297 for (i = 0; i < NG_ONE2MANY_MAX_LINKS; i++) 298 conf->enabledLinks[i] = !!conf->enabledLinks[i]; 299 300 /* Copy config and reset */ 301 bcopy(conf, &priv->conf, sizeof(*conf)); 302 ng_one2many_update_many(priv); 303 break; 304 } 305 case NGM_ONE2MANY_GET_CONFIG: 306 { 307 struct ng_one2many_config *conf; 308 309 NG_MKRESPONSE(resp, msg, sizeof(*conf), M_NOWAIT); 310 if (resp == NULL) { 311 error = ENOMEM; 312 break; 313 } 314 conf = (struct ng_one2many_config *)resp->data; 315 bcopy(&priv->conf, conf, sizeof(priv->conf)); 316 break; 317 } 318 case NGM_ONE2MANY_GET_STATS: 319 case NGM_ONE2MANY_CLR_STATS: 320 case NGM_ONE2MANY_GETCLR_STATS: 321 { 322 struct ng_one2many_link *link; 323 int linkNum; 324 325 /* Get link */ 326 if (msg->header.arglen != sizeof(int32_t)) { 327 error = EINVAL; 328 break; 329 } 330 linkNum = *((int32_t *)msg->data); 331 if (linkNum == NG_ONE2MANY_ONE_LINKNUM) 332 link = &priv->one; 333 else if (linkNum == 0 334 && linkNum < NG_ONE2MANY_MAX_LINKS) { 335 link = &priv->many[linkNum]; 336 } else { 337 error = EINVAL; 338 break; 339 } 340 341 /* Get/clear stats */ 342 if (msg->header.cmd != NGM_ONE2MANY_CLR_STATS) { 343 NG_MKRESPONSE(resp, msg, 344 sizeof(link->stats), M_NOWAIT); 345 if (resp == NULL) { 346 error = ENOMEM; 347 break; 348 } 349 bcopy(&link->stats, 350 resp->data, sizeof(link->stats)); 351 } 352 if (msg->header.cmd != NGM_ONE2MANY_GET_STATS) 353 bzero(&link->stats, sizeof(link->stats)); 354 break; 355 } 356 default: 357 error = EINVAL; 358 break; 359 } 360 break; 361 default: 362 error = EINVAL; 363 break; 364 } 365 366 /* Done */ 367 NG_RESPOND_MSG(error, node, item, resp); 368 NG_FREE_MSG(msg); 369 return (error); 370 } 371 372 /* 373 * Receive data on a hook 374 */ 375 static int 376 ng_one2many_rcvdata(hook_p hook, item_p item) 377 { 378 const node_p node = hook->node; 379 const priv_p priv = node->private; 380 struct ng_one2many_link *src; 381 struct ng_one2many_link *dst; 382 int error = 0; 383 int linkNum; 384 struct mbuf *m; 385 386 m = NGI_M(item); /* just peaking, mbuf still owned by item */ 387 /* Get link number */ 388 linkNum = LINK_NUM(hook); 389 KASSERT(linkNum == NG_ONE2MANY_ONE_LINKNUM 390 || (linkNum >= 0 && linkNum < NG_ONE2MANY_MAX_LINKS), 391 ("%s: linkNum=%d", __FUNCTION__, linkNum)); 392 393 /* Figure out source link */ 394 src = (linkNum == NG_ONE2MANY_ONE_LINKNUM) ? 395 &priv->one : &priv->many[linkNum]; 396 KASSERT(src->hook != NULL, ("%s: no src%d", __FUNCTION__, linkNum)); 397 398 /* Update receive stats */ 399 src->stats.recvPackets++; 400 src->stats.recvOctets += m->m_pkthdr.len; 401 402 /* Figure out destination link */ 403 if (linkNum == NG_ONE2MANY_ONE_LINKNUM) { 404 if (priv->numActiveMany == 0) { 405 NG_FREE_ITEM(item); 406 return (ENOTCONN); 407 } 408 dst = &priv->many[priv->activeMany[priv->nextMany]]; 409 priv->nextMany = (priv->nextMany + 1) % priv->numActiveMany; 410 } else 411 dst = &priv->one; 412 413 /* Update transmit stats */ 414 dst->stats.xmitPackets++; 415 dst->stats.xmitOctets += m->m_pkthdr.len; 416 417 /* Deliver packet */ 418 NG_FWD_DATA(error, item, dst->hook); 419 return (error); 420 } 421 422 /* 423 * Shutdown node 424 */ 425 static int 426 ng_one2many_shutdown(node_p node) 427 { 428 const priv_p priv = node->private; 429 430 KASSERT(priv->numActiveMany == 0, 431 ("%s: numActiveMany=%d", __FUNCTION__, priv->numActiveMany)); 432 FREE(priv, M_NETGRAPH); 433 node->private = NULL; 434 ng_unref(node); 435 return (0); 436 } 437 438 /* 439 * Hook disconnection. 440 */ 441 static int 442 ng_one2many_disconnect(hook_p hook) 443 { 444 const priv_p priv = hook->node->private; 445 int linkNum; 446 447 /* Get link number */ 448 linkNum = LINK_NUM(hook); 449 KASSERT(linkNum == NG_ONE2MANY_ONE_LINKNUM 450 || (linkNum >= 0 && linkNum < NG_ONE2MANY_MAX_LINKS), 451 ("%s: linkNum=%d", __FUNCTION__, linkNum)); 452 453 /* Nuke the link */ 454 if (linkNum == NG_ONE2MANY_ONE_LINKNUM) 455 priv->one.hook = NULL; 456 else { 457 priv->many[linkNum].hook = NULL; 458 priv->conf.enabledLinks[linkNum] = 0; 459 ng_one2many_update_many(priv); 460 } 461 462 /* If no hooks left, go away */ 463 if ((hook->node->numhooks == 0) 464 && ((hook->node->flags & NG_INVALID) == 0)) 465 ng_rmnode_self(hook->node); 466 return (0); 467 } 468 469 /****************************************************************** 470 OTHER FUNCTIONS 471 ******************************************************************/ 472 473 /* 474 * Update internal state after the addition or removal of a "many" link 475 */ 476 static void 477 ng_one2many_update_many(priv_p priv) 478 { 479 int linkNum; 480 481 /* Update list of which "many" links are up */ 482 priv->numActiveMany = 0; 483 for (linkNum = 0; linkNum < NG_ONE2MANY_MAX_LINKS; linkNum++) { 484 switch (priv->conf.failAlg) { 485 case NG_ONE2MANY_FAIL_MANUAL: 486 if (priv->many[linkNum].hook != NULL 487 && priv->conf.enabledLinks[linkNum]) { 488 priv->activeMany[priv->numActiveMany] = linkNum; 489 priv->numActiveMany++; 490 } 491 break; 492 #ifdef INVARIANTS 493 default: 494 panic("%s: invalid failAlg", __FUNCTION__); 495 #endif 496 } 497 } 498 499 /* Update transmit algorithm state */ 500 switch (priv->conf.xmitAlg) { 501 case NG_ONE2MANY_XMIT_ROUNDROBIN: 502 if (priv->numActiveMany > 0) 503 priv->nextMany %= priv->numActiveMany; 504 break; 505 #ifdef INVARIANTS 506 default: 507 panic("%s: invalid xmitAlg", __FUNCTION__); 508 #endif 509 } 510 } 511 512 513