1/* 2 * Copyright (c) 2007-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_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 72extern "C" { 73#endif 74 75/* 76 * Packet Queue types 77 */ 78typedef enum classq_type { 79 Q_DROPHEAD, 80 Q_DROPTAIL, 81 Q_RED, 82 Q_RIO, 83 Q_BLUE, 84 Q_SFB 85} classq_type_t; 86 87/* 88 * Packet Queue states 89 */ 90typedef enum classq_state { 91 QS_RUNNING, 92 QS_SUSPENDED 93} classq_state_t; 94 95#define DEFAULT_QLIMIT 128 /* default */ 96 97/* 98 * generic packet counter 99 */ 100struct pktcntr { 101 u_int64_t packets; 102 u_int64_t bytes; 103}; 104 105#ifdef BSD_KERNEL_PRIVATE 106#include <sys/mcache.h> 107#include <sys/mbuf.h> 108#include <sys/sysctl.h> 109 110/* 111 * Packet Queue structures and macros to manipulate them. 112 */ 113typedef struct _class_queue_ { 114 MBUFQ_HEAD(mq_head) mbufq; /* Packet queue */ 115 u_int32_t qlen; /* Queue length (in number of packets) */ 116 u_int32_t qlim; /* Queue limit (in number of packets*) */ 117 u_int64_t qsize; /* Approx. queue size (in number of bytes) */ 118 classq_type_t qtype; /* Queue type */ 119 classq_state_t qstate; /* Queue state */ 120} class_queue_t; 121 122#define qtype(q) (q)->qtype /* Get queue type */ 123#define qstate(q) (q)->qstate /* Get queue state */ 124#define qlimit(q) (q)->qlim /* Max packets to be queued */ 125#define qlen(q) (q)->qlen /* Current queue length. */ 126#define qsize(q) (q)->qsize /* Approx. bytes in queue */ 127/* #define qtail(q) MBUFQ_LAST(&(q)->mbufq) */ 128#define qhead(q) MBUFQ_FIRST(&(q)->mbufq) 129 130#define qempty(q) (qlen(q) == 0) /* Is the queue empty?? */ 131#define q_is_red(q) (qtype(q) == Q_RED) /* Is the queue a RED queue */ 132#define q_is_rio(q) (qtype(q) == Q_RIO) /* Is the queue a RIO queue */ 133#define q_is_blue(q) (qtype(q) == Q_BLUE) /* Is the queue a BLUE queue */ 134#define q_is_sfb(q) (qtype(q) == Q_SFB) /* Is the queue a SFB queue */ 135#define q_is_red_or_rio(q) (qtype(q) == Q_RED || qtype(q) == Q_RIO) 136#define q_is_suspended(q) (qstate(q) == QS_SUSPENDED) 137 138#define PKTCNTR_ADD(_cntr, _pkt, _len) do { \ 139 (_cntr)->packets += (_pkt); \ 140 (_cntr)->bytes += (_len); \ 141} while (0) 142 143#define PKTCNTR_CLEAR(_cntr) do { \ 144 (_cntr)->packets = 0; \ 145 (_cntr)->bytes = 0; \ 146} while (0) 147 148/* flags for mark_ecn() */ 149#define CLASSQF_ECN4 0x01 /* use packet marking for IPv4 packets */ 150#define CLASSQF_ECN6 0x02 /* use packet marking for IPv6 packets */ 151#define CLASSQF_ECN (CLASSQF_ECN4 | CLASSQF_ECN6) 152 153extern u_int32_t classq_verbose; 154 155SYSCTL_DECL(_net_classq); 156 157extern void _qinit(class_queue_t *, int, int); 158extern void _addq(class_queue_t *, struct mbuf *); 159extern void _addq_multi(class_queue_t *, struct mbuf *, struct mbuf *, 160 u_int32_t, u_int32_t); 161extern struct mbuf *_getq(class_queue_t *); 162extern struct mbuf *_getq_all(class_queue_t *); 163extern struct mbuf *_getq_tail(class_queue_t *); 164extern struct mbuf *_getq_random(class_queue_t *); 165extern struct mbuf *_getq_flow(class_queue_t *, u_int32_t); 166extern void _removeq(class_queue_t *, struct mbuf *); 167extern void _flushq(class_queue_t *); 168extern void _flushq_flow(class_queue_t *, u_int32_t, u_int32_t *, u_int32_t *); 169 170extern void classq_init(void); 171 172#if PF_ECN 173extern u_int8_t read_dsfield(struct mbuf *, struct pf_mtag *); 174extern void write_dsfield(struct mbuf *, struct pf_mtag *, u_int8_t); 175extern int mark_ecn(struct mbuf *, struct pf_mtag *, int); 176#endif /* PF_ECN */ 177#endif /* BSD_KERNEL_PRIVATE */ 178 179#ifdef __cplusplus 180} 181#endif 182#endif /* PRIVATE */ 183#endif /* _NET_CLASSQ_CLASSQ_H_ */ 184