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