2 * Copyright (c) 2005 Nuno Antunes <nuno.antunes@gmail.com>
3 * Copyright (c) 2007 Alexander Motin <mav@freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * ng_car - An implementation of commited access rate for netgraph
34 * - Sanitize input config values (impose some limits)
35 * - Implement internal packet painting (possibly using mbuf tags)
36 * - Implement color-aware mode
37 * - Implement DSCP marking for IPv4
40 #include <sys/param.h>
41 #include <sys/errno.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
46 #include <netgraph/ng_message.h>
47 #include <netgraph/ng_parse.h>
48 #include <netgraph/netgraph.h>
49 #include <netgraph/ng_car.h>
51 #define NG_CAR_QUEUE_SIZE 100 /* Maximum queue size for SHAPE mode */
52 #define NG_CAR_QUEUE_MIN_TH 8 /* Minimum RED threshhold for SHAPE mode */
54 /* Hook private info */
56 hook_p hook; /* this (source) hook */
57 hook_p dest; /* destination hook */
59 int64_t tc; /* commited token bucket counter */
60 int64_t te; /* exceeded/peak token bucket counter */
61 struct bintime lastRefill; /* last token refill time */
63 struct ng_car_hookconf conf; /* hook configuration */
64 struct ng_car_hookstats stats; /* hook stats */
66 struct mbuf *q[NG_CAR_QUEUE_SIZE]; /* circular packet queue */
67 u_int q_first; /* first queue element */
68 u_int q_last; /* last queue element */
69 struct callout q_callout; /* periodic queue processing routine */
70 struct mtx q_mtx; /* queue mutex */
73 /* Private information for each node instance */
75 node_p node; /* the node itself */
76 struct hookinfo upper; /* hook to upper layers */
77 struct hookinfo lower; /* hook to lower layers */
79 typedef struct privdata *priv_p;
81 static ng_constructor_t ng_car_constructor;
82 static ng_rcvmsg_t ng_car_rcvmsg;
83 static ng_shutdown_t ng_car_shutdown;
84 static ng_newhook_t ng_car_newhook;
85 static ng_rcvdata_t ng_car_rcvdata;
86 static ng_disconnect_t ng_car_disconnect;
88 static void ng_car_refillhook(struct hookinfo *h);
89 static void ng_car_schedule(struct hookinfo *h);
90 void ng_car_q_event(node_p node, hook_p hook, void *arg, int arg2);
91 static void ng_car_enqueue(struct hookinfo *h, item_p item);
93 /* Parse type for struct ng_car_hookstats */
94 static const struct ng_parse_struct_field ng_car_hookstats_type_fields[]
96 static const struct ng_parse_type ng_car_hookstats_type = {
97 &ng_parse_struct_type,
98 &ng_car_hookstats_type_fields
101 /* Parse type for struct ng_car_bulkstats */
102 static const struct ng_parse_struct_field ng_car_bulkstats_type_fields[]
103 = NG_CAR_BULKSTATS(&ng_car_hookstats_type);
104 static const struct ng_parse_type ng_car_bulkstats_type = {
105 &ng_parse_struct_type,
106 &ng_car_bulkstats_type_fields
109 /* Parse type for struct ng_car_hookconf */
110 static const struct ng_parse_struct_field ng_car_hookconf_type_fields[]
112 static const struct ng_parse_type ng_car_hookconf_type = {
113 &ng_parse_struct_type,
114 &ng_car_hookconf_type_fields
117 /* Parse type for struct ng_car_bulkconf */
118 static const struct ng_parse_struct_field ng_car_bulkconf_type_fields[]
119 = NG_CAR_BULKCONF(&ng_car_hookconf_type);
120 static const struct ng_parse_type ng_car_bulkconf_type = {
121 &ng_parse_struct_type,
122 &ng_car_bulkconf_type_fields
126 static struct ng_cmdlist ng_car_cmdlist[] = {
132 &ng_car_bulkstats_type,
143 NGM_CAR_GETCLR_STATS,
146 &ng_car_bulkstats_type,
154 &ng_car_bulkconf_type,
160 &ng_car_bulkconf_type,
166 /* Netgraph node type descriptor */
167 static struct ng_type ng_car_typestruct = {
168 .version = NG_ABI_VERSION,
169 .name = NG_CAR_NODE_TYPE,
170 .constructor = ng_car_constructor,
171 .rcvmsg = ng_car_rcvmsg,
172 .shutdown = ng_car_shutdown,
173 .newhook = ng_car_newhook,
174 .rcvdata = ng_car_rcvdata,
175 .disconnect = ng_car_disconnect,
176 .cmdlist = ng_car_cmdlist,
178 NETGRAPH_INIT(car, &ng_car_typestruct);
184 ng_car_constructor(node_p node)
188 /* Initialize private descriptor. */
189 priv = malloc(sizeof(*priv), M_NETGRAPH, M_WAITOK | M_ZERO);
191 NG_NODE_SET_PRIVATE(node, priv);
195 * Arbitrary default values
198 priv->upper.hook = NULL;
199 priv->upper.dest = NULL;
200 priv->upper.tc = priv->upper.conf.cbs = NG_CAR_CBS_MIN;
201 priv->upper.te = priv->upper.conf.ebs = NG_CAR_EBS_MIN;
202 priv->upper.conf.cir = NG_CAR_CIR_DFLT;
203 priv->upper.conf.green_action = NG_CAR_ACTION_FORWARD;
204 priv->upper.conf.yellow_action = NG_CAR_ACTION_FORWARD;
205 priv->upper.conf.red_action = NG_CAR_ACTION_DROP;
206 priv->upper.conf.mode = 0;
207 getbinuptime(&priv->upper.lastRefill);
208 priv->upper.q_first = 0;
209 priv->upper.q_last = 0;
210 ng_callout_init(&priv->upper.q_callout);
211 mtx_init(&priv->upper.q_mtx, "ng_car_u", NULL, MTX_DEF);
213 priv->lower.hook = NULL;
214 priv->lower.dest = NULL;
215 priv->lower.tc = priv->lower.conf.cbs = NG_CAR_CBS_MIN;
216 priv->lower.te = priv->lower.conf.ebs = NG_CAR_EBS_MIN;
217 priv->lower.conf.cir = NG_CAR_CIR_DFLT;
218 priv->lower.conf.green_action = NG_CAR_ACTION_FORWARD;
219 priv->lower.conf.yellow_action = NG_CAR_ACTION_FORWARD;
220 priv->lower.conf.red_action = NG_CAR_ACTION_DROP;
221 priv->lower.conf.mode = 0;
222 priv->lower.lastRefill = priv->upper.lastRefill;
223 priv->lower.q_first = 0;
224 priv->lower.q_last = 0;
225 ng_callout_init(&priv->lower.q_callout);
226 mtx_init(&priv->lower.q_mtx, "ng_car_l", NULL, MTX_DEF);
235 ng_car_newhook(node_p node, hook_p hook, const char *name)
237 const priv_p priv = NG_NODE_PRIVATE(node);
239 if (strcmp(name, NG_CAR_HOOK_LOWER) == 0) {
240 priv->lower.hook = hook;
241 priv->upper.dest = hook;
242 bzero(&priv->lower.stats, sizeof(priv->lower.stats));
243 NG_HOOK_SET_PRIVATE(hook, &priv->lower);
244 } else if (strcmp(name, NG_CAR_HOOK_UPPER) == 0) {
245 priv->upper.hook = hook;
246 priv->lower.dest = hook;
247 bzero(&priv->upper.stats, sizeof(priv->upper.stats));
248 NG_HOOK_SET_PRIVATE(hook, &priv->upper);
258 ng_car_rcvdata(hook_p hook, item_p item )
260 struct hookinfo *const hinfo = NG_HOOK_PRIVATE(hook);
265 /* If queue is not empty now then enqueue packet. */
266 if (hinfo->q_first != hinfo->q_last) {
267 ng_car_enqueue(hinfo, item);
273 #define NG_CAR_PERFORM_MATCH_ACTION(a) \
276 case NG_CAR_ACTION_FORWARD: \
279 case NG_CAR_ACTION_MARK: \
280 /* XXX find a way to mark packets (mbuf tag?) */ \
281 ++hinfo->stats.errors; \
283 case NG_CAR_ACTION_DROP: \
285 /* Drop packet and return. */ \
286 NG_FREE_ITEM(item); \
287 ++hinfo->stats.droped_pkts; \
292 /* Packet is counted as 128 tokens for better resolution */
293 if (hinfo->conf.opt & NG_CAR_COUNT_PACKETS) {
296 len = m->m_pkthdr.len;
299 /* Check commited token bucket. */
300 if (hinfo->tc - len >= 0) {
301 /* This packet is green. */
302 ++hinfo->stats.green_pkts;
304 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.green_action);
307 /* Refill only if not green without it. */
308 ng_car_refillhook(hinfo);
310 /* Check commited token bucket again after refill. */
311 if (hinfo->tc - len >= 0) {
312 /* This packet is green */
313 ++hinfo->stats.green_pkts;
315 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.green_action);
317 /* If not green and mode is SHAPE, enqueue packet. */
318 } else if (hinfo->conf.mode == NG_CAR_SHAPE) {
319 ng_car_enqueue(hinfo, item);
322 /* If not green and mode is RED, calculate probability. */
323 } else if (hinfo->conf.mode == NG_CAR_RED) {
324 /* Is packet is bigger then extended burst? */
325 if (len - (hinfo->tc - len) > hinfo->conf.ebs) {
326 /* This packet is definitely red. */
327 ++hinfo->stats.red_pkts;
329 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.red_action);
331 /* Use token bucket to simulate RED-like drop
333 } else if (hinfo->te + (len - hinfo->tc) <
335 /* This packet is yellow */
336 ++hinfo->stats.yellow_pkts;
337 hinfo->te += len - hinfo->tc;
338 /* Go to negative tokens. */
340 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.yellow_action);
342 /* This packet is probaly red. */
343 ++hinfo->stats.red_pkts;
345 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.red_action);
347 /* If not green and mode is SINGLE/DOUBLE RATE. */
349 /* Check extended token bucket. */
350 if (hinfo->te - len >= 0) {
351 /* This packet is yellow */
352 ++hinfo->stats.yellow_pkts;
354 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.yellow_action);
356 /* This packet is red */
357 ++hinfo->stats.red_pkts;
358 NG_CAR_PERFORM_MATCH_ACTION(hinfo->conf.red_action);
363 #undef NG_CAR_PERFORM_MATCH_ACTION
365 NG_FWD_ITEM_HOOK(error, item, hinfo->dest);
367 ++hinfo->stats.errors;
368 ++hinfo->stats.passed_pkts;
374 * Receive a control message.
377 ng_car_rcvmsg(node_p node, item_p item, hook_p lasthook)
379 const priv_p priv = NG_NODE_PRIVATE(node);
380 struct ng_mesg *resp = NULL;
384 NGI_GET_MSG(item, msg);
385 switch (msg->header.typecookie) {
387 switch (msg->header.cmd) {
388 case NGM_CAR_GET_STATS:
389 case NGM_CAR_GETCLR_STATS:
391 struct ng_car_bulkstats *bstats;
393 NG_MKRESPONSE(resp, msg,
394 sizeof(*bstats), M_NOWAIT);
399 bstats = (struct ng_car_bulkstats *)resp->data;
401 bcopy(&priv->upper.stats, &bstats->downstream,
402 sizeof(bstats->downstream));
403 bcopy(&priv->lower.stats, &bstats->upstream,
404 sizeof(bstats->upstream));
406 if (msg->header.cmd == NGM_CAR_GET_STATS)
408 case NGM_CAR_CLR_STATS:
409 bzero(&priv->upper.stats,
410 sizeof(priv->upper.stats));
411 bzero(&priv->lower.stats,
412 sizeof(priv->lower.stats));
414 case NGM_CAR_GET_CONF:
416 struct ng_car_bulkconf *bconf;
418 NG_MKRESPONSE(resp, msg,
419 sizeof(*bconf), M_NOWAIT);
424 bconf = (struct ng_car_bulkconf *)resp->data;
426 bcopy(&priv->upper.conf, &bconf->downstream,
427 sizeof(bconf->downstream));
428 bcopy(&priv->lower.conf, &bconf->upstream,
429 sizeof(bconf->upstream));
430 /* Convert internal 1/(8*128) of pps into pps */
431 if (bconf->downstream.opt & NG_CAR_COUNT_PACKETS) {
432 bconf->downstream.cir /= 1024;
433 bconf->downstream.pir /= 1024;
434 bconf->downstream.cbs /= 128;
435 bconf->downstream.ebs /= 128;
437 if (bconf->upstream.opt & NG_CAR_COUNT_PACKETS) {
438 bconf->upstream.cir /= 1024;
439 bconf->upstream.pir /= 1024;
440 bconf->upstream.cbs /= 128;
441 bconf->upstream.ebs /= 128;
445 case NGM_CAR_SET_CONF:
447 struct ng_car_bulkconf *const bconf =
448 (struct ng_car_bulkconf *)msg->data;
450 /* Check for invalid or illegal config. */
451 if (msg->header.arglen != sizeof(*bconf)) {
455 /* Convert pps into internal 1/(8*128) of pps */
456 if (bconf->downstream.opt & NG_CAR_COUNT_PACKETS) {
457 bconf->downstream.cir *= 1024;
458 bconf->downstream.pir *= 1024;
459 bconf->downstream.cbs *= 125;
460 bconf->downstream.ebs *= 125;
462 if (bconf->upstream.opt & NG_CAR_COUNT_PACKETS) {
463 bconf->upstream.cir *= 1024;
464 bconf->upstream.pir *= 1024;
465 bconf->upstream.cbs *= 125;
466 bconf->upstream.ebs *= 125;
468 if ((bconf->downstream.cir > 1000000000) ||
469 (bconf->downstream.pir > 1000000000) ||
470 (bconf->upstream.cir > 1000000000) ||
471 (bconf->upstream.pir > 1000000000) ||
472 (bconf->downstream.cbs == 0 &&
473 bconf->downstream.ebs == 0) ||
474 (bconf->upstream.cbs == 0 &&
475 bconf->upstream.ebs == 0))
480 if ((bconf->upstream.mode == NG_CAR_SHAPE) &&
481 (bconf->upstream.cir == 0)) {
485 if ((bconf->downstream.mode == NG_CAR_SHAPE) &&
486 (bconf->downstream.cir == 0)) {
491 /* Copy downstream config. */
492 bcopy(&bconf->downstream, &priv->upper.conf,
493 sizeof(priv->upper.conf));
494 priv->upper.tc = priv->upper.conf.cbs;
495 if (priv->upper.conf.mode == NG_CAR_RED ||
496 priv->upper.conf.mode == NG_CAR_SHAPE) {
499 priv->upper.te = priv->upper.conf.ebs;
502 /* Copy upstream config. */
503 bcopy(&bconf->upstream, &priv->lower.conf,
504 sizeof(priv->lower.conf));
505 priv->lower.tc = priv->lower.conf.cbs;
506 if (priv->lower.conf.mode == NG_CAR_RED ||
507 priv->lower.conf.mode == NG_CAR_SHAPE) {
510 priv->lower.te = priv->lower.conf.ebs;
523 NG_RESPOND_MSG(error, node, item, resp);
529 * Do local shutdown processing.
532 ng_car_shutdown(node_p node)
534 const priv_p priv = NG_NODE_PRIVATE(node);
536 ng_uncallout(&priv->upper.q_callout, node);
537 ng_uncallout(&priv->lower.q_callout, node);
538 mtx_destroy(&priv->upper.q_mtx);
539 mtx_destroy(&priv->lower.q_mtx);
540 NG_NODE_UNREF(priv->node);
541 free(priv, M_NETGRAPH);
546 * Hook disconnection.
548 * For this type, removal of the last link destroys the node.
551 ng_car_disconnect(hook_p hook)
553 struct hookinfo *const hinfo = NG_HOOK_PRIVATE(hook);
554 const node_p node = NG_HOOK_NODE(hook);
555 const priv_p priv = NG_NODE_PRIVATE(node);
558 /* Purge queue if not empty. */
559 while (hinfo->q_first != hinfo->q_last) {
560 NG_FREE_M(hinfo->q[hinfo->q_first]);
562 if (hinfo->q_first >= NG_CAR_QUEUE_SIZE)
565 /* Remove hook refs. */
566 if (hinfo->hook == priv->upper.hook)
567 priv->lower.dest = NULL;
569 priv->upper.dest = NULL;
572 /* Already shutting down? */
573 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
574 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook))))
575 ng_rmnode_self(NG_HOOK_NODE(hook));
580 * Hook's token buckets refillment.
583 ng_car_refillhook(struct hookinfo *h)
585 struct bintime newt, deltat;
586 unsigned int deltat_us;
588 /* Get current time. */
591 /* Get time delta since last refill. */
593 bintime_sub(&deltat, &h->lastRefill);
595 /* Time must go forward. */
596 if (deltat.sec < 0) {
597 h->lastRefill = newt;
601 /* But not too far forward. */
602 if (deltat.sec >= 1000) {
603 deltat_us = (1000 << 20);
605 /* convert bintime to the 1/(2^20) of sec */
606 deltat_us = (deltat.sec << 20) + (deltat.frac >> 44);
609 if (h->conf.mode == NG_CAR_SINGLE_RATE) {
611 /* Refill commited token bucket. */
612 h->tc += (h->conf.cir * deltat_us) >> 23;
613 delta = h->tc - h->conf.cbs;
617 /* Refill exceeded token bucket. */
619 if (h->te > ((int64_t)h->conf.ebs))
623 } else if (h->conf.mode == NG_CAR_DOUBLE_RATE) {
624 /* Refill commited token bucket. */
625 h->tc += (h->conf.cir * deltat_us) >> 23;
626 if (h->tc > ((int64_t)h->conf.cbs))
629 /* Refill peak token bucket. */
630 h->te += (h->conf.pir * deltat_us) >> 23;
631 if (h->te > ((int64_t)h->conf.ebs))
634 } else { /* RED or SHAPE mode. */
635 /* Refill commited token bucket. */
636 h->tc += (h->conf.cir * deltat_us) >> 23;
637 if (h->tc > ((int64_t)h->conf.cbs))
641 /* Remember this moment. */
642 h->lastRefill = newt;
646 * Schedule callout when we will have required tokens.
649 ng_car_schedule(struct hookinfo *hinfo)
653 delay = (-(hinfo->tc)) * hz * 8 / hinfo->conf.cir + 1;
655 ng_callout(&hinfo->q_callout, NG_HOOK_NODE(hinfo->hook), hinfo->hook,
656 delay, &ng_car_q_event, NULL, 0);
660 * Queue processing callout handler.
663 ng_car_q_event(node_p node, hook_p hook, void *arg, int arg2)
665 struct hookinfo *hinfo = NG_HOOK_PRIVATE(hook);
669 /* Refill tokens for time we have slept. */
670 ng_car_refillhook(hinfo);
672 /* If we have some tokens */
673 while (hinfo->tc >= 0) {
676 m = hinfo->q[hinfo->q_first];
677 NG_SEND_DATA_ONLY(error, hinfo->dest, m);
679 ++hinfo->stats.errors;
680 ++hinfo->stats.passed_pkts;
684 if (hinfo->q_first >= NG_CAR_QUEUE_SIZE)
687 /* Stop if none left. */
688 if (hinfo->q_first == hinfo->q_last)
691 /* If we have more packet, try it. */
692 m = hinfo->q[hinfo->q_first];
693 if (hinfo->conf.opt & NG_CAR_COUNT_PACKETS) {
696 hinfo->tc -= m->m_pkthdr.len;
700 /* If something left */
701 if (hinfo->q_first != hinfo->q_last)
702 /* Schedule queue processing. */
703 ng_car_schedule(hinfo);
710 ng_car_enqueue(struct hookinfo *hinfo, item_p item)
718 /* Lock queue mutex. */
719 mtx_lock(&hinfo->q_mtx);
721 /* Calculate used queue length. */
722 len = hinfo->q_last - hinfo->q_first;
724 len += NG_CAR_QUEUE_SIZE;
726 /* If queue is overflowed or we have no RED tokens. */
727 if ((len >= (NG_CAR_QUEUE_SIZE - 1)) ||
728 (hinfo->te + len >= NG_CAR_QUEUE_SIZE)) {
730 ++hinfo->stats.red_pkts;
731 ++hinfo->stats.droped_pkts;
736 /* This packet is yellow. */
737 ++hinfo->stats.yellow_pkts;
739 /* Enqueue packet. */
740 hinfo->q[hinfo->q_last] = m;
742 if (hinfo->q_last >= NG_CAR_QUEUE_SIZE)
745 /* Use RED tokens. */
746 if (len > NG_CAR_QUEUE_MIN_TH)
747 hinfo->te += len - NG_CAR_QUEUE_MIN_TH;
749 /* If this is a first packet in the queue. */
751 if (hinfo->conf.opt & NG_CAR_COUNT_PACKETS) {
754 hinfo->tc -= m->m_pkthdr.len;
757 /* Schedule queue processing. */
758 ng_car_schedule(hinfo);
762 /* Unlock queue mutex. */
763 mtx_unlock(&hinfo->q_mtx);