1 | /* $NetBSD: if_altq.h,v 1.15 2016/04/20 08:58:48 knakahara Exp $ */ |
2 | /* $KAME: if_altq.h,v 1.12 2005/04/13 03:44:25 suz Exp $ */ |
3 | |
4 | /* |
5 | * Copyright (C) 1997-2003 |
6 | * Sony Computer Science Laboratories Inc. All rights reserved. |
7 | * |
8 | * Redistribution and use in source and binary forms, with or without |
9 | * modification, are permitted provided that the following conditions |
10 | * are met: |
11 | * 1. Redistributions of source code must retain the above copyright |
12 | * notice, this list of conditions and the following disclaimer. |
13 | * 2. Redistributions in binary form must reproduce the above copyright |
14 | * notice, this list of conditions and the following disclaimer in the |
15 | * documentation and/or other materials provided with the distribution. |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND |
18 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
20 | * ARE DISCLAIMED. IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE |
21 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
22 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
23 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
24 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
25 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
26 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
27 | * SUCH DAMAGE. |
28 | */ |
29 | #ifndef _ALTQ_IF_ALTQ_H_ |
30 | #define _ALTQ_IF_ALTQ_H_ |
31 | |
32 | #if defined(_KERNEL_OPT) |
33 | #include "opt_altq_enabled.h" |
34 | #endif |
35 | |
36 | struct altq_pktattr; struct tb_regulator; struct top_cdnr; |
37 | |
38 | /* |
39 | * Structure defining a queue for a network interface. |
40 | */ |
41 | struct ifaltq { |
42 | /* fields compatible with struct ifqueue */ |
43 | struct mbuf *ifq_head; |
44 | struct mbuf *ifq_tail; |
45 | int ifq_len; |
46 | int ifq_maxlen; |
47 | int ifq_drops; |
48 | kmutex_t *ifq_lock; |
49 | |
50 | /* alternate queueing related fields */ |
51 | int altq_type; /* discipline type */ |
52 | int altq_flags; /* flags (e.g. ready, in-use) */ |
53 | void *altq_disc; /* for discipline-specific use */ |
54 | struct ifnet *altq_ifp; /* back pointer to interface */ |
55 | |
56 | int (*altq_enqueue)(struct ifaltq *, struct mbuf *); |
57 | struct mbuf *(*altq_dequeue)(struct ifaltq *, int); |
58 | int (*altq_request)(struct ifaltq *, int, void *); |
59 | |
60 | /* classifier fields */ |
61 | void *altq_clfier; /* classifier-specific use */ |
62 | void *(*altq_classify)(void *, struct mbuf *, int); |
63 | |
64 | /* token bucket regulator */ |
65 | struct tb_regulator *altq_tbr; |
66 | |
67 | /* input traffic conditioner (doesn't belong to the output queue...) */ |
68 | struct top_cdnr *altq_cdnr; |
69 | }; |
70 | |
71 | |
72 | #ifdef _KERNEL |
73 | |
74 | /* |
75 | * packet attributes used by queueing disciplines. |
76 | * pattr_class is a discipline-dependent scheduling class that is |
77 | * set by a classifier. |
78 | * pattr_hdr and pattr_af may be used by a discipline to access |
79 | * the header within a mbuf. (e.g. ECN needs to update the CE bit) |
80 | * note that pattr_hdr could be stale after m_pullup, though link |
81 | * layer output routines usually don't use m_pullup. link-level |
82 | * compression also invalidates these fields. thus, pattr_hdr needs |
83 | * to be verified when a discipline touches the header. |
84 | */ |
85 | struct altq_pktattr { |
86 | void *pattr_class; /* sched class set by classifier */ |
87 | int pattr_af; /* address family */ |
88 | void * pattr_hdr; /* saved header position in mbuf */ |
89 | }; |
90 | |
91 | /* |
92 | * mbuf tag to carry a queue id (and hints for ECN). |
93 | */ |
94 | struct altq_tag { |
95 | u_int32_t qid; /* queue id */ |
96 | /* hints for ecn */ |
97 | int af; /* address family */ |
98 | void *hdr; /* saved header position in mbuf */ |
99 | }; |
100 | |
101 | /* |
102 | * a token-bucket regulator limits the rate that a network driver can |
103 | * dequeue packets from the output queue. |
104 | * modern cards are able to buffer a large amount of packets and dequeue |
105 | * too many packets at a time. this bursty dequeue behavior makes it |
106 | * impossible to schedule packets by queueing disciplines. |
107 | * a token-bucket is used to control the burst size in a device |
108 | * independent manner. |
109 | */ |
110 | struct tb_regulator { |
111 | int64_t tbr_rate; /* (scaled) token bucket rate */ |
112 | int64_t tbr_depth; /* (scaled) token bucket depth */ |
113 | |
114 | int64_t tbr_token; /* (scaled) current token */ |
115 | int64_t tbr_filluptime; /* (scaled) time to fill up bucket */ |
116 | u_int64_t tbr_last; /* last time token was updated */ |
117 | |
118 | int tbr_lastop; /* last dequeue operation type |
119 | needed for poll-and-dequeue */ |
120 | }; |
121 | |
122 | /* if_altqflags */ |
123 | #define ALTQF_READY 0x01 /* driver supports alternate queueing */ |
124 | #define ALTQF_ENABLED 0x02 /* altq is in use */ |
125 | #define ALTQF_CLASSIFY 0x04 /* classify packets */ |
126 | #define ALTQF_CNDTNING 0x08 /* altq traffic conditioning is enabled */ |
127 | #define ALTQF_DRIVER1 0x40 /* driver specific */ |
128 | |
129 | /* if_altqflags set internally only: */ |
130 | #define ALTQF_CANTCHANGE (ALTQF_READY) |
131 | |
132 | /* altq_dequeue 2nd arg */ |
133 | #define ALTDQ_REMOVE 1 /* dequeue mbuf from the queue */ |
134 | #define ALTDQ_POLL 2 /* don't dequeue mbuf from the queue */ |
135 | |
136 | /* altq request types (currently only purge is defined) */ |
137 | #define ALTRQ_PURGE 1 /* purge all packets */ |
138 | |
139 | #define ALTQ_IS_READY(ifq) ((ifq)->altq_flags & ALTQF_READY) |
140 | #define ALTQ_IS_ENABLED(ifq) ((ifq)->altq_flags & ALTQF_ENABLED) |
141 | #define ALTQ_NEEDS_CLASSIFY(ifq) ((ifq)->altq_flags & ALTQF_CLASSIFY) |
142 | #define ALTQ_IS_CNDTNING(ifq) ((ifq)->altq_flags & ALTQF_CNDTNING) |
143 | |
144 | #define ALTQ_SET_CNDTNING(ifq) ((ifq)->altq_flags |= ALTQF_CNDTNING) |
145 | #define ALTQ_CLEAR_CNDTNING(ifq) ((ifq)->altq_flags &= ~ALTQF_CNDTNING) |
146 | #define ALTQ_IS_ATTACHED(ifq) ((ifq)->altq_disc != NULL) |
147 | |
148 | #define ALTQ_ENQUEUE(ifq, m, err) \ |
149 | (err) = (*(ifq)->altq_enqueue)((ifq),(m)) |
150 | #define ALTQ_DEQUEUE(ifq, m) \ |
151 | (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_REMOVE) |
152 | #define ALTQ_POLL(ifq, m) \ |
153 | (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_POLL) |
154 | #define ALTQ_PURGE(ifq) \ |
155 | (void)(*(ifq)->altq_request)((ifq), ALTRQ_PURGE, (void *)0) |
156 | #define ALTQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) |
157 | #define TBR_IS_ENABLED(ifq) ((ifq)->altq_tbr != NULL) |
158 | |
159 | extern int altq_attach(struct ifaltq *, int, void *, |
160 | int (*)(struct ifaltq *, struct mbuf *), |
161 | struct mbuf *(*)(struct ifaltq *, int), |
162 | int (*)(struct ifaltq *, int, void *), |
163 | void *, |
164 | void *(*)(void *, struct mbuf *, int)); |
165 | extern int altq_detach(struct ifaltq *); |
166 | extern int altq_enable(struct ifaltq *); |
167 | extern int altq_disable(struct ifaltq *); |
168 | extern struct mbuf *tbr_dequeue(struct ifaltq *, int); |
169 | extern int (*altq_input)(struct mbuf *, int); |
170 | #if 1 /* ALTQ3_CLFIER_COMPAT */ |
171 | void altq_etherclassify(struct ifaltq *, struct mbuf *); |
172 | #endif |
173 | #endif /* _KERNEL */ |
174 | |
175 | #endif /* _ALTQ_IF_ALTQ_H_ */ |
176 | |