Import source code for dummynet innode emulation.
[ipfw.git] / dummynet / ip_dummynet.c
1 /*-
2  * Copyright (c) 1998-2002 Luigi Rizzo, Universita` di Pisa
3  * Portions Copyright (c) 2000 Akamba Corp.
4  * All rights reserved
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, 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.
14  *
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
25  * SUCH DAMAGE.
26  */
27
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD: src/sys/netinet/ip_dummynet.c,v 1.110.2.4 2008/10/31 12:58:12 oleg Exp $");
30
31 #define DUMMYNET_DEBUG
32
33 #include "opt_inet6.h"
34
35 /*
36  * This module implements IP dummynet, a bandwidth limiter/delay emulator
37  * used in conjunction with the ipfw package.
38  * Description of the data structures used is in ip_dummynet.h
39  * Here you mainly find the following blocks of code:
40  *  + variable declarations;
41  *  + heap management functions;
42  *  + scheduler and dummynet functions;
43  *  + configuration and initialization.
44  *
45  * NOTA BENE: critical sections are protected by the "dummynet lock".
46  *
47  * Most important Changes:
48  *
49  * 011004: KLDable
50  * 010124: Fixed WF2Q behaviour
51  * 010122: Fixed spl protection.
52  * 000601: WF2Q support
53  * 000106: large rewrite, use heaps to handle very many pipes.
54  * 980513:      initial release
55  *
56  * include files marked with XXX are probably not needed
57  */
58
59 #include <sys/limits.h>
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/malloc.h>
63 #include <sys/mbuf.h>
64 #include <sys/kernel.h>
65 #include <sys/lock.h>
66 #include <sys/module.h>
67 #include <sys/mutex.h>
68 #include <sys/priv.h>
69 #include <sys/proc.h>
70 #include <sys/socket.h>
71 #include <sys/socketvar.h>
72 #include <sys/time.h>
73 #include <sys/sysctl.h>
74 #include <sys/taskqueue.h>
75 #include <net/if.h>     /* IFNAMSIZ, struct ifaddr, ifq head */
76 #include <net/netisr.h>
77 #include <netinet/in.h>
78 #include <netinet/ip.h>         /* ip_len, ip_off */
79 #include <netinet/ip_fw.h>
80 #include <netinet/ip_dummynet.h>
81 #include <netinet/ip_var.h>     /* ip_output(), IP_FORWARDING */
82
83 #include <netinet/if_ether.h> /* various ether_* routines */
84
85 #include <netinet/ip6.h>       /* for ip6_input, ip6_output prototypes */
86 #include <netinet6/ip6_var.h>
87
88 #include "missing.h"
89 /*
90  * We keep a private variable for the simulation time, but we could
91  * probably use an existing one ("softticks" in sys/kern/kern_timeout.c)
92  */
93 static dn_key curr_time = 0 ; /* current simulation time */
94
95 static int dn_hash_size = 64 ;  /* default hash size */
96
97 /* statistics on number of queue searches and search steps */
98 static long searches, search_steps ;
99 static int pipe_expire = 1 ;   /* expire queue if empty */
100 static int dn_max_ratio = 16 ; /* max queues/buckets ratio */
101
102 static long pipe_slot_limit = 100; /* Foot shooting limit for pipe queues. */
103 static long pipe_byte_limit = 1024 * 1024;
104
105 static int red_lookup_depth = 256;      /* RED - default lookup table depth */
106 static int red_avg_pkt_size = 512;      /* RED - default medium packet size */
107 static int red_max_pkt_size = 1500;     /* RED - default max packet size */
108
109 static struct timeval prev_t, t;
110 static long tick_last;                  /* Last tick duration (usec). */
111 static long tick_delta;                 /* Last vs standard tick diff (usec). */
112 static long tick_delta_sum;             /* Accumulated tick difference (usec).*/
113 static long tick_adjustment;            /* Tick adjustments done. */
114 static long tick_lost;                  /* Lost(coalesced) ticks number. */
115 /* Adjusted vs non-adjusted curr_time difference (ticks). */
116 static long tick_diff;
117
118 static int              io_fast;
119 static unsigned long    io_pkt;
120 static unsigned long    io_pkt_fast;
121 static unsigned long    io_pkt_drop;
122
123 /*
124  * Three heaps contain queues and pipes that the scheduler handles:
125  *
126  * ready_heap contains all dn_flow_queue related to fixed-rate pipes.
127  *
128  * wfq_ready_heap contains the pipes associated with WF2Q flows
129  *
130  * extract_heap contains pipes associated with delay lines.
131  *
132  */
133
134 MALLOC_DEFINE(M_DUMMYNET, "dummynet", "dummynet heap");
135
136 static struct dn_heap ready_heap, extract_heap, wfq_ready_heap ;
137
138 static int      heap_init(struct dn_heap *h, int size);
139 static int      heap_insert (struct dn_heap *h, dn_key key1, void *p);
140 static void     heap_extract(struct dn_heap *h, void *obj);
141 static void     transmit_event(struct dn_pipe *pipe, struct mbuf **head,
142                     struct mbuf **tail);
143 static void     ready_event(struct dn_flow_queue *q, struct mbuf **head,
144                     struct mbuf **tail);
145 static void     ready_event_wfq(struct dn_pipe *p, struct mbuf **head,
146                     struct mbuf **tail);
147
148 #define HASHSIZE        16
149 #define HASH(num)       ((((num) >> 8) ^ ((num) >> 4) ^ (num)) & 0x0f)
150 static struct dn_pipe_head      pipehash[HASHSIZE];     /* all pipes */
151 static struct dn_flow_set_head  flowsethash[HASHSIZE];  /* all flowsets */
152
153 static struct callout dn_timeout;
154
155 extern  void (*bridge_dn_p)(struct mbuf *, struct ifnet *);
156
157 #ifdef SYSCTL_NODE
158 SYSCTL_DECL(_net_inet);
159 SYSCTL_DECL(_net_inet_ip);
160
161 SYSCTL_NODE(_net_inet_ip, OID_AUTO, dummynet, CTLFLAG_RW, 0, "Dummynet");
162 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, hash_size,
163     CTLFLAG_RW, &dn_hash_size, 0, "Default hash table size");
164 #if 0 /* curr_time is 64 bit */
165 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, curr_time,
166     CTLFLAG_RD, &curr_time, 0, "Current tick");
167 #endif
168 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, ready_heap,
169     CTLFLAG_RD, &ready_heap.size, 0, "Size of ready heap");
170 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, extract_heap,
171     CTLFLAG_RD, &extract_heap.size, 0, "Size of extract heap");
172 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, searches,
173     CTLFLAG_RD, &searches, 0, "Number of queue searches");
174 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, search_steps,
175     CTLFLAG_RD, &search_steps, 0, "Number of queue search steps");
176 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, expire,
177     CTLFLAG_RW, &pipe_expire, 0, "Expire queue if empty");
178 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, max_chain_len,
179     CTLFLAG_RW, &dn_max_ratio, 0,
180     "Max ratio between dynamic queues and buckets");
181 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_lookup_depth,
182     CTLFLAG_RD, &red_lookup_depth, 0, "Depth of RED lookup table");
183 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_avg_pkt_size,
184     CTLFLAG_RD, &red_avg_pkt_size, 0, "RED Medium packet size");
185 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_max_pkt_size,
186     CTLFLAG_RD, &red_max_pkt_size, 0, "RED Max packet size");
187 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_delta,
188     CTLFLAG_RD, &tick_delta, 0, "Last vs standard tick difference (usec).");
189 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_delta_sum,
190     CTLFLAG_RD, &tick_delta_sum, 0, "Accumulated tick difference (usec).");
191 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_adjustment,
192     CTLFLAG_RD, &tick_adjustment, 0, "Tick adjustments done.");
193 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_diff,
194     CTLFLAG_RD, &tick_diff, 0,
195     "Adjusted vs non-adjusted curr_time difference (ticks).");
196 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_lost,
197     CTLFLAG_RD, &tick_lost, 0,
198     "Number of ticks coalesced by dummynet taskqueue.");
199 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, io_fast,
200     CTLFLAG_RW, &io_fast, 0, "Enable fast dummynet io.");
201 SYSCTL_ULONG(_net_inet_ip_dummynet, OID_AUTO, io_pkt,
202     CTLFLAG_RD, &io_pkt, 0,
203     "Number of packets passed to dummynet.");
204 SYSCTL_ULONG(_net_inet_ip_dummynet, OID_AUTO, io_pkt_fast,
205     CTLFLAG_RD, &io_pkt_fast, 0,
206     "Number of packets bypassed dummynet scheduler.");
207 SYSCTL_ULONG(_net_inet_ip_dummynet, OID_AUTO, io_pkt_drop,
208     CTLFLAG_RD, &io_pkt_drop, 0,
209     "Number of packets dropped by dummynet.");
210 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, pipe_slot_limit,
211     CTLFLAG_RW, &pipe_slot_limit, 0, "Upper limit in slots for pipe queue.");
212 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, pipe_byte_limit,
213     CTLFLAG_RW, &pipe_byte_limit, 0, "Upper limit in bytes for pipe queue.");
214 #endif
215
216 #ifdef DUMMYNET_DEBUG
217 int     dummynet_debug = 0;
218 #ifdef SYSCTL_NODE
219 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, debug, CTLFLAG_RW, &dummynet_debug,
220             0, "control debugging printfs");
221 #endif
222 #define DPRINTF(X)      if (dummynet_debug) printf X
223 #else
224 #define DPRINTF(X)
225 #endif
226
227 static struct task      dn_task;
228 static struct taskqueue *dn_tq = NULL;
229 static void dummynet_task(void *, int);
230
231 #if defined( __linux__ ) || defined( _WIN32 )
232 static DEFINE_SPINLOCK(dummynet_mtx);
233 #else
234 static struct mtx dummynet_mtx;
235 #endif
236 #define DUMMYNET_LOCK_INIT() \
237         mtx_init(&dummynet_mtx, "dummynet", NULL, MTX_DEF)
238 #define DUMMYNET_LOCK_DESTROY() mtx_destroy(&dummynet_mtx)
239 #define DUMMYNET_LOCK()         mtx_lock(&dummynet_mtx)
240 #define DUMMYNET_UNLOCK()       mtx_unlock(&dummynet_mtx)
241 #define DUMMYNET_LOCK_ASSERT()  mtx_assert(&dummynet_mtx, MA_OWNED)
242
243 static int      config_pipe(struct dn_pipe *p);
244 static int      ip_dn_ctl(struct sockopt *sopt);
245
246 static void     dummynet(void *);
247 static void     dummynet_flush(void);
248 static void     dummynet_send(struct mbuf *);
249 void            dummynet_drain(void);
250 static ip_dn_io_t dummynet_io;
251 static void     dn_rule_delete(void *);
252
253 /*
254  * Heap management functions.
255  *
256  * In the heap, first node is element 0. Children of i are 2i+1 and 2i+2.
257  * Some macros help finding parent/children so we can optimize them.
258  *
259  * heap_init() is called to expand the heap when needed.
260  * Increment size in blocks of 16 entries.
261  * XXX failure to allocate a new element is a pretty bad failure
262  * as we basically stall a whole queue forever!!
263  * Returns 1 on error, 0 on success
264  */
265 #define HEAP_FATHER(x) ( ( (x) - 1 ) / 2 )
266 #define HEAP_LEFT(x) ( 2*(x) + 1 )
267 #define HEAP_IS_LEFT(x) ( (x) & 1 )
268 #define HEAP_RIGHT(x) ( 2*(x) + 2 )
269 #define HEAP_SWAP(a, b, buffer) { buffer = a ; a = b ; b = buffer ; }
270 #define HEAP_INCREMENT  15
271
272 static int
273 heap_init(struct dn_heap *h, int new_size)
274 {
275     struct dn_heap_entry *p;
276
277     if (h->size >= new_size ) {
278         printf("dummynet: %s, Bogus call, have %d want %d\n", __func__,
279                 h->size, new_size);
280         return 0 ;
281     }
282     new_size = (new_size + HEAP_INCREMENT ) & ~HEAP_INCREMENT ;
283     p = malloc(new_size * sizeof(*p), M_DUMMYNET, M_NOWAIT);
284     if (p == NULL) {
285         printf("dummynet: %s, resize %d failed\n", __func__, new_size );
286         return 1 ; /* error */
287     }
288     if (h->size > 0) {
289         bcopy(h->p, p, h->size * sizeof(*p) );
290         free(h->p, M_DUMMYNET);
291     }
292     h->p = p ;
293     h->size = new_size ;
294     return 0 ;
295 }
296
297 /*
298  * Insert element in heap. Normally, p != NULL, we insert p in
299  * a new position and bubble up. If p == NULL, then the element is
300  * already in place, and key is the position where to start the
301  * bubble-up.
302  * Returns 1 on failure (cannot allocate new heap entry)
303  *
304  * If offset > 0 the position (index, int) of the element in the heap is
305  * also stored in the element itself at the given offset in bytes.
306  */
307 #define SET_OFFSET(heap, node) \
308     if (heap->offset > 0) \
309             *((int *)((char *)(heap->p[node].object) + heap->offset)) = node ;
310 /*
311  * RESET_OFFSET is used for sanity checks. It sets offset to an invalid value.
312  */
313 #define RESET_OFFSET(heap, node) \
314     if (heap->offset > 0) \
315             *((int *)((char *)(heap->p[node].object) + heap->offset)) = -1 ;
316 static int
317 heap_insert(struct dn_heap *h, dn_key key1, void *p)
318 {
319     int son = h->elements ;
320
321     if (p == NULL)      /* data already there, set starting point */
322         son = key1 ;
323     else {              /* insert new element at the end, possibly resize */
324         son = h->elements ;
325         if (son == h->size) /* need resize... */
326             if (heap_init(h, h->elements+1) )
327                 return 1 ; /* failure... */
328         h->p[son].object = p ;
329         h->p[son].key = key1 ;
330         h->elements++ ;
331     }
332     while (son > 0) {                           /* bubble up */
333         int father = HEAP_FATHER(son) ;
334         struct dn_heap_entry tmp  ;
335
336         if (DN_KEY_LT( h->p[father].key, h->p[son].key ) )
337             break ; /* found right position */
338         /* son smaller than father, swap and repeat */
339         HEAP_SWAP(h->p[son], h->p[father], tmp) ;
340         SET_OFFSET(h, son);
341         son = father ;
342     }
343     SET_OFFSET(h, son);
344     return 0 ;
345 }
346
347 /*
348  * remove top element from heap, or obj if obj != NULL
349  */
350 static void
351 heap_extract(struct dn_heap *h, void *obj)
352 {
353     int child, father, max = h->elements - 1 ;
354
355     if (max < 0) {
356         printf("dummynet: warning, extract from empty heap 0x%p\n", h);
357         return ;
358     }
359     father = 0 ; /* default: move up smallest child */
360     if (obj != NULL) { /* extract specific element, index is at offset */
361         if (h->offset <= 0)
362             panic("dummynet: heap_extract from middle not supported on this heap!!!\n");
363         father = *((int *)((char *)obj + h->offset)) ;
364         if (father < 0 || father >= h->elements) {
365             printf("dummynet: heap_extract, father %d out of bound 0..%d\n",
366                 father, h->elements);
367             panic("dummynet: heap_extract");
368         }
369     }
370     RESET_OFFSET(h, father);
371     child = HEAP_LEFT(father) ;         /* left child */
372     while (child <= max) {              /* valid entry */
373         if (child != max && DN_KEY_LT(h->p[child+1].key, h->p[child].key) )
374             child = child+1 ;           /* take right child, otherwise left */
375         h->p[father] = h->p[child] ;
376         SET_OFFSET(h, father);
377         father = child ;
378         child = HEAP_LEFT(child) ;   /* left child for next loop */
379     }
380     h->elements-- ;
381     if (father != max) {
382         /*
383          * Fill hole with last entry and bubble up, reusing the insert code
384          */
385         h->p[father] = h->p[max] ;
386         heap_insert(h, father, NULL); /* this one cannot fail */
387     }
388 }
389
390 #if 0
391 /*
392  * change object position and update references
393  * XXX this one is never used!
394  */
395 static void
396 heap_move(struct dn_heap *h, dn_key new_key, void *object)
397 {
398     int temp;
399     int i ;
400     int max = h->elements-1 ;
401     struct dn_heap_entry buf ;
402
403     if (h->offset <= 0)
404         panic("cannot move items on this heap");
405
406     i = *((int *)((char *)object + h->offset));
407     if (DN_KEY_LT(new_key, h->p[i].key) ) { /* must move up */
408         h->p[i].key = new_key ;
409         for (; i>0 && DN_KEY_LT(new_key, h->p[(temp = HEAP_FATHER(i))].key) ;
410                  i = temp ) { /* bubble up */
411             HEAP_SWAP(h->p[i], h->p[temp], buf) ;
412             SET_OFFSET(h, i);
413         }
414     } else {            /* must move down */
415         h->p[i].key = new_key ;
416         while ( (temp = HEAP_LEFT(i)) <= max ) { /* found left child */
417             if ((temp != max) && DN_KEY_GT(h->p[temp].key, h->p[temp+1].key))
418                 temp++ ; /* select child with min key */
419             if (DN_KEY_GT(new_key, h->p[temp].key)) { /* go down */
420                 HEAP_SWAP(h->p[i], h->p[temp], buf) ;
421                 SET_OFFSET(h, i);
422             } else
423                 break ;
424             i = temp ;
425         }
426     }
427     SET_OFFSET(h, i);
428 }
429 #endif /* heap_move, unused */
430
431 /*
432  * heapify() will reorganize data inside an array to maintain the
433  * heap property. It is needed when we delete a bunch of entries.
434  */
435 static void
436 heapify(struct dn_heap *h)
437 {
438     int i ;
439
440     for (i = 0 ; i < h->elements ; i++ )
441         heap_insert(h, i , NULL) ;
442 }
443
444 /*
445  * cleanup the heap and free data structure
446  */
447 static void
448 heap_free(struct dn_heap *h)
449 {
450     if (h->size >0 )
451         free(h->p, M_DUMMYNET);
452     bzero(h, sizeof(*h) );
453 }
454
455 /*
456  * --- end of heap management functions ---
457  */
458
459 /*
460  * Return the mbuf tag holding the dummynet state.  As an optimization
461  * this is assumed to be the first tag on the list.  If this turns out
462  * wrong we'll need to search the list.
463  */
464 static struct dn_pkt_tag *
465 dn_tag_get(struct mbuf *m)
466 {
467     struct m_tag *mtag = m_tag_first(m);
468     KASSERT(mtag != NULL &&
469             mtag->m_tag_cookie == MTAG_ABI_COMPAT &&
470             mtag->m_tag_id == PACKET_TAG_DUMMYNET,
471             ("packet on dummynet queue w/o dummynet tag!"));
472     return (struct dn_pkt_tag *)(mtag+1);
473 }
474
475 /*
476  * Scheduler functions:
477  *
478  * transmit_event() is called when the delay-line needs to enter
479  * the scheduler, either because of existing pkts getting ready,
480  * or new packets entering the queue. The event handled is the delivery
481  * time of the packet.
482  *
483  * ready_event() does something similar with fixed-rate queues, and the
484  * event handled is the finish time of the head pkt.
485  *
486  * wfq_ready_event() does something similar with WF2Q queues, and the
487  * event handled is the start time of the head pkt.
488  *
489  * In all cases, we make sure that the data structures are consistent
490  * before passing pkts out, because this might trigger recursive
491  * invocations of the procedures.
492  */
493 static void
494 transmit_event(struct dn_pipe *pipe, struct mbuf **head, struct mbuf **tail)
495 {
496         struct mbuf *m;
497         struct dn_pkt_tag *pkt;
498
499         DUMMYNET_LOCK_ASSERT();
500
501         while ((m = pipe->head) != NULL) {
502                 pkt = dn_tag_get(m);
503                 if (!DN_KEY_LEQ(pkt->output_time, curr_time))
504                         break;
505
506                 pipe->head = m->m_nextpkt;
507                 if (*tail != NULL)
508                         (*tail)->m_nextpkt = m;
509                 else
510                         *head = m;
511                 *tail = m;
512         }
513         if (*tail != NULL)
514                 (*tail)->m_nextpkt = NULL;
515
516         /* If there are leftover packets, put into the heap for next event. */
517         if ((m = pipe->head) != NULL) {
518                 pkt = dn_tag_get(m);
519                 /*
520                  * XXX Should check errors on heap_insert, by draining the
521                  * whole pipe p and hoping in the future we are more successful.
522                  */
523                 heap_insert(&extract_heap, pkt->output_time, pipe);
524         }
525 }
526
527 #ifndef __linux__
528 #define div64(a, b)     ((int64_t)(a) / (int64_t)(b))
529 #endif
530 #define DN_TO_DROP      0xffff
531 /*
532  * Compute how many ticks we have to wait before being able to send
533  * a packet. This is computed as the "wire time" for the packet
534  * (length + extra bits), minus the credit available, scaled to ticks.
535  * Check that the result is not be negative (it could be if we have
536  * too much leftover credit in q->numbytes).
537  */
538 static inline dn_key
539 set_ticks(struct mbuf *m, struct dn_flow_queue *q, struct dn_pipe *p)
540 {
541         int64_t ret;
542
543         ret = div64( (m->m_pkthdr.len * 8 + q->extra_bits) * hz
544                 - q->numbytes + p->bandwidth - 1 , p->bandwidth);
545 #if 0
546         printf("%s %d extra_bits %d numb %d ret %d\n",
547                 __FUNCTION__, __LINE__,
548                 (int)(q->extra_bits & 0xffffffff),
549                 (int)(q->numbytes & 0xffffffff),
550                 (int)(ret & 0xffffffff));
551 #endif
552         if (ret < 0)
553                 ret = 0;
554         return ret;
555 }
556
557 /*
558  * Convert the additional MAC overheads/delays into an equivalent
559  * number of bits for the given data rate. The samples are in milliseconds
560  * so we need to divide by 1000.
561  */
562 static dn_key
563 compute_extra_bits(struct mbuf *pkt, struct dn_pipe *p)
564 {
565         int index;
566         dn_key extra_bits;
567
568         if (!p->samples || p->samples_no == 0)
569                 return 0;
570         index  = random() % p->samples_no;
571         extra_bits = div64((dn_key)p->samples[index] * p->bandwidth, 1000);
572         if (index >= p->loss_level) {
573                 struct dn_pkt_tag *dt = dn_tag_get(pkt);
574                 if (dt)
575                         dt->dn_dir = DN_TO_DROP;
576         }
577         return extra_bits;
578 }
579
580 static void
581 free_pipe(struct dn_pipe *p)
582 {
583         if (p->samples)
584                 free(p->samples, M_DUMMYNET);
585         free(p, M_DUMMYNET);
586 }
587
588 /*
589  * extract pkt from queue, compute output time (could be now)
590  * and put into delay line (p_queue)
591  */
592 static void
593 move_pkt(struct mbuf *pkt, struct dn_flow_queue *q, struct dn_pipe *p,
594     int len)
595 {
596     struct dn_pkt_tag *dt = dn_tag_get(pkt);
597
598     q->head = pkt->m_nextpkt ;
599     q->len-- ;
600     q->len_bytes -= len ;
601
602     dt->output_time = curr_time + p->delay ;
603
604     if (p->head == NULL)
605         p->head = pkt;
606     else
607         p->tail->m_nextpkt = pkt;
608     p->tail = pkt;
609     p->tail->m_nextpkt = NULL;
610 }
611
612 /*
613  * ready_event() is invoked every time the queue must enter the
614  * scheduler, either because the first packet arrives, or because
615  * a previously scheduled event fired.
616  * On invokation, drain as many pkts as possible (could be 0) and then
617  * if there are leftover packets reinsert the pkt in the scheduler.
618  */
619 static void
620 ready_event(struct dn_flow_queue *q, struct mbuf **head, struct mbuf **tail)
621 {
622         struct mbuf *pkt;
623         struct dn_pipe *p = q->fs->pipe;
624         int p_was_empty;
625
626         DUMMYNET_LOCK_ASSERT();
627
628         if (p == NULL) {
629                 printf("dummynet: ready_event- pipe is gone\n");
630                 return;
631         }
632         p_was_empty = (p->head == NULL);
633
634         /*
635          * Schedule fixed-rate queues linked to this pipe:
636          * account for the bw accumulated since last scheduling, then
637          * drain as many pkts as allowed by q->numbytes and move to
638          * the delay line (in p) computing output time.
639          * bandwidth==0 (no limit) means we can drain the whole queue,
640          * setting len_scaled = 0 does the job.
641          */
642         q->numbytes += (curr_time - q->sched_time) * p->bandwidth;
643         while ((pkt = q->head) != NULL) {
644                 int len = pkt->m_pkthdr.len;
645                 dn_key len_scaled = p->bandwidth ? len*8*hz
646                         + q->extra_bits*hz
647                         : 0;
648
649                 if (DN_KEY_GT(len_scaled, q->numbytes))
650                         break;
651                 q->numbytes -= len_scaled;
652                 move_pkt(pkt, q, p, len);
653                 if (q->head)
654                         q->extra_bits = compute_extra_bits(q->head, p);
655         }
656         /*
657          * If we have more packets queued, schedule next ready event
658          * (can only occur when bandwidth != 0, otherwise we would have
659          * flushed the whole queue in the previous loop).
660          * To this purpose we record the current time and compute how many
661          * ticks to go for the finish time of the packet.
662          */
663         if ((pkt = q->head) != NULL) {  /* this implies bandwidth != 0 */
664                 dn_key t = set_ticks(pkt, q, p); /* ticks i have to wait */
665
666                 q->sched_time = curr_time;
667                 heap_insert(&ready_heap, curr_time + t, (void *)q);
668                 /*
669                  * XXX Should check errors on heap_insert, and drain the whole
670                  * queue on error hoping next time we are luckier.
671                  */
672         } else          /* RED needs to know when the queue becomes empty. */
673                 q->q_time = curr_time;
674
675         /*
676          * If the delay line was empty call transmit_event() now.
677          * Otherwise, the scheduler will take care of it.
678          */
679         if (p_was_empty)
680                 transmit_event(p, head, tail);
681 }
682
683 /*
684  * Called when we can transmit packets on WF2Q queues. Take pkts out of
685  * the queues at their start time, and enqueue into the delay line.
686  * Packets are drained until p->numbytes < 0. As long as
687  * len_scaled >= p->numbytes, the packet goes into the delay line
688  * with a deadline p->delay. For the last packet, if p->numbytes < 0,
689  * there is an additional delay.
690  */
691 static void
692 ready_event_wfq(struct dn_pipe *p, struct mbuf **head, struct mbuf **tail)
693 {
694         int p_was_empty = (p->head == NULL);
695         struct dn_heap *sch = &(p->scheduler_heap);
696         struct dn_heap *neh = &(p->not_eligible_heap);
697         int64_t p_numbytes = p->numbytes;
698
699         DUMMYNET_LOCK_ASSERT();
700
701         if (p->if_name[0] == 0)         /* tx clock is simulated */
702                 /*
703                  * Since result may not fit into p->numbytes (32bit) we
704                  * are using 64bit var here.
705                  */
706                 p_numbytes += (curr_time - p->sched_time) * p->bandwidth;
707         else {  /*
708                  * tx clock is for real,
709                  * the ifq must be empty or this is a NOP.
710                  * XXX not supported in Linux
711                  */
712                 if (1) // p->ifp && p->ifp->if_snd.ifq_head != NULL)
713                         return;
714                 else {
715                         DPRINTF(("dummynet: pipe %d ready from %s --\n",
716                             p->pipe_nr, p->if_name));
717                 }
718         }
719
720         /*
721          * While we have backlogged traffic AND credit, we need to do
722          * something on the queue.
723          */
724         while (p_numbytes >= 0 && (sch->elements > 0 || neh->elements > 0)) {
725                 if (sch->elements > 0) {
726                         /* Have some eligible pkts to send out. */
727                         struct dn_flow_queue *q = sch->p[0].object;
728                         struct mbuf *pkt = q->head;
729                         struct dn_flow_set *fs = q->fs;
730                         uint64_t len = pkt->m_pkthdr.len;
731                         int len_scaled = p->bandwidth ? len * 8 * hz : 0;
732
733                         heap_extract(sch, NULL); /* Remove queue from heap. */
734                         p_numbytes -= len_scaled;
735                         move_pkt(pkt, q, p, len);
736
737                         p->V += div64((len << MY_M), p->sum);   /* Update V. */
738                         q->S = q->F;                    /* Update start time. */
739                         if (q->len == 0) {
740                                 /* Flow not backlogged any more. */
741                                 fs->backlogged--;
742                                 heap_insert(&(p->idle_heap), q->F, q);
743                         } else {
744                                 /* Still backlogged. */
745
746                                 /*
747                                  * Update F and position in backlogged queue,
748                                  * then put flow in not_eligible_heap
749                                  * (we will fix this later).
750                                  */
751                                 len = (q->head)->m_pkthdr.len;
752                                 q->F += div64((len << MY_M), fs->weight);
753                                 if (DN_KEY_LEQ(q->S, p->V))
754                                         heap_insert(neh, q->S, q);
755                                 else
756                                         heap_insert(sch, q->F, q);
757                         }
758                 }
759                 /*
760                  * Now compute V = max(V, min(S_i)). Remember that all elements
761                  * in sch have by definition S_i <= V so if sch is not empty,
762                  * V is surely the max and we must not update it. Conversely,
763                  * if sch is empty we only need to look at neh.
764                  */
765                 if (sch->elements == 0 && neh->elements > 0)
766                         p->V = MAX64(p->V, neh->p[0].key);
767                 /* Move from neh to sch any packets that have become eligible */
768                 while (neh->elements > 0 && DN_KEY_LEQ(neh->p[0].key, p->V)) {
769                         struct dn_flow_queue *q = neh->p[0].object;
770                         heap_extract(neh, NULL);
771                         heap_insert(sch, q->F, q);
772                 }
773
774                 if (p->if_name[0] != '\0') { /* Tx clock is from a real thing */
775                         p_numbytes = -1;        /* Mark not ready for I/O. */
776                         break;
777                 }
778         }
779         if (sch->elements == 0 && neh->elements == 0 && p_numbytes >= 0 &&
780             p->idle_heap.elements > 0) {
781                 /*
782                  * No traffic and no events scheduled.
783                  * We can get rid of idle-heap.
784                  */
785                 int i;
786
787                 for (i = 0; i < p->idle_heap.elements; i++) {
788                         struct dn_flow_queue *q = p->idle_heap.p[i].object;
789
790                         q->F = 0;
791                         q->S = q->F + 1;
792                 }
793                 p->sum = 0;
794                 p->V = 0;
795                 p->idle_heap.elements = 0;
796         }
797         /*
798          * If we are getting clocks from dummynet (not a real interface) and
799          * If we are under credit, schedule the next ready event.
800          * Also fix the delivery time of the last packet.
801          */
802         if (p->if_name[0]==0 && p_numbytes < 0) { /* This implies bw > 0. */
803                 dn_key t = 0;           /* Number of ticks i have to wait. */
804
805                 if (p->bandwidth > 0)
806                         t = div64(p->bandwidth - 1 - p_numbytes, p->bandwidth);
807                 dn_tag_get(p->tail)->output_time += t;
808                 p->sched_time = curr_time;
809                 heap_insert(&wfq_ready_heap, curr_time + t, (void *)p);
810                 /*
811                  * XXX Should check errors on heap_insert, and drain the whole
812                  * queue on error hoping next time we are luckier.
813                  */
814         }
815
816         /* Fit (adjust if necessary) 64bit result into 32bit variable. */
817         if (p_numbytes > INT_MAX)
818                 p->numbytes = INT_MAX;
819         else if (p_numbytes < INT_MIN)
820                 p->numbytes = INT_MIN;
821         else
822                 p->numbytes = p_numbytes;
823
824         /*
825          * If the delay line was empty call transmit_event() now.
826          * Otherwise, the scheduler will take care of it.
827          */
828         if (p_was_empty)
829                 transmit_event(p, head, tail);
830 }
831
832 /*
833  * This is called one tick, after previous run. It is used to
834  * schedule next run.
835  */
836 static void
837 dummynet(void * __unused unused)
838 {
839
840         taskqueue_enqueue(dn_tq, &dn_task);
841 }
842
843 /*
844  * The main dummynet processing function.
845  */
846 static void
847 dummynet_task(void *context, int pending)
848 {
849         struct mbuf *head = NULL, *tail = NULL;
850         struct dn_pipe *pipe;
851         struct dn_heap *heaps[3];
852         struct dn_heap *h;
853         void *p;        /* generic parameter to handler */
854         int i;
855
856         DUMMYNET_LOCK();
857
858         heaps[0] = &ready_heap;                 /* fixed-rate queues */
859         heaps[1] = &wfq_ready_heap;             /* wfq queues */
860         heaps[2] = &extract_heap;               /* delay line */
861
862         /* Update number of lost(coalesced) ticks. */
863         tick_lost += pending - 1;
864  
865         getmicrouptime(&t);
866         /* Last tick duration (usec). */
867         tick_last = (t.tv_sec - prev_t.tv_sec) * 1000000 +
868             (t.tv_usec - prev_t.tv_usec);
869         /* Last tick vs standard tick difference (usec). */
870         tick_delta = (tick_last * hz - 1000000) / hz;
871         /* Accumulated tick difference (usec). */
872         tick_delta_sum += tick_delta;
873  
874         prev_t = t;
875  
876         /*
877          * Adjust curr_time if accumulated tick difference greater than
878          * 'standard' tick. Since curr_time should be monotonically increasing,
879          * we do positive adjustment as required and throttle curr_time in
880          * case of negative adjustment.
881          */
882         curr_time++;
883         if (tick_delta_sum - tick >= 0) {
884                 int diff = tick_delta_sum / tick;
885  
886                 curr_time += diff;
887                 tick_diff += diff;
888                 tick_delta_sum %= tick;
889                 tick_adjustment++;
890         } else if (tick_delta_sum + tick <= 0) {
891                 curr_time--;
892                 tick_diff--;
893                 tick_delta_sum += tick;
894                 tick_adjustment++;
895         }
896
897         for (i = 0; i < 3; i++) {
898                 h = heaps[i];
899                 while (h->elements > 0 && DN_KEY_LEQ(h->p[0].key, curr_time)) {
900                         if (h->p[0].key > curr_time)
901                                 printf("dummynet: warning, "
902                                     "heap %d is %d ticks late\n",
903                                     i, (int)(curr_time - h->p[0].key));
904                         /* store a copy before heap_extract */
905                         p = h->p[0].object;
906                         /* need to extract before processing */
907                         heap_extract(h, NULL);
908                         if (i == 0)
909                                 ready_event(p, &head, &tail);
910                         else if (i == 1) {
911                                 struct dn_pipe *pipe = p;
912                                 if (pipe->if_name[0] != '\0')
913                                         printf("dummynet: bad ready_event_wfq "
914                                             "for pipe %s\n", pipe->if_name);
915                                 else
916                                         ready_event_wfq(p, &head, &tail);
917                         } else
918                                 transmit_event(p, &head, &tail);
919                 }
920         }
921
922         /* Sweep pipes trying to expire idle flow_queues. */
923         for (i = 0; i < HASHSIZE; i++)
924                 SLIST_FOREACH(pipe, &pipehash[i], next)
925                         if (pipe->idle_heap.elements > 0 &&
926                             DN_KEY_LT(pipe->idle_heap.p[0].key, pipe->V)) {
927                                 struct dn_flow_queue *q =
928                                     pipe->idle_heap.p[0].object;
929
930                                 heap_extract(&(pipe->idle_heap), NULL);
931                                 /* Mark timestamp as invalid. */
932                                 q->S = q->F + 1;
933                                 pipe->sum -= q->fs->weight;
934                         }
935
936         DUMMYNET_UNLOCK();
937
938         if (head != NULL)
939                 dummynet_send(head);
940
941         callout_reset(&dn_timeout, 1, dummynet, NULL);
942 }
943
944 static void
945 dummynet_send(struct mbuf *m)
946 {
947         struct dn_pkt_tag *pkt;
948         struct mbuf *n;
949         struct ip *ip;
950         int dst;
951
952         for (; m != NULL; m = n) {
953                 n = m->m_nextpkt;
954                 m->m_nextpkt = NULL;
955                 if (m_tag_first(m) == NULL) {
956                         pkt = NULL; /* probably unnecessary */
957                         dst = DN_TO_DROP;
958                 } else {
959                         pkt = dn_tag_get(m);
960                         dst = pkt->dn_dir;
961                 }
962                 switch (dst) {
963                 case DN_TO_IP_OUT:
964                         ip_output(m, NULL, NULL, IP_FORWARDING, NULL, NULL);
965                         break ;
966                 case DN_TO_IP_IN :
967                         ip = mtod(m, struct ip *);
968 #ifndef __linux__       /* restore net format for FreeBSD */
969                         ip->ip_len = htons(ip->ip_len);
970                         ip->ip_off = htons(ip->ip_off);
971 #endif
972                         netisr_dispatch(NETISR_IP, m);
973                         break;
974 #ifdef INET6
975                 case DN_TO_IP6_IN:
976                         netisr_dispatch(NETISR_IPV6, m);
977                         break;
978
979                 case DN_TO_IP6_OUT:
980                         ip6_output(m, NULL, NULL, IPV6_FORWARDING, NULL, NULL, NULL);
981                         break;
982 #endif
983                 case DN_TO_IFB_FWD:
984                         if (bridge_dn_p != NULL)
985                                 ((*bridge_dn_p)(m, pkt->ifp));
986                         else
987                                 printf("dummynet: if_bridge not loaded\n");
988
989                         break;
990                 case DN_TO_ETH_DEMUX:
991                         /*
992                          * The Ethernet code assumes the Ethernet header is
993                          * contiguous in the first mbuf header.
994                          * Insure this is true.
995                          */
996                         if (m->m_len < ETHER_HDR_LEN &&
997                             (m = m_pullup(m, ETHER_HDR_LEN)) == NULL) {
998                                 printf("dummynet/ether: pullup failed, "
999                                     "dropping packet\n");
1000                                 break;
1001                         }
1002                         ether_demux(m->m_pkthdr.rcvif, m);
1003                         break;
1004                 case DN_TO_ETH_OUT:
1005                         ether_output_frame(pkt->ifp, m);
1006                         break;
1007
1008                 case DN_TO_DROP:
1009                         /* drop the packet after some time */
1010 #ifdef __linux__
1011                         netisr_dispatch(-1, m); /* -1 drop the packet */
1012 #else
1013                         m_freem(m);
1014 #endif
1015                         printf("need to drop the skbuf\n");
1016                         break;
1017
1018                 default:
1019                         printf("dummynet: bad switch %d!\n", pkt->dn_dir);
1020                         m_freem(m);
1021                         break;
1022                 }
1023         }
1024 }
1025
1026 /*
1027  * Unconditionally expire empty queues in case of shortage.
1028  * Returns the number of queues freed.
1029  */
1030 static int
1031 expire_queues(struct dn_flow_set *fs)
1032 {
1033     struct dn_flow_queue *q, *prev ;
1034     int i, initial_elements = fs->rq_elements ;
1035
1036     if (fs->last_expired == time_uptime)
1037         return 0 ;
1038     fs->last_expired = time_uptime ;
1039     for (i = 0 ; i <= fs->rq_size ; i++) /* last one is overflow */
1040         for (prev=NULL, q = fs->rq[i] ; q != NULL ; )
1041             if (q->head != NULL || q->S != q->F+1) {
1042                 prev = q ;
1043                 q = q->next ;
1044             } else { /* entry is idle, expire it */
1045                 struct dn_flow_queue *old_q = q ;
1046
1047                 if (prev != NULL)
1048                     prev->next = q = q->next ;
1049                 else
1050                     fs->rq[i] = q = q->next ;
1051                 fs->rq_elements-- ;
1052                 free(old_q, M_DUMMYNET);
1053             }
1054     return initial_elements - fs->rq_elements ;
1055 }
1056
1057 /*
1058  * If room, create a new queue and put at head of slot i;
1059  * otherwise, create or use the default queue.
1060  */
1061 static struct dn_flow_queue *
1062 create_queue(struct dn_flow_set *fs, int i)
1063 {
1064         struct dn_flow_queue *q;
1065
1066         if (fs->rq_elements > fs->rq_size * dn_max_ratio &&
1067             expire_queues(fs) == 0) {
1068                 /* No way to get room, use or create overflow queue. */
1069                 i = fs->rq_size;
1070                 if (fs->rq[i] != NULL)
1071                     return fs->rq[i];
1072         }
1073         q = malloc(sizeof(*q), M_DUMMYNET, M_NOWAIT | M_ZERO);
1074         if (q == NULL) {
1075                 printf("dummynet: sorry, cannot allocate queue for new flow\n");
1076                 return (NULL);
1077         }
1078         q->fs = fs;
1079         q->hash_slot = i;
1080         q->next = fs->rq[i];
1081         q->S = q->F + 1;        /* hack - mark timestamp as invalid. */
1082         q->numbytes = io_fast ? fs->pipe->bandwidth : 0;
1083         fs->rq[i] = q;
1084         fs->rq_elements++;
1085         return (q);
1086 }
1087
1088 /*
1089  * Given a flow_set and a pkt in last_pkt, find a matching queue
1090  * after appropriate masking. The queue is moved to front
1091  * so that further searches take less time.
1092  */
1093 static struct dn_flow_queue *
1094 find_queue(struct dn_flow_set *fs, struct ipfw_flow_id *id)
1095 {
1096     int i = 0 ; /* we need i and q for new allocations */
1097     struct dn_flow_queue *q, *prev;
1098     int is_v6 = IS_IP6_FLOW_ID(id);
1099
1100     if ( !(fs->flags_fs & DN_HAVE_FLOW_MASK) )
1101         q = fs->rq[0] ;
1102     else {
1103         /* first, do the masking, then hash */
1104         id->dst_port &= fs->flow_mask.dst_port ;
1105         id->src_port &= fs->flow_mask.src_port ;
1106         id->proto &= fs->flow_mask.proto ;
1107         id->flags = 0 ; /* we don't care about this one */
1108         if (is_v6) {
1109             APPLY_MASK(&id->dst_ip6, &fs->flow_mask.dst_ip6);
1110             APPLY_MASK(&id->src_ip6, &fs->flow_mask.src_ip6);
1111             id->flow_id6 &= fs->flow_mask.flow_id6;
1112
1113             i = ((id->dst_ip6.__u6_addr.__u6_addr32[0]) & 0xffff)^
1114                 ((id->dst_ip6.__u6_addr.__u6_addr32[1]) & 0xffff)^
1115                 ((id->dst_ip6.__u6_addr.__u6_addr32[2]) & 0xffff)^
1116                 ((id->dst_ip6.__u6_addr.__u6_addr32[3]) & 0xffff)^
1117
1118                 ((id->dst_ip6.__u6_addr.__u6_addr32[0] >> 15) & 0xffff)^
1119                 ((id->dst_ip6.__u6_addr.__u6_addr32[1] >> 15) & 0xffff)^
1120                 ((id->dst_ip6.__u6_addr.__u6_addr32[2] >> 15) & 0xffff)^
1121                 ((id->dst_ip6.__u6_addr.__u6_addr32[3] >> 15) & 0xffff)^
1122
1123                 ((id->src_ip6.__u6_addr.__u6_addr32[0] << 1) & 0xfffff)^
1124                 ((id->src_ip6.__u6_addr.__u6_addr32[1] << 1) & 0xfffff)^
1125                 ((id->src_ip6.__u6_addr.__u6_addr32[2] << 1) & 0xfffff)^
1126                 ((id->src_ip6.__u6_addr.__u6_addr32[3] << 1) & 0xfffff)^
1127
1128                 ((id->src_ip6.__u6_addr.__u6_addr32[0] << 16) & 0xffff)^
1129                 ((id->src_ip6.__u6_addr.__u6_addr32[1] << 16) & 0xffff)^
1130                 ((id->src_ip6.__u6_addr.__u6_addr32[2] << 16) & 0xffff)^
1131                 ((id->src_ip6.__u6_addr.__u6_addr32[3] << 16) & 0xffff)^
1132
1133                 (id->dst_port << 1) ^ (id->src_port) ^
1134                 (id->proto ) ^
1135                 (id->flow_id6);
1136         } else {
1137             id->dst_ip &= fs->flow_mask.dst_ip ;
1138             id->src_ip &= fs->flow_mask.src_ip ;
1139
1140             i = ( (id->dst_ip) & 0xffff ) ^
1141                 ( (id->dst_ip >> 15) & 0xffff ) ^
1142                 ( (id->src_ip << 1) & 0xffff ) ^
1143                 ( (id->src_ip >> 16 ) & 0xffff ) ^
1144                 (id->dst_port << 1) ^ (id->src_port) ^
1145                 (id->proto );
1146         }
1147         i = i % fs->rq_size ;
1148         /* finally, scan the current list for a match */
1149         searches++ ;
1150         for (prev=NULL, q = fs->rq[i] ; q ; ) {
1151             search_steps++;
1152             if (is_v6 &&
1153                     IN6_ARE_ADDR_EQUAL(&id->dst_ip6,&q->id.dst_ip6) &&  
1154                     IN6_ARE_ADDR_EQUAL(&id->src_ip6,&q->id.src_ip6) &&  
1155                     id->dst_port == q->id.dst_port &&
1156                     id->src_port == q->id.src_port &&
1157                     id->proto == q->id.proto &&
1158                     id->flags == q->id.flags &&
1159                     id->flow_id6 == q->id.flow_id6)
1160                 break ; /* found */
1161
1162             if (!is_v6 && id->dst_ip == q->id.dst_ip &&
1163                     id->src_ip == q->id.src_ip &&
1164                     id->dst_port == q->id.dst_port &&
1165                     id->src_port == q->id.src_port &&
1166                     id->proto == q->id.proto &&
1167                     id->flags == q->id.flags)
1168                 break ; /* found */
1169
1170             /* No match. Check if we can expire the entry */
1171             if (pipe_expire && q->head == NULL && q->S == q->F+1 ) {
1172                 /* entry is idle and not in any heap, expire it */
1173                 struct dn_flow_queue *old_q = q ;
1174
1175                 if (prev != NULL)
1176                     prev->next = q = q->next ;
1177                 else
1178                     fs->rq[i] = q = q->next ;
1179                 fs->rq_elements-- ;
1180                 free(old_q, M_DUMMYNET);
1181                 continue ;
1182             }
1183             prev = q ;
1184             q = q->next ;
1185         }
1186         if (q && prev != NULL) { /* found and not in front */
1187             prev->next = q->next ;
1188             q->next = fs->rq[i] ;
1189             fs->rq[i] = q ;
1190         }
1191     }
1192     if (q == NULL) { /* no match, need to allocate a new entry */
1193         q = create_queue(fs, i);
1194         if (q != NULL)
1195         q->id = *id ;
1196     }
1197     return q ;
1198 }
1199
1200 static int
1201 red_drops(struct dn_flow_set *fs, struct dn_flow_queue *q, int len)
1202 {
1203         /*
1204          * RED algorithm
1205          *
1206          * RED calculates the average queue size (avg) using a low-pass filter
1207          * with an exponential weighted (w_q) moving average:
1208          *      avg  <-  (1-w_q) * avg + w_q * q_size
1209          * where q_size is the queue length (measured in bytes or * packets).
1210          *
1211          * If q_size == 0, we compute the idle time for the link, and set
1212          *      avg = (1 - w_q)^(idle/s)
1213          * where s is the time needed for transmitting a medium-sized packet.
1214          *
1215          * Now, if avg < min_th the packet is enqueued.
1216          * If avg > max_th the packet is dropped. Otherwise, the packet is
1217          * dropped with probability P function of avg.
1218          */
1219
1220         int64_t p_b = 0;
1221
1222         /* Queue in bytes or packets? */
1223         u_int q_size = (fs->flags_fs & DN_QSIZE_IS_BYTES) ?
1224             q->len_bytes : q->len;
1225
1226         DPRINTF(("\ndummynet: %d q: %2u ", (int)curr_time, q_size));
1227
1228         /* Average queue size estimation. */
1229         if (q_size != 0) {
1230                 /* Queue is not empty, avg <- avg + (q_size - avg) * w_q */
1231                 int diff = SCALE(q_size) - q->avg;
1232                 int64_t v = SCALE_MUL((int64_t)diff, (int64_t)fs->w_q);
1233
1234                 q->avg += (int)v;
1235         } else {
1236                 /*
1237                  * Queue is empty, find for how long the queue has been
1238                  * empty and use a lookup table for computing
1239                  * (1 - * w_q)^(idle_time/s) where s is the time to send a
1240                  * (small) packet.
1241                  * XXX check wraps...
1242                  */
1243                 if (q->avg) {
1244                         u_int t = div64(curr_time - q->q_time,
1245                             fs->lookup_step);
1246
1247                         q->avg = (t >= 0 && t < fs->lookup_depth) ?
1248                             SCALE_MUL(q->avg, fs->w_q_lookup[t]) : 0;
1249                 }
1250         }
1251         DPRINTF(("dummynet: avg: %u ", SCALE_VAL(q->avg)));
1252
1253         /* Should i drop? */
1254         if (q->avg < fs->min_th) {
1255                 q->count = -1;
1256                 return (0);     /* accept packet */
1257         }
1258         if (q->avg >= fs->max_th) {     /* average queue >=  max threshold */
1259                 if (fs->flags_fs & DN_IS_GENTLE_RED) {
1260                         /*
1261                          * According to Gentle-RED, if avg is greater than
1262                          * max_th the packet is dropped with a probability
1263                          *       p_b = c_3 * avg - c_4
1264                          * where c_3 = (1 - max_p) / max_th
1265                          *       c_4 = 1 - 2 * max_p
1266                          */
1267                         p_b = SCALE_MUL((int64_t)fs->c_3, (int64_t)q->avg) -
1268                             fs->c_4;
1269                 } else {
1270                         q->count = -1;
1271                         DPRINTF(("dummynet: - drop"));
1272                         return (1);
1273                 }
1274         } else if (q->avg > fs->min_th) {
1275                 /*
1276                  * We compute p_b using the linear dropping function
1277                  *       p_b = c_1 * avg - c_2
1278                  * where c_1 = max_p / (max_th - min_th)
1279                  *       c_2 = max_p * min_th / (max_th - min_th)
1280                  */
1281                 p_b = SCALE_MUL((int64_t)fs->c_1, (int64_t)q->avg) - fs->c_2;
1282         }
1283
1284         if (fs->flags_fs & DN_QSIZE_IS_BYTES)
1285                 p_b = div64(p_b * len, fs->max_pkt_size);
1286         if (++q->count == 0)
1287                 q->random = random() & 0xffff;
1288         else {
1289                 /*
1290                  * q->count counts packets arrived since last drop, so a greater
1291                  * value of q->count means a greater packet drop probability.
1292                  */
1293                 if (SCALE_MUL(p_b, SCALE((int64_t)q->count)) > q->random) {
1294                         q->count = 0;
1295                         DPRINTF(("dummynet: - red drop"));
1296                         /* After a drop we calculate a new random value. */
1297                         q->random = random() & 0xffff;
1298                         return (1);     /* drop */
1299                 }
1300         }
1301         /* End of RED algorithm. */
1302
1303         return (0);     /* accept */
1304 }
1305
1306 static __inline struct dn_flow_set *
1307 locate_flowset(int fs_nr)
1308 {
1309         struct dn_flow_set *fs;
1310
1311         SLIST_FOREACH(fs, &flowsethash[HASH(fs_nr)], next)
1312                 if (fs->fs_nr == fs_nr)
1313                         return (fs);
1314
1315         return (NULL);
1316 }
1317
1318 static __inline struct dn_pipe *
1319 locate_pipe(int pipe_nr)
1320 {
1321         struct dn_pipe *pipe;
1322
1323         SLIST_FOREACH(pipe, &pipehash[HASH(pipe_nr)], next)
1324                 if (pipe->pipe_nr == pipe_nr)
1325                         return (pipe);
1326
1327         return (NULL);
1328 }
1329
1330 /*
1331  * dummynet hook for packets. Below 'pipe' is a pipe or a queue
1332  * depending on whether WF2Q or fixed bw is used.
1333  *
1334  * pipe_nr      pipe or queue the packet is destined for.
1335  * dir          where shall we send the packet after dummynet.
1336  * m            the mbuf with the packet
1337  * ifp          the 'ifp' parameter from the caller.
1338  *              NULL in ip_input, destination interface in ip_output,
1339  * rule         matching rule, in case of multiple passes
1340  */
1341 static int
1342 dummynet_io(struct mbuf **m0, int dir, struct ip_fw_args *fwa)
1343 {
1344         struct mbuf *m = *m0, *head = NULL, *tail = NULL;
1345         struct dn_pkt_tag *pkt;
1346         struct m_tag *mtag;
1347         struct dn_flow_set *fs = NULL;
1348         struct dn_pipe *pipe;
1349         uint64_t len = m->m_pkthdr.len;
1350         struct dn_flow_queue *q = NULL;
1351         int is_pipe;
1352         ipfw_insn *cmd = ACTION_PTR(fwa->rule);
1353
1354         KASSERT(m->m_nextpkt == NULL,
1355             ("dummynet_io: mbuf queue passed to dummynet"));
1356
1357         if (cmd->opcode == O_LOG)
1358                 cmd += F_LEN(cmd);
1359         if (cmd->opcode == O_ALTQ)
1360                 cmd += F_LEN(cmd);
1361         if (cmd->opcode == O_TAG)
1362                 cmd += F_LEN(cmd);
1363         is_pipe = (cmd->opcode == O_PIPE);
1364
1365         DUMMYNET_LOCK();
1366         io_pkt++;
1367         /*
1368          * This is a dummynet rule, so we expect an O_PIPE or O_QUEUE rule.
1369          *
1370          * XXXGL: probably the pipe->fs and fs->pipe logic here
1371          * below can be simplified.
1372          */
1373         if (is_pipe) {
1374                 pipe = locate_pipe(fwa->cookie);
1375                 if (pipe != NULL)
1376                         fs = &(pipe->fs);
1377         } else
1378                 fs = locate_flowset(fwa->cookie);
1379
1380         if (fs == NULL)
1381                 goto dropit;    /* This queue/pipe does not exist! */
1382         pipe = fs->pipe;
1383         if (pipe == NULL) {     /* Must be a queue, try find a matching pipe. */
1384                 pipe = locate_pipe(fs->parent_nr);
1385                 if (pipe != NULL)
1386                         fs->pipe = pipe;
1387                 else {
1388                         printf("dummynet: no pipe %d for queue %d, drop pkt\n",
1389                             fs->parent_nr, fs->fs_nr);
1390                         goto dropit;
1391                 }
1392         }
1393         q = find_queue(fs, &(fwa->f_id));
1394         if (q == NULL)
1395                 goto dropit;            /* Cannot allocate queue. */
1396
1397         /* Update statistics, then check reasons to drop pkt. */
1398         q->tot_bytes += len;
1399         q->tot_pkts++;
1400         if (fs->plr && random() < fs->plr)
1401                 goto dropit;            /* Random pkt drop. */
1402         if (fs->flags_fs & DN_QSIZE_IS_BYTES) {
1403                 if (q->len_bytes > fs->qsize)
1404                         goto dropit;    /* Queue size overflow. */
1405         } else {
1406                 if (q->len >= fs->qsize)
1407                         goto dropit;    /* Queue count overflow. */
1408         }
1409         if (fs->flags_fs & DN_IS_RED && red_drops(fs, q, len))
1410                 goto dropit;
1411
1412         /* XXX expensive to zero, see if we can remove it. */
1413         mtag = m_tag_get(PACKET_TAG_DUMMYNET,
1414             sizeof(struct dn_pkt_tag), M_NOWAIT | M_ZERO);
1415         if (mtag == NULL)
1416                 goto dropit;            /* Cannot allocate packet header. */
1417         m_tag_prepend(m, mtag);         /* Attach to mbuf chain. */
1418
1419         pkt = (struct dn_pkt_tag *)(mtag + 1);
1420         /*
1421          * Ok, i can handle the pkt now...
1422          * Build and enqueue packet + parameters.
1423          */
1424         pkt->rule = fwa->rule;
1425         pkt->dn_dir = dir;
1426
1427         pkt->ifp = fwa->oif;
1428
1429         if (q->head == NULL)
1430                 q->head = m;
1431         else
1432                 q->tail->m_nextpkt = m;
1433         q->tail = m;
1434         q->len++;
1435         q->len_bytes += len;
1436
1437         if (q->head != m)               /* Flow was not idle, we are done. */
1438                 goto done;
1439
1440         if (q->q_time < (uint32_t)curr_time)
1441                 q->numbytes = io_fast ? fs->pipe->bandwidth : 0;
1442         q->q_time = curr_time;
1443
1444         /*
1445          * If we reach this point the flow was previously idle, so we need
1446          * to schedule it. This involves different actions for fixed-rate or
1447          * WF2Q queues.
1448          */
1449         if (is_pipe) {
1450                 /* Fixed-rate queue: just insert into the ready_heap. */
1451                 dn_key t = 0;
1452
1453                 if (pipe->bandwidth) {
1454                         q->extra_bits = compute_extra_bits(m, pipe);
1455                         t = set_ticks(m, q, pipe);
1456                 }
1457                 q->sched_time = curr_time;
1458                 if (t == 0)             /* Must process it now. */
1459                         ready_event(q, &head, &tail);
1460                 else
1461                         heap_insert(&ready_heap, curr_time + t , q);
1462         } else {
1463                 /*
1464                  * WF2Q. First, compute start time S: if the flow was
1465                  * idle (S = F + 1) set S to the virtual time V for the
1466                  * controlling pipe, and update the sum of weights for the pipe;
1467                  * otherwise, remove flow from idle_heap and set S to max(F,V).
1468                  * Second, compute finish time F = S + len / weight.
1469                  * Third, if pipe was idle, update V = max(S, V).
1470                  * Fourth, count one more backlogged flow.
1471                  */
1472                 if (DN_KEY_GT(q->S, q->F)) { /* Means timestamps are invalid. */
1473                         q->S = pipe->V;
1474                         pipe->sum += fs->weight; /* Add weight of new queue. */
1475                 } else {
1476                         heap_extract(&(pipe->idle_heap), q);
1477                         q->S = MAX64(q->F, pipe->V);
1478                 }
1479                 q->F = div64(q->S + (len << MY_M), fs->weight);
1480
1481                 if (pipe->not_eligible_heap.elements == 0 &&
1482                     pipe->scheduler_heap.elements == 0)
1483                         pipe->V = MAX64(q->S, pipe->V);
1484                 fs->backlogged++;
1485                 /*
1486                  * Look at eligibility. A flow is not eligibile if S>V (when
1487                  * this happens, it means that there is some other flow already
1488                  * scheduled for the same pipe, so the scheduler_heap cannot be
1489                  * empty). If the flow is not eligible we just store it in the
1490                  * not_eligible_heap. Otherwise, we store in the scheduler_heap
1491                  * and possibly invoke ready_event_wfq() right now if there is
1492                  * leftover credit.
1493                  * Note that for all flows in scheduler_heap (SCH), S_i <= V,
1494                  * and for all flows in not_eligible_heap (NEH), S_i > V.
1495                  * So when we need to compute max(V, min(S_i)) forall i in
1496                  * SCH+NEH, we only need to look into NEH.
1497                  */
1498                 if (DN_KEY_GT(q->S, pipe->V)) {         /* Not eligible. */
1499                         if (pipe->scheduler_heap.elements == 0)
1500                                 printf("dummynet: ++ ouch! not eligible but empty scheduler!\n");
1501                         heap_insert(&(pipe->not_eligible_heap), q->S, q);
1502                 } else {
1503                         heap_insert(&(pipe->scheduler_heap), q->F, q);
1504                         if (pipe->numbytes >= 0) {       /* Pipe is idle. */
1505                                 if (pipe->scheduler_heap.elements != 1)
1506                                         printf("dummynet: OUCH! pipe should have been idle!\n");
1507                                 DPRINTF(("dummynet: waking up pipe %d at %d\n",
1508                                     pipe->pipe_nr, (int)(q->F >> MY_M)));
1509                                 pipe->sched_time = curr_time;
1510                                 ready_event_wfq(pipe, &head, &tail);
1511                         }
1512                 }
1513         }
1514 done:
1515         if (head == m && dir != DN_TO_IFB_FWD && dir != DN_TO_ETH_DEMUX &&
1516             dir != DN_TO_ETH_OUT) {     /* Fast io. */
1517                 io_pkt_fast++;
1518                 if (m->m_nextpkt != NULL)
1519                         printf("dummynet: fast io: pkt chain detected!\n");
1520                 head = m->m_nextpkt = NULL;
1521         } else
1522                 *m0 = NULL;             /* Normal io. */
1523
1524         DUMMYNET_UNLOCK();
1525         if (head != NULL)
1526                 dummynet_send(head);
1527         return (0);
1528
1529 dropit:
1530         io_pkt_drop++;
1531         if (q)
1532                 q->drops++;
1533         DUMMYNET_UNLOCK();
1534         /*
1535          * set the tag, if present. dn_tag_get cannot fail
1536          * so we need to check first
1537          */
1538         if (m_tag_first(m)) {
1539                 pkt = dn_tag_get(m);
1540                 pkt->dn_dir = DN_TO_DROP;
1541         }
1542         dummynet_send(m);       /* drop the packet */
1543         *m0 = NULL;
1544         return ((fs && (fs->flags_fs & DN_NOERROR)) ? 0 : ENOBUFS);
1545 }
1546
1547 /*
1548  * Below, the rt_unref is only needed when (pkt->dn_dir == DN_TO_IP_OUT)
1549  * Doing this would probably save us the initial bzero of dn_pkt
1550  */
1551 #define DN_FREE_PKT(_m) do {                            \
1552         m_freem(_m);                                    \
1553 } while (0)
1554
1555 /*
1556  * Dispose all packets and flow_queues on a flow_set.
1557  * If all=1, also remove red lookup table and other storage,
1558  * including the descriptor itself.
1559  * For the one in dn_pipe MUST also cleanup ready_heap...
1560  */
1561 static void
1562 purge_flow_set(struct dn_flow_set *fs, int all)
1563 {
1564         struct dn_flow_queue *q, *qn;
1565         int i;
1566
1567         DUMMYNET_LOCK_ASSERT();
1568
1569         for (i = 0; i <= fs->rq_size; i++) {
1570                 for (q = fs->rq[i]; q != NULL; q = qn) {
1571                         struct mbuf *m, *mnext;
1572
1573                         mnext = q->head;
1574                         while ((m = mnext) != NULL) {
1575                                 mnext = m->m_nextpkt;
1576                                 DN_FREE_PKT(m);
1577                         }
1578                         qn = q->next;
1579                         free(q, M_DUMMYNET);
1580                 }
1581                 fs->rq[i] = NULL;
1582         }
1583
1584         fs->rq_elements = 0;
1585         if (all) {
1586                 /* RED - free lookup table. */
1587                 if (fs->w_q_lookup != NULL)
1588                         free(fs->w_q_lookup, M_DUMMYNET);
1589                 if (fs->rq != NULL)
1590                         free(fs->rq, M_DUMMYNET);
1591                 /* If this fs is not part of a pipe, free it. */
1592                 if (fs->pipe == NULL || fs != &(fs->pipe->fs))
1593                         free(fs, M_DUMMYNET);
1594         }
1595 }
1596
1597 /*
1598  * Dispose all packets queued on a pipe (not a flow_set).
1599  * Also free all resources associated to a pipe, which is about
1600  * to be deleted.
1601  */
1602 static void
1603 purge_pipe(struct dn_pipe *pipe)
1604 {
1605     struct mbuf *m, *mnext;
1606
1607     purge_flow_set( &(pipe->fs), 1 );
1608
1609     mnext = pipe->head;
1610     while ((m = mnext) != NULL) {
1611         mnext = m->m_nextpkt;
1612         DN_FREE_PKT(m);
1613     }
1614
1615     heap_free( &(pipe->scheduler_heap) );
1616     heap_free( &(pipe->not_eligible_heap) );
1617     heap_free( &(pipe->idle_heap) );
1618 }
1619
1620 /*
1621  * Delete all pipes and heaps returning memory. Must also
1622  * remove references from all ipfw rules to all pipes.
1623  */
1624 static void
1625 dummynet_flush(void)
1626 {
1627         struct dn_pipe *pipe, *pipe1;
1628         struct dn_flow_set *fs, *fs1;
1629         int i;
1630
1631         DUMMYNET_LOCK();
1632         /* Free heaps so we don't have unwanted events. */
1633         heap_free(&ready_heap);
1634         heap_free(&wfq_ready_heap);
1635         heap_free(&extract_heap);
1636
1637         /*
1638          * Now purge all queued pkts and delete all pipes.
1639          *
1640          * XXXGL: can we merge the for(;;) cycles into one or not?
1641          */
1642         for (i = 0; i < HASHSIZE; i++)
1643                 SLIST_FOREACH_SAFE(fs, &flowsethash[i], next, fs1) {
1644                         SLIST_REMOVE(&flowsethash[i], fs, dn_flow_set, next);
1645                         purge_flow_set(fs, 1);
1646                 }
1647         for (i = 0; i < HASHSIZE; i++)
1648                 SLIST_FOREACH_SAFE(pipe, &pipehash[i], next, pipe1) {
1649                         SLIST_REMOVE(&pipehash[i], pipe, dn_pipe, next);
1650                         purge_pipe(pipe);
1651                         free_pipe(pipe);
1652                 }
1653         DUMMYNET_UNLOCK();
1654 }
1655
1656 extern struct ip_fw *ip_fw_default_rule;
1657 static void
1658 dn_rule_delete_fs(struct dn_flow_set *fs, void *r)
1659 {
1660     int i ;
1661     struct dn_flow_queue *q ;
1662     struct mbuf *m ;
1663
1664     for (i = 0 ; i <= fs->rq_size ; i++) /* last one is ovflow */
1665         for (q = fs->rq[i] ; q ; q = q->next )
1666             for (m = q->head ; m ; m = m->m_nextpkt ) {
1667                 struct dn_pkt_tag *pkt = dn_tag_get(m) ;
1668                 if (pkt->rule == r)
1669                     pkt->rule = ip_fw_default_rule ;
1670             }
1671 }
1672
1673 /*
1674  * When a firewall rule is deleted, scan all queues and remove the pointer
1675  * to the rule from matching packets, making them point to the default rule.
1676  * The pointer is used to reinject packets in case one_pass = 0.
1677  */
1678 void
1679 dn_rule_delete(void *r)
1680 {
1681     struct dn_pipe *pipe;
1682     struct dn_flow_set *fs;
1683     struct dn_pkt_tag *pkt;
1684     struct mbuf *m;
1685     int i;
1686
1687     DUMMYNET_LOCK();
1688     /*
1689      * If the rule references a queue (dn_flow_set), then scan
1690      * the flow set, otherwise scan pipes. Should do either, but doing
1691      * both does not harm.
1692      */
1693     for (i = 0; i < HASHSIZE; i++)
1694         SLIST_FOREACH(fs, &flowsethash[i], next)
1695                 dn_rule_delete_fs(fs, r);
1696
1697     for (i = 0; i < HASHSIZE; i++)
1698         SLIST_FOREACH(pipe, &pipehash[i], next) {
1699                 fs = &(pipe->fs);
1700                 dn_rule_delete_fs(fs, r);
1701                 for (m = pipe->head ; m ; m = m->m_nextpkt ) {
1702                         pkt = dn_tag_get(m);
1703                         if (pkt->rule == r)
1704                                 pkt->rule = ip_fw_default_rule;
1705                 }
1706         }
1707     DUMMYNET_UNLOCK();
1708 }
1709
1710 /*
1711  * setup RED parameters
1712  */
1713 static int
1714 config_red(struct dn_flow_set *p, struct dn_flow_set *x)
1715 {
1716         int i;
1717
1718         x->w_q = p->w_q;
1719         x->min_th = SCALE(p->min_th);
1720         x->max_th = SCALE(p->max_th);
1721         x->max_p = p->max_p;
1722
1723         x->c_1 = p->max_p / (p->max_th - p->min_th);
1724         x->c_2 = SCALE_MUL(x->c_1, SCALE(p->min_th));
1725
1726         if (x->flags_fs & DN_IS_GENTLE_RED) {
1727                 x->c_3 = (SCALE(1) - p->max_p) / p->max_th;
1728                 x->c_4 = SCALE(1) - 2 * p->max_p;
1729         }
1730
1731         /* If the lookup table already exist, free and create it again. */
1732         if (x->w_q_lookup) {
1733                 free(x->w_q_lookup, M_DUMMYNET);
1734                 x->w_q_lookup = NULL;
1735         }
1736         if (red_lookup_depth == 0) {
1737                 printf("\ndummynet: net.inet.ip.dummynet.red_lookup_depth"
1738                     "must be > 0\n");
1739                 free(x, M_DUMMYNET);
1740                 return (EINVAL);
1741         }
1742         x->lookup_depth = red_lookup_depth;
1743         x->w_q_lookup = (u_int *)malloc(x->lookup_depth * sizeof(int),
1744             M_DUMMYNET, M_NOWAIT);
1745         if (x->w_q_lookup == NULL) {
1746                 printf("dummynet: sorry, cannot allocate red lookup table\n");
1747                 free(x, M_DUMMYNET);
1748                 return(ENOSPC);
1749         }
1750
1751         /* Fill the lookup table with (1 - w_q)^x */
1752         x->lookup_step = p->lookup_step;
1753         x->lookup_weight = p->lookup_weight;
1754         x->w_q_lookup[0] = SCALE(1) - x->w_q;
1755
1756         for (i = 1; i < x->lookup_depth; i++)
1757                 x->w_q_lookup[i] =
1758                     SCALE_MUL(x->w_q_lookup[i - 1], x->lookup_weight);
1759
1760         if (red_avg_pkt_size < 1)
1761                 red_avg_pkt_size = 512;
1762         x->avg_pkt_size = red_avg_pkt_size;
1763         if (red_max_pkt_size < 1)
1764                 red_max_pkt_size = 1500;
1765         x->max_pkt_size = red_max_pkt_size;
1766         return (0);
1767 }
1768
1769 static int
1770 alloc_hash(struct dn_flow_set *x, struct dn_flow_set *pfs)
1771 {
1772     if (x->flags_fs & DN_HAVE_FLOW_MASK) {     /* allocate some slots */
1773         int l = pfs->rq_size;
1774
1775         if (l == 0)
1776             l = dn_hash_size;
1777         if (l < 4)
1778             l = 4;
1779         else if (l > DN_MAX_HASH_SIZE)
1780             l = DN_MAX_HASH_SIZE;
1781         x->rq_size = l;
1782     } else                  /* one is enough for null mask */
1783         x->rq_size = 1;
1784     x->rq = malloc((1 + x->rq_size) * sizeof(struct dn_flow_queue *),
1785             M_DUMMYNET, M_NOWAIT | M_ZERO);
1786     if (x->rq == NULL) {
1787         printf("dummynet: sorry, cannot allocate queue\n");
1788         return (ENOMEM);
1789     }
1790     x->rq_elements = 0;
1791     return 0 ;
1792 }
1793
1794 static void
1795 set_fs_parms(struct dn_flow_set *x, struct dn_flow_set *src)
1796 {
1797         x->flags_fs = src->flags_fs;
1798         x->qsize = src->qsize;
1799         x->plr = src->plr;
1800         x->flow_mask = src->flow_mask;
1801         if (x->flags_fs & DN_QSIZE_IS_BYTES) {
1802                 if (x->qsize > pipe_byte_limit)
1803                         x->qsize = 1024 * 1024;
1804         } else {
1805                 if (x->qsize == 0)
1806                         x->qsize = 50;
1807                 if (x->qsize > pipe_slot_limit)
1808                         x->qsize = 50;
1809         }
1810         /* Configuring RED. */
1811         if (x->flags_fs & DN_IS_RED)
1812                 config_red(src, x);     /* XXX should check errors */
1813 }
1814
1815 /*
1816  * Setup pipe or queue parameters.
1817  */
1818 static int
1819 config_pipe(struct dn_pipe *p)
1820 {
1821         struct dn_flow_set *pfs = &(p->fs);
1822         struct dn_flow_queue *q;
1823         int i, error;
1824
1825         /*
1826          * The config program passes parameters as follows:
1827          * bw = bits/second (0 means no limits),
1828          * delay = ms, must be translated into ticks.
1829          * qsize = slots/bytes
1830          */
1831         p->delay = (p->delay * hz) / 1000;
1832         /* We need either a pipe number or a flow_set number. */
1833         if (p->pipe_nr == 0 && pfs->fs_nr == 0)
1834                 return (EINVAL);
1835         if (p->pipe_nr != 0 && pfs->fs_nr != 0)
1836                 return (EINVAL);
1837         if (p->pipe_nr != 0) {                  /* this is a pipe */
1838                 struct dn_pipe *pipe;
1839
1840                 DUMMYNET_LOCK();
1841                 pipe = locate_pipe(p->pipe_nr); /* locate pipe */
1842
1843                 if (pipe == NULL) {             /* new pipe */
1844                         pipe = malloc(sizeof(struct dn_pipe), M_DUMMYNET,
1845                             M_NOWAIT | M_ZERO);
1846                         if (pipe == NULL) {
1847                                 DUMMYNET_UNLOCK();
1848                                 printf("dummynet: no memory for new pipe\n");
1849                                 return (ENOMEM);
1850                         }
1851                         pipe->pipe_nr = p->pipe_nr;
1852                         pipe->fs.pipe = pipe;
1853                         /*
1854                          * idle_heap is the only one from which
1855                          * we extract from the middle.
1856                          */
1857                         pipe->idle_heap.size = pipe->idle_heap.elements = 0;
1858                         pipe->idle_heap.offset =
1859                             offsetof(struct dn_flow_queue, heap_pos);
1860                 } else
1861                         /* Flush accumulated credit for all queues. */
1862                         for (i = 0; i <= pipe->fs.rq_size; i++)
1863                                 for (q = pipe->fs.rq[i]; q; q = q->next)
1864                                         q->numbytes = io_fast ? p->bandwidth : 0;
1865
1866                 pipe->bandwidth = p->bandwidth;
1867                 pipe->numbytes = 0;             /* just in case... */
1868                 bcopy(p->if_name, pipe->if_name, sizeof(p->if_name));
1869                 pipe->ifp = NULL;               /* reset interface ptr */
1870                 pipe->delay = p->delay;
1871                 set_fs_parms(&(pipe->fs), pfs);
1872
1873                 /* Handle changes in the delay profile. */
1874                 if (p->samples_no > 0) {
1875                         if (pipe->samples_no != p->samples_no) {
1876                                 if (pipe->samples != NULL)
1877                                         free(pipe->samples, M_DUMMYNET);
1878                                 pipe->samples =
1879                                     malloc(p->samples_no*sizeof(dn_key),
1880                                         M_DUMMYNET, M_NOWAIT | M_ZERO);
1881                                 if (pipe->samples == NULL) {
1882                                         DUMMYNET_UNLOCK();
1883                                         printf("dummynet: no memory "
1884                                                 "for new samples\n");
1885                                         return (ENOMEM);
1886                                 }
1887                                 pipe->samples_no = p->samples_no;
1888                         }
1889
1890                         strncpy(pipe->name,p->name,sizeof(pipe->name));
1891                         pipe->loss_level = p->loss_level;
1892                         for (i = 0; i<pipe->samples_no; ++i)
1893                                 pipe->samples[i] = p->samples[i];
1894                 } else if (pipe->samples != NULL) {
1895                         free(pipe->samples, M_DUMMYNET);
1896                         pipe->samples = NULL;
1897                         pipe->samples_no = 0;
1898                 }
1899
1900                 if (pipe->fs.rq == NULL) {      /* a new pipe */
1901                         error = alloc_hash(&(pipe->fs), pfs);
1902                         if (error) {
1903                                 DUMMYNET_UNLOCK();
1904                                 free_pipe(pipe);
1905                                 return (error);
1906                         }
1907                         SLIST_INSERT_HEAD(&pipehash[HASH(pipe->pipe_nr)],
1908                             pipe, next);
1909                 }
1910                 DUMMYNET_UNLOCK();
1911         } else {                                /* config queue */
1912                 struct dn_flow_set *fs;
1913
1914                 DUMMYNET_LOCK();
1915                 fs = locate_flowset(pfs->fs_nr); /* locate flow_set */
1916
1917                 if (fs == NULL) {               /* new */
1918                         if (pfs->parent_nr == 0) { /* need link to a pipe */
1919                                 DUMMYNET_UNLOCK();
1920                                 return (EINVAL);
1921                         }
1922                         fs = malloc(sizeof(struct dn_flow_set), M_DUMMYNET,
1923                             M_NOWAIT | M_ZERO);
1924                         if (fs == NULL) {
1925                                 DUMMYNET_UNLOCK();
1926                                 printf(
1927                                     "dummynet: no memory for new flow_set\n");
1928                                 return (ENOMEM);
1929                         }
1930                         fs->fs_nr = pfs->fs_nr;
1931                         fs->parent_nr = pfs->parent_nr;
1932                         fs->weight = pfs->weight;
1933                         if (fs->weight == 0)
1934                                 fs->weight = 1;
1935                         else if (fs->weight > 100)
1936                                 fs->weight = 100;
1937                 } else {
1938                         /*
1939                          * Change parent pipe not allowed;
1940                          * must delete and recreate.
1941                          */
1942                         if (pfs->parent_nr != 0 &&
1943                             fs->parent_nr != pfs->parent_nr) {
1944                                 DUMMYNET_UNLOCK();
1945                                 return (EINVAL);
1946                         }
1947                 }
1948
1949                 set_fs_parms(fs, pfs);
1950
1951                 if (fs->rq == NULL) {           /* a new flow_set */
1952                         error = alloc_hash(fs, pfs);
1953                         if (error) {
1954                                 DUMMYNET_UNLOCK();
1955                                 free(fs, M_DUMMYNET);
1956                                 return (error);
1957                         }
1958                         SLIST_INSERT_HEAD(&flowsethash[HASH(fs->fs_nr)],
1959                             fs, next);
1960                 }
1961                 DUMMYNET_UNLOCK();
1962         }
1963         return (0);
1964 }
1965
1966 /*
1967  * Helper function to remove from a heap queues which are linked to
1968  * a flow_set about to be deleted.
1969  */
1970 static void
1971 fs_remove_from_heap(struct dn_heap *h, struct dn_flow_set *fs)
1972 {
1973     int i = 0, found = 0 ;
1974     for (; i < h->elements ;)
1975         if ( ((struct dn_flow_queue *)h->p[i].object)->fs == fs) {
1976             h->elements-- ;
1977             h->p[i] = h->p[h->elements] ;
1978             found++ ;
1979         } else
1980             i++ ;
1981     if (found)
1982         heapify(h);
1983 }
1984
1985 /*
1986  * helper function to remove a pipe from a heap (can be there at most once)
1987  */
1988 static void
1989 pipe_remove_from_heap(struct dn_heap *h, struct dn_pipe *p)
1990 {
1991     if (h->elements > 0) {
1992         int i = 0 ;
1993         for (i=0; i < h->elements ; i++ ) {
1994             if (h->p[i].object == p) { /* found it */
1995                 h->elements-- ;
1996                 h->p[i] = h->p[h->elements] ;
1997                 heapify(h);
1998                 break ;
1999             }
2000         }
2001     }
2002 }
2003
2004 /*
2005  * drain all queues. Called in case of severe mbuf shortage.
2006  */
2007 void
2008 dummynet_drain(void)
2009 {
2010     struct dn_flow_set *fs;
2011     struct dn_pipe *pipe;
2012     struct mbuf *m, *mnext;
2013     int i;
2014
2015     DUMMYNET_LOCK_ASSERT();
2016
2017     heap_free(&ready_heap);
2018     heap_free(&wfq_ready_heap);
2019     heap_free(&extract_heap);
2020     /* remove all references to this pipe from flow_sets */
2021     for (i = 0; i < HASHSIZE; i++)
2022         SLIST_FOREACH(fs, &flowsethash[i], next)
2023                 purge_flow_set(fs, 0);
2024
2025     for (i = 0; i < HASHSIZE; i++) {
2026         SLIST_FOREACH(pipe, &pipehash[i], next) {
2027                 purge_flow_set(&(pipe->fs), 0);
2028
2029                 mnext = pipe->head;
2030                 while ((m = mnext) != NULL) {
2031                         mnext = m->m_nextpkt;
2032                         DN_FREE_PKT(m);
2033                 }
2034                 pipe->head = pipe->tail = NULL;
2035         }
2036     }
2037 }
2038
2039 /*
2040  * Fully delete a pipe or a queue, cleaning up associated info.
2041  */
2042 static int
2043 delete_pipe(struct dn_pipe *p)
2044 {
2045
2046     if (p->pipe_nr == 0 && p->fs.fs_nr == 0)
2047         return EINVAL ;
2048     if (p->pipe_nr != 0 && p->fs.fs_nr != 0)
2049         return EINVAL ;
2050     if (p->pipe_nr != 0) { /* this is an old-style pipe */
2051         struct dn_pipe *pipe;
2052         struct dn_flow_set *fs;
2053         int i;
2054
2055         DUMMYNET_LOCK();
2056         pipe = locate_pipe(p->pipe_nr); /* locate pipe */
2057
2058         if (pipe == NULL) {
2059             DUMMYNET_UNLOCK();
2060             return (ENOENT);    /* not found */
2061         }
2062
2063         /* Unlink from list of pipes. */
2064         SLIST_REMOVE(&pipehash[HASH(pipe->pipe_nr)], pipe, dn_pipe, next);
2065
2066         /* Remove all references to this pipe from flow_sets. */
2067         for (i = 0; i < HASHSIZE; i++)
2068             SLIST_FOREACH(fs, &flowsethash[i], next)
2069                 if (fs->pipe == pipe) {
2070                         printf("dummynet: ++ ref to pipe %d from fs %d\n",
2071                             p->pipe_nr, fs->fs_nr);
2072                         fs->pipe = NULL ;
2073                         purge_flow_set(fs, 0);
2074                 }
2075         fs_remove_from_heap(&ready_heap, &(pipe->fs));
2076         purge_pipe(pipe); /* remove all data associated to this pipe */
2077         /* remove reference to here from extract_heap and wfq_ready_heap */
2078         pipe_remove_from_heap(&extract_heap, pipe);
2079         pipe_remove_from_heap(&wfq_ready_heap, pipe);
2080         DUMMYNET_UNLOCK();
2081
2082         free_pipe(pipe);
2083     } else { /* this is a WF2Q queue (dn_flow_set) */
2084         struct dn_flow_set *fs;
2085
2086         DUMMYNET_LOCK();
2087         fs = locate_flowset(p->fs.fs_nr); /* locate set */
2088
2089         if (fs == NULL) {
2090             DUMMYNET_UNLOCK();
2091             return (ENOENT); /* not found */
2092         }
2093
2094         /* Unlink from list of flowsets. */
2095         SLIST_REMOVE( &flowsethash[HASH(fs->fs_nr)], fs, dn_flow_set, next);
2096
2097         if (fs->pipe != NULL) {
2098             /* Update total weight on parent pipe and cleanup parent heaps. */
2099             fs->pipe->sum -= fs->weight * fs->backlogged ;
2100             fs_remove_from_heap(&(fs->pipe->not_eligible_heap), fs);
2101             fs_remove_from_heap(&(fs->pipe->scheduler_heap), fs);
2102 #if 1   /* XXX should i remove from idle_heap as well ? */
2103             fs_remove_from_heap(&(fs->pipe->idle_heap), fs);
2104 #endif
2105         }
2106         purge_flow_set(fs, 1);
2107         DUMMYNET_UNLOCK();
2108     }
2109     return 0 ;
2110 }
2111
2112 /*
2113  * helper function used to copy data from kernel in DUMMYNET_GET
2114  */
2115 static char *
2116 dn_copy_set(struct dn_flow_set *set, char *bp)
2117 {
2118     int i, copied = 0 ;
2119     struct dn_flow_queue *q, *qp = (struct dn_flow_queue *)bp;
2120
2121     DUMMYNET_LOCK_ASSERT();
2122
2123     for (i = 0 ; i <= set->rq_size ; i++)
2124         for (q = set->rq[i] ; q ; q = q->next, qp++ ) {
2125             if (q->hash_slot != i)
2126                 printf("dummynet: ++ at %d: wrong slot (have %d, "
2127                     "should be %d)\n", copied, q->hash_slot, i);
2128             if (q->fs != set)
2129                 printf("dummynet: ++ at %d: wrong fs ptr (have %p, should be %p)\n",
2130                         i, q->fs, set);
2131             copied++ ;
2132             bcopy(q, qp, sizeof( *q ) );
2133             /* cleanup pointers */
2134             qp->next = NULL ;
2135             qp->head = qp->tail = NULL ;
2136             qp->fs = NULL ;
2137         }
2138     if (copied != set->rq_elements)
2139         printf("dummynet: ++ wrong count, have %d should be %d\n",
2140             copied, set->rq_elements);
2141     return (char *)qp ;
2142 }
2143
2144 static size_t
2145 dn_calc_size(void)
2146 {
2147     struct dn_flow_set *fs;
2148     struct dn_pipe *pipe;
2149     size_t size = 0;
2150     int i;
2151
2152     DUMMYNET_LOCK_ASSERT();
2153     /*
2154      * Compute size of data structures: list of pipes and flow_sets.
2155      */
2156     for (i = 0; i < HASHSIZE; i++) {
2157         SLIST_FOREACH(pipe, &pipehash[i], next)
2158                 size += sizeof(*pipe) +
2159                     pipe->fs.rq_elements * sizeof(struct dn_flow_queue);
2160         SLIST_FOREACH(fs, &flowsethash[i], next)
2161                 size += sizeof (*fs) +
2162                     fs->rq_elements * sizeof(struct dn_flow_queue);
2163     }
2164     return size;
2165 }
2166
2167 static int
2168 dummynet_get(struct sockopt *sopt)
2169 {
2170     char *buf, *bp ; /* bp is the "copy-pointer" */
2171     size_t size ;
2172     struct dn_flow_set *fs;
2173     struct dn_pipe *pipe;
2174     int error=0, i ;
2175
2176     /* XXX lock held too long */
2177     DUMMYNET_LOCK();
2178     /*
2179      * XXX: Ugly, but we need to allocate memory with M_WAITOK flag and we
2180      *      cannot use this flag while holding a mutex.
2181      */
2182     for (i = 0; i < 10; i++) {
2183         size = dn_calc_size();
2184         DUMMYNET_UNLOCK();
2185         buf = malloc(size, M_TEMP, M_WAITOK);
2186         DUMMYNET_LOCK();
2187         if (size == dn_calc_size())
2188                 break;
2189         free(buf, M_TEMP);
2190         buf = NULL;
2191     }
2192     if (buf == NULL) {
2193         DUMMYNET_UNLOCK();
2194         return ENOBUFS ;
2195     }
2196     bp = buf;
2197     for (i = 0; i < HASHSIZE; i++) 
2198         SLIST_FOREACH(pipe, &pipehash[i], next) {
2199                 struct dn_pipe *pipe_bp = (struct dn_pipe *)bp;
2200
2201                 /*
2202                  * Copy pipe descriptor into *bp, convert delay back to ms,
2203                  * then copy the flow_set descriptor(s) one at a time.
2204                  * After each flow_set, copy the queue descriptor it owns.
2205                  */
2206                 bcopy(pipe, bp, sizeof(*pipe));
2207                 pipe_bp->delay = (pipe_bp->delay * 1000) / hz;
2208                 /*
2209                  * XXX the following is a hack based on ->next being the
2210                  * first field in dn_pipe and dn_flow_set. The correct
2211                  * solution would be to move the dn_flow_set to the beginning
2212                  * of struct dn_pipe.
2213                  */
2214                 pipe_bp->next.sle_next = (struct dn_pipe *)DN_IS_PIPE;
2215                 /* Clean pointers. */
2216                 pipe_bp->head = pipe_bp->tail = NULL;
2217                 pipe_bp->fs.next.sle_next = NULL;
2218                 pipe_bp->fs.pipe = NULL;
2219                 pipe_bp->fs.rq = NULL;
2220                 pipe_bp->samples = NULL;
2221
2222                 bp += sizeof(*pipe) ;
2223                 bp = dn_copy_set(&(pipe->fs), bp);
2224         }
2225
2226     for (i = 0; i < HASHSIZE; i++) 
2227         SLIST_FOREACH(fs, &flowsethash[i], next) {
2228                 struct dn_flow_set *fs_bp = (struct dn_flow_set *)bp;
2229
2230                 bcopy(fs, bp, sizeof(*fs));
2231                 /* XXX same hack as above */
2232                 fs_bp->next.sle_next = (struct dn_flow_set *)DN_IS_QUEUE;
2233                 fs_bp->pipe = NULL;
2234                 fs_bp->rq = NULL;
2235                 bp += sizeof(*fs);
2236                 bp = dn_copy_set(fs, bp);
2237         }
2238
2239     DUMMYNET_UNLOCK();
2240
2241     error = sooptcopyout(sopt, buf, size);
2242     free(buf, M_TEMP);
2243     return error ;
2244 }
2245
2246 /*
2247  * Handler for the various dummynet socket options (get, flush, config, del)
2248  */
2249 static int
2250 ip_dn_ctl(struct sockopt *sopt)
2251 {
2252     int error;
2253     struct dn_pipe *p = NULL;
2254
2255     error = priv_check(sopt->sopt_td, PRIV_NETINET_DUMMYNET);
2256     if (error)
2257         return (error);
2258
2259     /* Disallow sets in really-really secure mode. */
2260     if (sopt->sopt_dir == SOPT_SET) {
2261 #if __FreeBSD_version >= 500034
2262         error =  securelevel_ge(sopt->sopt_td->td_ucred, 3);
2263         if (error)
2264             return (error);
2265 #else
2266         if (securelevel >= 3)
2267             return (EPERM);
2268 #endif
2269     }
2270
2271     switch (sopt->sopt_name) {
2272     default :
2273         printf("dummynet: -- unknown option %d", sopt->sopt_name);
2274         error = EINVAL ;
2275         break ;
2276
2277     case IP_DUMMYNET_GET :
2278         error = dummynet_get(sopt);
2279         break ;
2280
2281     case IP_DUMMYNET_FLUSH :
2282         dummynet_flush() ;
2283         break ;
2284
2285     case IP_DUMMYNET_CONFIGURE :
2286         p = malloc(sizeof(struct dn_pipe_max), M_TEMP, M_WAITOK);
2287         error = sooptcopyin(sopt, p, sizeof(struct dn_pipe_max), sizeof *p);
2288         if (error)
2289             break ;
2290         if (p->samples_no > 0)
2291             p->samples = &( ((struct dn_pipe_max*) p)->samples[0] );
2292
2293         error = config_pipe(p);
2294         break ;
2295
2296     case IP_DUMMYNET_DEL :      /* remove a pipe or queue */
2297         p = malloc(sizeof(struct dn_pipe_max), M_TEMP, M_WAITOK);
2298         error = sooptcopyin(sopt, p, sizeof *p, sizeof *p);
2299         if (error)
2300             break ;
2301
2302         error = delete_pipe(p);
2303         break ;
2304     }
2305
2306     if (p != NULL)
2307         free(p, M_TEMP);
2308
2309     return error ;
2310 }
2311
2312 static void
2313 ip_dn_init(void)
2314 {
2315         int i;
2316
2317         if (bootverbose)
2318                 printf("DUMMYNET with IPv6 initialized (040826)\n");
2319
2320         DUMMYNET_LOCK_INIT();
2321
2322         for (i = 0; i < HASHSIZE; i++) {
2323                 SLIST_INIT(&pipehash[i]);
2324                 SLIST_INIT(&flowsethash[i]);
2325         }
2326         ready_heap.size = ready_heap.elements = 0;
2327         ready_heap.offset = 0;
2328
2329         wfq_ready_heap.size = wfq_ready_heap.elements = 0;
2330         wfq_ready_heap.offset = 0;
2331
2332         extract_heap.size = extract_heap.elements = 0;
2333         extract_heap.offset = 0;
2334
2335         ip_dn_ctl_ptr = ip_dn_ctl;
2336         ip_dn_io_ptr = dummynet_io;
2337         ip_dn_ruledel_ptr = dn_rule_delete;
2338
2339         TASK_INIT(&dn_task, 0, dummynet_task, NULL);
2340         dn_tq = taskqueue_create_fast("dummynet", M_NOWAIT,
2341             taskqueue_thread_enqueue, &dn_tq);
2342         taskqueue_start_threads(&dn_tq, 1, PI_NET, "dummynet");
2343
2344         callout_init(&dn_timeout, CALLOUT_MPSAFE);
2345         callout_reset(&dn_timeout, 1, dummynet, NULL);
2346  
2347         /* Initialize curr_time adjustment mechanics. */
2348         getmicrouptime(&prev_t);
2349 }
2350
2351 #ifdef KLD_MODULE
2352 static void
2353 ip_dn_destroy(void)
2354 {
2355         ip_dn_ctl_ptr = NULL;
2356         ip_dn_io_ptr = NULL;
2357         ip_dn_ruledel_ptr = NULL;
2358
2359         DUMMYNET_LOCK();
2360         callout_stop(&dn_timeout);
2361         DUMMYNET_UNLOCK();
2362         taskqueue_drain(dn_tq, &dn_task);
2363         taskqueue_free(dn_tq);
2364
2365         dummynet_flush();
2366
2367         DUMMYNET_LOCK_DESTROY();
2368 }
2369 #endif /* KLD_MODULE */
2370
2371 static int
2372 dummynet_modevent(module_t mod, int type, void *data)
2373 {
2374
2375         switch (type) {
2376         case MOD_LOAD:
2377                 if (ip_dn_io_ptr) {
2378                     printf("DUMMYNET already loaded\n");
2379                     return EEXIST ;
2380                 }
2381                 ip_dn_init();
2382                 break;
2383
2384         case MOD_UNLOAD:
2385 #if !defined(KLD_MODULE)
2386                 printf("dummynet statically compiled, cannot unload\n");
2387                 return EINVAL ;
2388 #else
2389                 ip_dn_destroy();
2390 #endif
2391                 break ;
2392         default:
2393                 return EOPNOTSUPP;
2394                 break ;
2395         }
2396         return 0 ;
2397 }
2398
2399 static moduledata_t dummynet_mod = {
2400         "dummynet",
2401         dummynet_modevent,
2402         NULL
2403 };
2404 DECLARE_MODULE(dummynet, dummynet_mod, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_ANY);
2405 MODULE_DEPEND(dummynet, ipfw, 2, 2, 2);
2406 MODULE_VERSION(dummynet, 1);