dummynet2/dn_sched_fifo.c

   1 /*
   2  * Copyright (c) 2010 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  * $Id: dn_sched_fifo.c 5621 2010-03-04 16:51:27Z luigi $
  29  */
  30
  31 #ifdef _KERNEL
  32 #include <sys/malloc.h>
  33 #include <sys/socket.h>
  34 #include <sys/socketvar.h>
  35 #include <sys/kernel.h>
  36 #include <sys/mbuf.h>
  37 #include <sys/module.h>
  38 #include <net/if.h>     /* IFNAMSIZ */
  39 #include <netinet/in.h>
  40 #include <netinet/ip_var.h>             /* ipfw_rule_ref */
  41 #include <netinet/ip_fw.h>      /* flow_id */
  42 #include <netinet/ip_dummynet.h>
  43 #include <netinet/ipfw/dn_heap.h>
  44 #include <netinet/ipfw/ip_dn_private.h>
  45 #include <netinet/ipfw/dn_sched.h>
  46 #else
  47 #include <dn_test.h>
  48 #endif
  49
  50 /*
  51  * This file implements a FIFO scheduler for a single queue.
  52  * The queue is allocated as part of the scheduler instance,
  53  * and there is a single flowset is in the template which stores
  54  * queue size and policy.
  55  * Enqueue and dequeue use the default library functions.
  56  */
  57 static int
  58 fifo_enqueue(struct dn_sch_inst *si, struct dn_queue *q, struct mbuf *m)
  59 {
  60         /* XXX if called with q != NULL and m=NULL, this is a
  61          * re-enqueue from an existing scheduler, which we should
  62          * handle.
  63          */
  64         return dn_enqueue((struct dn_queue *)(si+1), m, 0);
  65 }
  66
  67 static struct mbuf *
  68 fifo_dequeue(struct dn_sch_inst *si)
  69 {
  70         return dn_dequeue((struct dn_queue *)(si + 1));
  71 }
  72
  73 static int
  74 fifo_new_sched(struct dn_sch_inst *si)
  75 {
  76         /* This scheduler instance contains the queue */
  77         struct dn_queue *q = (struct dn_queue *)(si + 1);
  78
  79         set_oid(&q->ni.oid, DN_QUEUE, sizeof(*q));
  80         q->_si = si;
  81         q->fs = si->sched->fs;
  82         return 0;
  83 }
  84
  85 static int
  86 fifo_free_sched(struct dn_sch_inst *si)
  87 {
  88         struct dn_queue *q = (struct dn_queue *)(si + 1);
  89         dn_free_pkts(q->mq.head);
  90         bzero(q, sizeof(*q));
  91         return 0;
  92 }
  93
  94 /*
  95  * FIFO scheduler descriptor
  96  * contains the type of the scheduler, the name, the size of extra
  97  * data structures, and function pointers.
  98  */
  99 static struct dn_alg fifo_desc = {
 100         _SI( .type = )  DN_SCHED_FIFO,
 101         _SI( .name = )  "FIFO",
 102         _SI( .flags = ) 0,
 103
 104         _SI( .schk_datalen = ) 0,
 105         _SI( .si_datalen = )  sizeof(struct dn_queue),
 106         _SI( .q_datalen = )  0,
 107
 108         _SI( .enqueue = )  fifo_enqueue,
 109         _SI( .dequeue = )  fifo_dequeue,
 110         _SI( .config = )  NULL,
 111         _SI( .destroy = )  NULL,
 112         _SI( .new_sched = )  fifo_new_sched,
 113         _SI( .free_sched = )  fifo_free_sched,
 114         _SI( .new_fsk = )  NULL,
 115         _SI( .free_fsk = )  NULL,
 116         _SI( .new_queue = )  NULL,
 117         _SI( .free_queue = )  NULL,
 118 };
 119
 120 DECLARE_DNSCHED_MODULE(dn_fifo, &fifo_desc);