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