bsd/net/classq/classq.h

   1 /*
   2  * Copyright (c) 2007-2018 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_classq.h,v 1.7 2006/10/12 19:59:08 peter Exp $    */
  30 /*      $KAME: altq_classq.h,v 1.6 2003/01/07 07:33:38 kjc Exp $        */
  31
  32 /*
  33  * Copyright (c) 1991-1997 Regents of the University of California.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. All advertising materials mentioning features or use of this software
  45  *    must display the following acknowledgement:
  46  *      This product includes software developed by the Network Research
  47  *      Group at Lawrence Berkeley Laboratory.
  48  * 4. Neither the name of the University nor of the Laboratory may be used
  49  *    to endorse or promote products derived from this software without
  50  *    specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  62  * SUCH DAMAGE.
  63  */
  64 /*
  65  * class queue definitions extracted from rm_class.h.
  66  */
  67 #ifndef _NET_CLASSQ_CLASSQ_H_
  68 #define _NET_CLASSQ_CLASSQ_H_
  69
  70 #ifdef PRIVATE
  71 #ifdef __cplusplus
  72 extern "C" {
  73 #endif
  74
  75 /*
  76  * Packet types
  77  */
  78 typedef enum classq_pkt_type {
  79         QP_INVALID = 0,
  80         QP_MBUF,        /* mbuf packet */
  81 } classq_pkt_type_t;
  82
  83 /*
  84  * Packet
  85  */
  86 typedef struct classq_pkt {
  87         union {
  88                 struct mbuf             *cp_mbuf;       /* mbuf packet */
  89         };
  90         classq_pkt_type_t       cp_ptype;
  91 } classq_pkt_t;
  92
  93 #define CLASSQ_PKT_INITIALIZER(_p)      \
  94         (classq_pkt_t){ .cp_mbuf = NULL, .cp_ptype = QP_INVALID }
  95
  96 #define CLASSQ_PKT_INIT(_p)    do {    \
  97         (_p)->cp_ptype = QP_INVALID;   \
  98         (_p)->cp_mbuf = NULL;          \
  99 } while (0)
 100
 101 #define CLASSQ_PKT_INIT_MBUF(_p, _m)    do {    \
 102         (_p)->cp_ptype = QP_MBUF;               \
 103         (_p)->cp_mbuf = (_m);                   \
 104 } while (0)
 105
 106
 107 /*
 108  * Packet Queue types
 109  */
 110 typedef enum classq_type {
 111         Q_DROPHEAD,
 112         Q_DROPTAIL,
 113         Q_SFB
 114 } classq_type_t;
 115
 116 /*
 117  * Packet Queue states
 118  */
 119 typedef enum classq_state {
 120         QS_RUNNING,
 121         QS_SUSPENDED
 122 } classq_state_t;
 123
 124 #define DEFAULT_QLIMIT  128 /* default */
 125
 126 #define CLASSQ_DEQUEUE_MAX_PKT_LIMIT    2048
 127 #define CLASSQ_DEQUEUE_MAX_BYTE_LIMIT   (1024 * 1024)
 128
 129 /*
 130  * generic packet counter
 131  */
 132 struct pktcntr {
 133         u_int64_t       packets;
 134         u_int64_t       bytes;
 135 };
 136
 137 #ifdef BSD_KERNEL_PRIVATE
 138 #include <sys/mcache.h>
 139 #include <sys/mbuf.h>
 140 #include <sys/sysctl.h>
 141
 142 /*
 143  * Packet Queue structures and macros to manipulate them.
 144  */
 145 typedef struct _class_queue_ {
 146         union {
 147                 MBUFQ_HEAD(mq_head) __mbufq; /* mbuf packet queue */
 148         } __pktq_u;
 149         u_int32_t       qlen;   /* Queue length (in number of packets) */
 150         u_int32_t       qlim;   /* Queue limit (in number of packets*) */
 151         u_int64_t       qsize;  /* Approx. queue size (in number of bytes) */
 152         classq_type_t   qtype;  /* Queue type */
 153         classq_state_t  qstate; /* Queue state */
 154         classq_pkt_type_t       qptype; /* Packet type */
 155 } class_queue_t;
 156
 157 #define qmbufq(q)       (q)->__pktq_u.__mbufq   /* Get mbuf packet queue */
 158 #define qptype(q)       (q)->qptype             /* Get queue packet type */
 159 #define qtype(q)        (q)->qtype              /* Get queue type */
 160 #define qstate(q)       (q)->qstate             /* Get queue state */
 161 #define qlimit(q)       (q)->qlim               /* Max packets to be queued */
 162 #define qlen(q)         (q)->qlen               /* Current queue length. */
 163 #define qsize(q)        (q)->qsize              /* Approx. bytes in queue */
 164
 165 #define qhead(q)        MBUFQ_FIRST(&qmbufq(q))
 166
 167 #define qempty(q)       (qlen(q) == 0)  /* Is the queue empty?? */
 168 #define q_is_red(q)     (qtype(q) == Q_RED)     /* Is the queue a RED queue */
 169 #define q_is_rio(q)     (qtype(q) == Q_RIO)     /* Is the queue a RIO queue */
 170 #define q_is_blue(q)    (qtype(q) == Q_BLUE)    /* Is the queue a BLUE queue */
 171 #define q_is_sfb(q)     (qtype(q) == Q_SFB)     /* Is the queue a SFB queue */
 172 #define q_is_red_or_rio(q) (qtype(q) == Q_RED || qtype(q) == Q_RIO)
 173 #define q_is_suspended(q) (qstate(q) == QS_SUSPENDED)
 174
 175 #define PKTCNTR_ADD(_cntr, _pkt, _len) do {                             \
 176         (_cntr)->packets += (_pkt);                                     \
 177         (_cntr)->bytes += (_len);                                       \
 178 } while (0)
 179
 180 #define PKTCNTR_CLEAR(_cntr) do {                                       \
 181         (_cntr)->packets = 0;                                           \
 182         (_cntr)->bytes = 0;                                             \
 183 } while (0)
 184
 185 /* flags for mark_ecn() */
 186 #define CLASSQF_ECN4    0x01    /* use packet marking for IPv4 packets */
 187 #define CLASSQF_ECN6    0x02    /* use packet marking for IPv6 packets */
 188 #define CLASSQF_ECN     (CLASSQF_ECN4 | CLASSQF_ECN6)
 189
 190 extern u_int32_t classq_verbose;
 191 #if DEBUG || DEVELOPMENT
 192 extern uint16_t fq_codel_quantum;
 193 #endif /* DEBUG || DEVELOPMENT */
 194
 195 SYSCTL_DECL(_net_classq);
 196
 197 extern void _qinit(class_queue_t *, int, int, classq_pkt_type_t);
 198 extern void _addq(class_queue_t *, classq_pkt_t *);
 199 extern void _addq_multi(class_queue_t *, classq_pkt_t *, classq_pkt_t *,
 200     u_int32_t, u_int64_t);
 201 extern void _getq(class_queue_t *, classq_pkt_t *);
 202 extern void _getq_all(class_queue_t *, classq_pkt_t *, classq_pkt_t *,
 203     u_int32_t *, u_int64_t *);
 204 extern void _getq_tail(class_queue_t *, classq_pkt_t *);
 205 extern void _getq_random(class_queue_t *, classq_pkt_t *);
 206 extern void _getq_flow(class_queue_t *, classq_pkt_t *, u_int32_t);
 207 extern void _getq_scidx_lt(class_queue_t *, classq_pkt_t *, u_int32_t);
 208 extern void _removeq(class_queue_t *, classq_pkt_t *);
 209 extern void _flushq(class_queue_t *);
 210 extern void _flushq_flow(class_queue_t *, u_int32_t, u_int32_t *, u_int32_t *);
 211
 212 extern void classq_init(void);
 213
 214 #if PF_ECN
 215 extern u_int8_t read_dsfield(struct mbuf *, struct pf_mtag *);
 216 extern void     write_dsfield(struct mbuf *, struct pf_mtag *, u_int8_t);
 217 extern int      mark_ecn(struct mbuf *, struct pf_mtag *, int);
 218 #endif /* PF_ECN */
 219 #endif /* BSD_KERNEL_PRIVATE */
 220
 221 #ifdef __cplusplus
 222 }
 223 #endif
 224 #endif /* PRIVATE */
 225 #endif /* _NET_CLASSQ_CLASSQ_H_ */