xref: /netbsd/sys/altq/altq_priq.h (revision bf9ec67e)
1 /*	$NetBSD: altq_priq.h,v 1.2 2000/12/14 08:49:50 thorpej Exp $	*/
2 /*	$KAME: altq_priq.h,v 1.1 2000/10/18 09:15:23 kjc Exp $	*/
3 /*
4  * Copyright (C) 2000
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
38 extern "C" {
39 #endif
40 
41 #define	PRIQ_MAXPRI	16	/* upper limit of the number of priorities */
42 
43 struct priq_interface {
44 	char	ifname[IFNAMSIZ];	/* interface name (e.g., fxp0) */
45 	u_long	arg;			/* request-specific argument */
46 };
47 
48 struct priq_add_class {
49 	struct priq_interface	iface;
50 	int			pri;	/* priority (0 is the lowest) */
51 	int			qlimit;	/* queue size limit */
52 	int			flags;	/* misc flags (see below) */
53 
54 	u_long			class_handle;  /* return value */
55 };
56 
57 /* priq class flags */
58 #define	PRCF_RED		0x0001	/* use RED */
59 #define	PRCF_ECN		0x0002  /* use RED/ECN */
60 #define	PRCF_RIO		0x0004  /* use RIO */
61 #define	PRCF_CLEARDSCP		0x0010  /* clear diffserv codepoint */
62 #define	PRCF_DEFAULTCLASS	0x1000	/* default class */
63 
64 /* special class handles */
65 #define	PRIQ_NULLCLASS_HANDLE	0
66 
67 struct priq_delete_class {
68 	struct priq_interface	iface;
69 	u_long			class_handle;
70 };
71 
72 struct priq_modify_class {
73 	struct priq_interface	iface;
74 	u_long			class_handle;
75 	int			pri;
76 	int			qlimit;
77 	int			flags;
78 };
79 
80 struct priq_add_filter {
81 	struct priq_interface	iface;
82 	u_long			class_handle;
83 	struct flow_filter	filter;
84 
85 	u_long			filter_handle;  /* return value */
86 };
87 
88 struct priq_delete_filter {
89 	struct priq_interface	iface;
90 	u_long			filter_handle;
91 };
92 
93 struct class_stats {
94 	u_long			class_handle;
95 
96 	u_int			qlength;
97 	u_int 			period;
98 	struct pktcntr		xmitcnt;  /* transmitted packet counter */
99 	struct pktcntr		dropcnt;  /* dropped packet counter */
100 
101 	/* red and rio related info */
102 	int		qtype;
103 	struct redstats	red[3];		/* rio has 3 red stats */
104 };
105 
106 struct priq_class_stats {
107 	struct priq_interface	iface;
108 	int			maxpri;	  /* in/out */
109 
110 	struct class_stats	*stats;   /* pointer to stats array */
111 };
112 
113 #define	PRIQ_IF_ATTACH		_IOW('Q', 1, struct priq_interface)
114 #define	PRIQ_IF_DETACH		_IOW('Q', 2, struct priq_interface)
115 #define	PRIQ_ENABLE		_IOW('Q', 3, struct priq_interface)
116 #define	PRIQ_DISABLE		_IOW('Q', 4, struct priq_interface)
117 #define	PRIQ_CLEAR		_IOW('Q', 5, struct priq_interface)
118 #define	PRIQ_ADD_CLASS		_IOWR('Q', 7, struct priq_add_class)
119 #define	PRIQ_DEL_CLASS		_IOW('Q', 8, struct priq_delete_class)
120 #define	PRIQ_MOD_CLASS		_IOW('Q', 9, struct priq_modify_class)
121 #define	PRIQ_ADD_FILTER		_IOWR('Q', 10, struct priq_add_filter)
122 #define	PRIQ_DEL_FILTER		_IOW('Q', 11, struct priq_delete_filter)
123 #define	PRIQ_GETSTATS		_IOWR('Q', 12, struct priq_class_stats)
124 
125 #ifdef _KERNEL
126 
127 struct priq_class {
128 	u_long		cl_handle;	/* class handle */
129 	class_queue_t	*cl_q;		/* class queue structure */
130 	struct red	*cl_red;	/* RED state */
131 	int		cl_pri;		/* priority */
132 	int		cl_flags;	/* class flags */
133 	struct priq_if	*cl_pif;	/* back pointer to pif */
134 	struct altq_pktattr *cl_pktattr; /* saved header used by ECN */
135 
136 	/* statistics */
137 	u_int		cl_period;	/* backlog period */
138 	struct pktcntr  cl_xmitcnt;	/* transmitted packet counter */
139 	struct pktcntr  cl_dropcnt;	/* dropped packet counter */
140 };
141 
142 /*
143  * priq interface state
144  */
145 struct priq_if {
146 	struct priq_if		*pif_next;	/* interface state list */
147 	struct ifaltq		*pif_ifq;	/* backpointer to ifaltq */
148 	u_int			pif_bandwidth;	/* link bandwidth in bps */
149 	int			pif_maxpri;	/* max priority in use */
150 	struct priq_class	*pif_default;	/* default class */
151 	struct priq_class	*pif_classes[PRIQ_MAXPRI]; /* classes */
152 	struct acc_classifier	pif_classifier;	/* classifier */
153 };
154 
155 #endif /* _KERNEL */
156 
157 #ifdef __cplusplus
158 }
159 #endif
160 
161 #endif /* _ALTQ_ALTQ_PRIQ_H_ */
162