1/*	$FreeBSD$	*/
2/*	$KAME: altq_priq.h,v 1.5 2003/07/10 12:07:48 kjc Exp $	*/
3/*
4 * Copyright (C) 2000-2003
5 *	Sony Computer Science Laboratories Inc.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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.
15 *
16 * THIS SOFTWARE IS PROVIDED BY SONY CSL 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 SONY CSL 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
26 * SUCH DAMAGE.
27 */
28
29#ifndef _ALTQ_ALTQ_PRIQ_H_
30#define	_ALTQ_ALTQ_PRIQ_H_
31
32#include <altq/altq.h>
33#include <altq/altq_classq.h>
34#include <altq/altq_red.h>
35#include <altq/altq_rio.h>
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41#define	PRIQ_MAXPRI	16	/* upper limit of the number of priorities */
42#define	PRIQ_MAXQID	256	/* upper limit of queues */
43
44#ifdef ALTQ3_COMPAT
45struct priq_interface {
46	char	ifname[IFNAMSIZ];	/* interface name (e.g., fxp0) */
47	u_long	arg;			/* request-specific argument */
48};
49
50struct priq_add_class {
51	struct priq_interface	iface;
52	int			pri;	/* priority (0 is the lowest) */
53	int			qlimit;	/* queue size limit */
54	int			flags;	/* misc flags (see below) */
55
56	u_int32_t		class_handle;  /* return value */
57};
58#endif /* ALTQ3_COMPAT */
59
60/* priq class flags */
61#define	PRCF_RED		0x0001	/* use RED */
62#define	PRCF_ECN		0x0002  /* use RED/ECN */
63#define	PRCF_RIO		0x0004  /* use RIO */
64#define	PRCF_CLEARDSCP		0x0010  /* clear diffserv codepoint */
65#define	PRCF_DEFAULTCLASS	0x1000	/* default class */
66
67/* special class handles */
68#define	PRIQ_NULLCLASS_HANDLE	0
69
70#ifdef ALTQ3_COMPAT
71struct priq_delete_class {
72	struct priq_interface	iface;
73	u_int32_t		class_handle;
74};
75
76struct priq_modify_class {
77	struct priq_interface	iface;
78	u_int32_t		class_handle;
79	int			pri;
80	int			qlimit;
81	int			flags;
82};
83
84struct priq_add_filter {
85	struct priq_interface	iface;
86	u_int32_t		class_handle;
87	struct flow_filter	filter;
88
89	u_long			filter_handle;  /* return value */
90};
91
92struct priq_delete_filter {
93	struct priq_interface	iface;
94	u_long			filter_handle;
95};
96#endif /* ALTQ3_COMPAT */
97
98struct priq_classstats {
99	u_int32_t		class_handle;
100
101	u_int			qlength;
102	u_int			qlimit;
103	u_int 			period;
104	struct pktcntr		xmitcnt;  /* transmitted packet counter */
105	struct pktcntr		dropcnt;  /* dropped packet counter */
106
107	/* red and rio related info */
108	int		qtype;
109	struct redstats	red[3];		/* rio has 3 red stats */
110};
111
112#ifdef ALTQ3_COMPAT
113struct priq_class_stats {
114	struct priq_interface	iface;
115	int			maxpri;	  /* in/out */
116
117	struct priq_classstats	*stats;   /* pointer to stats array */
118};
119
120#define	PRIQ_IF_ATTACH		_IOW('Q', 1, struct priq_interface)
121#define	PRIQ_IF_DETACH		_IOW('Q', 2, struct priq_interface)
122#define	PRIQ_ENABLE		_IOW('Q', 3, struct priq_interface)
123#define	PRIQ_DISABLE		_IOW('Q', 4, struct priq_interface)
124#define	PRIQ_CLEAR		_IOW('Q', 5, struct priq_interface)
125#define	PRIQ_ADD_CLASS		_IOWR('Q', 7, struct priq_add_class)
126#define	PRIQ_DEL_CLASS		_IOW('Q', 8, struct priq_delete_class)
127#define	PRIQ_MOD_CLASS		_IOW('Q', 9, struct priq_modify_class)
128#define	PRIQ_ADD_FILTER		_IOWR('Q', 10, struct priq_add_filter)
129#define	PRIQ_DEL_FILTER		_IOW('Q', 11, struct priq_delete_filter)
130#define	PRIQ_GETSTATS		_IOWR('Q', 12, struct priq_class_stats)
131
132#endif /* ALTQ3_COMPAT */
133
134#ifdef _KERNEL
135
136struct priq_class {
137	u_int32_t	cl_handle;	/* class handle */
138	class_queue_t	*cl_q;		/* class queue structure */
139	struct red	*cl_red;	/* RED state */
140	int		cl_pri;		/* priority */
141	int		cl_flags;	/* class flags */
142	struct priq_if	*cl_pif;	/* back pointer to pif */
143	struct altq_pktattr *cl_pktattr; /* saved header used by ECN */
144
145	/* statistics */
146	u_int		cl_period;	/* backlog period */
147	struct pktcntr  cl_xmitcnt;	/* transmitted packet counter */
148	struct pktcntr  cl_dropcnt;	/* dropped packet counter */
149};
150
151/*
152 * priq interface state
153 */
154struct priq_if {
155	struct priq_if		*pif_next;	/* interface state list */
156	struct ifaltq		*pif_ifq;	/* backpointer to ifaltq */
157	u_int			pif_bandwidth;	/* link bandwidth in bps */
158	int			pif_maxpri;	/* max priority in use */
159	struct priq_class	*pif_default;	/* default class */
160	struct priq_class	*pif_classes[PRIQ_MAXPRI]; /* classes */
161#ifdef ALTQ3_CLFIER_COMPAT
162	struct acc_classifier	pif_classifier;	/* classifier */
163#endif
164};
165
166#endif /* _KERNEL */
167
168#ifdef __cplusplus
169}
170#endif
171
172#endif /* _ALTQ_ALTQ_PRIQ_H_ */
173