[apple/xnu.git] / bsd / net / pktsched / pktsched_priq.h

/*
 * Copyright (c) 2011-2016 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

/*	$NetBSD: altq_priq.h,v 1.7 2006/10/12 19:59:08 peter Exp $	*/
/*	$KAME: altq_priq.h,v 1.7 2003/10/03 05:05:15 kjc Exp $	*/
/*
 * Copyright (C) 2000-2003
 *	Sony Computer Science Laboratories Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY SONY CSL AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL SONY CSL OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _NET_PKTSCHED_PKTSCHED_PRIQ_H_
#define _NET_PKTSCHED_PKTSCHED_PRIQ_H_

#ifdef PRIVATE
#include <net/pktsched/pktsched.h>
#include <net/classq/classq.h>
#include <net/classq/classq_red.h>
#include <net/classq/classq_rio.h>
#include <net/classq/classq_blue.h>
#include <net/classq/classq_sfb.h>

#ifdef __cplusplus
extern "C" {
#endif

#define PRIQ_MAXPRI     16      /* upper limit of the number of priorities */

/* priq class flags */
#define PRCF_RED                0x0001  /* use RED */
#define PRCF_ECN                0x0002  /* use ECN with RED/BLUE/SFB */
#define PRCF_RIO                0x0004  /* use RIO */
#define PRCF_CLEARDSCP          0x0010  /* clear diffserv codepoint */
#define PRCF_BLUE               0x0100  /* use BLUE */
#define PRCF_SFB                0x0200  /* use SFB */
#define PRCF_FLOWCTL            0x0400  /* enable flow control advisories */
#define PRCF_DEFAULTCLASS       0x1000  /* default class */
#ifdef BSD_KERNEL_PRIVATE
#define PRCF_LAZY               0x10000000 /* on-demand resource allocation */
#endif /* BSD_KERNEL_PRIVATE */

#define PRCF_USERFLAGS                                                  \
	(PRCF_RED | PRCF_ECN | PRCF_RIO | PRCF_CLEARDSCP | PRCF_BLUE |  \
	PRCF_SFB | PRCF_FLOWCTL | PRCF_DEFAULTCLASS)

#ifdef BSD_KERNEL_PRIVATE
#define PRCF_BITS \
	"\020\1RED\2ECN\3RIO\5CLEARDSCP\11BLUE\12SFB\13FLOWCTL\15DEFAULT" \
	"\35LAZY"
#else
#define PRCF_BITS \
	"\020\1RED\2ECN\3RIO\5CLEARDSCP\11BLUE\12SFB\13FLOWCTL\15DEFAULT"
#endif /* !BSD_KERNEL_PRIVATE */

struct priq_classstats {
	u_int32_t               class_handle;
	u_int32_t               priority;

	u_int32_t               qlength;
	u_int32_t               qlimit;
	u_int32_t               period;
	struct pktcntr          xmitcnt;  /* transmitted packet counter */
	struct pktcntr          dropcnt;  /* dropped packet counter */

	/* RED, RIO, BLUE, SFB related info */
	classq_type_t           qtype;
	union {
		/* RIO has 3 red stats */
		struct red_stats        red[RIO_NDROPPREC];
		struct blue_stats       blue;
		struct sfb_stats        sfb;
	};
	classq_state_t          qstate;
};

#ifdef __cplusplus
}
#endif
#endif /* PRIVATE */
#endif /* _NET_PKTSCHED_PKTSCHED_PRIQ_H_ */
Commit	Line	Data
316670eb	1	/*
5ba3f43e	2	* Copyright (c) 2011-2016 Apple Inc. All rights reserved.
316670eb A	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_
0a7de745	58	#define _NET_PKTSCHED_PKTSCHED_PRIQ_H_
316670eb A	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
0a7de745	72	#define PRIQ_MAXPRI 16 /* upper limit of the number of priorities */
316670eb A	73
316670eb A	74	/* priq class flags */
0a7de745 A	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 */
316670eb	83	#ifdef BSD_KERNEL_PRIVATE
0a7de745	84	#define PRCF_LAZY 0x10000000 /* on-demand resource allocation */
316670eb A	85	#endif /* BSD_KERNEL_PRIVATE */
316670eb A	86
0a7de745 A	87	#define PRCF_USERFLAGS \
0a7de745 A	88	(PRCF_RED \| PRCF_ECN \| PRCF_RIO \| PRCF_CLEARDSCP \| PRCF_BLUE \| \
316670eb A	89	PRCF_SFB \| PRCF_FLOWCTL \| PRCF_DEFAULTCLASS)
	90
	91	#ifdef BSD_KERNEL_PRIVATE
0a7de745	92	#define PRCF_BITS \
316670eb A	93	"\020\1RED\2ECN\3RIO\5CLEARDSCP\11BLUE\12SFB\13FLOWCTL\15DEFAULT" \
	94	"\35LAZY"
	95	#else
0a7de745	96	#define PRCF_BITS \
316670eb A	97	"\020\1RED\2ECN\3RIO\5CLEARDSCP\11BLUE\12SFB\13FLOWCTL\15DEFAULT"
	98	#endif /* !BSD_KERNEL_PRIVATE */
	99
	100	struct priq_classstats {
0a7de745 A	101	u_int32_t class_handle;
0a7de745 A	102	u_int32_t priority;
316670eb	103
0a7de745 A	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 */
316670eb A	109
316670eb A	110	/* RED, RIO, BLUE, SFB related info */
0a7de745	111	classq_type_t qtype;
316670eb A	112	union {
316670eb A	113	/* RIO has 3 red stats */
0a7de745 A	114	struct red_stats red[RIO_NDROPPREC];
	115	struct blue_stats blue;
	116	struct sfb_stats sfb;
316670eb	117	};
0a7de745	118	classq_state_t qstate;
316670eb A	119	};
316670eb A	120
316670eb A	121	#ifdef __cplusplus
	122	}
	123	#endif
	124	#endif /* PRIVATE */
	125	#endif /* _NET_PKTSCHED_PKTSCHED_PRIQ_H_ */