sys/net/altq/altq_var.h

   1 /*-
   2  * Copyright (C) 1998-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: altq_var.h,v 1.16 2003/10/03 05:05:15 kjc Exp $
  27  * $FreeBSD$
  28  */
  29 #ifndef _ALTQ_ALTQ_VAR_H_
  30 #define _ALTQ_ALTQ_VAR_H_
  31
  32 #ifdef _KERNEL
  33
  34 #include <sys/param.h>
  35 #include <sys/kernel.h>
  36 #include <sys/queue.h>
  37
  38 #ifdef ALTQ3_CLFIER_COMPAT
  39 /*
  40  * filter structure for altq common classifier
  41  */
  42 struct acc_filter {
  43         LIST_ENTRY(acc_filter)  f_chain;
  44         void                    *f_class;       /* pointer to the class */
  45         u_long                  f_handle;       /* filter id */
  46         u_int32_t               f_fbmask;       /* filter bitmask */
  47         struct flow_filter      f_filter;       /* filter value */
  48 };
  49
  50 /*
  51  * XXX ACC_FILTER_TABLESIZE can't be larger than 2048 unless we fix
  52  * the handle assignment.
  53  */
  54 #define ACC_FILTER_TABLESIZE    (256+1)
  55 #define ACC_FILTER_MASK         (ACC_FILTER_TABLESIZE - 2)
  56 #define ACC_WILDCARD_INDEX      (ACC_FILTER_TABLESIZE - 1)
  57 #ifdef __GNUC__
  58 #define ACC_GET_HASH_INDEX(addr) \
  59         ({int x = (addr) + ((addr) >> 16); (x + (x >> 8)) & ACC_FILTER_MASK;})
  60 #else
  61 #define ACC_GET_HASH_INDEX(addr) \
  62         (((addr) + ((addr) >> 8) + ((addr) >> 16) + ((addr) >> 24)) \
  63         & ACC_FILTER_MASK)
  64 #endif
  65 #define ACC_GET_HINDEX(handle) ((handle) >> 20)
  66
  67 #if (__FreeBSD_version > 500000)
  68 #define ACC_LOCK_INIT(ac)       mtx_init(&(ac)->acc_mtx, "classifier", MTX_DEF)
  69 #define ACC_LOCK_DESTROY(ac)    mtx_destroy(&(ac)->acc_mtx)
  70 #define ACC_LOCK(ac)            mtx_lock(&(ac)->acc_mtx)
  71 #define ACC_UNLOCK(ac)          mtx_unlock(&(ac)->acc_mtx)
  72 #else
  73 #define ACC_LOCK_INIT(ac)
  74 #define ACC_LOCK_DESTROY(ac)
  75 #define ACC_LOCK(ac)
  76 #define ACC_UNLOCK(ac)
  77 #endif
  78
  79 struct acc_classifier {
  80         u_int32_t                       acc_fbmask;
  81         LIST_HEAD(filt, acc_filter)     acc_filters[ACC_FILTER_TABLESIZE];
  82
  83 #if (__FreeBSD_version > 500000)
  84         struct  mtx acc_mtx;
  85 #endif
  86 };
  87
  88 /*
  89  * flowinfo mask bits used by classifier
  90  */
  91 /* for ipv4 */
  92 #define FIMB4_PROTO     0x0001
  93 #define FIMB4_TOS       0x0002
  94 #define FIMB4_DADDR     0x0004
  95 #define FIMB4_SADDR     0x0008
  96 #define FIMB4_DPORT     0x0010
  97 #define FIMB4_SPORT     0x0020
  98 #define FIMB4_GPI       0x0040
  99 #define FIMB4_ALL       0x007f
 100 /* for ipv6 */
 101 #define FIMB6_PROTO     0x0100
 102 #define FIMB6_TCLASS    0x0200
 103 #define FIMB6_DADDR     0x0400
 104 #define FIMB6_SADDR     0x0800
 105 #define FIMB6_DPORT     0x1000
 106 #define FIMB6_SPORT     0x2000
 107 #define FIMB6_GPI       0x4000
 108 #define FIMB6_FLABEL    0x8000
 109 #define FIMB6_ALL       0xff00
 110
 111 #define FIMB_ALL        (FIMB4_ALL|FIMB6_ALL)
 112
 113 #define FIMB4_PORTS     (FIMB4_DPORT|FIMB4_SPORT|FIMB4_GPI)
 114 #define FIMB6_PORTS     (FIMB6_DPORT|FIMB6_SPORT|FIMB6_GPI)
 115 #endif /* ALTQ3_CLFIER_COMPAT */
 116
 117 /*
 118  * machine dependent clock
 119  * a 64bit high resolution time counter.
 120  */
 121 extern int machclk_usepcc;
 122 extern u_int32_t machclk_freq;
 123 extern u_int32_t machclk_per_tick;
 124 extern void init_machclk(void);
 125 extern u_int64_t read_machclk(void);
 126
 127 /*
 128  * debug support
 129  */
 130 #ifdef ALTQ_DEBUG
 131 #ifdef __STDC__
 132 #define ASSERT(e)       ((e) ? (void)0 : altq_assert(__FILE__, __LINE__, #e))
 133 #else   /* PCC */
 134 #define ASSERT(e)       ((e) ? (void)0 : altq_assert(__FILE__, __LINE__, "e"))
 135 #endif
 136 #else
 137 #define ASSERT(e)       ((void)0)
 138 #endif
 139
 140 /*
 141  * misc stuff for compatibility
 142  */
 143 /* ioctl cmd type */
 144 typedef u_long ioctlcmd_t;
 145
 146 /*
 147  * queue macros:
 148  * the interface of TAILQ_LAST macro changed after the introduction
 149  * of softupdate. redefine it here to make it work with pre-2.2.7.
 150  */
 151 #undef TAILQ_LAST
 152 #define TAILQ_LAST(head, headname) \
 153         (*(((struct headname *)((head)->tqh_last))->tqh_last))
 154
 155 #ifndef TAILQ_EMPTY
 156 #define TAILQ_EMPTY(head) ((head)->tqh_first == NULL)
 157 #endif
 158 #ifndef TAILQ_FOREACH
 159 #define TAILQ_FOREACH(var, head, field)                                 \
 160         for (var = TAILQ_FIRST(head); var; var = TAILQ_NEXT(var, field))
 161 #endif
 162
 163 /* macro for timeout/untimeout */
 164 /* use callout */
 165 #include <sys/callout.h>
 166
 167 #if (__FreeBSD_version > 500000)
 168 #define CALLOUT_INIT(c)         callout_init((c), 0)
 169 #else
 170 #define CALLOUT_INIT(c)         callout_init((c))
 171 #endif
 172 #define CALLOUT_RESET(c,t,f,a)  callout_reset((c),(t),(f),(a))
 173 #define CALLOUT_STOP(c)         callout_stop((c))
 174 #if !defined(CALLOUT_INITIALIZER) && (__FreeBSD_version < 600000)
 175 #define CALLOUT_INITIALIZER     { { { NULL } }, 0, NULL, NULL, 0 }
 176 #endif
 177
 178 #define m_pktlen(m)             ((m)->m_pkthdr.len)
 179
 180 struct ifnet; struct mbuf;
 181 struct pf_altq;
 182 #ifdef ALTQ3_CLFIER_COMPAT
 183 struct flowinfo;
 184 #endif
 185
 186 void    *altq_lookup(char *, int);
 187 #ifdef ALTQ3_CLFIER_COMPAT
 188 int     altq_extractflow(struct mbuf *, int, struct flowinfo *, u_int32_t);
 189 int     acc_add_filter(struct acc_classifier *, struct flow_filter *,
 190             void *, u_long *);
 191 int     acc_delete_filter(struct acc_classifier *, u_long);
 192 int     acc_discard_filters(struct acc_classifier *, void *, int);
 193 void    *acc_classify(void *, struct mbuf *, int);
 194 #endif
 195 u_int8_t read_dsfield(struct mbuf *, struct altq_pktattr *);
 196 void    write_dsfield(struct mbuf *, struct altq_pktattr *, u_int8_t);
 197 void    altq_assert(const char *, int, const char *);
 198 int     tbr_set(struct ifaltq *, struct tb_profile *);
 199
 200 int     altq_pfattach(struct pf_altq *);
 201 int     altq_pfdetach(struct pf_altq *);
 202 int     altq_add(struct ifnet *, struct pf_altq *);
 203 int     altq_remove(struct pf_altq *);
 204 int     altq_add_queue(struct pf_altq *);
 205 int     altq_remove_queue(struct pf_altq *);
 206 int     altq_getqstats(struct pf_altq *, void *, int *, int);
 207
 208 int     cbq_pfattach(struct pf_altq *);
 209 int     cbq_add_altq(struct ifnet *, struct pf_altq *);
 210 int     cbq_remove_altq(struct pf_altq *);
 211 int     cbq_add_queue(struct pf_altq *);
 212 int     cbq_remove_queue(struct pf_altq *);
 213 int     cbq_getqstats(struct pf_altq *, void *, int *, int);
 214
 215 int     codel_pfattach(struct pf_altq *);
 216 int     codel_add_altq(struct ifnet *, struct pf_altq *);
 217 int     codel_remove_altq(struct pf_altq *);
 218 int     codel_getqstats(struct pf_altq *, void *, int *, int);
 219
 220 int     priq_pfattach(struct pf_altq *);
 221 int     priq_add_altq(struct ifnet *, struct pf_altq *);
 222 int     priq_remove_altq(struct pf_altq *);
 223 int     priq_add_queue(struct pf_altq *);
 224 int     priq_remove_queue(struct pf_altq *);
 225 int     priq_getqstats(struct pf_altq *, void *, int *, int);
 226
 227 int     hfsc_pfattach(struct pf_altq *);
 228 int     hfsc_add_altq(struct ifnet *, struct pf_altq *);
 229 int     hfsc_remove_altq(struct pf_altq *);
 230 int     hfsc_add_queue(struct pf_altq *);
 231 int     hfsc_remove_queue(struct pf_altq *);
 232 int     hfsc_getqstats(struct pf_altq *, void *, int *, int);
 233
 234 int     fairq_pfattach(struct pf_altq *);
 235 int     fairq_add_altq(struct ifnet *, struct pf_altq *);
 236 int     fairq_remove_altq(struct pf_altq *);
 237 int     fairq_add_queue(struct pf_altq *);
 238 int     fairq_remove_queue(struct pf_altq *);
 239 int     fairq_getqstats(struct pf_altq *, void *, int *, int);
 240
 241 #endif /* _KERNEL */
 242 #endif /* _ALTQ_ALTQ_VAR_H_ */