sys/netpfil/ipfw/ip_dn_io.c

   1 /*-
   2  * Copyright (c) 2010 Luigi Rizzo, Riccardo Panicucci, Universita` di Pisa
   3  * All rights reserved
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 /*
  28  * Dummynet portions related to packet handling.
  29  */
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include "opt_inet6.h"
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/malloc.h>
  38 #include <sys/mbuf.h>
  39 #include <sys/kernel.h>
  40 #include <sys/lock.h>
  41 #include <sys/module.h>
  42 #include <sys/mutex.h>
  43 #include <sys/priv.h>
  44 #include <sys/proc.h>
  45 #include <sys/rwlock.h>
  46 #include <sys/socket.h>
  47 #include <sys/time.h>
  48 #include <sys/sysctl.h>
  49
  50 #include <net/if.h>     /* IFNAMSIZ, struct ifaddr, ifq head, lock.h mutex.h */
  51 #include <net/netisr.h>
  52 #include <net/vnet.h>
  53
  54 #include <netinet/in.h>
  55 #include <netinet/ip.h>         /* ip_len, ip_off */
  56 #include <netinet/ip_var.h>     /* ip_output(), IP_FORWARDING */
  57 #include <netinet/ip_fw.h>
  58 #include <netinet/ip_dummynet.h>
  59 #include <netinet/if_ether.h> /* various ether_* routines */
  60 #include <netinet/ip6.h>       /* for ip6_input, ip6_output prototypes */
  61 #include <netinet6/ip6_var.h>
  62
  63 #include <netpfil/ipfw/ip_fw_private.h>
  64 #include <netpfil/ipfw/dn_heap.h>
  65 #include <netpfil/ipfw/ip_dn_private.h>
  66 #include <netpfil/ipfw/dn_sched.h>
  67
  68 /*
  69  * We keep a private variable for the simulation time, but we could
  70  * probably use an existing one ("softticks" in sys/kern/kern_timeout.c)
  71  * instead of dn_cfg.curr_time
  72  */
  73
  74 struct dn_parms dn_cfg;
  75 //VNET_DEFINE(struct dn_parms, _base_dn_cfg);
  76
  77 static long tick_last;          /* Last tick duration (usec). */
  78 static long tick_delta;         /* Last vs standard tick diff (usec). */
  79 static long tick_delta_sum;     /* Accumulated tick difference (usec).*/
  80 static long tick_adjustment;    /* Tick adjustments done. */
  81 static long tick_lost;          /* Lost(coalesced) ticks number. */
  82 /* Adjusted vs non-adjusted curr_time difference (ticks). */
  83 static long tick_diff;
  84
  85 static unsigned long    io_pkt;
  86 static unsigned long    io_pkt_fast;
  87 static unsigned long    io_pkt_drop;
  88
  89 /*
  90  * We use a heap to store entities for which we have pending timer events.
  91  * The heap is checked at every tick and all entities with expired events
  92  * are extracted.
  93  */
  94
  95 MALLOC_DEFINE(M_DUMMYNET, "dummynet", "dummynet heap");
  96
  97 extern  void (*bridge_dn_p)(struct mbuf *, struct ifnet *);
  98
  99 #ifdef SYSCTL_NODE
 100
 101 /*
 102  * Because of the way the SYSBEGIN/SYSEND macros work on other
 103  * platforms, there should not be functions between them.
 104  * So keep the handlers outside the block.
 105  */
 106 static int
 107 sysctl_hash_size(SYSCTL_HANDLER_ARGS)
 108 {
 109         int error, value;
 110
 111         value = dn_cfg.hash_size;
 112         error = sysctl_handle_int(oidp, &value, 0, req);
 113         if (error != 0 || req->newptr == NULL)
 114                 return (error);
 115         if (value < 16 || value > 65536)
 116                 return (EINVAL);
 117         dn_cfg.hash_size = value;
 118         return (0);
 119 }
 120
 121 static int
 122 sysctl_limits(SYSCTL_HANDLER_ARGS)
 123 {
 124         int error;
 125         long value;
 126
 127         if (arg2 != 0)
 128                 value = dn_cfg.slot_limit;
 129         else
 130                 value = dn_cfg.byte_limit;
 131         error = sysctl_handle_long(oidp, &value, 0, req);
 132
 133         if (error != 0 || req->newptr == NULL)
 134                 return (error);
 135         if (arg2 != 0) {
 136                 if (value < 1)
 137                         return (EINVAL);
 138                 dn_cfg.slot_limit = value;
 139         } else {
 140                 if (value < 1500)
 141                         return (EINVAL);
 142                 dn_cfg.byte_limit = value;
 143         }
 144         return (0);
 145 }
 146
 147 SYSBEGIN(f4)
 148
 149 SYSCTL_DECL(_net_inet);
 150 SYSCTL_DECL(_net_inet_ip);
 151 static SYSCTL_NODE(_net_inet_ip, OID_AUTO, dummynet, CTLFLAG_RW, 0, "Dummynet");
 152
 153 /* wrapper to pass dn_cfg fields to SYSCTL_* */
 154 //#define DC(x) (&(VNET_NAME(_base_dn_cfg).x))
 155 #define DC(x)   (&(dn_cfg.x))
 156 /* parameters */
 157
 158
 159 SYSCTL_PROC(_net_inet_ip_dummynet, OID_AUTO, hash_size,
 160     CTLTYPE_INT | CTLFLAG_RW, 0, 0, sysctl_hash_size,
 161     "I", "Default hash table size");
 162
 163
 164 SYSCTL_PROC(_net_inet_ip_dummynet, OID_AUTO, pipe_slot_limit,
 165     CTLTYPE_LONG | CTLFLAG_RW, 0, 1, sysctl_limits,
 166     "L", "Upper limit in slots for pipe queue.");
 167 SYSCTL_PROC(_net_inet_ip_dummynet, OID_AUTO, pipe_byte_limit,
 168     CTLTYPE_LONG | CTLFLAG_RW, 0, 0, sysctl_limits,
 169     "L", "Upper limit in bytes for pipe queue.");
 170 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, io_fast,
 171     CTLFLAG_RW, DC(io_fast), 0, "Enable fast dummynet io.");
 172 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, debug,
 173     CTLFLAG_RW, DC(debug), 0, "Dummynet debug level");
 174
 175 /* RED parameters */
 176 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_lookup_depth,
 177     CTLFLAG_RD, DC(red_lookup_depth), 0, "Depth of RED lookup table");
 178 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_avg_pkt_size,
 179     CTLFLAG_RD, DC(red_avg_pkt_size), 0, "RED Medium packet size");
 180 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, red_max_pkt_size,
 181     CTLFLAG_RD, DC(red_max_pkt_size), 0, "RED Max packet size");
 182
 183 /* time adjustment */
 184 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_delta,
 185     CTLFLAG_RD, &tick_delta, 0, "Last vs standard tick difference (usec).");
 186 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_delta_sum,
 187     CTLFLAG_RD, &tick_delta_sum, 0, "Accumulated tick difference (usec).");
 188 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_adjustment,
 189     CTLFLAG_RD, &tick_adjustment, 0, "Tick adjustments done.");
 190 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_diff,
 191     CTLFLAG_RD, &tick_diff, 0,
 192     "Adjusted vs non-adjusted curr_time difference (ticks).");
 193 SYSCTL_LONG(_net_inet_ip_dummynet, OID_AUTO, tick_lost,
 194     CTLFLAG_RD, &tick_lost, 0,
 195     "Number of ticks coalesced by dummynet taskqueue.");
 196
 197 /* Drain parameters */
 198 SYSCTL_UINT(_net_inet_ip_dummynet, OID_AUTO, expire,
 199     CTLFLAG_RW, DC(expire), 0, "Expire empty queues/pipes");
 200 SYSCTL_UINT(_net_inet_ip_dummynet, OID_AUTO, expire_cycle,
 201     CTLFLAG_RD, DC(expire_cycle), 0, "Expire cycle for queues/pipes");
 202
 203 /* statistics */
 204 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, schk_count,
 205     CTLFLAG_RD, DC(schk_count), 0, "Number of schedulers");
 206 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, si_count,
 207     CTLFLAG_RD, DC(si_count), 0, "Number of scheduler instances");
 208 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, fsk_count,
 209     CTLFLAG_RD, DC(fsk_count), 0, "Number of flowsets");
 210 SYSCTL_INT(_net_inet_ip_dummynet, OID_AUTO, queue_count,
 211     CTLFLAG_RD, DC(queue_count), 0, "Number of queues");
 212 SYSCTL_ULONG(_net_inet_ip_dummynet, OID_AUTO, io_pkt,
 213     CTLFLAG_RD, &io_pkt, 0,
 214     "Number of packets passed to dummynet.");
 215 SYSCTL_ULONG(_net_inet_ip_dummynet, OID_AUTO, io_pkt_fast,
 216     CTLFLAG_RD, &io_pkt_fast, 0,
 217     "Number of packets bypassed dummynet scheduler.");
 218 SYSCTL_ULONG(_net_inet_ip_dummynet, OID_AUTO, io_pkt_drop,
 219     CTLFLAG_RD, &io_pkt_drop, 0,
 220     "Number of packets dropped by dummynet.");
 221 #undef DC
 222 SYSEND
 223
 224 #endif
 225
 226 static void     dummynet_send(struct mbuf *);
 227
 228 /*
 229  * Packets processed by dummynet have an mbuf tag associated with
 230  * them that carries their dummynet state.
 231  * Outside dummynet, only the 'rule' field is relevant, and it must
 232  * be at the beginning of the structure.
 233  */
 234 struct dn_pkt_tag {
 235         struct ipfw_rule_ref rule;      /* matching rule        */
 236
 237         /* second part, dummynet specific */
 238         int dn_dir;             /* action when packet comes out.*/
 239                                 /* see ip_fw_private.h          */
 240         uint64_t output_time;   /* when the pkt is due for delivery*/
 241         struct ifnet *ifp;      /* interface, for ip_output     */
 242         struct _ip6dn_args ip6opt;      /* XXX ipv6 options     */
 243 };
 244
 245 /*
 246  * Return the mbuf tag holding the dummynet state (it should
 247  * be the first one on the list).
 248  */
 249 static struct dn_pkt_tag *
 250 dn_tag_get(struct mbuf *m)
 251 {
 252         struct m_tag *mtag = m_tag_first(m);
 253         KASSERT(mtag != NULL &&
 254             mtag->m_tag_cookie == MTAG_ABI_COMPAT &&
 255             mtag->m_tag_id == PACKET_TAG_DUMMYNET,
 256             ("packet on dummynet queue w/o dummynet tag!"));
 257         return (struct dn_pkt_tag *)(mtag+1);
 258 }
 259
 260 static inline void
 261 mq_append(struct mq *q, struct mbuf *m)
 262 {
 263 #ifdef USERSPACE
 264         // buffers from netmap need to be copied
 265         // XXX note that the routine is not expected to fail
 266         ND("append %p to %p", m, q);
 267         if (m->m_flags & M_STACK) {
 268                 struct mbuf *m_new;
 269                 void *p;
 270                 int l, ofs;
 271
 272                 ofs = m->m_data - m->__m_extbuf;
 273                 // XXX allocate
 274                 MGETHDR(m_new, M_NOWAIT, MT_DATA);
 275                 ND("*** WARNING, volatile buf %p ext %p %d dofs %d m_new %p",
 276                         m, m->__m_extbuf, m->__m_extlen, ofs, m_new);
 277                 p = m_new->__m_extbuf;  /* new pointer */
 278                 l = m_new->__m_extlen;  /* new len */
 279                 if (l <= m->__m_extlen) {
 280                         panic("extlen too large");
 281                 }
 282
 283                 *m_new = *m;    // copy
 284                 m_new->m_flags &= ~M_STACK;
 285                 m_new->__m_extbuf = p; // point to new buffer
 286                 pkt_copy(m->__m_extbuf, p, m->__m_extlen);
 287                 m_new->m_data = p + ofs;
 288                 m = m_new;
 289         }
 290 #endif /* USERSPACE */
 291         if (q->head == NULL)
 292                 q->head = m;
 293         else
 294                 q->tail->m_nextpkt = m;
 295         q->count++;
 296         q->tail = m;
 297         m->m_nextpkt = NULL;
 298 }
 299
 300 /*
 301  * Dispose a list of packet. Use a functions so if we need to do
 302  * more work, this is a central point to do it.
 303  */
 304 void dn_free_pkts(struct mbuf *mnext)
 305 {
 306         struct mbuf *m;
 307
 308         while ((m = mnext) != NULL) {
 309                 mnext = m->m_nextpkt;
 310                 FREE_PKT(m);
 311         }
 312 }
 313
 314 static int
 315 red_drops (struct dn_queue *q, int len)
 316 {
 317         /*
 318          * RED algorithm
 319          *
 320          * RED calculates the average queue size (avg) using a low-pass filter
 321          * with an exponential weighted (w_q) moving average:
 322          *      avg  <-  (1-w_q) * avg + w_q * q_size
 323          * where q_size is the queue length (measured in bytes or * packets).
 324          *
 325          * If q_size == 0, we compute the idle time for the link, and set
 326          *      avg = (1 - w_q)^(idle/s)
 327          * where s is the time needed for transmitting a medium-sized packet.
 328          *
 329          * Now, if avg < min_th the packet is enqueued.
 330          * If avg > max_th the packet is dropped. Otherwise, the packet is
 331          * dropped with probability P function of avg.
 332          */
 333
 334         struct dn_fsk *fs = q->fs;
 335         int64_t p_b = 0;
 336
 337         /* Queue in bytes or packets? */
 338         uint32_t q_size = (fs->fs.flags & DN_QSIZE_BYTES) ?
 339             q->ni.len_bytes : q->ni.length;
 340
 341         /* Average queue size estimation. */
 342         if (q_size != 0) {
 343                 /* Queue is not empty, avg <- avg + (q_size - avg) * w_q */
 344                 int diff = SCALE(q_size) - q->avg;
 345                 int64_t v = SCALE_MUL((int64_t)diff, (int64_t)fs->w_q);
 346
 347                 q->avg += (int)v;
 348         } else {
 349                 /*
 350                  * Queue is empty, find for how long the queue has been
 351                  * empty and use a lookup table for computing
 352                  * (1 - * w_q)^(idle_time/s) where s is the time to send a
 353                  * (small) packet.
 354                  * XXX check wraps...
 355                  */
 356                 if (q->avg) {
 357                         u_int t = div64((dn_cfg.curr_time - q->q_time), fs->lookup_step);
 358
 359                         q->avg = (t < fs->lookup_depth) ?
 360                             SCALE_MUL(q->avg, fs->w_q_lookup[t]) : 0;
 361                 }
 362         }
 363
 364         /* Should i drop? */
 365         if (q->avg < fs->min_th) {
 366                 q->count = -1;
 367                 return (0);     /* accept packet */
 368         }
 369         if (q->avg >= fs->max_th) {     /* average queue >=  max threshold */
 370                 if (fs->fs.flags & DN_IS_GENTLE_RED) {
 371                         /*
 372                          * According to Gentle-RED, if avg is greater than
 373                          * max_th the packet is dropped with a probability
 374                          *       p_b = c_3 * avg - c_4
 375                          * where c_3 = (1 - max_p) / max_th
 376                          *       c_4 = 1 - 2 * max_p
 377                          */
 378                         p_b = SCALE_MUL((int64_t)fs->c_3, (int64_t)q->avg) -
 379                             fs->c_4;
 380                 } else {
 381                         q->count = -1;
 382                         return (1);
 383                 }
 384         } else if (q->avg > fs->min_th) {
 385                 /*
 386                  * We compute p_b using the linear dropping function
 387                  *       p_b = c_1 * avg - c_2
 388                  * where c_1 = max_p / (max_th - min_th)
 389                  *       c_2 = max_p * min_th / (max_th - min_th)
 390                  */
 391                 p_b = SCALE_MUL((int64_t)fs->c_1, (int64_t)q->avg) - fs->c_2;
 392         }
 393
 394         if (fs->fs.flags & DN_QSIZE_BYTES)
 395                 p_b = div64((p_b * len) , fs->max_pkt_size);
 396         if (++q->count == 0)
 397                 q->random = random() & 0xffff;
 398         else {
 399                 /*
 400                  * q->count counts packets arrived since last drop, so a greater
 401                  * value of q->count means a greater packet drop probability.
 402                  */
 403                 if (SCALE_MUL(p_b, SCALE((int64_t)q->count)) > q->random) {
 404                         q->count = 0;
 405                         /* After a drop we calculate a new random value. */
 406                         q->random = random() & 0xffff;
 407                         return (1);     /* drop */
 408                 }
 409         }
 410         /* End of RED algorithm. */
 411
 412         return (0);     /* accept */
 413
 414 }
 415
 416 /*
 417  * Enqueue a packet in q, subject to space and queue management policy
 418  * (whose parameters are in q->fs).
 419  * Update stats for the queue and the scheduler.
 420  * Return 0 on success, 1 on drop. The packet is consumed anyways.
 421  */
 422 int
 423 dn_enqueue(struct dn_queue *q, struct mbuf* m, int drop)
 424 {
 425         struct dn_fs *f;
 426         struct dn_flow *ni;     /* stats for scheduler instance */
 427         uint64_t len;
 428
 429         if (q->fs == NULL || q->_si == NULL) {
 430                 printf("%s fs %p si %p, dropping\n",
 431                         __FUNCTION__, q->fs, q->_si);
 432                 FREE_PKT(m);
 433                 return 1;
 434         }
 435         f = &(q->fs->fs);
 436         ni = &q->_si->ni;
 437         len = m->m_pkthdr.len;
 438         /* Update statistics, then check reasons to drop pkt. */
 439         q->ni.tot_bytes += len;
 440         q->ni.tot_pkts++;
 441         ni->tot_bytes += len;
 442         ni->tot_pkts++;
 443         if (drop)
 444                 goto drop;
 445         if (f->plr && random() < f->plr)
 446                 goto drop;
 447         if (f->flags & DN_IS_RED && red_drops(q, m->m_pkthdr.len))
 448                 goto drop;
 449         if (f->flags & DN_QSIZE_BYTES) {
 450                 if (q->ni.len_bytes > f->qsize)
 451                         goto drop;
 452         } else if (q->ni.length >= f->qsize) {
 453                 goto drop;
 454         }
 455         mq_append(&q->mq, m);
 456         q->ni.length++;
 457         q->ni.len_bytes += len;
 458         ni->length++;
 459         ni->len_bytes += len;
 460         return 0;
 461
 462 drop:
 463         io_pkt_drop++;
 464         q->ni.drops++;
 465         ni->drops++;
 466         FREE_PKT(m);
 467         return 1;
 468 }
 469
 470 /*
 471  * Fetch packets from the delay line which are due now. If there are
 472  * leftover packets, reinsert the delay line in the heap.
 473  * Runs under scheduler lock.
 474  */
 475 static void
 476 transmit_event(struct mq *q, struct delay_line *dline, uint64_t now)
 477 {
 478         struct mbuf *m;
 479         struct dn_pkt_tag *pkt = NULL;
 480
 481         dline->oid.subtype = 0; /* not in heap */
 482         while ((m = dline->mq.head) != NULL) {
 483                 pkt = dn_tag_get(m);
 484                 if (!DN_KEY_LEQ(pkt->output_time, now))
 485                         break;
 486                 dline->mq.head = m->m_nextpkt;
 487                 dline->mq.count--;
 488                 mq_append(q, m);
 489         }
 490         if (m != NULL) {
 491                 dline->oid.subtype = 1; /* in heap */
 492                 heap_insert(&dn_cfg.evheap, pkt->output_time, dline);
 493         }
 494 }
 495
 496 /*
 497  * Convert the additional MAC overheads/delays into an equivalent
 498  * number of bits for the given data rate. The samples are
 499  * in milliseconds so we need to divide by 1000.
 500  */
 501 static uint64_t
 502 extra_bits(struct mbuf *m, struct dn_schk *s)
 503 {
 504         int index;
 505         uint64_t bits;
 506         struct dn_profile *pf = s->profile;
 507
 508         if (!pf || pf->samples_no == 0)
 509                 return 0;
 510         index  = random() % pf->samples_no;
 511         bits = div64((uint64_t)pf->samples[index] * s->link.bandwidth, 1000);
 512         if (index >= pf->loss_level) {
 513                 struct dn_pkt_tag *dt = dn_tag_get(m);
 514                 if (dt)
 515                         dt->dn_dir = DIR_DROP;
 516         }
 517         return bits;
 518 }
 519
 520 /*
 521  * Send traffic from a scheduler instance due by 'now'.
 522  * Return a pointer to the head of the queue.
 523  */
 524 static struct mbuf *
 525 serve_sched(struct mq *q, struct dn_sch_inst *si, uint64_t now)
 526 {
 527         struct mq def_q;
 528         struct dn_schk *s = si->sched;
 529         struct mbuf *m = NULL;
 530         int delay_line_idle = (si->dline.mq.head == NULL);
 531         int done, bw;
 532
 533         if (q == NULL) {
 534                 q = &def_q;
 535                 q->head = NULL;
 536         }
 537
 538         bw = s->link.bandwidth;
 539         si->kflags &= ~DN_ACTIVE;
 540
 541         if (bw > 0)
 542                 si->credit += (now - si->sched_time) * bw;
 543         else
 544                 si->credit = 0;
 545         si->sched_time = now;
 546         done = 0;
 547         while (si->credit >= 0 && (m = s->fp->dequeue(si)) != NULL) {
 548                 uint64_t len_scaled;
 549
 550                 done++;
 551                 len_scaled = (bw == 0) ? 0 : hz *
 552                         (m->m_pkthdr.len * 8 + extra_bits(m, s));
 553                 si->credit -= len_scaled;
 554                 /* Move packet in the delay line */
 555                 dn_tag_get(m)->output_time = dn_cfg.curr_time + s->link.delay ;
 556                 mq_append(&si->dline.mq, m);
 557         }
 558
 559         /*
 560          * If credit >= 0 the instance is idle, mark time.
 561          * Otherwise put back in the heap, and adjust the output
 562          * time of the last inserted packet, m, which was too early.
 563          */
 564         if (si->credit >= 0) {
 565                 si->idle_time = now;
 566         } else {
 567                 uint64_t t;
 568                 KASSERT (bw > 0, ("bw=0 and credit<0 ?"));
 569                 t = div64(bw - 1 - si->credit, bw);
 570                 if (m)
 571                         dn_tag_get(m)->output_time += t;
 572                 si->kflags |= DN_ACTIVE;
 573                 heap_insert(&dn_cfg.evheap, now + t, si);
 574         }
 575         if (delay_line_idle && done)
 576                 transmit_event(q, &si->dline, now);
 577         return q->head;
 578 }
 579
 580 /*
 581  * The timer handler for dummynet. Time is computed in ticks, but
 582  * but the code is tolerant to the actual rate at which this is called.
 583  * Once complete, the function reschedules itself for the next tick.
 584  */
 585 void
 586 dummynet_task(void *context, int pending)
 587 {
 588         struct timeval t;
 589         struct mq q = { NULL, NULL }; /* queue to accumulate results */
 590
 591         CURVNET_SET((struct vnet *)context);
 592
 593         DN_BH_WLOCK();
 594
 595         /* Update number of lost(coalesced) ticks. */
 596         tick_lost += pending - 1;
 597
 598         getmicrouptime(&t);
 599         /* Last tick duration (usec). */
 600         tick_last = (t.tv_sec - dn_cfg.prev_t.tv_sec) * 1000000 +
 601         (t.tv_usec - dn_cfg.prev_t.tv_usec);
 602         /* Last tick vs standard tick difference (usec). */
 603         tick_delta = (tick_last * hz - 1000000) / hz;
 604         /* Accumulated tick difference (usec). */
 605         tick_delta_sum += tick_delta;
 606
 607         dn_cfg.prev_t = t;
 608
 609         /*
 610         * Adjust curr_time if the accumulated tick difference is
 611         * greater than the 'standard' tick. Since curr_time should
 612         * be monotonically increasing, we do positive adjustments
 613         * as required, and throttle curr_time in case of negative
 614         * adjustment.
 615         */
 616         dn_cfg.curr_time++;
 617         if (tick_delta_sum - tick >= 0) {
 618                 int diff = tick_delta_sum / tick;
 619
 620                 dn_cfg.curr_time += diff;
 621                 tick_diff += diff;
 622                 tick_delta_sum %= tick;
 623                 tick_adjustment++;
 624         } else if (tick_delta_sum + tick <= 0) {
 625                 dn_cfg.curr_time--;
 626                 tick_diff--;
 627                 tick_delta_sum += tick;
 628                 tick_adjustment++;
 629         }
 630
 631         /* serve pending events, accumulate in q */
 632         for (;;) {
 633                 struct dn_id *p;    /* generic parameter to handler */
 634
 635                 if (dn_cfg.evheap.elements == 0 ||
 636                     DN_KEY_LT(dn_cfg.curr_time, HEAP_TOP(&dn_cfg.evheap)->key))
 637                         break;
 638                 p = HEAP_TOP(&dn_cfg.evheap)->object;
 639                 heap_extract(&dn_cfg.evheap, NULL);
 640
 641                 if (p->type == DN_SCH_I) {
 642                         serve_sched(&q, (struct dn_sch_inst *)p, dn_cfg.curr_time);
 643                 } else { /* extracted a delay line */
 644                         transmit_event(&q, (struct delay_line *)p, dn_cfg.curr_time);
 645                 }
 646         }
 647         if (dn_cfg.expire && ++dn_cfg.expire_cycle >= dn_cfg.expire) {
 648                 dn_cfg.expire_cycle = 0;
 649                 dn_drain_scheduler();
 650                 dn_drain_queue();
 651         }
 652
 653         DN_BH_WUNLOCK();
 654         dn_reschedule();
 655         if (q.head != NULL)
 656                 dummynet_send(q.head);
 657         CURVNET_RESTORE();
 658 }
 659
 660 /*
 661  * forward a chain of packets to the proper destination.
 662  * This runs outside the dummynet lock.
 663  */
 664 static void
 665 dummynet_send(struct mbuf *m)
 666 {
 667         struct mbuf *n;
 668
 669         for (; m != NULL; m = n) {
 670                 struct ifnet *ifp = NULL;       /* gcc 3.4.6 complains */
 671                 struct m_tag *tag;
 672                 int dst;
 673
 674                 n = m->m_nextpkt;
 675                 m->m_nextpkt = NULL;
 676                 tag = m_tag_first(m);
 677                 if (tag == NULL) { /* should not happen */
 678                         dst = DIR_DROP;
 679                 } else {
 680                         struct dn_pkt_tag *pkt = dn_tag_get(m);
 681                         /* extract the dummynet info, rename the tag
 682                          * to carry reinject info.
 683                          */
 684                         dst = pkt->dn_dir;
 685                         ifp = pkt->ifp;
 686                         tag->m_tag_cookie = MTAG_IPFW_RULE;
 687                         tag->m_tag_id = 0;
 688                 }
 689
 690                 switch (dst) {
 691                 case DIR_OUT:
 692                         ip_output(m, NULL, NULL, IP_FORWARDING, NULL, NULL);
 693                         break ;
 694
 695                 case DIR_IN :
 696                         netisr_dispatch(NETISR_IP, m);
 697                         break;
 698
 699 #ifdef INET6
 700                 case DIR_IN | PROTO_IPV6:
 701                         netisr_dispatch(NETISR_IPV6, m);
 702                         break;
 703
 704                 case DIR_OUT | PROTO_IPV6:
 705                         ip6_output(m, NULL, NULL, IPV6_FORWARDING, NULL, NULL, NULL);
 706                         break;
 707 #endif
 708
 709                 case DIR_FWD | PROTO_IFB: /* DN_TO_IFB_FWD: */
 710                         if (bridge_dn_p != NULL)
 711                                 ((*bridge_dn_p)(m, ifp));
 712                         else
 713                                 printf("dummynet: if_bridge not loaded\n");
 714
 715                         break;
 716
 717                 case DIR_IN | PROTO_LAYER2: /* DN_TO_ETH_DEMUX: */
 718                         /*
 719                          * The Ethernet code assumes the Ethernet header is
 720                          * contiguous in the first mbuf header.
 721                          * Insure this is true.
 722                          */
 723                         if (m->m_len < ETHER_HDR_LEN &&
 724                             (m = m_pullup(m, ETHER_HDR_LEN)) == NULL) {
 725                                 printf("dummynet/ether: pullup failed, "
 726                                     "dropping packet\n");
 727                                 break;
 728                         }
 729                         ether_demux(m->m_pkthdr.rcvif, m);
 730                         break;
 731
 732                 case DIR_OUT | PROTO_LAYER2: /* N_TO_ETH_OUT: */
 733                         ether_output_frame(ifp, m);
 734                         break;
 735
 736                 case DIR_DROP:
 737                         /* drop the packet after some time */
 738                         FREE_PKT(m);
 739                         break;
 740
 741                 default:
 742                         printf("dummynet: bad switch %d!\n", dst);
 743                         FREE_PKT(m);
 744                         break;
 745                 }
 746         }
 747 }
 748
 749 static inline int
 750 tag_mbuf(struct mbuf *m, int dir, struct ip_fw_args *fwa)
 751 {
 752         struct dn_pkt_tag *dt;
 753         struct m_tag *mtag;
 754
 755         mtag = m_tag_get(PACKET_TAG_DUMMYNET,
 756                     sizeof(*dt), M_NOWAIT | M_ZERO);
 757         if (mtag == NULL)
 758                 return 1;               /* Cannot allocate packet header. */
 759         m_tag_prepend(m, mtag);         /* Attach to mbuf chain. */
 760         dt = (struct dn_pkt_tag *)(mtag + 1);
 761         dt->rule = fwa->rule;
 762         dt->rule.info &= IPFW_ONEPASS;  /* only keep this info */
 763         dt->dn_dir = dir;
 764         dt->ifp = fwa->oif;
 765         /* dt->output tame is updated as we move through */
 766         dt->output_time = dn_cfg.curr_time;
 767         return 0;
 768 }
 769
 770
 771 /*
 772  * dummynet hook for packets.
 773  * We use the argument to locate the flowset fs and the sched_set sch
 774  * associated to it. The we apply flow_mask and sched_mask to
 775  * determine the queue and scheduler instances.
 776  *
 777  * dir          where shall we send the packet after dummynet.
 778  * *m0          the mbuf with the packet
 779  * ifp          the 'ifp' parameter from the caller.
 780  *              NULL in ip_input, destination interface in ip_output,
 781  */
 782 int
 783 dummynet_io(struct mbuf **m0, int dir, struct ip_fw_args *fwa)
 784 {
 785         struct mbuf *m = *m0;
 786         struct dn_fsk *fs = NULL;
 787         struct dn_sch_inst *si;
 788         struct dn_queue *q = NULL;      /* default */
 789
 790         int fs_id = (fwa->rule.info & IPFW_INFO_MASK) +
 791                 ((fwa->rule.info & IPFW_IS_PIPE) ? 2*DN_MAX_ID : 0);
 792         DN_BH_WLOCK();
 793         io_pkt++;
 794         /* we could actually tag outside the lock, but who cares... */
 795         if (tag_mbuf(m, dir, fwa))
 796                 goto dropit;
 797         if (dn_cfg.busy) {
 798                 /* if the upper half is busy doing something expensive,
 799                  * lets queue the packet and move forward
 800                  */
 801                 mq_append(&dn_cfg.pending, m);
 802                 m = *m0 = NULL; /* consumed */
 803                 goto done; /* already active, nothing to do */
 804         }
 805         /* XXX locate_flowset could be optimised with a direct ref. */
 806         fs = dn_ht_find(dn_cfg.fshash, fs_id, 0, NULL);
 807         if (fs == NULL)
 808                 goto dropit;    /* This queue/pipe does not exist! */
 809         if (fs->sched == NULL)  /* should not happen */
 810                 goto dropit;
 811         /* find scheduler instance, possibly applying sched_mask */
 812         si = ipdn_si_find(fs->sched, &(fwa->f_id));
 813         if (si == NULL)
 814                 goto dropit;
 815         /*
 816          * If the scheduler supports multiple queues, find the right one
 817          * (otherwise it will be ignored by enqueue).
 818          */
 819         if (fs->sched->fp->flags & DN_MULTIQUEUE) {
 820                 q = ipdn_q_find(fs, si, &(fwa->f_id));
 821                 if (q == NULL)
 822                         goto dropit;
 823         }
 824         if (fs->sched->fp->enqueue(si, q, m)) {
 825                 /* packet was dropped by enqueue() */
 826                 m = *m0 = NULL;
 827                 goto dropit;
 828         }
 829
 830         if (si->kflags & DN_ACTIVE) {
 831                 m = *m0 = NULL; /* consumed */
 832                 goto done; /* already active, nothing to do */
 833         }
 834
 835         /* compute the initial allowance */
 836         if (si->idle_time < dn_cfg.curr_time) {
 837             /* Do this only on the first packet on an idle pipe */
 838             struct dn_link *p = &fs->sched->link;
 839
 840             si->sched_time = dn_cfg.curr_time;
 841             si->credit = dn_cfg.io_fast ? p->bandwidth : 0;
 842             if (p->burst) {
 843                 uint64_t burst = (dn_cfg.curr_time - si->idle_time) * p->bandwidth;
 844                 if (burst > p->burst)
 845                         burst = p->burst;
 846                 si->credit += burst;
 847             }
 848         }
 849         /* pass through scheduler and delay line */
 850         m = serve_sched(NULL, si, dn_cfg.curr_time);
 851
 852         /* optimization -- pass it back to ipfw for immediate send */
 853         /* XXX Don't call dummynet_send() if scheduler return the packet
 854          *     just enqueued. This avoid a lock order reversal.
 855          *
 856          */
 857         if (/*dn_cfg.io_fast &&*/ m == *m0 && (dir & PROTO_LAYER2) == 0 ) {
 858                 /* fast io, rename the tag * to carry reinject info. */
 859                 struct m_tag *tag = m_tag_first(m);
 860
 861                 tag->m_tag_cookie = MTAG_IPFW_RULE;
 862                 tag->m_tag_id = 0;
 863                 io_pkt_fast++;
 864                 if (m->m_nextpkt != NULL) {
 865                         printf("dummynet: fast io: pkt chain detected!\n");
 866                         m->m_nextpkt = NULL;
 867                 }
 868                 m = NULL;
 869         } else {
 870                 *m0 = NULL;
 871         }
 872 done:
 873         DN_BH_WUNLOCK();
 874         if (m)
 875                 dummynet_send(m);
 876         return 0;
 877
 878 dropit:
 879         io_pkt_drop++;
 880         DN_BH_WUNLOCK();
 881         if (m)
 882                 FREE_PKT(m);
 883         *m0 = NULL;
 884         return (fs && (fs->fs.flags & DN_NOERROR)) ? 0 : ENOBUFS;
 885 }