sys/net/altq/if_altq.h

   1 /*      $KAME: if_altq.h,v 1.11 2003/07/10 12:07:50 kjc Exp $   */
   2
   3 /*
   4  * Copyright (C) 1997-2003
   5  *      Sony Computer Science Laboratories Inc.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28 #ifndef _NET_ALTQ_IF_ALTQ_H_
  29 #define _NET_ALTQ_IF_ALTQ_H_
  30
  31 #ifndef _SYS_SERIALIZE_H_
  32 #include <sys/serialize.h>
  33 #endif
  34
  35 /* Default subqueue */
  36 #define ALTQ_SUBQ_INDEX_DEFAULT 0
  37
  38 struct mbuf;
  39 struct altq_pktattr;
  40
  41 struct ifaltq_subque;
  42 struct ifaltq;
  43
  44 typedef int (*altq_mapsubq_t)(struct ifaltq *, int);
  45
  46 typedef int (*ifsq_enqueue_t)(struct ifaltq_subque *, struct mbuf *,
  47     struct altq_pktattr *);
  48 typedef struct mbuf *(*ifsq_dequeue_t)(struct ifaltq_subque *, int);
  49 typedef int (*ifsq_request_t)(struct ifaltq_subque *, int, void *);
  50
  51 struct ifsubq_stage {
  52         struct ifaltq_subque *stg_subq;
  53         int             stg_cnt;
  54         int             stg_len;
  55         uint32_t        stg_flags;
  56         TAILQ_ENTRY(ifsubq_stage) stg_link;
  57 } __cachealign;
  58
  59 #define IFSQ_STAGE_FLAG_QUED    0x1
  60 #define IFSQ_STAGE_FLAG_SCHED   0x2
  61
  62 struct ifaltq_subque {
  63         struct lwkt_serialize ifsq_lock;
  64         int             ifsq_index;
  65
  66         struct ifaltq   *ifsq_altq;
  67         struct ifnet    *ifsq_ifp;
  68         void            *ifsq_hw_priv;  /* hw private data */
  69
  70         struct mbuf     *ifsq_head;
  71         struct mbuf     *ifsq_tail;
  72         int             ifsq_len;       /* packet counter */
  73         int             ifsq_maxlen;
  74         int             ifsq_bcnt;      /* byte counter */
  75         int             ifsq_maxbcnt;
  76
  77         ifsq_enqueue_t  ifsq_enqueue;
  78         ifsq_dequeue_t  ifsq_dequeue;
  79         ifsq_request_t  ifsq_request;
  80
  81         struct lwkt_serialize *ifsq_hw_serialize;
  82                                         /* hw serializer */
  83         struct mbuf     *ifsq_prepended;/* mbuf dequeued, but not yet xmit */
  84         int             ifsq_started;   /* ifnet.if_start interlock */
  85         int             ifsq_hw_oactive;/* hw too busy, protected by driver */
  86         int             ifsq_cpuid;     /* owner cpu */
  87         struct ifsubq_stage *ifsq_stage;/* packet staging information */
  88         struct netmsg_base *ifsq_ifstart_nmsg;
  89                                         /* percpu msgs to sched if_start */
  90 } __cachealign;
  91
  92 #ifdef _KERNEL
  93
  94 #define ALTQ_SQ_ASSERT_LOCKED(ifsq)     ASSERT_SERIALIZED(&(ifsq)->ifsq_lock)
  95 #define ALTQ_SQ_LOCK_INIT(ifsq)         lwkt_serialize_init(&(ifsq)->ifsq_lock)
  96 #define ALTQ_SQ_LOCK(ifsq) \
  97         lwkt_serialize_adaptive_enter(&(ifsq)->ifsq_lock)
  98 #define ALTQ_SQ_UNLOCK(ifsq)            lwkt_serialize_exit(&(ifsq)->ifsq_lock)
  99
 100 #define ASSERT_ALTQ_SQ_SERIALIZED_HW(ifsq) \
 101         ASSERT_SERIALIZED((ifsq)->ifsq_hw_serialize)
 102 #define ASSERT_ALTQ_SQ_NOT_SERIALIZED_HW(ifsq) \
 103         ASSERT_NOT_SERIALIZED((ifsq)->ifsq_hw_serialize)
 104
 105 #define ALTQ_SQ_CNTR_INC(ifsq, bcnt) \
 106 do { \
 107         (ifsq)->ifsq_len++; \
 108         (ifsq)->ifsq_bcnt += (bcnt); \
 109 } while (0)
 110
 111 #define ALTQ_SQ_CNTR_DEC(ifsq, bcnt) \
 112 do { \
 113         KASSERT((ifsq)->ifsq_len > 0, ("invalid packet count")); \
 114         (ifsq)->ifsq_len--; \
 115         KASSERT((ifsq)->ifsq_bcnt >= bcnt, ("invalid byte count")); \
 116         (ifsq)->ifsq_bcnt -= (bcnt); \
 117 } while (0)
 118
 119 #define ALTQ_SQ_CNTR_RESET(ifsq) \
 120 do { \
 121         (ifsq)->ifsq_len = 0; \
 122         (ifsq)->ifsq_bcnt = 0; \
 123 } while (0)
 124
 125 #endif  /* _KERNEL */
 126
 127 /*
 128  * Structure defining a queue for a network interface.
 129  */
 130 struct  ifaltq {
 131         /* alternate queueing related fields */
 132         int     altq_type;              /* discipline type */
 133         int     altq_flags;             /* flags (e.g. ready, in-use) */
 134         void    *altq_disc;             /* for discipline-specific use */
 135         struct  ifnet *altq_ifp;        /* back pointer to interface */
 136
 137         /* classifier fields */
 138         void    *altq_clfier;           /* classifier-specific use */
 139         void    *(*altq_classify)(struct ifaltq *, struct mbuf *,
 140                                   struct altq_pktattr *);
 141
 142         /* token bucket regulator */
 143         struct  tb_regulator *altq_tbr;
 144
 145         /* Sub-queues mapping */
 146         altq_mapsubq_t altq_mapsubq;
 147         uint32_t altq_subq_mask;
 148
 149         /* Sub-queues */
 150         int     altq_subq_cnt;
 151         struct ifaltq_subque *altq_subq;
 152
 153         int     altq_maxlen;
 154 };
 155
 156 #ifdef _KERNRL
 157 /* COMPAT */
 158 #define ALTQ_LOCK(ifq) \
 159         ALTQ_SQ_LOCK(&(ifq)->altq_subq[ALTQ_SUBQ_INDEX_DEFAULT])
 160 /* COMPAT */
 161 #define ALTQ_UNLOCK(ifq) \
 162         ALTQ_SQ_UNLOCK(&(ifq)->altq_subq[ALTQ_SUBQ_INDEX_DEFAULT])
 163 #endif
 164
 165 #ifdef _KERNEL
 166
 167 /*
 168  * packet attributes used by queueing disciplines.
 169  * pattr_class is a discipline-dependent scheduling class that is
 170  * set by a classifier.
 171  * pattr_hdr and pattr_af may be used by a discipline to access
 172  * the header within a mbuf.  (e.g. ECN needs to update the CE bit)
 173  * note that pattr_hdr could be stale after m_pullup, though link
 174  * layer output routines usually don't use m_pullup.  link-level
 175  * compression also invalidates these fields.  thus, pattr_hdr needs
 176  * to be verified when a discipline touches the header.
 177  */
 178 struct altq_pktattr {
 179         void    *pattr_class;           /* sched class set by classifier */
 180         int     pattr_af;               /* address family */
 181         caddr_t pattr_hdr;              /* saved header position in mbuf */
 182 };
 183
 184 /*
 185  * a token-bucket regulator limits the rate that a network driver can
 186  * dequeue packets from the output queue.
 187  * modern cards are able to buffer a large amount of packets and dequeue
 188  * too many packets at a time.  this bursty dequeue behavior makes it
 189  * impossible to schedule packets by queueing disciplines.
 190  * a token-bucket is used to control the burst size in a device
 191  * independent manner.
 192  */
 193 struct tb_regulator {
 194         int64_t         tbr_rate;       /* (scaled) token bucket rate */
 195         int64_t         tbr_depth;      /* (scaled) token bucket depth */
 196
 197         int64_t         tbr_token;      /* (scaled) current token */
 198         int64_t         tbr_filluptime; /* (scaled) time to fill up bucket */
 199         uint64_t        tbr_last;       /* last time token was updated */
 200
 201         int             tbr_lastop;     /* last dequeue operation type
 202                                            needed for poll-and-dequeue */
 203 };
 204
 205 /* if_altqflags */
 206 #define ALTQF_READY      0x01   /* driver supports alternate queueing */
 207 #define ALTQF_ENABLED    0x02   /* altq is in use */
 208 #define ALTQF_CLASSIFY   0x04   /* classify packets */
 209 #define ALTQF_DRIVER1    0x40   /* driver specific */
 210
 211 /* if_altqflags set internally only: */
 212 #define ALTQF_CANTCHANGE        (ALTQF_READY)
 213
 214 /* altq_dequeue 2nd arg */
 215 #define ALTDQ_REMOVE            1       /* dequeue mbuf from the queue */
 216 #define ALTDQ_POLL              2       /* don't dequeue mbuf from the queue */
 217
 218 /* altq request types (currently only purge is defined) */
 219 #define ALTRQ_PURGE             1       /* purge all packets */
 220
 221 int     altq_attach(struct ifaltq *, int, void *, altq_mapsubq_t,
 222             ifsq_enqueue_t, ifsq_dequeue_t, ifsq_request_t, void *,
 223             void *(*)(struct ifaltq *, struct mbuf *, struct altq_pktattr *));
 224 int     altq_detach(struct ifaltq *);
 225 int     altq_enable(struct ifaltq *);
 226 int     altq_disable(struct ifaltq *);
 227 struct mbuf *tbr_dequeue(struct ifaltq_subque *, int);
 228 extern int      (*altq_input)(struct mbuf *, int);
 229 #endif /* _KERNEL */
 230
 231 #endif /* _NET_ALTQ_IF_ALTQ_H_ */