bsd/net/pktsched/pktsched_priq.h

   1 /*
   2  * Copyright (c) 2011-2012 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 /*      $NetBSD: altq_priq.h,v 1.7 2006/10/12 19:59:08 peter Exp $      */
  30 /*      $KAME: altq_priq.h,v 1.7 2003/10/03 05:05:15 kjc Exp $  */
  31 /*
  32  * Copyright (C) 2000-2003
  33  *      Sony Computer Science Laboratories Inc.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
  45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47  * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
  48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  */
  56
  57 #ifndef _NET_PKTSCHED_PKTSCHED_PRIQ_H_
  58 #define _NET_PKTSCHED_PKTSCHED_PRIQ_H_
  59
  60 #ifdef PRIVATE
  61 #include <net/pktsched/pktsched.h>
  62 #include <net/classq/classq.h>
  63 #include <net/classq/classq_red.h>
  64 #include <net/classq/classq_rio.h>
  65 #include <net/classq/classq_blue.h>
  66 #include <net/classq/classq_sfb.h>
  67
  68 #ifdef __cplusplus
  69 extern "C" {
  70 #endif
  71
  72 #define PRIQ_MAXPRI     16      /* upper limit of the number of priorities */
  73
  74 /* priq class flags */
  75 #define PRCF_RED                0x0001  /* use RED */
  76 #define PRCF_ECN                0x0002  /* use ECN with RED/BLUE/SFB */
  77 #define PRCF_RIO                0x0004  /* use RIO */
  78 #define PRCF_CLEARDSCP          0x0010  /* clear diffserv codepoint */
  79 #define PRCF_BLUE               0x0100  /* use BLUE */
  80 #define PRCF_SFB                0x0200  /* use SFB */
  81 #define PRCF_FLOWCTL            0x0400  /* enable flow control advisories */
  82 #define PRCF_DEFAULTCLASS       0x1000  /* default class */
  83 #ifdef BSD_KERNEL_PRIVATE
  84 #define PRCF_LAZY               0x10000000 /* on-demand resource allocation */
  85 #endif /* BSD_KERNEL_PRIVATE */
  86
  87 #define PRCF_USERFLAGS                                                  \
  88         (PRCF_RED | PRCF_ECN | PRCF_RIO | PRCF_CLEARDSCP | PRCF_BLUE |  \
  89         PRCF_SFB | PRCF_FLOWCTL | PRCF_DEFAULTCLASS)
  90
  91 #ifdef BSD_KERNEL_PRIVATE
  92 #define PRCF_BITS \
  93         "\020\1RED\2ECN\3RIO\5CLEARDSCP\11BLUE\12SFB\13FLOWCTL\15DEFAULT" \
  94         "\35LAZY"
  95 #else
  96 #define PRCF_BITS \
  97         "\020\1RED\2ECN\3RIO\5CLEARDSCP\11BLUE\12SFB\13FLOWCTL\15DEFAULT"
  98 #endif /* !BSD_KERNEL_PRIVATE */
  99
 100 struct priq_classstats {
 101         u_int32_t               class_handle;
 102         u_int32_t               priority;
 103
 104         u_int32_t               qlength;
 105         u_int32_t               qlimit;
 106         u_int32_t               period;
 107         struct pktcntr          xmitcnt;  /* transmitted packet counter */
 108         struct pktcntr          dropcnt;  /* dropped packet counter */
 109
 110         /* RED, RIO, BLUE, SFB related info */
 111         classq_type_t           qtype;
 112         union {
 113                 /* RIO has 3 red stats */
 114                 struct red_stats        red[RIO_NDROPPREC];
 115                 struct blue_stats       blue;
 116                 struct sfb_stats        sfb;
 117         };
 118         classq_state_t          qstate;
 119 };
 120
 121 #ifdef BSD_KERNEL_PRIVATE
 122 struct priq_class {
 123         u_int32_t       cl_handle;      /* class handle */
 124         class_queue_t   cl_q;           /* class queue structure */
 125         u_int32_t       cl_qflags;      /* class queue flags */
 126         union {
 127                 void            *ptr;
 128                 struct red      *red;   /* RED state */
 129                 struct rio      *rio;   /* RIO state */
 130                 struct blue     *blue;  /* BLUE state */
 131                 struct sfb      *sfb;   /* SFB state */
 132         } cl_qalg;
 133         int32_t         cl_pri;         /* priority */
 134         u_int32_t       cl_flags;       /* class flags */
 135         struct priq_if  *cl_pif;        /* back pointer to pif */
 136
 137         /* statistics */
 138         u_int32_t       cl_period;      /* backlog period */
 139         struct pktcntr  cl_xmitcnt;     /* transmitted packet counter */
 140         struct pktcntr  cl_dropcnt;     /* dropped packet counter */
 141 };
 142
 143 #define cl_red  cl_qalg.red
 144 #define cl_rio  cl_qalg.rio
 145 #define cl_blue cl_qalg.blue
 146 #define cl_sfb  cl_qalg.sfb
 147
 148 /* priq_if flags */
 149 #define PRIQIFF_ALTQ            0x1     /* configured via PF/ALTQ */
 150
 151 /*
 152  * priq interface state
 153  */
 154 struct priq_if {
 155         struct ifclassq         *pif_ifq;       /* backpointer to ifclassq */
 156         int                     pif_maxpri;     /* max priority in use */
 157         u_int32_t               pif_flags;      /* flags */
 158         u_int32_t               pif_throttle;   /* throttling level */
 159         pktsched_bitmap_t       pif_bitmap;     /* active class bitmap */
 160         struct priq_class       *pif_default;   /* default class */
 161         struct priq_class       *pif_classes[PRIQ_MAXPRI]; /* classes */
 162 };
 163
 164 #define PRIQIF_IFP(_pif)        ((_pif)->pif_ifq->ifcq_ifp)
 165
 166 struct if_ifclassq_stats;
 167
 168 extern void priq_init(void);
 169 extern struct priq_if *priq_alloc(struct ifnet *, int, boolean_t);
 170 extern int priq_destroy(struct priq_if *);
 171 extern void priq_purge(struct priq_if *);
 172 extern void priq_event(struct priq_if *, cqev_t);
 173 extern int priq_add_queue(struct priq_if *, int, u_int32_t, int, u_int32_t,
 174     struct priq_class **);
 175 extern int priq_remove_queue(struct priq_if *, u_int32_t);
 176 extern int priq_get_class_stats(struct priq_if *, u_int32_t,
 177     struct priq_classstats *);
 178 extern int priq_enqueue(struct priq_if *, struct priq_class *, struct mbuf *,
 179     struct pf_mtag *);
 180 extern struct mbuf *priq_dequeue(struct priq_if *, cqdq_op_t);
 181 extern int priq_setup_ifclassq(struct ifclassq *, u_int32_t);
 182 extern int priq_teardown_ifclassq(struct ifclassq *ifq);
 183 extern int priq_getqstats_ifclassq(struct ifclassq *, u_int32_t,
 184     struct if_ifclassq_stats *);
 185 extern int priq_set_throttle(struct ifclassq *, u_int32_t);
 186 extern int priq_get_throttle(struct ifclassq *, u_int32_t *);
 187 #endif /* BSD_KERNEL_PRIVATE */
 188 #ifdef __cplusplus
 189 }
 190 #endif
 191 #endif /* PRIVATE */
 192 #endif /* _NET_PKTSCHED_PKTSCHED_PRIQ_H_ */