xref: /dragonfly/sys/net/altq/altq_hfsc.c (revision 25a2db75)
1 /*	$KAME: altq_hfsc.c,v 1.25 2004/04/17 10:54:48 kjc Exp $	*/
2 
3 /*
4  * Copyright (c) 1997-1999 Carnegie Mellon University. All Rights Reserved.
5  *
6  * Permission to use, copy, modify, and distribute this software and
7  * its documentation is hereby granted (including for commercial or
8  * for-profit use), provided that both the copyright notice and this
9  * permission notice appear in all copies of the software, derivative
10  * works, or modified versions, and any portions thereof.
11  *
12  * THIS SOFTWARE IS EXPERIMENTAL AND IS KNOWN TO HAVE BUGS, SOME OF
13  * WHICH MAY HAVE SERIOUS CONSEQUENCES.  CARNEGIE MELLON PROVIDES THIS
14  * SOFTWARE IN ITS ``AS IS'' CONDITION, AND ANY EXPRESS OR IMPLIED
15  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
20  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
21  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
24  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25  * DAMAGE.
26  *
27  * Carnegie Mellon encourages (but does not require) users of this
28  * software to return any improvements or extensions that they make,
29  * and to grant Carnegie Mellon the rights to redistribute these
30  * changes without encumbrance.
31  */
32 /*
33  * H-FSC is described in Proceedings of SIGCOMM'97,
34  * "A Hierarchical Fair Service Curve Algorithm for Link-Sharing,
35  * Real-Time and Priority Service"
36  * by Ion Stoica, Hui Zhang, and T. S. Eugene Ng.
37  *
38  * Oleg Cherevko <olwi@aq.ml.com.ua> added the upperlimit for link-sharing.
39  * when a class has an upperlimit, the fit-time is computed from the
40  * upperlimit service curve.  the link-sharing scheduler does not schedule
41  * a class whose fit-time exceeds the current time.
42  */
43 
44 #include "opt_altq.h"
45 #include "opt_inet.h"
46 #include "opt_inet6.h"
47 
48 #ifdef ALTQ_HFSC  /* hfsc is enabled by ALTQ_HFSC option in opt_altq.h */
49 
50 #include <sys/param.h>
51 #include <sys/malloc.h>
52 #include <sys/mbuf.h>
53 #include <sys/socket.h>
54 #include <sys/systm.h>
55 #include <sys/errno.h>
56 #include <sys/queue.h>
57 #include <sys/thread.h>
58 
59 #include <net/if.h>
60 #include <net/ifq_var.h>
61 #include <netinet/in.h>
62 
63 #include <net/pf/pfvar.h>
64 #include <net/altq/altq.h>
65 #include <net/altq/altq_hfsc.h>
66 
67 #include <sys/thread2.h>
68 
69 #define HFSC_SUBQ_INDEX		ALTQ_SUBQ_INDEX_DEFAULT
70 #define HFSC_LOCK(ifq) \
71     ALTQ_SQ_LOCK(&(ifq)->altq_subq[HFSC_SUBQ_INDEX])
72 #define HFSC_UNLOCK(ifq) \
73     ALTQ_SQ_UNLOCK(&(ifq)->altq_subq[HFSC_SUBQ_INDEX])
74 
75 /*
76  * function prototypes
77  */
78 static int	hfsc_clear_interface(struct hfsc_if *);
79 static int	hfsc_request(struct ifaltq_subque *, int, void *);
80 static void	hfsc_purge(struct hfsc_if *);
81 static struct hfsc_class *hfsc_class_create(struct hfsc_if *,
82 					    struct service_curve *,
83 					    struct service_curve *,
84 					    struct service_curve *,
85 					    struct hfsc_class *, int, int, int);
86 static int	hfsc_class_destroy(struct hfsc_class *);
87 static struct hfsc_class *hfsc_nextclass(struct hfsc_class *);
88 static int	hfsc_enqueue(struct ifaltq_subque *, struct mbuf *,
89 			     struct altq_pktattr *);
90 static struct mbuf *hfsc_dequeue(struct ifaltq_subque *, struct mbuf *, int);
91 
92 static int	hfsc_addq(struct hfsc_class *, struct mbuf *);
93 static struct mbuf *hfsc_getq(struct hfsc_class *);
94 static struct mbuf *hfsc_pollq(struct hfsc_class *);
95 static void	hfsc_purgeq(struct hfsc_class *);
96 
97 static void	update_cfmin(struct hfsc_class *);
98 static void	set_active(struct hfsc_class *, int);
99 static void	set_passive(struct hfsc_class *);
100 
101 static void	init_ed(struct hfsc_class *, int);
102 static void	update_ed(struct hfsc_class *, int);
103 static void	update_d(struct hfsc_class *, int);
104 static void	init_vf(struct hfsc_class *, int);
105 static void	update_vf(struct hfsc_class *, int, uint64_t);
106 static ellist_t *ellist_alloc(void);
107 static void	ellist_destroy(ellist_t *);
108 static void	ellist_insert(struct hfsc_class *);
109 static void	ellist_remove(struct hfsc_class *);
110 static void	ellist_update(struct hfsc_class *);
111 struct hfsc_class *ellist_get_mindl(ellist_t *, uint64_t);
112 static actlist_t *actlist_alloc(void);
113 static void	actlist_destroy(actlist_t *);
114 static void	actlist_insert(struct hfsc_class *);
115 static void	actlist_remove(struct hfsc_class *);
116 static void	actlist_update(struct hfsc_class *);
117 
118 static struct hfsc_class *actlist_firstfit(struct hfsc_class *, uint64_t);
119 
120 static __inline uint64_t	seg_x2y(uint64_t, uint64_t);
121 static __inline uint64_t	seg_y2x(uint64_t, uint64_t);
122 static __inline uint64_t	m2sm(u_int);
123 static __inline uint64_t	m2ism(u_int);
124 static __inline uint64_t	d2dx(u_int);
125 static u_int			sm2m(uint64_t);
126 static u_int			dx2d(uint64_t);
127 
128 static void	sc2isc(struct service_curve *, struct internal_sc *);
129 static void	rtsc_init(struct runtime_sc *, struct internal_sc *,
130 			  uint64_t, uint64_t);
131 static uint64_t	rtsc_y2x(struct runtime_sc *, uint64_t);
132 static uint64_t	rtsc_x2y(struct runtime_sc *, uint64_t);
133 static void	rtsc_min(struct runtime_sc *, struct internal_sc *,
134 			 uint64_t, uint64_t);
135 
136 static void	get_class_stats(struct hfsc_classstats *, struct hfsc_class *);
137 static struct hfsc_class *clh_to_clp(struct hfsc_if *, uint32_t);
138 
139 /*
140  * macros
141  */
142 #define	is_a_parent_class(cl)	((cl)->cl_children != NULL)
143 
144 #define	HT_INFINITY	0xffffffffffffffffLL	/* infinite time value */
145 
146 int
147 hfsc_pfattach(struct pf_altq *a, struct ifaltq *ifq)
148 {
149 	return altq_attach(ifq, ALTQT_HFSC, a->altq_disc, ifq_mapsubq_default,
150 	    hfsc_enqueue, hfsc_dequeue, hfsc_request, NULL, NULL);
151 }
152 
153 int
154 hfsc_add_altq(struct pf_altq *a)
155 {
156 	struct hfsc_if *hif;
157 	struct ifnet *ifp;
158 
159 	if ((ifp = ifunit(a->ifname)) == NULL)
160 		return (EINVAL);
161 	if (!ifq_is_ready(&ifp->if_snd))
162 		return (ENODEV);
163 
164 	hif = kmalloc(sizeof(struct hfsc_if), M_ALTQ, M_WAITOK | M_ZERO);
165 
166 	hif->hif_eligible = ellist_alloc();
167 	hif->hif_ifq = &ifp->if_snd;
168 	ifq_purge_all(&ifp->if_snd);
169 
170 	/* keep the state in pf_altq */
171 	a->altq_disc = hif;
172 
173 	return (0);
174 }
175 
176 int
177 hfsc_remove_altq(struct pf_altq *a)
178 {
179 	struct hfsc_if *hif;
180 
181 	if ((hif = a->altq_disc) == NULL)
182 		return (EINVAL);
183 	a->altq_disc = NULL;
184 
185 	hfsc_clear_interface(hif);
186 	hfsc_class_destroy(hif->hif_rootclass);
187 
188 	ellist_destroy(hif->hif_eligible);
189 
190 	kfree(hif, M_ALTQ);
191 
192 	return (0);
193 }
194 
195 static int
196 hfsc_add_queue_locked(struct pf_altq *a, struct hfsc_if *hif)
197 {
198 	struct hfsc_class *cl, *parent;
199 	struct hfsc_opts *opts;
200 	struct service_curve rtsc, lssc, ulsc;
201 
202 	KKASSERT(a->qid != 0);
203 
204 	opts = &a->pq_u.hfsc_opts;
205 
206 	if (a->parent_qid == HFSC_NULLCLASS_HANDLE && hif->hif_rootclass == NULL)
207 		parent = NULL;
208 	else if ((parent = clh_to_clp(hif, a->parent_qid)) == NULL)
209 		return (EINVAL);
210 
211 	if (clh_to_clp(hif, a->qid) != NULL)
212 		return (EBUSY);
213 
214 	rtsc.m1 = opts->rtsc_m1;
215 	rtsc.d  = opts->rtsc_d;
216 	rtsc.m2 = opts->rtsc_m2;
217 	lssc.m1 = opts->lssc_m1;
218 	lssc.d  = opts->lssc_d;
219 	lssc.m2 = opts->lssc_m2;
220 	ulsc.m1 = opts->ulsc_m1;
221 	ulsc.d  = opts->ulsc_d;
222 	ulsc.m2 = opts->ulsc_m2;
223 
224 	cl = hfsc_class_create(hif, &rtsc, &lssc, &ulsc, parent, a->qlimit,
225 			       opts->flags, a->qid);
226 	if (cl == NULL)
227 		return (ENOMEM);
228 
229 	return (0);
230 }
231 
232 int
233 hfsc_add_queue(struct pf_altq *a)
234 {
235 	struct hfsc_if *hif;
236 	struct ifaltq *ifq;
237 	int error;
238 
239 	if (a->qid == 0)
240 		return (EINVAL);
241 
242 	/* XXX not MP safe */
243 	if ((hif = a->altq_disc) == NULL)
244 		return (EINVAL);
245 	ifq = hif->hif_ifq;
246 
247 	HFSC_LOCK(ifq);
248 	error = hfsc_add_queue_locked(a, hif);
249 	HFSC_UNLOCK(ifq);
250 
251 	return error;
252 }
253 
254 static int
255 hfsc_remove_queue_locked(struct pf_altq *a, struct hfsc_if *hif)
256 {
257 	struct hfsc_class *cl;
258 
259 	if ((cl = clh_to_clp(hif, a->qid)) == NULL)
260 		return (EINVAL);
261 
262 	return (hfsc_class_destroy(cl));
263 }
264 
265 int
266 hfsc_remove_queue(struct pf_altq *a)
267 {
268 	struct hfsc_if *hif;
269 	struct ifaltq *ifq;
270 	int error;
271 
272 	/* XXX not MP safe */
273 	if ((hif = a->altq_disc) == NULL)
274 		return (EINVAL);
275 	ifq = hif->hif_ifq;
276 
277 	HFSC_LOCK(ifq);
278 	error = hfsc_remove_queue_locked(a, hif);
279 	HFSC_UNLOCK(ifq);
280 
281 	return error;
282 }
283 
284 int
285 hfsc_getqstats(struct pf_altq *a, void *ubuf, int *nbytes)
286 {
287 	struct hfsc_if *hif;
288 	struct hfsc_class *cl;
289 	struct hfsc_classstats stats;
290 	struct ifaltq *ifq;
291 	int error = 0;
292 
293 	if (*nbytes < sizeof(stats))
294 		return (EINVAL);
295 
296 	/* XXX not MP safe */
297 	if ((hif = altq_lookup(a->ifname, ALTQT_HFSC)) == NULL)
298 		return (EBADF);
299 	ifq = hif->hif_ifq;
300 
301 	HFSC_LOCK(ifq);
302 
303 	if ((cl = clh_to_clp(hif, a->qid)) == NULL) {
304 		HFSC_UNLOCK(ifq);
305 		return (EINVAL);
306 	}
307 
308 	get_class_stats(&stats, cl);
309 
310 	HFSC_UNLOCK(ifq);
311 
312 	if ((error = copyout((caddr_t)&stats, ubuf, sizeof(stats))) != 0)
313 		return (error);
314 	*nbytes = sizeof(stats);
315 	return (0);
316 }
317 
318 /*
319  * bring the interface back to the initial state by discarding
320  * all the filters and classes except the root class.
321  */
322 static int
323 hfsc_clear_interface(struct hfsc_if *hif)
324 {
325 	struct hfsc_class *cl;
326 
327 	if (hif->hif_rootclass == NULL)
328 		return (0);
329 
330 
331 	/* clear out the classes */
332 	while ((cl = hif->hif_rootclass->cl_children) != NULL) {
333 		/*
334 		 * remove the first leaf class found in the hierarchy
335 		 * then start over
336 		 */
337 		for (; cl != NULL; cl = hfsc_nextclass(cl)) {
338 			if (!is_a_parent_class(cl)) {
339 				hfsc_class_destroy(cl);
340 				break;
341 			}
342 		}
343 	}
344 
345 	return (0);
346 }
347 
348 static int
349 hfsc_request(struct ifaltq_subque *ifsq, int req, void *arg)
350 {
351 	struct ifaltq *ifq = ifsq->ifsq_altq;
352 	struct hfsc_if *hif = (struct hfsc_if *)ifq->altq_disc;
353 
354 	crit_enter();
355 	switch (req) {
356 	case ALTRQ_PURGE:
357 		if (ifsq_get_index(ifsq) == HFSC_SUBQ_INDEX) {
358 			hfsc_purge(hif);
359 		} else {
360 			/*
361 			 * Race happened, the unrelated subqueue was
362 			 * picked during the packet scheduler transition.
363 			 */
364 			ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
365 		}
366 		break;
367 	}
368 	crit_exit();
369 	return (0);
370 }
371 
372 /* discard all the queued packets on the interface */
373 static void
374 hfsc_purge(struct hfsc_if *hif)
375 {
376 	struct hfsc_class *cl;
377 
378 	for (cl = hif->hif_rootclass; cl != NULL; cl = hfsc_nextclass(cl)) {
379 		if (!qempty(cl->cl_q))
380 			hfsc_purgeq(cl);
381 	}
382 	if (ifq_is_enabled(hif->hif_ifq))
383 		hif->hif_ifq->altq_subq[HFSC_SUBQ_INDEX].ifq_len = 0;
384 }
385 
386 struct hfsc_class *
387 hfsc_class_create(struct hfsc_if *hif, struct service_curve *rsc,
388 		  struct service_curve *fsc, struct service_curve *usc,
389 		  struct hfsc_class *parent, int qlimit, int flags, int qid)
390 {
391 	struct hfsc_class *cl, *p;
392 	int i;
393 
394 	if (hif->hif_classes >= HFSC_MAX_CLASSES)
395 		return (NULL);
396 
397 #ifndef ALTQ_RED
398 	if (flags & HFCF_RED) {
399 #ifdef ALTQ_DEBUG
400 		kprintf("hfsc_class_create: RED not configured for HFSC!\n");
401 #endif
402 		return (NULL);
403 	}
404 #endif
405 
406 	cl = kmalloc(sizeof(*cl), M_ALTQ, M_WAITOK | M_ZERO);
407 	cl->cl_q = kmalloc(sizeof(*cl->cl_q), M_ALTQ, M_WAITOK | M_ZERO);
408 	cl->cl_actc = actlist_alloc();
409 
410 	if (qlimit == 0)
411 		qlimit = 50;  /* use default */
412 	qlimit(cl->cl_q) = qlimit;
413 	qtype(cl->cl_q) = Q_DROPTAIL;
414 	qlen(cl->cl_q) = 0;
415 	cl->cl_flags = flags;
416 #ifdef ALTQ_RED
417 	if (flags & (HFCF_RED|HFCF_RIO)) {
418 		int red_flags, red_pkttime;
419 		u_int m2;
420 
421 		m2 = 0;
422 		if (rsc != NULL && rsc->m2 > m2)
423 			m2 = rsc->m2;
424 		if (fsc != NULL && fsc->m2 > m2)
425 			m2 = fsc->m2;
426 		if (usc != NULL && usc->m2 > m2)
427 			m2 = usc->m2;
428 
429 		red_flags = 0;
430 		if (flags & HFCF_ECN)
431 			red_flags |= REDF_ECN;
432 #ifdef ALTQ_RIO
433 		if (flags & HFCF_CLEARDSCP)
434 			red_flags |= RIOF_CLEARDSCP;
435 #endif
436 		if (m2 < 8)
437 			red_pkttime = 1000 * 1000 * 1000; /* 1 sec */
438 		else
439 			red_pkttime = (int64_t)hif->hif_ifq->altq_ifp->if_mtu
440 				* 1000 * 1000 * 1000 / (m2 / 8);
441 		if (flags & HFCF_RED) {
442 			cl->cl_red = red_alloc(0, 0,
443 			    qlimit(cl->cl_q) * 10/100,
444 			    qlimit(cl->cl_q) * 30/100,
445 			    red_flags, red_pkttime);
446 			if (cl->cl_red != NULL)
447 				qtype(cl->cl_q) = Q_RED;
448 		}
449 #ifdef ALTQ_RIO
450 		else {
451 			cl->cl_red = (red_t *)rio_alloc(0, NULL,
452 			    red_flags, red_pkttime);
453 			if (cl->cl_red != NULL)
454 				qtype(cl->cl_q) = Q_RIO;
455 		}
456 #endif
457 	}
458 #endif /* ALTQ_RED */
459 
460 	if (rsc != NULL && (rsc->m1 != 0 || rsc->m2 != 0)) {
461 		cl->cl_rsc = kmalloc(sizeof(*cl->cl_rsc), M_ALTQ, M_WAITOK);
462 		sc2isc(rsc, cl->cl_rsc);
463 		rtsc_init(&cl->cl_deadline, cl->cl_rsc, 0, 0);
464 		rtsc_init(&cl->cl_eligible, cl->cl_rsc, 0, 0);
465 	}
466 	if (fsc != NULL && (fsc->m1 != 0 || fsc->m2 != 0)) {
467 		cl->cl_fsc = kmalloc(sizeof(*cl->cl_fsc), M_ALTQ, M_WAITOK);
468 		sc2isc(fsc, cl->cl_fsc);
469 		rtsc_init(&cl->cl_virtual, cl->cl_fsc, 0, 0);
470 	}
471 	if (usc != NULL && (usc->m1 != 0 || usc->m2 != 0)) {
472 		cl->cl_usc = kmalloc(sizeof(*cl->cl_usc), M_ALTQ, M_WAITOK);
473 		sc2isc(usc, cl->cl_usc);
474 		rtsc_init(&cl->cl_ulimit, cl->cl_usc, 0, 0);
475 	}
476 
477 	cl->cl_id = hif->hif_classid++;
478 	cl->cl_handle = qid;
479 	cl->cl_hif = hif;
480 	cl->cl_parent = parent;
481 
482 	crit_enter();
483 	hif->hif_classes++;
484 
485 	/*
486 	 * find a free slot in the class table.  if the slot matching
487 	 * the lower bits of qid is free, use this slot.  otherwise,
488 	 * use the first free slot.
489 	 */
490 	i = qid % HFSC_MAX_CLASSES;
491 	if (hif->hif_class_tbl[i] == NULL)
492 		hif->hif_class_tbl[i] = cl;
493 	else {
494 		for (i = 0; i < HFSC_MAX_CLASSES; i++) {
495 			if (hif->hif_class_tbl[i] == NULL) {
496 				hif->hif_class_tbl[i] = cl;
497 				break;
498 			}
499 		}
500 		if (i == HFSC_MAX_CLASSES) {
501 			crit_exit();
502 			goto err_ret;
503 		}
504 	}
505 
506 	if (flags & HFCF_DEFAULTCLASS)
507 		hif->hif_defaultclass = cl;
508 
509 	if (parent == NULL) {
510 		/* this is root class */
511 		hif->hif_rootclass = cl;
512 	} else if (parent->cl_children == NULL) {
513 		/* add this class to the children list of the parent */
514 		parent->cl_children = cl;
515 	} else {
516 		p = parent->cl_children;
517 		while (p->cl_siblings != NULL)
518 			p = p->cl_siblings;
519 		p->cl_siblings = cl;
520 	}
521 	crit_exit();
522 
523 	return (cl);
524 
525  err_ret:
526 	if (cl->cl_actc != NULL)
527 		actlist_destroy(cl->cl_actc);
528 	if (cl->cl_red != NULL) {
529 #ifdef ALTQ_RIO
530 		if (q_is_rio(cl->cl_q))
531 			rio_destroy((rio_t *)cl->cl_red);
532 #endif
533 #ifdef ALTQ_RED
534 		if (q_is_red(cl->cl_q))
535 			red_destroy(cl->cl_red);
536 #endif
537 	}
538 	if (cl->cl_fsc != NULL)
539 		kfree(cl->cl_fsc, M_ALTQ);
540 	if (cl->cl_rsc != NULL)
541 		kfree(cl->cl_rsc, M_ALTQ);
542 	if (cl->cl_usc != NULL)
543 		kfree(cl->cl_usc, M_ALTQ);
544 	if (cl->cl_q != NULL)
545 		kfree(cl->cl_q, M_ALTQ);
546 	kfree(cl, M_ALTQ);
547 	return (NULL);
548 }
549 
550 static int
551 hfsc_class_destroy(struct hfsc_class *cl)
552 {
553 	struct hfsc_if *hif;
554 	int i;
555 
556 	if (cl == NULL)
557 		return (0);
558 	hif = cl->cl_hif;
559 
560 	if (is_a_parent_class(cl))
561 		return (EBUSY);
562 
563 	crit_enter();
564 
565 	if (!qempty(cl->cl_q))
566 		hfsc_purgeq(cl);
567 
568 	if (cl->cl_parent == NULL) {
569 		/* this is root class */
570 	} else {
571 		struct hfsc_class *p = cl->cl_parent->cl_children;
572 
573 		if (p == cl) {
574 			cl->cl_parent->cl_children = cl->cl_siblings;
575 		} else {
576 			do {
577 				if (p->cl_siblings == cl) {
578 					p->cl_siblings = cl->cl_siblings;
579 					break;
580 				}
581 			} while ((p = p->cl_siblings) != NULL);
582 		}
583 		KKASSERT(p != NULL);
584 	}
585 
586 	for (i = 0; i < HFSC_MAX_CLASSES; i++) {
587 		if (hif->hif_class_tbl[i] == cl) {
588 			hif->hif_class_tbl[i] = NULL;
589 			break;
590 		}
591 	}
592 
593 	hif->hif_classes--;
594 	crit_exit();
595 
596 	actlist_destroy(cl->cl_actc);
597 
598 	if (cl->cl_red != NULL) {
599 #ifdef ALTQ_RIO
600 		if (q_is_rio(cl->cl_q))
601 			rio_destroy((rio_t *)cl->cl_red);
602 #endif
603 #ifdef ALTQ_RED
604 		if (q_is_red(cl->cl_q))
605 			red_destroy(cl->cl_red);
606 #endif
607 	}
608 
609 	if (cl == hif->hif_rootclass)
610 		hif->hif_rootclass = NULL;
611 	if (cl == hif->hif_defaultclass)
612 		hif->hif_defaultclass = NULL;
613 	if (cl == hif->hif_pollcache)
614 		hif->hif_pollcache = NULL;
615 
616 	if (cl->cl_usc != NULL)
617 		kfree(cl->cl_usc, M_ALTQ);
618 	if (cl->cl_fsc != NULL)
619 		kfree(cl->cl_fsc, M_ALTQ);
620 	if (cl->cl_rsc != NULL)
621 		kfree(cl->cl_rsc, M_ALTQ);
622 	kfree(cl->cl_q, M_ALTQ);
623 	kfree(cl, M_ALTQ);
624 
625 	return (0);
626 }
627 
628 /*
629  * hfsc_nextclass returns the next class in the tree.
630  *   usage:
631  *	for (cl = hif->hif_rootclass; cl != NULL; cl = hfsc_nextclass(cl))
632  *		do_something;
633  */
634 static struct hfsc_class *
635 hfsc_nextclass(struct hfsc_class *cl)
636 {
637 	if (cl->cl_children != NULL) {
638 		cl = cl->cl_children;
639 	} else if (cl->cl_siblings != NULL) {
640 		cl = cl->cl_siblings;
641 	} else {
642 		while ((cl = cl->cl_parent) != NULL) {
643 			if (cl->cl_siblings != NULL) {
644 				cl = cl->cl_siblings;
645 				break;
646 			}
647 		}
648 	}
649 
650 	return (cl);
651 }
652 
653 /*
654  * hfsc_enqueue is an enqueue function to be registered to
655  * (*altq_enqueue) in struct ifaltq.
656  */
657 static int
658 hfsc_enqueue(struct ifaltq_subque *ifsq, struct mbuf *m,
659     struct altq_pktattr *pktattr)
660 {
661 	struct ifaltq *ifq = ifsq->ifsq_altq;
662 	struct hfsc_if	*hif = (struct hfsc_if *)ifq->altq_disc;
663 	struct hfsc_class *cl;
664 	int len;
665 
666 	if (ifsq_get_index(ifsq) != HFSC_SUBQ_INDEX) {
667 		/*
668 		 * Race happened, the unrelated subqueue was
669 		 * picked during the packet scheduler transition.
670 		 */
671 		ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
672 		m_freem(m);
673 		return ENOBUFS;
674 	}
675 
676 	/* grab class set by classifier */
677 	if ((m->m_flags & M_PKTHDR) == 0) {
678 		/* should not happen */
679 		if_printf(ifq->altq_ifp, "altq: packet does not have pkthdr\n");
680 		m_freem(m);
681 		return (ENOBUFS);
682 	}
683 	crit_enter();
684 	if (m->m_pkthdr.fw_flags & PF_MBUF_STRUCTURE)
685 		cl = clh_to_clp(hif, m->m_pkthdr.pf.qid);
686 	else
687 		cl = NULL;
688 	if (cl == NULL || is_a_parent_class(cl)) {
689 		cl = hif->hif_defaultclass;
690 		if (cl == NULL) {
691 			m_freem(m);
692 			crit_exit();
693 			return (ENOBUFS);
694 		}
695 	}
696 	cl->cl_pktattr = NULL;
697 	len = m_pktlen(m);
698 	if (hfsc_addq(cl, m) != 0) {
699 		/* drop occurred.  mbuf was freed in hfsc_addq. */
700 		PKTCNTR_ADD(&cl->cl_stats.drop_cnt, len);
701 		crit_exit();
702 		return (ENOBUFS);
703 	}
704 	ifsq->ifq_len++;
705 	cl->cl_hif->hif_packets++;
706 
707 	/* successfully queued. */
708 	if (qlen(cl->cl_q) == 1)
709 		set_active(cl, m_pktlen(m));
710 	crit_exit();
711 	return (0);
712 }
713 
714 /*
715  * hfsc_dequeue is a dequeue function to be registered to
716  * (*altq_dequeue) in struct ifaltq.
717  *
718  * note: ALTDQ_POLL returns the next packet without removing the packet
719  *	from the queue.  ALTDQ_REMOVE is a normal dequeue operation.
720  *	ALTDQ_REMOVE must return the same packet if called immediately
721  *	after ALTDQ_POLL.
722  */
723 static struct mbuf *
724 hfsc_dequeue(struct ifaltq_subque *ifsq, struct mbuf *mpolled, int op)
725 {
726 	struct ifaltq *ifq = ifsq->ifsq_altq;
727 	struct hfsc_if	*hif = (struct hfsc_if *)ifq->altq_disc;
728 	struct hfsc_class *cl;
729 	struct mbuf *m;
730 	int len, next_len;
731 	int realtime = 0;
732 	uint64_t cur_time;
733 
734 	if (ifsq_get_index(ifsq) != HFSC_SUBQ_INDEX) {
735 		/*
736 		 * Race happened, the unrelated subqueue was
737 		 * picked during the packet scheduler transition.
738 		 */
739 		ifsq_classic_request(ifsq, ALTRQ_PURGE, NULL);
740 		return NULL;
741 	}
742 
743 	if (hif->hif_packets == 0) {
744 		/* no packet in the tree */
745 		return (NULL);
746 	}
747 
748 	crit_enter();
749 	cur_time = read_machclk();
750 
751 	if (op == ALTDQ_REMOVE && hif->hif_pollcache != NULL) {
752 		cl = hif->hif_pollcache;
753 		hif->hif_pollcache = NULL;
754 		/* check if the class was scheduled by real-time criteria */
755 		if (cl->cl_rsc != NULL)
756 			realtime = (cl->cl_e <= cur_time);
757 	} else {
758 		/*
759 		 * if there are eligible classes, use real-time criteria.
760 		 * find the class with the minimum deadline among
761 		 * the eligible classes.
762 		 */
763 		if ((cl = ellist_get_mindl(hif->hif_eligible, cur_time)) != NULL) {
764 			realtime = 1;
765 		} else {
766 #ifdef ALTQ_DEBUG
767 			int fits = 0;
768 #endif
769 			/*
770 			 * use link-sharing criteria
771 			 * get the class with the minimum vt in the hierarchy
772 			 */
773 			cl = hif->hif_rootclass;
774 			while (is_a_parent_class(cl)) {
775 
776 				cl = actlist_firstfit(cl, cur_time);
777 				if (cl == NULL) {
778 #ifdef ALTQ_DEBUG
779 					if (fits > 0)
780 						kprintf("%d fit but none found\n",fits);
781 #endif
782 					m = NULL;
783 					goto done;
784 				}
785 				/*
786 				 * update parent's cl_cvtmin.
787 				 * don't update if the new vt is smaller.
788 				 */
789 				if (cl->cl_parent->cl_cvtmin < cl->cl_vt)
790 					cl->cl_parent->cl_cvtmin = cl->cl_vt;
791 #ifdef ALTQ_DEBUG
792 				fits++;
793 #endif
794 			}
795 		}
796 
797 		if (op == ALTDQ_POLL) {
798 #ifdef foo
799 			/*
800 			 * Don't use poll cache; the poll/dequeue
801 			 * model is no longer applicable to SMP
802 			 * system.  e.g.
803 			 *    CPU-A            CPU-B
804 			 *      :                :
805 			 *    poll               :
806 			 *      :              poll
807 			 *    dequeue (+)        :
808 			 *
809 			 * The dequeue at (+) will hit the poll
810 			 * cache set by CPU-B.
811 			 */
812 			hif->hif_pollcache = cl;
813 #endif
814 			m = hfsc_pollq(cl);
815 			goto done;
816 		}
817 	}
818 
819 	m = hfsc_getq(cl);
820 	if (m == NULL)
821 		panic("hfsc_dequeue:");
822 	len = m_pktlen(m);
823 	cl->cl_hif->hif_packets--;
824 	ifsq->ifq_len--;
825 	PKTCNTR_ADD(&cl->cl_stats.xmit_cnt, len);
826 
827 	update_vf(cl, len, cur_time);
828 	if (realtime)
829 		cl->cl_cumul += len;
830 
831 	if (!qempty(cl->cl_q)) {
832 		if (cl->cl_rsc != NULL) {
833 			/* update ed */
834 			next_len = m_pktlen(qhead(cl->cl_q));
835 
836 			if (realtime)
837 				update_ed(cl, next_len);
838 			else
839 				update_d(cl, next_len);
840 		}
841 	} else {
842 		/* the class becomes passive */
843 		set_passive(cl);
844 	}
845 done:
846 	crit_exit();
847 	KKASSERT(mpolled == NULL || m == mpolled);
848 	return (m);
849 }
850 
851 static int
852 hfsc_addq(struct hfsc_class *cl, struct mbuf *m)
853 {
854 
855 #ifdef ALTQ_RIO
856 	if (q_is_rio(cl->cl_q))
857 		return rio_addq((rio_t *)cl->cl_red, cl->cl_q,
858 				m, cl->cl_pktattr);
859 #endif
860 #ifdef ALTQ_RED
861 	if (q_is_red(cl->cl_q))
862 		return red_addq(cl->cl_red, cl->cl_q, m, cl->cl_pktattr);
863 #endif
864 	if (qlen(cl->cl_q) >= qlimit(cl->cl_q)) {
865 		m_freem(m);
866 		return (-1);
867 	}
868 
869 	if (cl->cl_flags & HFCF_CLEARDSCP)
870 		write_dsfield(m, cl->cl_pktattr, 0);
871 
872 	_addq(cl->cl_q, m);
873 
874 	return (0);
875 }
876 
877 static struct mbuf *
878 hfsc_getq(struct hfsc_class *cl)
879 {
880 #ifdef ALTQ_RIO
881 	if (q_is_rio(cl->cl_q))
882 		return rio_getq((rio_t *)cl->cl_red, cl->cl_q);
883 #endif
884 #ifdef ALTQ_RED
885 	if (q_is_red(cl->cl_q))
886 		return red_getq(cl->cl_red, cl->cl_q);
887 #endif
888 	return _getq(cl->cl_q);
889 }
890 
891 static struct mbuf *
892 hfsc_pollq(struct hfsc_class *cl)
893 {
894 	return qhead(cl->cl_q);
895 }
896 
897 static void
898 hfsc_purgeq(struct hfsc_class *cl)
899 {
900 	struct mbuf *m;
901 
902 	if (qempty(cl->cl_q))
903 		return;
904 
905 	while ((m = _getq(cl->cl_q)) != NULL) {
906 		PKTCNTR_ADD(&cl->cl_stats.drop_cnt, m_pktlen(m));
907 		m_freem(m);
908 		cl->cl_hif->hif_packets--;
909 		cl->cl_hif->hif_ifq->altq_subq[HFSC_SUBQ_INDEX].ifq_len--;
910 	}
911 	KKASSERT(qlen(cl->cl_q) == 0);
912 
913 	update_vf(cl, 0, 0);	/* remove cl from the actlist */
914 	set_passive(cl);
915 }
916 
917 static void
918 set_active(struct hfsc_class *cl, int len)
919 {
920 	if (cl->cl_rsc != NULL)
921 		init_ed(cl, len);
922 	if (cl->cl_fsc != NULL)
923 		init_vf(cl, len);
924 
925 	cl->cl_stats.period++;
926 }
927 
928 static void
929 set_passive(struct hfsc_class *cl)
930 {
931 	if (cl->cl_rsc != NULL)
932 		ellist_remove(cl);
933 
934 	/*
935 	 * actlist is now handled in update_vf() so that update_vf(cl, 0, 0)
936 	 * needs to be called explicitly to remove a class from actlist
937 	 */
938 }
939 
940 static void
941 init_ed(struct hfsc_class *cl, int next_len)
942 {
943 	uint64_t cur_time;
944 
945 	cur_time = read_machclk();
946 
947 	/* update the deadline curve */
948 	rtsc_min(&cl->cl_deadline, cl->cl_rsc, cur_time, cl->cl_cumul);
949 
950 	/*
951 	 * update the eligible curve.
952 	 * for concave, it is equal to the deadline curve.
953 	 * for convex, it is a linear curve with slope m2.
954 	 */
955 	cl->cl_eligible = cl->cl_deadline;
956 	if (cl->cl_rsc->sm1 <= cl->cl_rsc->sm2) {
957 		cl->cl_eligible.dx = 0;
958 		cl->cl_eligible.dy = 0;
959 	}
960 
961 	/* compute e and d */
962 	cl->cl_e = rtsc_y2x(&cl->cl_eligible, cl->cl_cumul);
963 	cl->cl_d = rtsc_y2x(&cl->cl_deadline, cl->cl_cumul + next_len);
964 
965 	ellist_insert(cl);
966 }
967 
968 static void
969 update_ed(struct hfsc_class *cl, int next_len)
970 {
971 	cl->cl_e = rtsc_y2x(&cl->cl_eligible, cl->cl_cumul);
972 	cl->cl_d = rtsc_y2x(&cl->cl_deadline, cl->cl_cumul + next_len);
973 
974 	ellist_update(cl);
975 }
976 
977 static void
978 update_d(struct hfsc_class *cl, int next_len)
979 {
980 	cl->cl_d = rtsc_y2x(&cl->cl_deadline, cl->cl_cumul + next_len);
981 }
982 
983 static void
984 init_vf(struct hfsc_class *cl, int len)
985 {
986 	struct hfsc_class *max_cl, *p;
987 	uint64_t vt, f, cur_time;
988 	int go_active;
989 
990 	cur_time = 0;
991 	go_active = 1;
992 	for ( ; cl->cl_parent != NULL; cl = cl->cl_parent) {
993 		if (go_active && cl->cl_nactive++ == 0)
994 			go_active = 1;
995 		else
996 			go_active = 0;
997 
998 		if (go_active) {
999 			max_cl = actlist_last(cl->cl_parent->cl_actc);
1000 			if (max_cl != NULL) {
1001 				/*
1002 				 * set vt to the average of the min and max
1003 				 * classes.  if the parent's period didn't
1004 				 * change, don't decrease vt of the class.
1005 				 */
1006 				vt = max_cl->cl_vt;
1007 				if (cl->cl_parent->cl_cvtmin != 0)
1008 					vt = (cl->cl_parent->cl_cvtmin + vt)/2;
1009 
1010 				if (cl->cl_parent->cl_vtperiod !=
1011 				    cl->cl_parentperiod || vt > cl->cl_vt)
1012 					cl->cl_vt = vt;
1013 			} else {
1014 				/*
1015 				 * first child for a new parent backlog period.
1016 				 * add parent's cvtmax to vtoff of children
1017 				 * to make a new vt (vtoff + vt) larger than
1018 				 * the vt in the last period for all children.
1019 				 */
1020 				vt = cl->cl_parent->cl_cvtmax;
1021 				for (p = cl->cl_parent->cl_children; p != NULL;
1022 				     p = p->cl_siblings)
1023 					p->cl_vtoff += vt;
1024 				cl->cl_vt = 0;
1025 				cl->cl_parent->cl_cvtmax = 0;
1026 				cl->cl_parent->cl_cvtmin = 0;
1027 			}
1028 			cl->cl_initvt = cl->cl_vt;
1029 
1030 			/* update the virtual curve */
1031 			vt = cl->cl_vt + cl->cl_vtoff;
1032 			rtsc_min(&cl->cl_virtual, cl->cl_fsc, vt, cl->cl_total);
1033 			if (cl->cl_virtual.x == vt) {
1034 				cl->cl_virtual.x -= cl->cl_vtoff;
1035 				cl->cl_vtoff = 0;
1036 			}
1037 			cl->cl_vtadj = 0;
1038 
1039 			cl->cl_vtperiod++;  /* increment vt period */
1040 			cl->cl_parentperiod = cl->cl_parent->cl_vtperiod;
1041 			if (cl->cl_parent->cl_nactive == 0)
1042 				cl->cl_parentperiod++;
1043 			cl->cl_f = 0;
1044 
1045 			actlist_insert(cl);
1046 
1047 			if (cl->cl_usc != NULL) {
1048 				/* class has upper limit curve */
1049 				if (cur_time == 0)
1050 					cur_time = read_machclk();
1051 
1052 				/* update the ulimit curve */
1053 				rtsc_min(&cl->cl_ulimit, cl->cl_usc, cur_time,
1054 				    cl->cl_total);
1055 				/* compute myf */
1056 				cl->cl_myf = rtsc_y2x(&cl->cl_ulimit,
1057 				    cl->cl_total);
1058 				cl->cl_myfadj = 0;
1059 			}
1060 		}
1061 
1062 		if (cl->cl_myf > cl->cl_cfmin)
1063 			f = cl->cl_myf;
1064 		else
1065 			f = cl->cl_cfmin;
1066 		if (f != cl->cl_f) {
1067 			cl->cl_f = f;
1068 			update_cfmin(cl->cl_parent);
1069 		}
1070 	}
1071 }
1072 
1073 static void
1074 update_vf(struct hfsc_class *cl, int len, uint64_t cur_time)
1075 {
1076 	uint64_t f, myf_bound, delta;
1077 	int go_passive;
1078 
1079 	go_passive = qempty(cl->cl_q);
1080 
1081 	for (; cl->cl_parent != NULL; cl = cl->cl_parent) {
1082 		cl->cl_total += len;
1083 
1084 		if (cl->cl_fsc == NULL || cl->cl_nactive == 0)
1085 			continue;
1086 
1087 		if (go_passive && --cl->cl_nactive == 0)
1088 			go_passive = 1;
1089 		else
1090 			go_passive = 0;
1091 
1092 		if (go_passive) {
1093 			/* no more active child, going passive */
1094 
1095 			/* update cvtmax of the parent class */
1096 			if (cl->cl_vt > cl->cl_parent->cl_cvtmax)
1097 				cl->cl_parent->cl_cvtmax = cl->cl_vt;
1098 
1099 			/* remove this class from the vt list */
1100 			actlist_remove(cl);
1101 
1102 			update_cfmin(cl->cl_parent);
1103 
1104 			continue;
1105 		}
1106 
1107 		/*
1108 		 * update vt and f
1109 		 */
1110 		cl->cl_vt = rtsc_y2x(&cl->cl_virtual, cl->cl_total)
1111 		    - cl->cl_vtoff + cl->cl_vtadj;
1112 
1113 		/*
1114 		 * if vt of the class is smaller than cvtmin,
1115 		 * the class was skipped in the past due to non-fit.
1116 		 * if so, we need to adjust vtadj.
1117 		 */
1118 		if (cl->cl_vt < cl->cl_parent->cl_cvtmin) {
1119 			cl->cl_vtadj += cl->cl_parent->cl_cvtmin - cl->cl_vt;
1120 			cl->cl_vt = cl->cl_parent->cl_cvtmin;
1121 		}
1122 
1123 		/* update the vt list */
1124 		actlist_update(cl);
1125 
1126 		if (cl->cl_usc != NULL) {
1127 			cl->cl_myf = cl->cl_myfadj
1128 			    + rtsc_y2x(&cl->cl_ulimit, cl->cl_total);
1129 
1130 			/*
1131 			 * if myf lags behind by more than one clock tick
1132 			 * from the current time, adjust myfadj to prevent
1133 			 * a rate-limited class from going greedy.
1134 			 * in a steady state under rate-limiting, myf
1135 			 * fluctuates within one clock tick.
1136 			 */
1137 			myf_bound = cur_time - machclk_per_tick;
1138 			if (cl->cl_myf < myf_bound) {
1139 				delta = cur_time - cl->cl_myf;
1140 				cl->cl_myfadj += delta;
1141 				cl->cl_myf += delta;
1142 			}
1143 		}
1144 
1145 		/* cl_f is max(cl_myf, cl_cfmin) */
1146 		if (cl->cl_myf > cl->cl_cfmin)
1147 			f = cl->cl_myf;
1148 		else
1149 			f = cl->cl_cfmin;
1150 		if (f != cl->cl_f) {
1151 			cl->cl_f = f;
1152 			update_cfmin(cl->cl_parent);
1153 		}
1154 	}
1155 }
1156 
1157 static void
1158 update_cfmin(struct hfsc_class *cl)
1159 {
1160 	struct hfsc_class *p;
1161 	uint64_t cfmin;
1162 
1163 	if (TAILQ_EMPTY(cl->cl_actc)) {
1164 		cl->cl_cfmin = 0;
1165 		return;
1166 	}
1167 	cfmin = HT_INFINITY;
1168 	TAILQ_FOREACH(p, cl->cl_actc, cl_actlist) {
1169 		if (p->cl_f == 0) {
1170 			cl->cl_cfmin = 0;
1171 			return;
1172 		}
1173 		if (p->cl_f < cfmin)
1174 			cfmin = p->cl_f;
1175 	}
1176 	cl->cl_cfmin = cfmin;
1177 }
1178 
1179 /*
1180  * TAILQ based ellist and actlist implementation
1181  * (ion wanted to make a calendar queue based implementation)
1182  */
1183 /*
1184  * eligible list holds backlogged classes being sorted by their eligible times.
1185  * there is one eligible list per interface.
1186  */
1187 
1188 static ellist_t *
1189 ellist_alloc(void)
1190 {
1191 	ellist_t *head;
1192 
1193 	head = kmalloc(sizeof(*head), M_ALTQ, M_WAITOK);
1194 	TAILQ_INIT(head);
1195 	return (head);
1196 }
1197 
1198 static void
1199 ellist_destroy(ellist_t *head)
1200 {
1201 	kfree(head, M_ALTQ);
1202 }
1203 
1204 static void
1205 ellist_insert(struct hfsc_class *cl)
1206 {
1207 	struct hfsc_if *hif = cl->cl_hif;
1208 	struct hfsc_class *p;
1209 
1210 	/* check the last entry first */
1211 	if ((p = TAILQ_LAST(hif->hif_eligible, _eligible)) == NULL ||
1212 	    p->cl_e <= cl->cl_e) {
1213 		TAILQ_INSERT_TAIL(hif->hif_eligible, cl, cl_ellist);
1214 		return;
1215 	}
1216 
1217 	TAILQ_FOREACH(p, hif->hif_eligible, cl_ellist) {
1218 		if (cl->cl_e < p->cl_e) {
1219 			TAILQ_INSERT_BEFORE(p, cl, cl_ellist);
1220 			return;
1221 		}
1222 	}
1223 	KKASSERT(0); /* should not reach here */
1224 }
1225 
1226 static void
1227 ellist_remove(struct hfsc_class *cl)
1228 {
1229 	struct hfsc_if *hif = cl->cl_hif;
1230 
1231 	TAILQ_REMOVE(hif->hif_eligible, cl, cl_ellist);
1232 }
1233 
1234 static void
1235 ellist_update(struct hfsc_class *cl)
1236 {
1237 	struct hfsc_if *hif = cl->cl_hif;
1238 	struct hfsc_class *p, *last;
1239 
1240 	/*
1241 	 * the eligible time of a class increases monotonically.
1242 	 * if the next entry has a larger eligible time, nothing to do.
1243 	 */
1244 	p = TAILQ_NEXT(cl, cl_ellist);
1245 	if (p == NULL || cl->cl_e <= p->cl_e)
1246 		return;
1247 
1248 	/* check the last entry */
1249 	last = TAILQ_LAST(hif->hif_eligible, _eligible);
1250 	KKASSERT(last != NULL);
1251 	if (last->cl_e <= cl->cl_e) {
1252 		TAILQ_REMOVE(hif->hif_eligible, cl, cl_ellist);
1253 		TAILQ_INSERT_TAIL(hif->hif_eligible, cl, cl_ellist);
1254 		return;
1255 	}
1256 
1257 	/*
1258 	 * the new position must be between the next entry
1259 	 * and the last entry
1260 	 */
1261 	while ((p = TAILQ_NEXT(p, cl_ellist)) != NULL) {
1262 		if (cl->cl_e < p->cl_e) {
1263 			TAILQ_REMOVE(hif->hif_eligible, cl, cl_ellist);
1264 			TAILQ_INSERT_BEFORE(p, cl, cl_ellist);
1265 			return;
1266 		}
1267 	}
1268 	KKASSERT(0); /* should not reach here */
1269 }
1270 
1271 /* find the class with the minimum deadline among the eligible classes */
1272 struct hfsc_class *
1273 ellist_get_mindl(ellist_t *head, uint64_t cur_time)
1274 {
1275 	struct hfsc_class *p, *cl = NULL;
1276 
1277 	TAILQ_FOREACH(p, head, cl_ellist) {
1278 		if (p->cl_e > cur_time)
1279 			break;
1280 		if (cl == NULL || p->cl_d < cl->cl_d)
1281 			cl = p;
1282 	}
1283 	return (cl);
1284 }
1285 
1286 /*
1287  * active children list holds backlogged child classes being sorted
1288  * by their virtual time.
1289  * each intermediate class has one active children list.
1290  */
1291 static actlist_t *
1292 actlist_alloc(void)
1293 {
1294 	actlist_t *head;
1295 
1296 	head = kmalloc(sizeof(*head), M_ALTQ, M_WAITOK);
1297 	TAILQ_INIT(head);
1298 	return (head);
1299 }
1300 
1301 static void
1302 actlist_destroy(actlist_t *head)
1303 {
1304 	kfree(head, M_ALTQ);
1305 }
1306 static void
1307 actlist_insert(struct hfsc_class *cl)
1308 {
1309 	struct hfsc_class *p;
1310 
1311 	/* check the last entry first */
1312 	if ((p = TAILQ_LAST(cl->cl_parent->cl_actc, _active)) == NULL
1313 	    || p->cl_vt <= cl->cl_vt) {
1314 		TAILQ_INSERT_TAIL(cl->cl_parent->cl_actc, cl, cl_actlist);
1315 		return;
1316 	}
1317 
1318 	TAILQ_FOREACH(p, cl->cl_parent->cl_actc, cl_actlist) {
1319 		if (cl->cl_vt < p->cl_vt) {
1320 			TAILQ_INSERT_BEFORE(p, cl, cl_actlist);
1321 			return;
1322 		}
1323 	}
1324 	KKASSERT(0); /* should not reach here */
1325 }
1326 
1327 static void
1328 actlist_remove(struct hfsc_class *cl)
1329 {
1330 	TAILQ_REMOVE(cl->cl_parent->cl_actc, cl, cl_actlist);
1331 }
1332 
1333 static void
1334 actlist_update(struct hfsc_class *cl)
1335 {
1336 	struct hfsc_class *p, *last;
1337 
1338 	/*
1339 	 * the virtual time of a class increases monotonically during its
1340 	 * backlogged period.
1341 	 * if the next entry has a larger virtual time, nothing to do.
1342 	 */
1343 	p = TAILQ_NEXT(cl, cl_actlist);
1344 	if (p == NULL || cl->cl_vt < p->cl_vt)
1345 		return;
1346 
1347 	/* check the last entry */
1348 	last = TAILQ_LAST(cl->cl_parent->cl_actc, _active);
1349 	KKASSERT(last != NULL);
1350 	if (last->cl_vt <= cl->cl_vt) {
1351 		TAILQ_REMOVE(cl->cl_parent->cl_actc, cl, cl_actlist);
1352 		TAILQ_INSERT_TAIL(cl->cl_parent->cl_actc, cl, cl_actlist);
1353 		return;
1354 	}
1355 
1356 	/*
1357 	 * the new position must be between the next entry
1358 	 * and the last entry
1359 	 */
1360 	while ((p = TAILQ_NEXT(p, cl_actlist)) != NULL) {
1361 		if (cl->cl_vt < p->cl_vt) {
1362 			TAILQ_REMOVE(cl->cl_parent->cl_actc, cl, cl_actlist);
1363 			TAILQ_INSERT_BEFORE(p, cl, cl_actlist);
1364 			return;
1365 		}
1366 	}
1367 	KKASSERT(0); /* should not reach here */
1368 }
1369 
1370 static struct hfsc_class *
1371 actlist_firstfit(struct hfsc_class *cl, uint64_t cur_time)
1372 {
1373 	struct hfsc_class *p;
1374 
1375 	TAILQ_FOREACH(p, cl->cl_actc, cl_actlist) {
1376 		if (p->cl_f <= cur_time)
1377 			return (p);
1378 	}
1379 	return (NULL);
1380 }
1381 
1382 /*
1383  * service curve support functions
1384  *
1385  *  external service curve parameters
1386  *	m: bits/sec
1387  *	d: msec
1388  *  internal service curve parameters
1389  *	sm: (bytes/tsc_interval) << SM_SHIFT
1390  *	ism: (tsc_count/byte) << ISM_SHIFT
1391  *	dx: tsc_count
1392  *
1393  * SM_SHIFT and ISM_SHIFT are scaled in order to keep effective digits.
1394  * we should be able to handle 100K-1Gbps linkspeed with 200Hz-1GHz CPU
1395  * speed.  SM_SHIFT and ISM_SHIFT are selected to have at least 3 effective
1396  * digits in decimal using the following table.
1397  *
1398  *  bits/sec    100Kbps     1Mbps     10Mbps     100Mbps    1Gbps
1399  *  ----------+-------------------------------------------------------
1400  *  bytes/nsec  12.5e-6    125e-6     1250e-6    12500e-6   125000e-6
1401  *  sm(500MHz)  25.0e-6    250e-6     2500e-6    25000e-6   250000e-6
1402  *  sm(200MHz)  62.5e-6    625e-6     6250e-6    62500e-6   625000e-6
1403  *
1404  *  nsec/byte   80000      8000       800        80         8
1405  *  ism(500MHz) 40000      4000       400        40         4
1406  *  ism(200MHz) 16000      1600       160        16         1.6
1407  */
1408 #define	SM_SHIFT	24
1409 #define	ISM_SHIFT	10
1410 
1411 #define	SM_MASK		((1LL << SM_SHIFT) - 1)
1412 #define	ISM_MASK	((1LL << ISM_SHIFT) - 1)
1413 
1414 static __inline uint64_t
1415 seg_x2y(uint64_t x, uint64_t sm)
1416 {
1417 	uint64_t y;
1418 
1419 	/*
1420 	 * compute
1421 	 *	y = x * sm >> SM_SHIFT
1422 	 * but divide it for the upper and lower bits to avoid overflow
1423 	 */
1424 	y = (x >> SM_SHIFT) * sm + (((x & SM_MASK) * sm) >> SM_SHIFT);
1425 	return (y);
1426 }
1427 
1428 static __inline uint64_t
1429 seg_y2x(uint64_t y, uint64_t ism)
1430 {
1431 	uint64_t x;
1432 
1433 	if (y == 0)
1434 		x = 0;
1435 	else if (ism == HT_INFINITY)
1436 		x = HT_INFINITY;
1437 	else
1438 		x = (y >> ISM_SHIFT) * ism + (((y & ISM_MASK) * ism) >> ISM_SHIFT);
1439 
1440 	return (x);
1441 }
1442 
1443 static __inline uint64_t
1444 m2sm(u_int m)
1445 {
1446 	uint64_t sm;
1447 
1448 	sm = ((uint64_t)m << SM_SHIFT) / 8 / machclk_freq;
1449 	return (sm);
1450 }
1451 
1452 static __inline uint64_t
1453 m2ism(u_int m)
1454 {
1455 	uint64_t ism;
1456 
1457 	if (m == 0)
1458 		ism = HT_INFINITY;
1459 	else
1460 		ism = ((uint64_t)machclk_freq << ISM_SHIFT) * 8 / m;
1461 	return (ism);
1462 }
1463 
1464 static __inline uint64_t
1465 d2dx(u_int d)
1466 {
1467 	uint64_t dx;
1468 
1469 	dx = ((uint64_t)d * machclk_freq) / 1000;
1470 	return (dx);
1471 }
1472 
1473 static u_int
1474 sm2m(uint64_t sm)
1475 {
1476 	uint64_t m;
1477 
1478 	m = (sm * 8 * machclk_freq) >> SM_SHIFT;
1479 	return ((u_int)m);
1480 }
1481 
1482 static u_int
1483 dx2d(uint64_t dx)
1484 {
1485 	uint64_t d;
1486 
1487 	d = dx * 1000 / machclk_freq;
1488 	return ((u_int)d);
1489 }
1490 
1491 static void
1492 sc2isc(struct service_curve *sc, struct internal_sc *isc)
1493 {
1494 	isc->sm1 = m2sm(sc->m1);
1495 	isc->ism1 = m2ism(sc->m1);
1496 	isc->dx = d2dx(sc->d);
1497 	isc->dy = seg_x2y(isc->dx, isc->sm1);
1498 	isc->sm2 = m2sm(sc->m2);
1499 	isc->ism2 = m2ism(sc->m2);
1500 }
1501 
1502 /*
1503  * initialize the runtime service curve with the given internal
1504  * service curve starting at (x, y).
1505  */
1506 static void
1507 rtsc_init(struct runtime_sc *rtsc, struct internal_sc *isc, uint64_t x, uint64_t y)
1508 {
1509 	rtsc->x = x;
1510 	rtsc->y = y;
1511 	rtsc->sm1 = isc->sm1;
1512 	rtsc->ism1 = isc->ism1;
1513 	rtsc->dx = isc->dx;
1514 	rtsc->dy = isc->dy;
1515 	rtsc->sm2 = isc->sm2;
1516 	rtsc->ism2 = isc->ism2;
1517 }
1518 
1519 /*
1520  * calculate the y-projection of the runtime service curve by the
1521  * given x-projection value
1522  */
1523 static uint64_t
1524 rtsc_y2x(struct runtime_sc *rtsc, uint64_t y)
1525 {
1526 	uint64_t x;
1527 
1528 	if (y < rtsc->y) {
1529 		x = rtsc->x;
1530 	} else if (y <= rtsc->y + rtsc->dy) {
1531 		/* x belongs to the 1st segment */
1532 		if (rtsc->dy == 0)
1533 			x = rtsc->x + rtsc->dx;
1534 		else
1535 			x = rtsc->x + seg_y2x(y - rtsc->y, rtsc->ism1);
1536 	} else {
1537 		/* x belongs to the 2nd segment */
1538 		x = rtsc->x + rtsc->dx
1539 		    + seg_y2x(y - rtsc->y - rtsc->dy, rtsc->ism2);
1540 	}
1541 	return (x);
1542 }
1543 
1544 static uint64_t
1545 rtsc_x2y(struct runtime_sc *rtsc, uint64_t x)
1546 {
1547 	uint64_t y;
1548 
1549 	if (x <= rtsc->x) {
1550 		y = rtsc->y;
1551 	} else if (x <= rtsc->x + rtsc->dx) {
1552 		/* y belongs to the 1st segment */
1553 		y = rtsc->y + seg_x2y(x - rtsc->x, rtsc->sm1);
1554 	} else
1555 		/* y belongs to the 2nd segment */
1556 		y = rtsc->y + rtsc->dy
1557 		    + seg_x2y(x - rtsc->x - rtsc->dx, rtsc->sm2);
1558 	return (y);
1559 }
1560 
1561 /*
1562  * update the runtime service curve by taking the minimum of the current
1563  * runtime service curve and the service curve starting at (x, y).
1564  */
1565 static void
1566 rtsc_min(struct runtime_sc *rtsc, struct internal_sc *isc, uint64_t x, uint64_t y)
1567 {
1568 	uint64_t y1, y2, dx, dy;
1569 
1570 	if (isc->sm1 <= isc->sm2) {
1571 		/* service curve is convex */
1572 		y1 = rtsc_x2y(rtsc, x);
1573 		if (y1 < y)
1574 			/* the current rtsc is smaller */
1575 			return;
1576 		rtsc->x = x;
1577 		rtsc->y = y;
1578 		return;
1579 	}
1580 
1581 	/*
1582 	 * service curve is concave
1583 	 * compute the two y values of the current rtsc
1584 	 *	y1: at x
1585 	 *	y2: at (x + dx)
1586 	 */
1587 	y1 = rtsc_x2y(rtsc, x);
1588 	if (y1 <= y) {
1589 		/* rtsc is below isc, no change to rtsc */
1590 		return;
1591 	}
1592 
1593 	y2 = rtsc_x2y(rtsc, x + isc->dx);
1594 	if (y2 >= y + isc->dy) {
1595 		/* rtsc is above isc, replace rtsc by isc */
1596 		rtsc->x = x;
1597 		rtsc->y = y;
1598 		rtsc->dx = isc->dx;
1599 		rtsc->dy = isc->dy;
1600 		return;
1601 	}
1602 
1603 	/*
1604 	 * the two curves intersect
1605 	 * compute the offsets (dx, dy) using the reverse
1606 	 * function of seg_x2y()
1607 	 *	seg_x2y(dx, sm1) == seg_x2y(dx, sm2) + (y1 - y)
1608 	 */
1609 	dx = ((y1 - y) << SM_SHIFT) / (isc->sm1 - isc->sm2);
1610 	/*
1611 	 * check if (x, y1) belongs to the 1st segment of rtsc.
1612 	 * if so, add the offset.
1613 	 */
1614 	if (rtsc->x + rtsc->dx > x)
1615 		dx += rtsc->x + rtsc->dx - x;
1616 	dy = seg_x2y(dx, isc->sm1);
1617 
1618 	rtsc->x = x;
1619 	rtsc->y = y;
1620 	rtsc->dx = dx;
1621 	rtsc->dy = dy;
1622 }
1623 
1624 static void
1625 get_class_stats(struct hfsc_classstats *sp, struct hfsc_class *cl)
1626 {
1627 	sp->class_id = cl->cl_id;
1628 	sp->class_handle = cl->cl_handle;
1629 
1630 	if (cl->cl_rsc != NULL) {
1631 		sp->rsc.m1 = sm2m(cl->cl_rsc->sm1);
1632 		sp->rsc.d = dx2d(cl->cl_rsc->dx);
1633 		sp->rsc.m2 = sm2m(cl->cl_rsc->sm2);
1634 	} else {
1635 		sp->rsc.m1 = 0;
1636 		sp->rsc.d = 0;
1637 		sp->rsc.m2 = 0;
1638 	}
1639 	if (cl->cl_fsc != NULL) {
1640 		sp->fsc.m1 = sm2m(cl->cl_fsc->sm1);
1641 		sp->fsc.d = dx2d(cl->cl_fsc->dx);
1642 		sp->fsc.m2 = sm2m(cl->cl_fsc->sm2);
1643 	} else {
1644 		sp->fsc.m1 = 0;
1645 		sp->fsc.d = 0;
1646 		sp->fsc.m2 = 0;
1647 	}
1648 	if (cl->cl_usc != NULL) {
1649 		sp->usc.m1 = sm2m(cl->cl_usc->sm1);
1650 		sp->usc.d = dx2d(cl->cl_usc->dx);
1651 		sp->usc.m2 = sm2m(cl->cl_usc->sm2);
1652 	} else {
1653 		sp->usc.m1 = 0;
1654 		sp->usc.d = 0;
1655 		sp->usc.m2 = 0;
1656 	}
1657 
1658 	sp->total = cl->cl_total;
1659 	sp->cumul = cl->cl_cumul;
1660 
1661 	sp->d = cl->cl_d;
1662 	sp->e = cl->cl_e;
1663 	sp->vt = cl->cl_vt;
1664 	sp->f = cl->cl_f;
1665 
1666 	sp->initvt = cl->cl_initvt;
1667 	sp->vtperiod = cl->cl_vtperiod;
1668 	sp->parentperiod = cl->cl_parentperiod;
1669 	sp->nactive = cl->cl_nactive;
1670 	sp->vtoff = cl->cl_vtoff;
1671 	sp->cvtmax = cl->cl_cvtmax;
1672 	sp->myf = cl->cl_myf;
1673 	sp->cfmin = cl->cl_cfmin;
1674 	sp->cvtmin = cl->cl_cvtmin;
1675 	sp->myfadj = cl->cl_myfadj;
1676 	sp->vtadj = cl->cl_vtadj;
1677 
1678 	sp->cur_time = read_machclk();
1679 	sp->machclk_freq = machclk_freq;
1680 
1681 	sp->qlength = qlen(cl->cl_q);
1682 	sp->qlimit = qlimit(cl->cl_q);
1683 	sp->xmit_cnt = cl->cl_stats.xmit_cnt;
1684 	sp->drop_cnt = cl->cl_stats.drop_cnt;
1685 	sp->period = cl->cl_stats.period;
1686 
1687 	sp->qtype = qtype(cl->cl_q);
1688 #ifdef ALTQ_RED
1689 	if (q_is_red(cl->cl_q))
1690 		red_getstats(cl->cl_red, &sp->red[0]);
1691 #endif
1692 #ifdef ALTQ_RIO
1693 	if (q_is_rio(cl->cl_q))
1694 		rio_getstats((rio_t *)cl->cl_red, &sp->red[0]);
1695 #endif
1696 }
1697 
1698 /* convert a class handle to the corresponding class pointer */
1699 static struct hfsc_class *
1700 clh_to_clp(struct hfsc_if *hif, uint32_t chandle)
1701 {
1702 	int i;
1703 	struct hfsc_class *cl;
1704 
1705 	if (chandle == 0)
1706 		return (NULL);
1707 	/*
1708 	 * first, try optimistically the slot matching the lower bits of
1709 	 * the handle.  if it fails, do the linear table search.
1710 	 */
1711 	i = chandle % HFSC_MAX_CLASSES;
1712 	if ((cl = hif->hif_class_tbl[i]) != NULL && cl->cl_handle == chandle)
1713 		return (cl);
1714 	for (i = 0; i < HFSC_MAX_CLASSES; i++)
1715 		if ((cl = hif->hif_class_tbl[i]) != NULL &&
1716 		    cl->cl_handle == chandle)
1717 			return (cl);
1718 	return (NULL);
1719 }
1720 
1721 #endif /* ALTQ_HFSC */
1722