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