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_rio.h,v 1.5 2006/10/12 19:59:08 peter Exp $ */ 30/* $KAME: altq_rio.h,v 1.9 2003/07/10 12:07:49 kjc Exp $ */ 31 32/* 33 * Copyright (C) 1998-2003 34 * Sony Computer Science Laboratories Inc. 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 * 45 * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND 46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 48 * ARE DISCLAIMED. IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE 49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 55 * SUCH DAMAGE. 56 */ 57 58#ifndef _NET_CLASSQ_CLASSQ_RIO_H_ 59#define _NET_CLASSQ_CLASSQ_RIO_H_ 60 61#ifdef PRIVATE 62#ifdef BSD_KERNEL_PRIVATE 63#include <net/classq/if_classq.h> 64#endif /* BSD_KERNEL_PRIVATE */ 65 66#ifdef __cplusplus 67extern "C" { 68#endif 69 70/* 71 * RIO: RED with IN/OUT bit 72 * (extended to support more than 2 drop precedence values) 73 */ 74#define RIO_NDROPPREC 3 /* number of drop precedence values */ 75 76#ifdef BSD_KERNEL_PRIVATE 77/* rio flags */ 78#define RIOF_ECN4 0x01 /* use packet marking for IPv4 packets */ 79#define RIOF_ECN6 0x02 /* use packet marking for IPv6 packets */ 80#define RIOF_ECN (RIOF_ECN4 | RIOF_ECN6) 81#define RIOF_CLEARDSCP 0x200 /* clear diffserv codepoint */ 82 83#define RIOF_USERFLAGS \ 84 (RIOF_ECN4 | RIOF_ECN6 | RIOF_CLEARDSCP) 85 86typedef struct rio { 87 /* per drop precedence structure */ 88 struct dropprec_state { 89 /* red parameters */ 90 int inv_pmax; /* inverse of max drop probability */ 91 int th_min; /* red min threshold */ 92 int th_max; /* red max threshold */ 93 94 /* variables for internal use */ 95 int th_min_s; /* th_min scaled by avgshift */ 96 int th_max_s; /* th_max scaled by avgshift */ 97 int probd; /* drop probability denominator */ 98 99 int qlen; /* queue length */ 100 int avg; /* (scaled) queue length average */ 101 int count; /* packet count since the last */ 102 /* dropped/marked packet */ 103 int idle; /* queue was empty */ 104 int old; /* avg is above th_min */ 105 struct timeval last; /* timestamp when queue becomes idle */ 106 } rio_precstate[RIO_NDROPPREC]; 107 108 int rio_wshift; /* log(red_weight) */ 109 int rio_weight; /* weight for EWMA */ 110 struct wtab *rio_wtab; /* weight table */ 111 112 int rio_pkttime; /* average packet time in micro sec */ 113 /* used for idle calibration */ 114 int rio_flags; /* rio flags */ 115 struct ifnet *rio_ifp; /* back pointer to ifnet */ 116 117 u_int8_t rio_codepoint; /* codepoint value to tag packets */ 118 u_int8_t rio_codepointmask; /* codepoint mask bits */ 119 120 struct red_stats q_stats[RIO_NDROPPREC]; /* statistics */ 121} rio_t; 122 123extern void rio_init(void); 124extern rio_t *rio_alloc(struct ifnet *, int, struct redparams *, int, int); 125extern void rio_destroy(rio_t *); 126extern void rio_getstats(rio_t *, struct red_stats *); 127extern int rio_addq(rio_t *, class_queue_t *, struct mbuf *, struct pf_mtag *); 128extern struct mbuf *rio_getq(rio_t *, class_queue_t *); 129extern void rio_purgeq(struct rio *, class_queue_t *, u_int32_t, 130 u_int32_t *, u_int32_t *); 131extern void rio_updateq(rio_t *, cqev_t); 132extern int rio_suspendq(rio_t *, class_queue_t *, boolean_t); 133#endif /* BSD_KERNEL_PRIVATE */ 134 135#ifdef __cplusplus 136} 137#endif 138#endif /* PRIVATE */ 139#endif /* _NET_CLASSQ_CLASSQ_RIO_H_ */ 140