xref: /freebsd/sys/net/altq/altq_red.h (revision e8d8bef961a50d4dc22501cde4fb9fb0be1b2532)
1 /*-
2  * Copyright (C) 1997-2003
3  *	Sony Computer Science Laboratories Inc.  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 SONY CSL 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 SONY CSL 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  * $KAME: altq_red.h,v 1.8 2003/07/10 12:07:49 kjc Exp $
27  * $FreeBSD$
28  */
29 
30 #ifndef _ALTQ_ALTQ_RED_H_
31 #define	_ALTQ_ALTQ_RED_H_
32 
33 #include <net/altq/altq_classq.h>
34 
35 /* red flags */
36 #define	REDF_ECN4	0x01	/* use packet marking for IPv4 packets */
37 #define	REDF_ECN6	0x02	/* use packet marking for IPv6 packets */
38 #define	REDF_ECN	(REDF_ECN4 | REDF_ECN6)
39 #define	REDF_FLOWVALVE	0x04	/* use flowvalve (aka penalty-box) */
40 
41 /*
42  * simpler versions of red parameters and statistics used by other
43  * disciplines (e.g., CBQ)
44  */
45 struct redparams {
46 	int th_min;		/* red min threshold */
47 	int th_max;		/* red max threshold */
48 	int inv_pmax;		/* inverse of max drop probability */
49 };
50 
51 struct redstats {
52 	int		q_avg;
53 	struct pktcntr	xmit_cnt;
54 	struct pktcntr	drop_cnt;
55 	u_int		drop_forced;
56 	u_int		drop_unforced;
57 	u_int		marked_packets;
58 };
59 
60 #ifdef _KERNEL
61 
62 /* weight table structure for idle time calibration */
63 struct wtab {
64 	struct wtab	*w_next;
65 	int		 w_weight;
66 	int		 w_param_max;
67 	int		 w_refcount;
68 	int32_t		 w_tab[32];
69 };
70 
71 typedef struct red {
72 	int		red_pkttime;	/* average packet time in micro sec
73 					   used for idle calibration */
74 	int		red_flags;	/* red flags */
75 
76 	/* red parameters */
77 	int		red_weight;	/* weight for EWMA */
78 	int		red_inv_pmax;	/* inverse of max drop probability */
79 	int		red_thmin;	/* red min threshold */
80 	int		red_thmax;	/* red max threshold */
81 
82 	/* variables for internal use */
83 	int		red_wshift;	/* log(red_weight) */
84 	int		red_thmin_s;	/* th_min scaled by avgshift */
85 	int		red_thmax_s;	/* th_max scaled by avgshift */
86 	int		red_probd;	/* drop probability denominator */
87 
88 	int		red_avg;	/* queue len avg scaled by avgshift */
89 	int		red_count;	/* packet count since last dropped/
90 					   marked packet */
91 	int		red_idle;	/* queue was empty */
92 	int		red_old;	/* avg is above th_min */
93 	struct wtab	*red_wtab;	/* weight table */
94 	struct timeval	 red_last;	/* time when the queue becomes idle */
95 
96 	struct {
97 		struct pktcntr	xmit_cnt;
98 		struct pktcntr	drop_cnt;
99 		u_int		drop_forced;
100 		u_int		drop_unforced;
101 		u_int		marked_packets;
102 	} red_stats;
103 } red_t;
104 
105 /* red drop types */
106 #define	DTYPE_NODROP	0	/* no drop */
107 #define	DTYPE_FORCED	1	/* a "forced" drop */
108 #define	DTYPE_EARLY	2	/* an "unforced" (early) drop */
109 
110 extern red_t		*red_alloc(int, int, int, int, int, int);
111 extern void		 red_destroy(red_t *);
112 extern void		 red_getstats(red_t *, struct redstats *);
113 extern int		 red_addq(red_t *, class_queue_t *, struct mbuf *,
114 			     struct altq_pktattr *);
115 extern struct mbuf	*red_getq(red_t *, class_queue_t *);
116 extern int		 drop_early(int, int, int);
117 extern int		 mark_ecn(struct mbuf *, struct altq_pktattr *, int);
118 extern struct wtab	*wtab_alloc(int);
119 extern int		 wtab_destroy(struct wtab *);
120 extern int32_t		 pow_w(struct wtab *, int);
121 
122 #endif /* _KERNEL */
123 
124 #endif /* _ALTQ_ALTQ_RED_H_ */
125