2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 Riccardo Panicucci, Universita` di Pisa
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/malloc.h>
35 #include <sys/socket.h>
36 #include <sys/socketvar.h>
37 #include <sys/kernel.h>
40 #include <sys/module.h>
41 #include <sys/rwlock.h>
42 #include <net/if.h> /* IFNAMSIZ */
43 #include <netinet/in.h>
44 #include <netinet/ip_var.h> /* ipfw_rule_ref */
45 #include <netinet/ip_fw.h> /* flow_id */
46 #include <netinet/ip_dummynet.h>
47 #include <netpfil/ipfw/ip_fw_private.h>
48 #include <netpfil/ipfw/dn_heap.h>
49 #include <netpfil/ipfw/ip_dn_private.h>
51 #include <netpfil/ipfw/dn_aqm.h>
53 #include <netpfil/ipfw/dn_sched.h>
58 #define DN_SCHED_RR 3 // XXX Where?
61 struct dn_queue q; /* Standard queue */
62 int status; /* 1: queue is in the list */
63 uint32_t credit; /* max bytes we can transmit */
64 uint32_t quantum; /* quantum * weight */
65 struct rr_queue *qnext; /* */
68 /* struct rr_schk contains global config parameters
69 * and is right after dn_schk
72 uint32_t min_q; /* Min quantum */
73 uint32_t max_q; /* Max quantum */
74 uint32_t q_bytes; /* default quantum in bytes */
77 /* per-instance round robin list, right after dn_sch_inst */
79 struct rr_queue *head, *tail; /* Pointer to current queue */
82 /* Append a queue to the rr list */
84 rr_append(struct rr_queue *q, struct rr_si *si)
86 q->status = 1; /* mark as in-rr_list */
87 q->credit = q->quantum; /* initialize credit */
89 /* append to the tail */
94 si->tail = q; /* advance the tail pointer */
95 q->qnext = si->head; /* make it circular */
98 /* Remove the head queue from circular list. */
100 rr_remove_head(struct rr_si *si)
102 if (si->head == NULL)
103 return; /* empty queue */
104 si->head->status = 0;
106 if (si->head == si->tail) {
107 si->head = si->tail = NULL;
111 si->head = si->head->qnext;
112 si->tail->qnext = si->head;
115 /* Remove a queue from circular list.
116 * XXX see if ti can be merge with remove_queue()
119 remove_queue_q(struct rr_queue *q, struct rr_si *si)
121 struct rr_queue *prev;
130 for (prev = si->head; prev; prev = prev->qnext) {
131 if (prev->qnext != q)
133 prev->qnext = q->qnext;
142 next_pointer(struct rr_si *si)
144 if (si->head == NULL)
145 return; /* empty queue */
147 si->head = si->head->qnext;
148 si->tail = si->tail->qnext;
152 rr_enqueue(struct dn_sch_inst *_si, struct dn_queue *q, struct mbuf *m)
155 struct rr_queue *rrq;
157 if (m != q->mq.head) {
158 if (dn_enqueue(q, m, 0)) /* packet was dropped */
164 /* If reach this point, queue q was idle */
165 si = (struct rr_si *)(_si + 1);
166 rrq = (struct rr_queue *)q;
168 if (rrq->status == 1) /* Queue is already in the queue list */
171 /* Insert the queue in the queue list */
178 rr_dequeue(struct dn_sch_inst *_si)
180 /* Access scheduler instance private data */
181 struct rr_si *si = (struct rr_si *)(_si + 1);
182 struct rr_queue *rrq;
185 while ( (rrq = si->head) ) {
186 struct mbuf *m = rrq->q.mq.head;
188 /* empty queue, remove from list */
192 len = m->m_pkthdr.len;
194 if (len > rrq->credit) {
196 rrq->credit += rrq->quantum;
201 return dn_dequeue(&rrq->q);
205 /* no packet to dequeue*/
210 rr_config(struct dn_schk *_schk)
212 struct rr_schk *schk = (struct rr_schk *)(_schk + 1);
215 /* use reasonable quantums (64..2k bytes, default 1500) */
218 schk->q_bytes = 1500; /* quantum */
224 rr_new_sched(struct dn_sch_inst *_si)
226 struct rr_si *si = (struct rr_si *)(_si + 1);
229 si->head = si->tail = NULL;
235 rr_free_sched(struct dn_sch_inst *_si)
244 rr_new_fsk(struct dn_fsk *fs)
246 struct rr_schk *schk = (struct rr_schk *)(fs->sched + 1);
247 /* par[0] is the weight, par[1] is the quantum step */
248 /* make sure the product fits an uint32_t */
249 ipdn_bound_var(&fs->fs.par[0], 1,
250 1, 65536, "RR weight");
251 ipdn_bound_var(&fs->fs.par[1], schk->q_bytes,
252 schk->min_q, schk->max_q, "RR quantum");
257 rr_new_queue(struct dn_queue *_q)
259 struct rr_queue *q = (struct rr_queue *)_q;
262 _q->ni.oid.subtype = DN_SCHED_RR;
264 quantum = (uint64_t)_q->fs->fs.par[0] * _q->fs->fs.par[1];
265 if (quantum >= (1ULL<< 32)) {
266 D("quantum too large, truncating to 4G - 1");
267 quantum = (1ULL<< 32) - 1;
269 q->quantum = quantum;
270 ND("called, q->quantum %d", q->quantum);
271 q->credit = q->quantum;
274 if (_q->mq.head != NULL) {
275 /* Queue NOT empty, insert in the queue list */
276 rr_append(q, (struct rr_si *)(_q->_si + 1));
282 rr_free_queue(struct dn_queue *_q)
284 struct rr_queue *q = (struct rr_queue *)_q;
287 if (q->status == 1) {
288 struct rr_si *si = (struct rr_si *)(_q->_si + 1);
289 remove_queue_q(q, si);
295 * RR scheduler descriptor
296 * contains the type of the scheduler, the name, the size of the
297 * structures and function pointers.
299 static struct dn_alg rr_desc = {
300 _SI( .type = ) DN_SCHED_RR,
302 _SI( .flags = ) DN_MULTIQUEUE,
304 _SI( .schk_datalen = ) sizeof(struct rr_schk),
305 _SI( .si_datalen = ) sizeof(struct rr_si),
306 _SI( .q_datalen = ) sizeof(struct rr_queue) - sizeof(struct dn_queue),
308 _SI( .enqueue = ) rr_enqueue,
309 _SI( .dequeue = ) rr_dequeue,
311 _SI( .config = ) rr_config,
312 _SI( .destroy = ) NULL,
313 _SI( .new_sched = ) rr_new_sched,
314 _SI( .free_sched = ) rr_free_sched,
315 _SI( .new_fsk = ) rr_new_fsk,
316 _SI( .free_fsk = ) NULL,
317 _SI( .new_queue = ) rr_new_queue,
318 _SI( .free_queue = ) rr_free_queue,
320 _SI( .getconfig = ) NULL,
324 DECLARE_DNSCHED_MODULE(dn_rr, &rr_desc);