2 * Copyright (c) 1998-2002 Luigi Rizzo, Universita` di Pisa
3 * Portions Copyright (c) 2000 Akamba Corp.
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 THE 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 THE 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
27 * $FreeBSD: src/sys/netinet/ip_dummynet.c,v 1.24.2.22 2003/05/13 09:31:06 maxim Exp $
28 * $DragonFly: src/sys/net/dummynet/ip_dummynet.c,v 1.6 2004/03/06 01:58:55 hsu Exp $
31 #if !defined(KLD_MODULE)
32 #include "opt_ipfw.h" /* for IPFW2 definition */
39 * This module implements IP dummynet, a bandwidth limiter/delay emulator
40 * used in conjunction with the ipfw package.
41 * Description of the data structures used is in ip_dummynet.h
42 * Here you mainly find the following blocks of code:
43 * + variable declarations;
44 * + heap management functions;
45 * + scheduler and dummynet functions;
46 * + configuration and initialization.
48 * NOTA BENE: critical sections are protected by splimp()/splx()
49 * pairs. One would think that splnet() is enough as for most of
50 * the netinet code, but it is not so because when used with
51 * bridging, dummynet is invoked at splimp().
53 * Most important Changes:
56 * 010124: Fixed WF2Q behaviour
57 * 010122: Fixed spl protection.
58 * 000601: WF2Q support
59 * 000106: large rewrite, use heaps to handle very many pipes.
60 * 980513: initial release
62 * include files marked with XXX are probably not needed
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/malloc.h>
69 #include <sys/kernel.h>
70 #include <sys/module.h>
72 #include <sys/socket.h>
73 #include <sys/socketvar.h>
75 #include <sys/sysctl.h>
77 #include <net/route.h>
78 #include <netinet/in.h>
79 #include <netinet/in_systm.h>
80 #include <netinet/in_var.h>
81 #include <netinet/ip.h>
82 #include <net/ipfw/ip_fw.h>
83 #include <net/netisr.h>
84 #include "ip_dummynet.h"
85 #include <netinet/ip_var.h>
87 #include <netinet/if_ether.h> /* for struct arpcom */
88 #include <net/bridge/bridge.h>
91 * We keep a private variable for the simulation time, but we could
92 * probably use an existing one ("softticks" in sys/kern/kern_timer.c)
94 static dn_key curr_time = 0 ; /* current simulation time */
96 static int dn_hash_size = 64 ; /* default hash size */
98 /* statistics on number of queue searches and search steps */
99 static int searches, search_steps ;
100 static int pipe_expire = 1 ; /* expire queue if empty */
101 static int dn_max_ratio = 16 ; /* max queues/buckets ratio */
103 static int red_lookup_depth = 256; /* RED - default lookup table depth */
104 static int red_avg_pkt_size = 512; /* RED - default medium packet size */
105 static int red_max_pkt_size = 1500; /* RED - default max packet size */
108 * Three heaps contain queues and pipes that the scheduler handles:
110 * ready_heap contains all dn_flow_queue related to fixed-rate pipes.
112 * wfq_ready_heap contains the pipes associated with WF2Q flows
114 * extract_heap contains pipes associated with delay lines.
118 MALLOC_DEFINE(M_DUMMYNET, "dummynet", "dummynet heap");
120 static struct dn_heap ready_heap, extract_heap, wfq_ready_heap ;
122 static int heap_init(struct dn_heap *h, int size) ;
123 static int heap_insert (struct dn_heap *h, dn_key key1, void *p);
124 static void heap_extract(struct dn_heap *h, void *obj);
126 static void transmit_event(struct dn_pipe *pipe);
127 static void ready_event(struct dn_flow_queue *q);
129 static struct dn_pipe *all_pipes = NULL ; /* list of all pipes */
130 static struct dn_flow_set *all_flow_sets = NULL ;/* list of all flow_sets */
132 static struct callout_handle dn_timeout;
135 SYSCTL_NODE(_net_inet_ip, OID_AUTO, dummynet,
136 CTLFLAG_RW, 0, "Dummynet");
137 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, hash_size,
138 CTLFLAG_RW, &dn_hash_size, 0, "Default hash table size");
139 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, curr_time,
140 CTLFLAG_RD, &curr_time, 0, "Current tick");
141 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, ready_heap,
142 CTLFLAG_RD, &ready_heap.size, 0, "Size of ready heap");
143 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, extract_heap,
144 CTLFLAG_RD, &extract_heap.size, 0, "Size of extract heap");
145 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, searches,
146 CTLFLAG_RD, &searches, 0, "Number of queue searches");
147 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, search_steps,
148 CTLFLAG_RD, &search_steps, 0, "Number of queue search steps");
149 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, expire,
150 CTLFLAG_RW, &pipe_expire, 0, "Expire queue if empty");
151 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, max_chain_len,
152 CTLFLAG_RW, &dn_max_ratio, 0,
153 "Max ratio between dynamic queues and buckets");
154 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_lookup_depth,
155 CTLFLAG_RD, &red_lookup_depth, 0, "Depth of RED lookup table");
156 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_avg_pkt_size,
157 CTLFLAG_RD, &red_avg_pkt_size, 0, "RED Medium packet size");
158 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_max_pkt_size,
159 CTLFLAG_RD, &red_max_pkt_size, 0, "RED Max packet size");
162 static int config_pipe(struct dn_pipe *p);
163 static int ip_dn_ctl(struct sockopt *sopt);
165 static void rt_unref(struct rtentry *);
166 static void dummynet(void *);
167 static void dummynet_flush(void);
168 void dummynet_drain(void);
169 static ip_dn_io_t dummynet_io;
170 static void dn_rule_delete(void *);
172 int if_tx_rdy(struct ifnet *ifp);
175 rt_unref(struct rtentry *rt)
179 if (rt->rt_refcnt <= 0)
180 printf("-- warning, refcnt now %ld, decreasing\n", rt->rt_refcnt);
185 * Heap management functions.
187 * In the heap, first node is element 0. Children of i are 2i+1 and 2i+2.
188 * Some macros help finding parent/children so we can optimize them.
190 * heap_init() is called to expand the heap when needed.
191 * Increment size in blocks of 16 entries.
192 * XXX failure to allocate a new element is a pretty bad failure
193 * as we basically stall a whole queue forever!!
194 * Returns 1 on error, 0 on success
196 #define HEAP_FATHER(x) ( ( (x) - 1 ) / 2 )
197 #define HEAP_LEFT(x) ( 2*(x) + 1 )
198 #define HEAP_IS_LEFT(x) ( (x) & 1 )
199 #define HEAP_RIGHT(x) ( 2*(x) + 2 )
200 #define HEAP_SWAP(a, b, buffer) { buffer = a ; a = b ; b = buffer ; }
201 #define HEAP_INCREMENT 15
204 heap_init(struct dn_heap *h, int new_size)
206 struct dn_heap_entry *p;
208 if (h->size >= new_size ) {
209 printf("heap_init, Bogus call, have %d want %d\n",
213 new_size = (new_size + HEAP_INCREMENT ) & ~HEAP_INCREMENT ;
214 p = malloc(new_size * sizeof(*p), M_DUMMYNET, M_NOWAIT);
216 printf(" heap_init, resize %d failed\n", new_size );
217 return 1 ; /* error */
220 bcopy(h->p, p, h->size * sizeof(*p) );
221 free(h->p, M_DUMMYNET);
229 * Insert element in heap. Normally, p != NULL, we insert p in
230 * a new position and bubble up. If p == NULL, then the element is
231 * already in place, and key is the position where to start the
233 * Returns 1 on failure (cannot allocate new heap entry)
235 * If offset > 0 the position (index, int) of the element in the heap is
236 * also stored in the element itself at the given offset in bytes.
238 #define SET_OFFSET(heap, node) \
239 if (heap->offset > 0) \
240 *((int *)((char *)(heap->p[node].object) + heap->offset)) = node ;
242 * RESET_OFFSET is used for sanity checks. It sets offset to an invalid value.
244 #define RESET_OFFSET(heap, node) \
245 if (heap->offset > 0) \
246 *((int *)((char *)(heap->p[node].object) + heap->offset)) = -1 ;
248 heap_insert(struct dn_heap *h, dn_key key1, void *p)
250 int son = h->elements ;
252 if (p == NULL) /* data already there, set starting point */
254 else { /* insert new element at the end, possibly resize */
256 if (son == h->size) /* need resize... */
257 if (heap_init(h, h->elements+1) )
258 return 1 ; /* failure... */
259 h->p[son].object = p ;
260 h->p[son].key = key1 ;
263 while (son > 0) { /* bubble up */
264 int father = HEAP_FATHER(son) ;
265 struct dn_heap_entry tmp ;
267 if (DN_KEY_LT( h->p[father].key, h->p[son].key ) )
268 break ; /* found right position */
269 /* son smaller than father, swap and repeat */
270 HEAP_SWAP(h->p[son], h->p[father], tmp) ;
279 * remove top element from heap, or obj if obj != NULL
282 heap_extract(struct dn_heap *h, void *obj)
284 int child, father, max = h->elements - 1 ;
287 printf("warning, extract from empty heap 0x%p\n", h);
290 father = 0 ; /* default: move up smallest child */
291 if (obj != NULL) { /* extract specific element, index is at offset */
293 panic("*** heap_extract from middle not supported on this heap!!!\n");
294 father = *((int *)((char *)obj + h->offset)) ;
295 if (father < 0 || father >= h->elements) {
296 printf("dummynet: heap_extract, father %d out of bound 0..%d\n",
297 father, h->elements);
298 panic("heap_extract");
301 RESET_OFFSET(h, father);
302 child = HEAP_LEFT(father) ; /* left child */
303 while (child <= max) { /* valid entry */
304 if (child != max && DN_KEY_LT(h->p[child+1].key, h->p[child].key) )
305 child = child+1 ; /* take right child, otherwise left */
306 h->p[father] = h->p[child] ;
307 SET_OFFSET(h, father);
309 child = HEAP_LEFT(child) ; /* left child for next loop */
314 * Fill hole with last entry and bubble up, reusing the insert code
316 h->p[father] = h->p[max] ;
317 heap_insert(h, father, NULL); /* this one cannot fail */
323 * change object position and update references
324 * XXX this one is never used!
327 heap_move(struct dn_heap *h, dn_key new_key, void *object)
331 int max = h->elements-1 ;
332 struct dn_heap_entry buf ;
335 panic("cannot move items on this heap");
337 i = *((int *)((char *)object + h->offset));
338 if (DN_KEY_LT(new_key, h->p[i].key) ) { /* must move up */
339 h->p[i].key = new_key ;
340 for (; i>0 && DN_KEY_LT(new_key, h->p[(temp = HEAP_FATHER(i))].key) ;
341 i = temp ) { /* bubble up */
342 HEAP_SWAP(h->p[i], h->p[temp], buf) ;
345 } else { /* must move down */
346 h->p[i].key = new_key ;
347 while ( (temp = HEAP_LEFT(i)) <= max ) { /* found left child */
348 if ((temp != max) && DN_KEY_GT(h->p[temp].key, h->p[temp+1].key))
349 temp++ ; /* select child with min key */
350 if (DN_KEY_GT(new_key, h->p[temp].key)) { /* go down */
351 HEAP_SWAP(h->p[i], h->p[temp], buf) ;
360 #endif /* heap_move, unused */
363 * heapify() will reorganize data inside an array to maintain the
364 * heap property. It is needed when we delete a bunch of entries.
367 heapify(struct dn_heap *h)
371 for (i = 0 ; i < h->elements ; i++ )
372 heap_insert(h, i , NULL) ;
376 * cleanup the heap and free data structure
379 heap_free(struct dn_heap *h)
382 free(h->p, M_DUMMYNET);
383 bzero(h, sizeof(*h) );
387 * --- end of heap management functions ---
391 * Scheduler functions:
393 * transmit_event() is called when the delay-line needs to enter
394 * the scheduler, either because of existing pkts getting ready,
395 * or new packets entering the queue. The event handled is the delivery
396 * time of the packet.
398 * ready_event() does something similar with fixed-rate queues, and the
399 * event handled is the finish time of the head pkt.
401 * wfq_ready_event() does something similar with WF2Q queues, and the
402 * event handled is the start time of the head pkt.
404 * In all cases, we make sure that the data structures are consistent
405 * before passing pkts out, because this might trigger recursive
406 * invocations of the procedures.
409 transmit_event(struct dn_pipe *pipe)
413 while ( (pkt = pipe->head) && DN_KEY_LEQ(pkt->output_time, curr_time) ) {
415 * first unlink, then call procedures, since ip_input() can invoke
416 * ip_output() and viceversa, thus causing nested calls
418 pipe->head = DN_NEXT(pkt) ;
421 * The actual mbuf is preceded by a struct dn_pkt, resembling an mbuf
422 * (NOT A REAL one, just a small block of malloc'ed memory) with
423 * m_type = MT_TAG, m_flags = PACKET_TAG_DUMMYNET
424 * dn_m (m_next) = actual mbuf to be processed by ip_input/output
425 * and some other fields.
426 * The block IS FREED HERE because it contains parameters passed
427 * to the called routine.
429 switch (pkt->dn_dir) {
431 (void)ip_output((struct mbuf *)pkt, NULL, NULL, 0, NULL, NULL);
432 rt_unref (pkt->ro.ro_rt) ;
437 struct netmsg_packet msg;
439 msg.nm_packet = (struct mbuf *)&pkt;
440 ip_input((struct netmsg *)&msg) ;
446 /* somebody unloaded the bridge module. Drop pkt */
447 printf("-- dropping bridged packet trapped in pipe--\n");
451 case DN_TO_ETH_DEMUX:
453 struct mbuf *m = (struct mbuf *)pkt ;
454 struct ether_header *eh;
456 if (pkt->dn_m->m_len < ETHER_HDR_LEN &&
457 (pkt->dn_m = m_pullup(pkt->dn_m, ETHER_HDR_LEN)) == NULL) {
458 printf("dummynet/bridge: pullup fail, dropping pkt\n");
462 * same as ether_input, make eh be a pointer into the mbuf
464 eh = mtod(pkt->dn_m, struct ether_header *);
465 m_adj(pkt->dn_m, ETHER_HDR_LEN);
467 * bdg_forward() wants a pointer to the pseudo-mbuf-header, but
468 * on return it will supply the pointer to the actual packet
469 * (originally pkt->dn_m, but could be something else now) if
470 * it has not consumed it.
472 if (pkt->dn_dir == DN_TO_BDG_FWD) {
473 m = bdg_forward_ptr(m, eh, pkt->ifp);
477 ether_demux(NULL, eh, m); /* which consumes the mbuf */
481 ether_output_frame(pkt->ifp, (struct mbuf *)pkt);
485 printf("dummynet: bad switch %d!\n", pkt->dn_dir);
489 free(pkt, M_DUMMYNET);
491 /* if there are leftover packets, put into the heap for next event */
492 if ( (pkt = pipe->head) )
493 heap_insert(&extract_heap, pkt->output_time, pipe ) ;
494 /* XXX should check errors on heap_insert, by draining the
495 * whole pipe p and hoping in the future we are more successful
500 * the following macro computes how many ticks we have to wait
501 * before being able to transmit a packet. The credit is taken from
502 * either a pipe (WF2Q) or a flow_queue (per-flow queueing)
504 #define SET_TICKS(pkt, q, p) \
505 (pkt->dn_m->m_pkthdr.len*8*hz - (q)->numbytes + p->bandwidth - 1 ) / \
509 * extract pkt from queue, compute output time (could be now)
510 * and put into delay line (p_queue)
513 move_pkt(struct dn_pkt *pkt, struct dn_flow_queue *q,
514 struct dn_pipe *p, int len)
516 q->head = DN_NEXT(pkt) ;
518 q->len_bytes -= len ;
520 pkt->output_time = curr_time + p->delay ;
525 DN_NEXT(p->tail) = pkt;
527 DN_NEXT(p->tail) = NULL;
531 * ready_event() is invoked every time the queue must enter the
532 * scheduler, either because the first packet arrives, or because
533 * a previously scheduled event fired.
534 * On invokation, drain as many pkts as possible (could be 0) and then
535 * if there are leftover packets reinsert the pkt in the scheduler.
538 ready_event(struct dn_flow_queue *q)
541 struct dn_pipe *p = q->fs->pipe ;
545 printf("ready_event- pipe is gone\n");
548 p_was_empty = (p->head == NULL) ;
551 * schedule fixed-rate queues linked to this pipe:
552 * Account for the bw accumulated since last scheduling, then
553 * drain as many pkts as allowed by q->numbytes and move to
554 * the delay line (in p) computing output time.
555 * bandwidth==0 (no limit) means we can drain the whole queue,
556 * setting len_scaled = 0 does the job.
558 q->numbytes += ( curr_time - q->sched_time ) * p->bandwidth;
559 while ( (pkt = q->head) != NULL ) {
560 int len = pkt->dn_m->m_pkthdr.len;
561 int len_scaled = p->bandwidth ? len*8*hz : 0 ;
562 if (len_scaled > q->numbytes )
564 q->numbytes -= len_scaled ;
565 move_pkt(pkt, q, p, len);
568 * If we have more packets queued, schedule next ready event
569 * (can only occur when bandwidth != 0, otherwise we would have
570 * flushed the whole queue in the previous loop).
571 * To this purpose we record the current time and compute how many
572 * ticks to go for the finish time of the packet.
574 if ( (pkt = q->head) != NULL ) { /* this implies bandwidth != 0 */
575 dn_key t = SET_TICKS(pkt, q, p); /* ticks i have to wait */
576 q->sched_time = curr_time ;
577 heap_insert(&ready_heap, curr_time + t, (void *)q );
578 /* XXX should check errors on heap_insert, and drain the whole
579 * queue on error hoping next time we are luckier.
581 } else { /* RED needs to know when the queue becomes empty */
582 q->q_time = curr_time;
586 * If the delay line was empty call transmit_event(p) now.
587 * Otherwise, the scheduler will take care of it.
594 * Called when we can transmit packets on WF2Q queues. Take pkts out of
595 * the queues at their start time, and enqueue into the delay line.
596 * Packets are drained until p->numbytes < 0. As long as
597 * len_scaled >= p->numbytes, the packet goes into the delay line
598 * with a deadline p->delay. For the last packet, if p->numbytes<0,
599 * there is an additional delay.
602 ready_event_wfq(struct dn_pipe *p)
604 int p_was_empty = (p->head == NULL) ;
605 struct dn_heap *sch = &(p->scheduler_heap);
606 struct dn_heap *neh = &(p->not_eligible_heap) ;
608 if (p->if_name[0] == 0) /* tx clock is simulated */
609 p->numbytes += ( curr_time - p->sched_time ) * p->bandwidth;
610 else { /* tx clock is for real, the ifq must be empty or this is a NOP */
611 if (p->ifp && p->ifp->if_snd.ifq_head != NULL)
614 DEB(printf("pipe %d ready from %s --\n",
615 p->pipe_nr, p->if_name);)
620 * While we have backlogged traffic AND credit, we need to do
621 * something on the queue.
623 while ( p->numbytes >=0 && (sch->elements>0 || neh->elements >0) ) {
624 if (sch->elements > 0) { /* have some eligible pkts to send out */
625 struct dn_flow_queue *q = sch->p[0].object ;
626 struct dn_pkt *pkt = q->head;
627 struct dn_flow_set *fs = q->fs;
628 u_int64_t len = pkt->dn_m->m_pkthdr.len;
629 int len_scaled = p->bandwidth ? len*8*hz : 0 ;
631 heap_extract(sch, NULL); /* remove queue from heap */
632 p->numbytes -= len_scaled ;
633 move_pkt(pkt, q, p, len);
635 p->V += (len<<MY_M) / p->sum ; /* update V */
636 q->S = q->F ; /* update start time */
637 if (q->len == 0) { /* Flow not backlogged any more */
639 heap_insert(&(p->idle_heap), q->F, q);
640 } else { /* still backlogged */
642 * update F and position in backlogged queue, then
643 * put flow in not_eligible_heap (we will fix this later).
645 len = (q->head)->dn_m->m_pkthdr.len;
646 q->F += (len<<MY_M)/(u_int64_t) fs->weight ;
647 if (DN_KEY_LEQ(q->S, p->V))
648 heap_insert(neh, q->S, q);
650 heap_insert(sch, q->F, q);
654 * now compute V = max(V, min(S_i)). Remember that all elements in sch
655 * have by definition S_i <= V so if sch is not empty, V is surely
656 * the max and we must not update it. Conversely, if sch is empty
657 * we only need to look at neh.
659 if (sch->elements == 0 && neh->elements > 0)
660 p->V = MAX64 ( p->V, neh->p[0].key );
661 /* move from neh to sch any packets that have become eligible */
662 while (neh->elements > 0 && DN_KEY_LEQ(neh->p[0].key, p->V) ) {
663 struct dn_flow_queue *q = neh->p[0].object ;
664 heap_extract(neh, NULL);
665 heap_insert(sch, q->F, q);
668 if (p->if_name[0] != '\0') {/* tx clock is from a real thing */
669 p->numbytes = -1 ; /* mark not ready for I/O */
673 if (sch->elements == 0 && neh->elements == 0 && p->numbytes >= 0
674 && p->idle_heap.elements > 0) {
676 * no traffic and no events scheduled. We can get rid of idle-heap.
680 for (i = 0 ; i < p->idle_heap.elements ; i++) {
681 struct dn_flow_queue *q = p->idle_heap.p[i].object ;
688 p->idle_heap.elements = 0 ;
691 * If we are getting clocks from dummynet (not a real interface) and
692 * If we are under credit, schedule the next ready event.
693 * Also fix the delivery time of the last packet.
695 if (p->if_name[0]==0 && p->numbytes < 0) { /* this implies bandwidth >0 */
696 dn_key t=0 ; /* number of ticks i have to wait */
698 if (p->bandwidth > 0)
699 t = ( p->bandwidth -1 - p->numbytes) / p->bandwidth ;
700 p->tail->output_time += t ;
701 p->sched_time = curr_time ;
702 heap_insert(&wfq_ready_heap, curr_time + t, (void *)p);
703 /* XXX should check errors on heap_insert, and drain the whole
704 * queue on error hoping next time we are luckier.
708 * If the delay line was empty call transmit_event(p) now.
709 * Otherwise, the scheduler will take care of it.
716 * This is called once per tick, or HZ times per second. It is used to
717 * increment the current tick counter and schedule expired events.
720 dummynet(void * __unused unused)
722 void *p ; /* generic parameter to handler */
725 struct dn_heap *heaps[3];
729 heaps[0] = &ready_heap ; /* fixed-rate queues */
730 heaps[1] = &wfq_ready_heap ; /* wfq queues */
731 heaps[2] = &extract_heap ; /* delay line */
732 s = splimp(); /* see note on top, splnet() is not enough */
734 for (i=0; i < 3 ; i++) {
736 while (h->elements > 0 && DN_KEY_LEQ(h->p[0].key, curr_time) ) {
737 DDB(if (h->p[0].key > curr_time)
738 printf("-- dummynet: warning, heap %d is %d ticks late\n",
739 i, (int)(curr_time - h->p[0].key));)
740 p = h->p[0].object ; /* store a copy before heap_extract */
741 heap_extract(h, NULL); /* need to extract before processing */
745 struct dn_pipe *pipe = p;
746 if (pipe->if_name[0] != '\0')
747 printf("*** bad ready_event_wfq for pipe %s\n",
755 /* sweep pipes trying to expire idle flow_queues */
756 for (pe = all_pipes; pe ; pe = pe->next )
757 if (pe->idle_heap.elements > 0 &&
758 DN_KEY_LT(pe->idle_heap.p[0].key, pe->V) ) {
759 struct dn_flow_queue *q = pe->idle_heap.p[0].object ;
761 heap_extract(&(pe->idle_heap), NULL);
762 q->S = q->F + 1 ; /* mark timestamp as invalid */
763 pe->sum -= q->fs->weight ;
766 dn_timeout = timeout(dummynet, NULL, 1);
770 * called by an interface when tx_rdy occurs.
773 if_tx_rdy(struct ifnet *ifp)
777 for (p = all_pipes; p ; p = p->next )
781 for (p = all_pipes; p ; p = p->next )
782 if (!strcmp(p->if_name, ifp->if_xname) ) {
784 DEB(printf("++ tx rdy from %s (now found)\n", ifp->if_xname);)
789 DEB(printf("++ tx rdy from %s - qlen %d\n", ifp->if_xname,
790 ifp->if_snd.ifq_len);)
791 p->numbytes = 0 ; /* mark ready for I/O */
798 * Unconditionally expire empty queues in case of shortage.
799 * Returns the number of queues freed.
802 expire_queues(struct dn_flow_set *fs)
804 struct dn_flow_queue *q, *prev ;
805 int i, initial_elements = fs->rq_elements ;
807 if (fs->last_expired == time_second)
809 fs->last_expired = time_second ;
810 for (i = 0 ; i <= fs->rq_size ; i++) /* last one is overflow */
811 for (prev=NULL, q = fs->rq[i] ; q != NULL ; )
812 if (q->head != NULL || q->S != q->F+1) {
815 } else { /* entry is idle, expire it */
816 struct dn_flow_queue *old_q = q ;
819 prev->next = q = q->next ;
821 fs->rq[i] = q = q->next ;
823 free(old_q, M_DUMMYNET);
825 return initial_elements - fs->rq_elements ;
829 * If room, create a new queue and put at head of slot i;
830 * otherwise, create or use the default queue.
832 static struct dn_flow_queue *
833 create_queue(struct dn_flow_set *fs, int i)
835 struct dn_flow_queue *q ;
837 if (fs->rq_elements > fs->rq_size * dn_max_ratio &&
838 expire_queues(fs) == 0) {
840 * No way to get room, use or create overflow queue.
843 if ( fs->rq[i] != NULL )
846 q = malloc(sizeof(*q), M_DUMMYNET, M_NOWAIT | M_ZERO);
848 printf("sorry, cannot allocate queue for new flow\n");
853 q->next = fs->rq[i] ;
854 q->S = q->F + 1; /* hack - mark timestamp as invalid */
861 * Given a flow_set and a pkt in last_pkt, find a matching queue
862 * after appropriate masking. The queue is moved to front
863 * so that further searches take less time.
865 static struct dn_flow_queue *
866 find_queue(struct dn_flow_set *fs, struct ipfw_flow_id *id)
868 int i = 0 ; /* we need i and q for new allocations */
869 struct dn_flow_queue *q, *prev;
871 if ( !(fs->flags_fs & DN_HAVE_FLOW_MASK) )
874 /* first, do the masking */
875 id->dst_ip &= fs->flow_mask.dst_ip ;
876 id->src_ip &= fs->flow_mask.src_ip ;
877 id->dst_port &= fs->flow_mask.dst_port ;
878 id->src_port &= fs->flow_mask.src_port ;
879 id->proto &= fs->flow_mask.proto ;
880 id->flags = 0 ; /* we don't care about this one */
881 /* then, hash function */
882 i = ( (id->dst_ip) & 0xffff ) ^
883 ( (id->dst_ip >> 15) & 0xffff ) ^
884 ( (id->src_ip << 1) & 0xffff ) ^
885 ( (id->src_ip >> 16 ) & 0xffff ) ^
886 (id->dst_port << 1) ^ (id->src_port) ^
888 i = i % fs->rq_size ;
889 /* finally, scan the current list for a match */
891 for (prev=NULL, q = fs->rq[i] ; q ; ) {
893 if (id->dst_ip == q->id.dst_ip &&
894 id->src_ip == q->id.src_ip &&
895 id->dst_port == q->id.dst_port &&
896 id->src_port == q->id.src_port &&
897 id->proto == q->id.proto &&
898 id->flags == q->id.flags)
900 else if (pipe_expire && q->head == NULL && q->S == q->F+1 ) {
901 /* entry is idle and not in any heap, expire it */
902 struct dn_flow_queue *old_q = q ;
905 prev->next = q = q->next ;
907 fs->rq[i] = q = q->next ;
909 free(old_q, M_DUMMYNET);
915 if (q && prev != NULL) { /* found and not in front */
916 prev->next = q->next ;
917 q->next = fs->rq[i] ;
921 if (q == NULL) { /* no match, need to allocate a new entry */
922 q = create_queue(fs, i);
930 red_drops(struct dn_flow_set *fs, struct dn_flow_queue *q, int len)
935 * RED calculates the average queue size (avg) using a low-pass filter
936 * with an exponential weighted (w_q) moving average:
937 * avg <- (1-w_q) * avg + w_q * q_size
938 * where q_size is the queue length (measured in bytes or * packets).
940 * If q_size == 0, we compute the idle time for the link, and set
941 * avg = (1 - w_q)^(idle/s)
942 * where s is the time needed for transmitting a medium-sized packet.
944 * Now, if avg < min_th the packet is enqueued.
945 * If avg > max_th the packet is dropped. Otherwise, the packet is
946 * dropped with probability P function of avg.
951 /* queue in bytes or packets ? */
952 u_int q_size = (fs->flags_fs & DN_QSIZE_IS_BYTES) ? q->len_bytes : q->len;
954 DEB(printf("\n%d q: %2u ", (int) curr_time, q_size);)
956 /* average queue size estimation */
959 * queue is not empty, avg <- avg + (q_size - avg) * w_q
961 int diff = SCALE(q_size) - q->avg;
962 int64_t v = SCALE_MUL((int64_t) diff, (int64_t) fs->w_q);
967 * queue is empty, find for how long the queue has been
968 * empty and use a lookup table for computing
969 * (1 - * w_q)^(idle_time/s) where s is the time to send a
974 u_int t = (curr_time - q->q_time) / fs->lookup_step;
976 q->avg = (t < fs->lookup_depth) ?
977 SCALE_MUL(q->avg, fs->w_q_lookup[t]) : 0;
980 DEB(printf("avg: %u ", SCALE_VAL(q->avg));)
982 /* should i drop ? */
984 if (q->avg < fs->min_th) {
986 return 0; /* accept packet ; */
988 if (q->avg >= fs->max_th) { /* average queue >= max threshold */
989 if (fs->flags_fs & DN_IS_GENTLE_RED) {
991 * According to Gentle-RED, if avg is greater than max_th the
992 * packet is dropped with a probability
993 * p_b = c_3 * avg - c_4
994 * where c_3 = (1 - max_p) / max_th, and c_4 = 1 - 2 * max_p
996 p_b = SCALE_MUL((int64_t) fs->c_3, (int64_t) q->avg) - fs->c_4;
1002 } else if (q->avg > fs->min_th) {
1004 * we compute p_b using the linear dropping function p_b = c_1 *
1005 * avg - c_2, where c_1 = max_p / (max_th - min_th), and c_2 =
1006 * max_p * min_th / (max_th - min_th)
1008 p_b = SCALE_MUL((int64_t) fs->c_1, (int64_t) q->avg) - fs->c_2;
1010 if (fs->flags_fs & DN_QSIZE_IS_BYTES)
1011 p_b = (p_b * len) / fs->max_pkt_size;
1012 if (++q->count == 0)
1013 q->random = random() & 0xffff;
1016 * q->count counts packets arrived since last drop, so a greater
1017 * value of q->count means a greater packet drop probability.
1019 if (SCALE_MUL(p_b, SCALE((int64_t) q->count)) > q->random) {
1021 DEB(printf("- red drop");)
1022 /* after a drop we calculate a new random value */
1023 q->random = random() & 0xffff;
1024 return 1; /* drop */
1027 /* end of RED algorithm */
1028 return 0 ; /* accept */
1032 struct dn_flow_set *
1033 locate_flowset(int pipe_nr, struct ip_fw *rule)
1036 struct dn_flow_set *fs;
1037 ipfw_insn *cmd = rule->cmd + rule->act_ofs;
1039 if (cmd->opcode == O_LOG)
1041 fs = ((ipfw_insn_pipe *)cmd)->pipe_ptr;
1046 if (cmd->opcode == O_QUEUE)
1048 struct dn_flow_set *fs = NULL ;
1050 if ( (rule->fw_flg & IP_FW_F_COMMAND) == IP_FW_F_QUEUE )
1052 for (fs=all_flow_sets; fs && fs->fs_nr != pipe_nr; fs=fs->next)
1056 for (p1 = all_pipes; p1 && p1->pipe_nr != pipe_nr; p1 = p1->next)
1061 /* record for the future */
1063 ((ipfw_insn_pipe *)cmd)->pipe_ptr = fs;
1066 rule->pipe_ptr = fs;
1072 * dummynet hook for packets. Below 'pipe' is a pipe or a queue
1073 * depending on whether WF2Q or fixed bw is used.
1075 * pipe_nr pipe or queue the packet is destined for.
1076 * dir where shall we send the packet after dummynet.
1077 * m the mbuf with the packet
1078 * ifp the 'ifp' parameter from the caller.
1079 * NULL in ip_input, destination interface in ip_output,
1080 * real_dst in bdg_forward
1081 * ro route parameter (only used in ip_output, NULL otherwise)
1082 * dst destination address, only used by ip_output
1083 * rule matching rule, in case of multiple passes
1084 * flags flags from the caller, only used in ip_output
1088 dummynet_io(struct mbuf *m, int pipe_nr, int dir, struct ip_fw_args *fwa)
1091 struct dn_flow_set *fs;
1092 struct dn_pipe *pipe ;
1093 u_int64_t len = m->m_pkthdr.len ;
1094 struct dn_flow_queue *q = NULL ;
1098 ipfw_insn *cmd = fwa->rule->cmd + fwa->rule->act_ofs;
1100 if (cmd->opcode == O_LOG)
1102 is_pipe = (cmd->opcode == O_PIPE);
1104 is_pipe = (fwa->rule->fw_flg & IP_FW_F_COMMAND) == IP_FW_F_PIPE;
1110 * this is a dummynet rule, so we expect a O_PIPE or O_QUEUE rule
1112 fs = locate_flowset(pipe_nr, fwa->rule);
1114 goto dropit ; /* this queue/pipe does not exist! */
1116 if (pipe == NULL) { /* must be a queue, try find a matching pipe */
1117 for (pipe = all_pipes; pipe && pipe->pipe_nr != fs->parent_nr;
1123 printf("No pipe %d for queue %d, drop pkt\n",
1124 fs->parent_nr, fs->fs_nr);
1128 q = find_queue(fs, &(fwa->f_id));
1130 goto dropit ; /* cannot allocate queue */
1132 * update statistics, then check reasons to drop pkt
1134 q->tot_bytes += len ;
1136 if ( fs->plr && random() < fs->plr )
1137 goto dropit ; /* random pkt drop */
1138 if ( fs->flags_fs & DN_QSIZE_IS_BYTES) {
1139 if (q->len_bytes > fs->qsize)
1140 goto dropit ; /* queue size overflow */
1142 if (q->len >= fs->qsize)
1143 goto dropit ; /* queue count overflow */
1145 if ( fs->flags_fs & DN_IS_RED && red_drops(fs, q, len) )
1148 /* XXX expensive to zero, see if we can remove it*/
1149 pkt = (struct dn_pkt *)malloc(sizeof (*pkt), M_DUMMYNET, M_NOWAIT|M_ZERO);
1151 goto dropit ; /* cannot allocate packet header */
1152 /* ok, i can handle the pkt now... */
1153 /* build and enqueue packet + parameters */
1154 pkt->hdr.mh_type = MT_TAG;
1155 pkt->hdr.mh_flags = PACKET_TAG_DUMMYNET;
1156 pkt->rule = fwa->rule ;
1157 DN_NEXT(pkt) = NULL;
1161 pkt->ifp = fwa->oif;
1162 if (dir == DN_TO_IP_OUT) {
1164 * We need to copy *ro because for ICMP pkts (and maybe others)
1165 * the caller passed a pointer into the stack; dst might also be
1166 * a pointer into *ro so it needs to be updated.
1168 pkt->ro = *(fwa->ro);
1170 fwa->ro->ro_rt->rt_refcnt++ ;
1171 if (fwa->dst == (struct sockaddr_in *)&fwa->ro->ro_dst) /* dst points into ro */
1172 fwa->dst = (struct sockaddr_in *)&(pkt->ro.ro_dst) ;
1174 pkt->dn_dst = fwa->dst;
1175 pkt->flags = fwa->flags;
1177 if (q->head == NULL)
1180 DN_NEXT(q->tail) = pkt;
1183 q->len_bytes += len ;
1185 if ( q->head != pkt ) /* flow was not idle, we are done */
1188 * If we reach this point the flow was previously idle, so we need
1189 * to schedule it. This involves different actions for fixed-rate or
1194 * Fixed-rate queue: just insert into the ready_heap.
1197 if (pipe->bandwidth)
1198 t = SET_TICKS(pkt, q, pipe);
1199 q->sched_time = curr_time ;
1200 if (t == 0) /* must process it now */
1203 heap_insert(&ready_heap, curr_time + t , q );
1206 * WF2Q. First, compute start time S: if the flow was idle (S=F+1)
1207 * set S to the virtual time V for the controlling pipe, and update
1208 * the sum of weights for the pipe; otherwise, remove flow from
1209 * idle_heap and set S to max(F,V).
1210 * Second, compute finish time F = S + len/weight.
1211 * Third, if pipe was idle, update V=max(S, V).
1212 * Fourth, count one more backlogged flow.
1214 if (DN_KEY_GT(q->S, q->F)) { /* means timestamps are invalid */
1216 pipe->sum += fs->weight ; /* add weight of new queue */
1218 heap_extract(&(pipe->idle_heap), q);
1219 q->S = MAX64(q->F, pipe->V ) ;
1221 q->F = q->S + ( len<<MY_M )/(u_int64_t) fs->weight;
1223 if (pipe->not_eligible_heap.elements == 0 &&
1224 pipe->scheduler_heap.elements == 0)
1225 pipe->V = MAX64 ( q->S, pipe->V );
1228 * Look at eligibility. A flow is not eligibile if S>V (when
1229 * this happens, it means that there is some other flow already
1230 * scheduled for the same pipe, so the scheduler_heap cannot be
1231 * empty). If the flow is not eligible we just store it in the
1232 * not_eligible_heap. Otherwise, we store in the scheduler_heap
1233 * and possibly invoke ready_event_wfq() right now if there is
1235 * Note that for all flows in scheduler_heap (SCH), S_i <= V,
1236 * and for all flows in not_eligible_heap (NEH), S_i > V .
1237 * So when we need to compute max( V, min(S_i) ) forall i in SCH+NEH,
1238 * we only need to look into NEH.
1240 if (DN_KEY_GT(q->S, pipe->V) ) { /* not eligible */
1241 if (pipe->scheduler_heap.elements == 0)
1242 printf("++ ouch! not eligible but empty scheduler!\n");
1243 heap_insert(&(pipe->not_eligible_heap), q->S, q);
1245 heap_insert(&(pipe->scheduler_heap), q->F, q);
1246 if (pipe->numbytes >= 0) { /* pipe is idle */
1247 if (pipe->scheduler_heap.elements != 1)
1248 printf("*** OUCH! pipe should have been idle!\n");
1249 DEB(printf("Waking up pipe %d at %d\n",
1250 pipe->pipe_nr, (int)(q->F >> MY_M)); )
1251 pipe->sched_time = curr_time ;
1252 ready_event_wfq(pipe);
1265 return ( (fs && (fs->flags_fs & DN_NOERROR)) ? 0 : ENOBUFS);
1269 * Below, the rt_unref is only needed when (pkt->dn_dir == DN_TO_IP_OUT)
1270 * Doing this would probably save us the initial bzero of dn_pkt
1272 #define DN_FREE_PKT(pkt) { \
1273 struct dn_pkt *n = pkt ; \
1274 rt_unref ( n->ro.ro_rt ) ; \
1276 pkt = DN_NEXT(n) ; \
1277 free(n, M_DUMMYNET) ; }
1280 * Dispose all packets and flow_queues on a flow_set.
1281 * If all=1, also remove red lookup table and other storage,
1282 * including the descriptor itself.
1283 * For the one in dn_pipe MUST also cleanup ready_heap...
1286 purge_flow_set(struct dn_flow_set *fs, int all)
1288 struct dn_pkt *pkt ;
1289 struct dn_flow_queue *q, *qn ;
1292 for (i = 0 ; i <= fs->rq_size ; i++ ) {
1293 for (q = fs->rq[i] ; q ; q = qn ) {
1294 for (pkt = q->head ; pkt ; )
1297 free(q, M_DUMMYNET);
1301 fs->rq_elements = 0 ;
1303 /* RED - free lookup table */
1305 free(fs->w_q_lookup, M_DUMMYNET);
1307 free(fs->rq, M_DUMMYNET);
1308 /* if this fs is not part of a pipe, free it */
1309 if (fs->pipe && fs != &(fs->pipe->fs) )
1310 free(fs, M_DUMMYNET);
1315 * Dispose all packets queued on a pipe (not a flow_set).
1316 * Also free all resources associated to a pipe, which is about
1320 purge_pipe(struct dn_pipe *pipe)
1322 struct dn_pkt *pkt ;
1324 purge_flow_set( &(pipe->fs), 1 );
1326 for (pkt = pipe->head ; pkt ; )
1329 heap_free( &(pipe->scheduler_heap) );
1330 heap_free( &(pipe->not_eligible_heap) );
1331 heap_free( &(pipe->idle_heap) );
1335 * Delete all pipes and heaps returning memory. Must also
1336 * remove references from all ipfw rules to all pipes.
1341 struct dn_pipe *curr_p, *p ;
1342 struct dn_flow_set *fs, *curr_fs;
1347 /* remove all references to pipes ...*/
1348 flush_pipe_ptrs(NULL);
1349 /* prevent future matches... */
1352 fs = all_flow_sets ;
1353 all_flow_sets = NULL ;
1354 /* and free heaps so we don't have unwanted events */
1355 heap_free(&ready_heap);
1356 heap_free(&wfq_ready_heap);
1357 heap_free(&extract_heap);
1360 * Now purge all queued pkts and delete all pipes
1362 /* scan and purge all flow_sets. */
1366 purge_flow_set(curr_fs, 1);
1372 free(curr_p, M_DUMMYNET);
1377 extern struct ip_fw *ip_fw_default_rule ;
1379 dn_rule_delete_fs(struct dn_flow_set *fs, void *r)
1382 struct dn_flow_queue *q ;
1383 struct dn_pkt *pkt ;
1385 for (i = 0 ; i <= fs->rq_size ; i++) /* last one is ovflow */
1386 for (q = fs->rq[i] ; q ; q = q->next )
1387 for (pkt = q->head ; pkt ; pkt = DN_NEXT(pkt) )
1389 pkt->rule = ip_fw_default_rule ;
1392 * when a firewall rule is deleted, scan all queues and remove the flow-id
1393 * from packets matching this rule.
1396 dn_rule_delete(void *r)
1399 struct dn_pkt *pkt ;
1400 struct dn_flow_set *fs ;
1403 * If the rule references a queue (dn_flow_set), then scan
1404 * the flow set, otherwise scan pipes. Should do either, but doing
1405 * both does not harm.
1407 for ( fs = all_flow_sets ; fs ; fs = fs->next )
1408 dn_rule_delete_fs(fs, r);
1409 for ( p = all_pipes ; p ; p = p->next ) {
1411 dn_rule_delete_fs(fs, r);
1412 for (pkt = p->head ; pkt ; pkt = DN_NEXT(pkt) )
1414 pkt->rule = ip_fw_default_rule ;
1419 * setup RED parameters
1422 config_red(struct dn_flow_set *p, struct dn_flow_set * x)
1427 x->min_th = SCALE(p->min_th);
1428 x->max_th = SCALE(p->max_th);
1429 x->max_p = p->max_p;
1431 x->c_1 = p->max_p / (p->max_th - p->min_th);
1432 x->c_2 = SCALE_MUL(x->c_1, SCALE(p->min_th));
1433 if (x->flags_fs & DN_IS_GENTLE_RED) {
1434 x->c_3 = (SCALE(1) - p->max_p) / p->max_th;
1435 x->c_4 = (SCALE(1) - 2 * p->max_p);
1438 /* if the lookup table already exist, free and create it again */
1439 if (x->w_q_lookup) {
1440 free(x->w_q_lookup, M_DUMMYNET);
1441 x->w_q_lookup = NULL ;
1443 if (red_lookup_depth == 0) {
1444 printf("\nnet.inet.ip.dummynet.red_lookup_depth must be > 0");
1445 free(x, M_DUMMYNET);
1448 x->lookup_depth = red_lookup_depth;
1449 x->w_q_lookup = (u_int *) malloc(x->lookup_depth * sizeof(int),
1450 M_DUMMYNET, M_NOWAIT);
1451 if (x->w_q_lookup == NULL) {
1452 printf("sorry, cannot allocate red lookup table\n");
1453 free(x, M_DUMMYNET);
1457 /* fill the lookup table with (1 - w_q)^x */
1458 x->lookup_step = p->lookup_step ;
1459 x->lookup_weight = p->lookup_weight ;
1460 x->w_q_lookup[0] = SCALE(1) - x->w_q;
1461 for (i = 1; i < x->lookup_depth; i++)
1462 x->w_q_lookup[i] = SCALE_MUL(x->w_q_lookup[i - 1], x->lookup_weight);
1463 if (red_avg_pkt_size < 1)
1464 red_avg_pkt_size = 512 ;
1465 x->avg_pkt_size = red_avg_pkt_size ;
1466 if (red_max_pkt_size < 1)
1467 red_max_pkt_size = 1500 ;
1468 x->max_pkt_size = red_max_pkt_size ;
1473 alloc_hash(struct dn_flow_set *x, struct dn_flow_set *pfs)
1475 if (x->flags_fs & DN_HAVE_FLOW_MASK) { /* allocate some slots */
1476 int l = pfs->rq_size;
1482 else if (l > DN_MAX_HASH_SIZE)
1483 l = DN_MAX_HASH_SIZE;
1485 } else /* one is enough for null mask */
1487 x->rq = malloc((1 + x->rq_size) * sizeof(struct dn_flow_queue *),
1488 M_DUMMYNET, M_NOWAIT | M_ZERO);
1489 if (x->rq == NULL) {
1490 printf("sorry, cannot allocate queue\n");
1498 set_fs_parms(struct dn_flow_set *x, struct dn_flow_set *src)
1500 x->flags_fs = src->flags_fs;
1501 x->qsize = src->qsize;
1503 x->flow_mask = src->flow_mask;
1504 if (x->flags_fs & DN_QSIZE_IS_BYTES) {
1505 if (x->qsize > 1024*1024)
1506 x->qsize = 1024*1024 ;
1513 /* configuring RED */
1514 if ( x->flags_fs & DN_IS_RED )
1515 config_red(src, x) ; /* XXX should check errors */
1519 * setup pipe or queue parameters.
1523 config_pipe(struct dn_pipe *p)
1526 struct dn_flow_set *pfs = &(p->fs);
1527 struct dn_flow_queue *q;
1530 * The config program passes parameters as follows:
1531 * bw = bits/second (0 means no limits),
1532 * delay = ms, must be translated into ticks.
1533 * qsize = slots/bytes
1535 p->delay = ( p->delay * hz ) / 1000 ;
1536 /* We need either a pipe number or a flow_set number */
1537 if (p->pipe_nr == 0 && pfs->fs_nr == 0)
1539 if (p->pipe_nr != 0 && pfs->fs_nr != 0)
1541 if (p->pipe_nr != 0) { /* this is a pipe */
1542 struct dn_pipe *x, *a, *b;
1544 for (a = NULL , b = all_pipes ; b && b->pipe_nr < p->pipe_nr ;
1545 a = b , b = b->next) ;
1547 if (b == NULL || b->pipe_nr != p->pipe_nr) { /* new pipe */
1548 x = malloc(sizeof(struct dn_pipe), M_DUMMYNET, M_NOWAIT | M_ZERO);
1550 printf("ip_dummynet.c: no memory for new pipe\n");
1553 x->pipe_nr = p->pipe_nr;
1555 /* idle_heap is the only one from which we extract from the middle.
1557 x->idle_heap.size = x->idle_heap.elements = 0 ;
1558 x->idle_heap.offset=OFFSET_OF(struct dn_flow_queue, heap_pos);
1562 /* Flush accumulated credit for all queues */
1563 for (i = 0; i <= x->fs.rq_size; i++)
1564 for (q = x->fs.rq[i]; q; q = q->next)
1570 x->bandwidth = p->bandwidth ;
1571 x->numbytes = 0; /* just in case... */
1572 bcopy(p->if_name, x->if_name, sizeof(p->if_name) );
1573 x->ifp = NULL ; /* reset interface ptr */
1574 x->delay = p->delay ;
1575 set_fs_parms(&(x->fs), pfs);
1578 if ( x->fs.rq == NULL ) { /* a new pipe */
1579 s = alloc_hash(&(x->fs), pfs) ;
1581 free(x, M_DUMMYNET);
1591 } else { /* config queue */
1592 struct dn_flow_set *x, *a, *b ;
1594 /* locate flow_set */
1595 for (a=NULL, b=all_flow_sets ; b && b->fs_nr < pfs->fs_nr ;
1596 a = b , b = b->next) ;
1598 if (b == NULL || b->fs_nr != pfs->fs_nr) { /* new */
1599 if (pfs->parent_nr == 0) /* need link to a pipe */
1601 x = malloc(sizeof(struct dn_flow_set), M_DUMMYNET, M_NOWAIT|M_ZERO);
1603 printf("ip_dummynet.c: no memory for new flow_set\n");
1606 x->fs_nr = pfs->fs_nr;
1607 x->parent_nr = pfs->parent_nr;
1608 x->weight = pfs->weight ;
1611 else if (x->weight > 100)
1614 /* Change parent pipe not allowed; must delete and recreate */
1615 if (pfs->parent_nr != 0 && b->parent_nr != pfs->parent_nr)
1620 set_fs_parms(x, pfs);
1622 if ( x->rq == NULL ) { /* a new flow_set */
1623 s = alloc_hash(x, pfs) ;
1625 free(x, M_DUMMYNET);
1640 * Helper function to remove from a heap queues which are linked to
1641 * a flow_set about to be deleted.
1644 fs_remove_from_heap(struct dn_heap *h, struct dn_flow_set *fs)
1646 int i = 0, found = 0 ;
1647 for (; i < h->elements ;)
1648 if ( ((struct dn_flow_queue *)h->p[i].object)->fs == fs) {
1650 h->p[i] = h->p[h->elements] ;
1659 * helper function to remove a pipe from a heap (can be there at most once)
1662 pipe_remove_from_heap(struct dn_heap *h, struct dn_pipe *p)
1664 if (h->elements > 0) {
1666 for (i=0; i < h->elements ; i++ ) {
1667 if (h->p[i].object == p) { /* found it */
1669 h->p[i] = h->p[h->elements] ;
1678 * drain all queues. Called in case of severe mbuf shortage.
1683 struct dn_flow_set *fs;
1687 heap_free(&ready_heap);
1688 heap_free(&wfq_ready_heap);
1689 heap_free(&extract_heap);
1690 /* remove all references to this pipe from flow_sets */
1691 for (fs = all_flow_sets; fs; fs= fs->next )
1692 purge_flow_set(fs, 0);
1694 for (p = all_pipes; p; p= p->next ) {
1695 purge_flow_set(&(p->fs), 0);
1696 for (pkt = p->head ; pkt ; )
1698 p->head = p->tail = NULL ;
1703 * Fully delete a pipe or a queue, cleaning up associated info.
1706 delete_pipe(struct dn_pipe *p)
1710 if (p->pipe_nr == 0 && p->fs.fs_nr == 0)
1712 if (p->pipe_nr != 0 && p->fs.fs_nr != 0)
1714 if (p->pipe_nr != 0) { /* this is an old-style pipe */
1715 struct dn_pipe *a, *b;
1716 struct dn_flow_set *fs;
1719 for (a = NULL , b = all_pipes ; b && b->pipe_nr < p->pipe_nr ;
1720 a = b , b = b->next) ;
1721 if (b == NULL || (b->pipe_nr != p->pipe_nr) )
1722 return EINVAL ; /* not found */
1726 /* unlink from list of pipes */
1728 all_pipes = b->next ;
1731 /* remove references to this pipe from the ip_fw rules. */
1732 flush_pipe_ptrs(&(b->fs));
1734 /* remove all references to this pipe from flow_sets */
1735 for (fs = all_flow_sets; fs; fs= fs->next )
1736 if (fs->pipe == b) {
1737 printf("++ ref to pipe %d from fs %d\n",
1738 p->pipe_nr, fs->fs_nr);
1740 purge_flow_set(fs, 0);
1742 fs_remove_from_heap(&ready_heap, &(b->fs));
1743 purge_pipe(b); /* remove all data associated to this pipe */
1744 /* remove reference to here from extract_heap and wfq_ready_heap */
1745 pipe_remove_from_heap(&extract_heap, b);
1746 pipe_remove_from_heap(&wfq_ready_heap, b);
1748 free(b, M_DUMMYNET);
1749 } else { /* this is a WF2Q queue (dn_flow_set) */
1750 struct dn_flow_set *a, *b;
1753 for (a = NULL, b = all_flow_sets ; b && b->fs_nr < p->fs.fs_nr ;
1754 a = b , b = b->next) ;
1755 if (b == NULL || (b->fs_nr != p->fs.fs_nr) )
1756 return EINVAL ; /* not found */
1760 all_flow_sets = b->next ;
1763 /* remove references to this flow_set from the ip_fw rules. */
1766 if (b->pipe != NULL) {
1767 /* Update total weight on parent pipe and cleanup parent heaps */
1768 b->pipe->sum -= b->weight * b->backlogged ;
1769 fs_remove_from_heap(&(b->pipe->not_eligible_heap), b);
1770 fs_remove_from_heap(&(b->pipe->scheduler_heap), b);
1771 #if 1 /* XXX should i remove from idle_heap as well ? */
1772 fs_remove_from_heap(&(b->pipe->idle_heap), b);
1775 purge_flow_set(b, 1);
1782 * helper function used to copy data from kernel in DUMMYNET_GET
1785 dn_copy_set(struct dn_flow_set *set, char *bp)
1788 struct dn_flow_queue *q, *qp = (struct dn_flow_queue *)bp;
1790 for (i = 0 ; i <= set->rq_size ; i++)
1791 for (q = set->rq[i] ; q ; q = q->next, qp++ ) {
1792 if (q->hash_slot != i)
1793 printf("++ at %d: wrong slot (have %d, "
1794 "should be %d)\n", copied, q->hash_slot, i);
1796 printf("++ at %d: wrong fs ptr (have %p, should be %p)\n",
1799 bcopy(q, qp, sizeof( *q ) );
1800 /* cleanup pointers */
1802 qp->head = qp->tail = NULL ;
1805 if (copied != set->rq_elements)
1806 printf("++ wrong count, have %d should be %d\n",
1807 copied, set->rq_elements);
1812 dummynet_get(struct sockopt *sopt)
1814 char *buf, *bp ; /* bp is the "copy-pointer" */
1816 struct dn_flow_set *set ;
1822 * compute size of data structures: list of pipes and flow_sets.
1824 for (p = all_pipes, size = 0 ; p ; p = p->next )
1825 size += sizeof( *p ) +
1826 p->fs.rq_elements * sizeof(struct dn_flow_queue);
1827 for (set = all_flow_sets ; set ; set = set->next )
1828 size += sizeof ( *set ) +
1829 set->rq_elements * sizeof(struct dn_flow_queue);
1830 buf = malloc(size, M_TEMP, M_NOWAIT);
1835 for (p = all_pipes, bp = buf ; p ; p = p->next ) {
1836 struct dn_pipe *pipe_bp = (struct dn_pipe *)bp ;
1839 * copy pipe descriptor into *bp, convert delay back to ms,
1840 * then copy the flow_set descriptor(s) one at a time.
1841 * After each flow_set, copy the queue descriptor it owns.
1843 bcopy(p, bp, sizeof( *p ) );
1844 pipe_bp->delay = (pipe_bp->delay * 1000) / hz ;
1846 * XXX the following is a hack based on ->next being the
1847 * first field in dn_pipe and dn_flow_set. The correct
1848 * solution would be to move the dn_flow_set to the beginning
1849 * of struct dn_pipe.
1851 pipe_bp->next = (struct dn_pipe *)DN_IS_PIPE ;
1852 /* clean pointers */
1853 pipe_bp->head = pipe_bp->tail = NULL ;
1854 pipe_bp->fs.next = NULL ;
1855 pipe_bp->fs.pipe = NULL ;
1856 pipe_bp->fs.rq = NULL ;
1858 bp += sizeof( *p ) ;
1859 bp = dn_copy_set( &(p->fs), bp );
1861 for (set = all_flow_sets ; set ; set = set->next ) {
1862 struct dn_flow_set *fs_bp = (struct dn_flow_set *)bp ;
1863 bcopy(set, bp, sizeof( *set ) );
1864 /* XXX same hack as above */
1865 fs_bp->next = (struct dn_flow_set *)DN_IS_QUEUE ;
1866 fs_bp->pipe = NULL ;
1868 bp += sizeof( *set ) ;
1869 bp = dn_copy_set( set, bp );
1872 error = sooptcopyout(sopt, buf, size);
1878 * Handler for the various dummynet socket options (get, flush, config, del)
1881 ip_dn_ctl(struct sockopt *sopt)
1884 struct dn_pipe *p, tmp_pipe;
1886 /* Disallow sets in really-really secure mode. */
1887 if (sopt->sopt_dir == SOPT_SET) {
1888 #if defined(__FreeBSD__) && __FreeBSD_version >= 500034
1889 error = securelevel_ge(sopt->sopt_td->td_ucred, 3);
1893 if (securelevel >= 3)
1898 switch (sopt->sopt_name) {
1900 printf("ip_dn_ctl -- unknown option %d", sopt->sopt_name);
1903 case IP_DUMMYNET_GET :
1904 error = dummynet_get(sopt);
1907 case IP_DUMMYNET_FLUSH :
1911 case IP_DUMMYNET_CONFIGURE :
1913 error = sooptcopyin(sopt, p, sizeof *p, sizeof *p);
1916 error = config_pipe(p);
1919 case IP_DUMMYNET_DEL : /* remove a pipe or queue */
1921 error = sooptcopyin(sopt, p, sizeof *p, sizeof *p);
1925 error = delete_pipe(p);
1934 printf("DUMMYNET initialized (011031)\n");
1936 all_flow_sets = NULL ;
1937 ready_heap.size = ready_heap.elements = 0 ;
1938 ready_heap.offset = 0 ;
1940 wfq_ready_heap.size = wfq_ready_heap.elements = 0 ;
1941 wfq_ready_heap.offset = 0 ;
1943 extract_heap.size = extract_heap.elements = 0 ;
1944 extract_heap.offset = 0 ;
1945 ip_dn_ctl_ptr = ip_dn_ctl;
1946 ip_dn_io_ptr = dummynet_io;
1947 ip_dn_ruledel_ptr = dn_rule_delete;
1948 bzero(&dn_timeout, sizeof(struct callout_handle));
1949 dn_timeout = timeout(dummynet, NULL, 1);
1953 dummynet_modevent(module_t mod, int type, void *data)
1959 if (DUMMYNET_LOADED) {
1961 printf("DUMMYNET already loaded\n");
1969 #if !defined(KLD_MODULE)
1970 printf("dummynet statically compiled, cannot unload\n");
1974 untimeout(dummynet, NULL, dn_timeout);
1976 ip_dn_ctl_ptr = NULL;
1977 ip_dn_io_ptr = NULL;
1978 ip_dn_ruledel_ptr = NULL;
1988 static moduledata_t dummynet_mod = {
1993 DECLARE_MODULE(dummynet, dummynet_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
1994 MODULE_DEPEND(dummynet, ipfw, 1, 1, 1);
1995 MODULE_VERSION(dummynet, 1);