1/*
2 * Copyright (c) 2011-2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29/*	$NetBSD: altq_red.h,v 1.5 2006/10/12 19:59:08 peter Exp $	*/
30/*	$KAME: altq_red.h,v 1.8 2003/07/10 12:07:49 kjc Exp $	*/
31
32/*
33 * Copyright (C) 1997-2003
34 *	Sony Computer Science Laboratories Inc.  All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 *    notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 *    notice, this list of conditions and the following disclaimer in the
43 *    documentation and/or other materials provided with the distribution.
44 *
45 * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 * SUCH DAMAGE.
56 */
57
58#ifndef _NET_CLASSQ_CLASSQ_RED_H_
59#define	_NET_CLASSQ_CLASSQ_RED_H_
60
61#ifdef PRIVATE
62#ifdef BSD_KERNEL_PRIVATE
63#include <net/classq/if_classq.h>
64#endif /* BSD_KERNEL_PRIVATE */
65
66#ifdef __cplusplus
67extern "C" {
68#endif
69
70/*
71 * simpler versions of red parameters and statistics used by other
72 * disciplines (e.g., CBQ)
73 */
74struct redparams {
75	int th_min;		/* red min threshold */
76	int th_max;		/* red max threshold */
77	int inv_pmax;		/* inverse of max drop probability */
78};
79
80struct red_stats {
81	int32_t		q_avg;
82	u_int32_t	_pad;
83	u_int32_t	drop_forced;
84	u_int32_t	drop_unforced;
85	u_int32_t	marked_packets;
86};
87
88#ifdef BSD_KERNEL_PRIVATE
89/* weight table structure for idle time calibration */
90struct wtab {
91	struct wtab	*w_next;
92	int		 w_weight;
93	int		 w_param_max;
94	int		 w_refcount;
95	int32_t		 w_tab[32];
96};
97
98/* red flags */
99#define	REDF_ECN4	0x01	/* use packet marking for IPv4 packets */
100#define	REDF_ECN6	0x02	/* use packet marking for IPv6 packets */
101#define	REDF_ECN	(REDF_ECN4 | REDF_ECN6)
102#define	REDF_FLOWVALVE	0x04	/* use flowvalve (aka penalty-box) */
103
104#define	REDF_USERFLAGS							\
105	(REDF_ECN4 | REDF_ECN6 | REDF_FLOWVALVE)
106
107typedef struct red {
108	int		red_pkttime;	/* average packet time in micro sec */
109					/*   used for idle calibration */
110	int		red_flags;	/* red flags */
111	struct ifnet	*red_ifp;	/* back pointer to ifnet */
112
113	/* red parameters */
114	int		red_weight;	/* weight for EWMA */
115	int		red_inv_pmax;	/* inverse of max drop probability */
116	int		red_thmin;	/* red min threshold */
117	int		red_thmax;	/* red max threshold */
118
119	/* variables for internal use */
120	int		red_wshift;	/* log(red_weight) */
121	int		red_thmin_s;	/* th_min scaled by avgshift */
122	int		red_thmax_s;	/* th_max scaled by avgshift */
123	int		red_probd;	/* drop probability denominator */
124
125	int		red_avg;	/* queue len avg scaled by avgshift */
126	int		red_count;	/* packet count since last dropped/ */
127					/*   marked packet */
128	int		red_idle;	/* queue was empty */
129	int		red_old;	/* avg is above th_min */
130	struct wtab	*red_wtab;	/* weight table */
131	struct timeval	 red_last;	/* time when the queue becomes idle */
132
133	struct {
134		struct pktcntr	xmit_cnt;
135		struct pktcntr	drop_cnt;
136		u_int32_t	drop_forced;
137		u_int32_t	drop_unforced;
138		u_int32_t	marked_packets;
139	} red_stats;
140} red_t;
141
142/* red drop types */
143#define	DTYPE_NODROP	0	/* no drop */
144#define	DTYPE_FORCED	1	/* a "forced" drop */
145#define	DTYPE_EARLY	2	/* an "unforced" (early) drop */
146
147extern void red_init(void);
148extern red_t *red_alloc(struct ifnet *, int, int, int, int, int, int);
149extern void red_destroy(red_t *);
150extern void red_getstats(red_t *, struct red_stats *);
151extern int red_addq(red_t *, class_queue_t *, struct mbuf *, struct pf_mtag *);
152extern struct mbuf *red_getq(red_t *, class_queue_t *);
153extern void red_purgeq(struct red *, class_queue_t *, u_int32_t,
154    u_int32_t *, u_int32_t *);
155extern void red_updateq(red_t *, cqev_t);
156extern int red_suspendq(red_t *, class_queue_t *, boolean_t);
157
158extern int drop_early(int, int, int);
159extern struct wtab *wtab_alloc(int);
160extern void wtab_destroy(struct wtab *);
161extern int32_t pow_w(struct wtab *, int);
162#endif /* BSD_KERNEL_PRIVATE */
163
164#ifdef __cplusplus
165}
166#endif
167#endif /* PRIVATE */
168#endif /* _NET_CLASSQ_CLASSQ_RED_H_ */
169