xref: /freebsd/sys/net/altq/altq_rio.h (revision 580744621f33383027108364dcadad718df46ffe)
1 /*-
2  * Copyright (C) 1998-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_rio.h,v 1.9 2003/07/10 12:07:49 kjc Exp $
27  * $FreeBSD$
28  */
29 
30 #ifndef _ALTQ_ALTQ_RIO_H_
31 #define	_ALTQ_ALTQ_RIO_H_
32 
33 #include <net/altq/altq_classq.h>
34 
35 /*
36  * RIO: RED with IN/OUT bit
37  * (extended to support more than 2 drop precedence values)
38  */
39 #define	RIO_NDROPPREC	3	/* number of drop precedence values */
40 
41 
42 /* rio flags */
43 #define	RIOF_ECN4	0x01	/* use packet marking for IPv4 packets */
44 #define	RIOF_ECN6	0x02	/* use packet marking for IPv6 packets */
45 #define	RIOF_ECN	(RIOF_ECN4 | RIOF_ECN6)
46 #define	RIOF_CLEARDSCP	0x200	/* clear diffserv codepoint */
47 
48 
49 #ifdef _KERNEL
50 
51 typedef struct rio {
52 	/* per drop precedence structure */
53 	struct dropprec_state {
54 		/* red parameters */
55 		int	inv_pmax;	/* inverse of max drop probability */
56 		int	th_min;		/* red min threshold */
57 		int	th_max;		/* red max threshold */
58 
59 		/* variables for internal use */
60 		int	th_min_s;	/* th_min scaled by avgshift */
61 		int	th_max_s;	/* th_max scaled by avgshift */
62 		int	probd;		/* drop probability denominator */
63 
64 		int	qlen;		/* queue length */
65 		int	avg;		/* (scaled) queue length average */
66 		int	count;		/* packet count since the last dropped/
67 					   marked packet */
68 		int	idle;		/* queue was empty */
69 		int	old;		/* avg is above th_min */
70 		struct timeval	last;	/* timestamp when queue becomes idle */
71 	} rio_precstate[RIO_NDROPPREC];
72 
73 	int		 rio_wshift;	/* log(red_weight) */
74 	int		 rio_weight;	/* weight for EWMA */
75 	struct wtab	*rio_wtab;	/* weight table */
76 
77 	int		 rio_pkttime;	/* average packet time in micro sec
78 					   used for idle calibration */
79 	int		 rio_flags;	/* rio flags */
80 
81 	u_int8_t	 rio_codepoint;	/* codepoint value to tag packets */
82 	u_int8_t	 rio_codepointmask;	/* codepoint mask bits */
83 
84 	struct redstats q_stats[RIO_NDROPPREC];	/* statistics */
85 } rio_t;
86 
87 
88 extern rio_t		*rio_alloc(int, struct redparams *, int, int);
89 extern void		 rio_destroy(rio_t *);
90 extern void		 rio_getstats(rio_t *, struct redstats *);
91 extern int		 rio_addq(rio_t *, class_queue_t *, struct mbuf *,
92 			     struct altq_pktattr *);
93 extern struct mbuf	*rio_getq(rio_t *, class_queue_t *);
94 
95 #endif /* _KERNEL */
96 
97 #endif /* _ALTQ_ALTQ_RIO_H_ */
98