if_altq.h revision 1.11
1 /* $NetBSD: if_altq.h,v 1.11 2006/10/12 19:59:08 peter 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 #ifdef __FreeBSD__ 49 struct mtx ifq_mtx; 50 #endif 51 52 /* alternate queueing related fields */ 53 int altq_type; /* discipline type */ 54 int altq_flags; /* flags (e.g. ready, in-use) */ 55 void *altq_disc; /* for discipline-specific use */ 56 struct ifnet *altq_ifp; /* back pointer to interface */ 57 58 int (*altq_enqueue)(struct ifaltq *, struct mbuf *, 59 struct altq_pktattr *); 60 struct mbuf *(*altq_dequeue)(struct ifaltq *, int); 61 int (*altq_request)(struct ifaltq *, int, void *); 62 63 /* classifier fields */ 64 void *altq_clfier; /* classifier-specific use */ 65 void *(*altq_classify)(void *, struct mbuf *, int); 66 67 /* token bucket regulator */ 68 struct tb_regulator *altq_tbr; 69 70 /* input traffic conditioner (doesn't belong to the output queue...) */ 71 struct top_cdnr *altq_cdnr; 72 }; 73 74 75 #ifdef _KERNEL 76 77 /* 78 * packet attributes used by queueing disciplines. 79 * pattr_class is a discipline-dependent scheduling class that is 80 * set by a classifier. 81 * pattr_hdr and pattr_af may be used by a discipline to access 82 * the header within a mbuf. (e.g. ECN needs to update the CE bit) 83 * note that pattr_hdr could be stale after m_pullup, though link 84 * layer output routines usually don't use m_pullup. link-level 85 * compression also invalidates these fields. thus, pattr_hdr needs 86 * to be verified when a discipline touches the header. 87 */ 88 struct altq_pktattr { 89 void *pattr_class; /* sched class set by classifier */ 90 int pattr_af; /* address family */ 91 caddr_t pattr_hdr; /* saved header position in mbuf */ 92 }; 93 94 /* 95 * mbuf tag to carry a queue id (and hints for ECN). 96 */ 97 struct altq_tag { 98 u_int32_t qid; /* queue id */ 99 /* hints for ecn */ 100 int af; /* address family */ 101 void *hdr; /* saved header position in mbuf */ 102 }; 103 104 /* 105 * a token-bucket regulator limits the rate that a network driver can 106 * dequeue packets from the output queue. 107 * modern cards are able to buffer a large amount of packets and dequeue 108 * too many packets at a time. this bursty dequeue behavior makes it 109 * impossible to schedule packets by queueing disciplines. 110 * a token-bucket is used to control the burst size in a device 111 * independent manner. 112 */ 113 struct tb_regulator { 114 int64_t tbr_rate; /* (scaled) token bucket rate */ 115 int64_t tbr_depth; /* (scaled) token bucket depth */ 116 117 int64_t tbr_token; /* (scaled) current token */ 118 int64_t tbr_filluptime; /* (scaled) time to fill up bucket */ 119 u_int64_t tbr_last; /* last time token was updated */ 120 121 int tbr_lastop; /* last dequeue operation type 122 needed for poll-and-dequeue */ 123 }; 124 125 /* if_altqflags */ 126 #define ALTQF_READY 0x01 /* driver supports alternate queueing */ 127 #define ALTQF_ENABLED 0x02 /* altq is in use */ 128 #define ALTQF_CLASSIFY 0x04 /* classify packets */ 129 #define ALTQF_CNDTNING 0x08 /* altq traffic conditioning is enabled */ 130 #define ALTQF_DRIVER1 0x40 /* driver specific */ 131 132 /* if_altqflags set internally only: */ 133 #define ALTQF_CANTCHANGE (ALTQF_READY) 134 135 /* altq_dequeue 2nd arg */ 136 #define ALTDQ_REMOVE 1 /* dequeue mbuf from the queue */ 137 #define ALTDQ_POLL 2 /* don't dequeue mbuf from the queue */ 138 139 /* altq request types (currently only purge is defined) */ 140 #define ALTRQ_PURGE 1 /* purge all packets */ 141 142 #define ALTQ_IS_READY(ifq) ((ifq)->altq_flags & ALTQF_READY) 143 #define ALTQ_IS_ENABLED(ifq) ((ifq)->altq_flags & ALTQF_ENABLED) 144 #define ALTQ_NEEDS_CLASSIFY(ifq) ((ifq)->altq_flags & ALTQF_CLASSIFY) 145 #define ALTQ_IS_CNDTNING(ifq) ((ifq)->altq_flags & ALTQF_CNDTNING) 146 147 #define ALTQ_SET_CNDTNING(ifq) ((ifq)->altq_flags |= ALTQF_CNDTNING) 148 #define ALTQ_CLEAR_CNDTNING(ifq) ((ifq)->altq_flags &= ~ALTQF_CNDTNING) 149 #define ALTQ_IS_ATTACHED(ifq) ((ifq)->altq_disc != NULL) 150 151 #define ALTQ_ENQUEUE(ifq, m, pa, err) \ 152 (err) = (*(ifq)->altq_enqueue)((ifq),(m),(pa)) 153 #define ALTQ_DEQUEUE(ifq, m) \ 154 (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_REMOVE) 155 #define ALTQ_POLL(ifq, m) \ 156 (m) = (*(ifq)->altq_dequeue)((ifq), ALTDQ_POLL) 157 #define ALTQ_PURGE(ifq) \ 158 (void)(*(ifq)->altq_request)((ifq), ALTRQ_PURGE, (void *)0) 159 #define ALTQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) 160 #define TBR_IS_ENABLED(ifq) ((ifq)->altq_tbr != NULL) 161 162 extern int altq_attach(struct ifaltq *, int, void *, 163 int (*)(struct ifaltq *, struct mbuf *, 164 struct altq_pktattr *), 165 struct mbuf *(*)(struct ifaltq *, int), 166 int (*)(struct ifaltq *, int, void *), 167 void *, 168 void *(*)(void *, struct mbuf *, int)); 169 extern int altq_detach(struct ifaltq *); 170 extern int altq_enable(struct ifaltq *); 171 extern int altq_disable(struct ifaltq *); 172 extern struct mbuf *tbr_dequeue(struct ifaltq *, int); 173 extern int (*altq_input)(struct mbuf *, int); 174 #if 1 /* ALTQ3_CLFIER_COMPAT */ 175 void altq_etherclassify(struct ifaltq *, struct mbuf *, struct altq_pktattr *); 176 #endif 177 #endif /* _KERNEL */ 178 179 #endif /* _ALTQ_IF_ALTQ_H_ */ 180
Indexes created Tue Sep 30 11:09:46 GMT 2025