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