[apple/xnu.git] / bsd / net / classq / classq.h

/*
 * Copyright (c) 2007-2018 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_classq.h,v 1.7 2006/10/12 19:59:08 peter Exp $	*/
/*	$KAME: altq_classq.h,v 1.6 2003/01/07 07:33:38 kjc Exp $	*/

/*
 * Copyright (c) 1991-1997 Regents of the University of California.
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the Network Research
 *	Group at Lawrence Berkeley Laboratory.
 * 4. Neither the name of the University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 THE REGENTS 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.
 */
/*
 * class queue definitions extracted from rm_class.h.
 */
#ifndef _NET_CLASSQ_CLASSQ_H_
#define _NET_CLASSQ_CLASSQ_H_

#ifdef PRIVATE
#ifdef __cplusplus
extern "C" {
#endif

/*
 * Packet types
 */
typedef enum classq_pkt_type {
	QP_INVALID = 0,
	QP_MBUF,        /* mbuf packet */
} classq_pkt_type_t;

/*
 * Packet
 */
typedef struct classq_pkt {
	union {
		struct mbuf             *cp_mbuf;       /* mbuf packet */
	};
	classq_pkt_type_t       cp_ptype;
} classq_pkt_t;

#define CLASSQ_PKT_INITIALIZER(_p)      \
	(classq_pkt_t){ .cp_mbuf = NULL, .cp_ptype = QP_INVALID }

#define CLASSQ_PKT_INIT_MBUF(_p, _m)    do {    \
	(_p)->cp_ptype = QP_MBUF;               \
	(_p)->cp_mbuf = (_m);                   \
} while (0)


/*
 * Packet Queue types
 */
typedef enum classq_type {
	Q_DROPHEAD,
	Q_DROPTAIL,
	Q_SFB
} classq_type_t;

/*
 * Packet Queue states
 */
typedef enum classq_state {
	QS_RUNNING,
	QS_SUSPENDED
} classq_state_t;

#define DEFAULT_QLIMIT  128 /* default */

#define CLASSQ_DEQUEUE_MAX_PKT_LIMIT    2048
#define CLASSQ_DEQUEUE_MAX_BYTE_LIMIT   (1024 * 1024)

/*
 * generic packet counter
 */
struct pktcntr {
	u_int64_t       packets;
	u_int64_t       bytes;
};

#ifdef BSD_KERNEL_PRIVATE
#include <sys/mcache.h>
#include <sys/mbuf.h>
#include <sys/sysctl.h>

/*
 * Packet Queue structures and macros to manipulate them.
 */
typedef struct _class_queue_ {
	union {
		MBUFQ_HEAD(mq_head) __mbufq; /* mbuf packet queue */
	} __pktq_u;
	u_int32_t       qlen;   /* Queue length (in number of packets) */
	u_int32_t       qlim;   /* Queue limit (in number of packets*) */
	u_int64_t       qsize;  /* Approx. queue size (in number of bytes) */
	classq_type_t   qtype;  /* Queue type */
	classq_state_t  qstate; /* Queue state */
	classq_pkt_type_t       qptype; /* Packet type */
} class_queue_t;

#define qmbufq(q)       (q)->__pktq_u.__mbufq   /* Get mbuf packet queue */
#define qptype(q)       (q)->qptype             /* Get queue packet type */
#define qtype(q)        (q)->qtype              /* Get queue type */
#define qstate(q)       (q)->qstate             /* Get queue state */
#define qlimit(q)       (q)->qlim               /* Max packets to be queued */
#define qlen(q)         (q)->qlen               /* Current queue length. */
#define qsize(q)        (q)->qsize              /* Approx. bytes in queue */

#define qhead(q)        MBUFQ_FIRST(&qmbufq(q))

#define qempty(q)       (qlen(q) == 0)  /* Is the queue empty?? */
#define q_is_red(q)     (qtype(q) == Q_RED)     /* Is the queue a RED queue */
#define q_is_rio(q)     (qtype(q) == Q_RIO)     /* Is the queue a RIO queue */
#define q_is_blue(q)    (qtype(q) == Q_BLUE)    /* Is the queue a BLUE queue */
#define q_is_sfb(q)     (qtype(q) == Q_SFB)     /* Is the queue a SFB queue */
#define q_is_red_or_rio(q) (qtype(q) == Q_RED || qtype(q) == Q_RIO)
#define q_is_suspended(q) (qstate(q) == QS_SUSPENDED)

#define PKTCNTR_ADD(_cntr, _pkt, _len) do {                             \
	(_cntr)->packets += (_pkt);                                     \
	(_cntr)->bytes += (_len);                                       \
} while (0)

#define PKTCNTR_CLEAR(_cntr) do {                                       \
	(_cntr)->packets = 0;                                           \
	(_cntr)->bytes = 0;                                             \
} while (0)

/* flags for mark_ecn() */
#define CLASSQF_ECN4    0x01    /* use packet marking for IPv4 packets */
#define CLASSQF_ECN6    0x02    /* use packet marking for IPv6 packets */
#define CLASSQF_ECN     (CLASSQF_ECN4 | CLASSQF_ECN6)

extern u_int32_t classq_verbose;

SYSCTL_DECL(_net_classq);

extern void _qinit(class_queue_t *, int, int, classq_pkt_type_t);
extern void _addq(class_queue_t *, classq_pkt_t *);
extern void _addq_multi(class_queue_t *, classq_pkt_t *, classq_pkt_t *,
    u_int32_t, u_int32_t);
extern void _getq(class_queue_t *, classq_pkt_t *);
extern void _getq_all(class_queue_t *, classq_pkt_t *, classq_pkt_t *,
    u_int32_t *, u_int64_t *);
extern void _getq_tail(class_queue_t *, classq_pkt_t *);
extern void _getq_random(class_queue_t *, classq_pkt_t *);
extern void _getq_flow(class_queue_t *, classq_pkt_t *, u_int32_t);
extern void _getq_scidx_lt(class_queue_t *, classq_pkt_t *, u_int32_t);
extern void _removeq(class_queue_t *, classq_pkt_t *);
extern void _flushq(class_queue_t *);
extern void _flushq_flow(class_queue_t *, u_int32_t, u_int32_t *, u_int32_t *);

extern void classq_init(void);

#if PF_ECN
extern u_int8_t read_dsfield(struct mbuf *, struct pf_mtag *);
extern void     write_dsfield(struct mbuf *, struct pf_mtag *, u_int8_t);
extern int      mark_ecn(struct mbuf *, struct pf_mtag *, int);
#endif /* PF_ECN */
#endif /* BSD_KERNEL_PRIVATE */

#ifdef __cplusplus
}
#endif
#endif /* PRIVATE */
#endif /* _NET_CLASSQ_CLASSQ_H_ */
Commit	Line	Data
316670eb	1	/*
cb323159	2	* Copyright (c) 2007-2018 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_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_
0a7de745	68	#define _NET_CLASSQ_CLASSQ_H_
316670eb A	69
	70	#ifdef PRIVATE
	71	#ifdef __cplusplus
	72	extern "C" {
	73	#endif
	74
5ba3f43e A	75	/*
	76	* Packet types
	77	*/
	78	typedef enum classq_pkt_type {
	79	QP_INVALID = 0,
0a7de745	80	QP_MBUF, /* mbuf packet */
5ba3f43e A	81	} classq_pkt_type_t;
5ba3f43e A	82
cb323159 A	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_MBUF(_p, _m) do { \
	97	(_p)->cp_ptype = QP_MBUF; \
	98	(_p)->cp_mbuf = (_m); \
	99	} while (0)
	100
	101
316670eb A	102	/*
	103	* Packet Queue types
	104	*/
	105	typedef enum classq_type {
	106	Q_DROPHEAD,
	107	Q_DROPTAIL,
316670eb A	108	Q_SFB
	109	} classq_type_t;
	110
	111	/*
	112	* Packet Queue states
	113	*/
	114	typedef enum classq_state {
	115	QS_RUNNING,
	116	QS_SUSPENDED
	117	} classq_state_t;
	118
0a7de745	119	#define DEFAULT_QLIMIT 128 /* default */
316670eb	120
0a7de745 A	121	#define CLASSQ_DEQUEUE_MAX_PKT_LIMIT 2048
0a7de745 A	122	#define CLASSQ_DEQUEUE_MAX_BYTE_LIMIT (1024 * 1024)
39037602	123
316670eb A	124	/*
	125	* generic packet counter
	126	*/
	127	struct pktcntr {
0a7de745 A	128	u_int64_t packets;
0a7de745 A	129	u_int64_t bytes;
316670eb A	130	};
	131
	132	#ifdef BSD_KERNEL_PRIVATE
	133	#include <sys/mcache.h>
	134	#include <sys/mbuf.h>
	135	#include <sys/sysctl.h>
	136
	137	/*
	138	* Packet Queue structures and macros to manipulate them.
	139	*/
	140	typedef struct _class_queue_ {
5ba3f43e A	141	union {
	142	MBUFQ_HEAD(mq_head) __mbufq; /* mbuf packet queue */
	143	} __pktq_u;
0a7de745 A	144	u_int32_t qlen; /* Queue length (in number of packets) */
	145	u_int32_t qlim; /* Queue limit (in number of packets) /
	146	u_int64_t qsize; /* Approx. queue size (in number of bytes) */
	147	classq_type_t qtype; /* Queue type */
	148	classq_state_t qstate; /* Queue state */
	149	classq_pkt_type_t qptype; /* Packet type */
316670eb A	150	} class_queue_t;
316670eb A	151
0a7de745 A	152	#define qmbufq(q) (q)->__pktq_u.__mbufq /* Get mbuf packet queue */
	153	#define qptype(q) (q)->qptype /* Get queue packet type */
	154	#define qtype(q) (q)->qtype /* Get queue type */
	155	#define qstate(q) (q)->qstate /* Get queue state */
	156	#define qlimit(q) (q)->qlim /* Max packets to be queued */
	157	#define qlen(q) (q)->qlen /* Current queue length. */
	158	#define qsize(q) (q)->qsize /* Approx. bytes in queue */
	159
	160	#define qhead(q) MBUFQ_FIRST(&qmbufq(q))
	161
	162	#define qempty(q) (qlen(q) == 0) /* Is the queue empty?? */
	163	#define q_is_red(q) (qtype(q) == Q_RED) /* Is the queue a RED queue */
	164	#define q_is_rio(q) (qtype(q) == Q_RIO) /* Is the queue a RIO queue */
	165	#define q_is_blue(q) (qtype(q) == Q_BLUE) /* Is the queue a BLUE queue */
	166	#define q_is_sfb(q) (qtype(q) == Q_SFB) /* Is the queue a SFB queue */
	167	#define q_is_red_or_rio(q) (qtype(q) == Q_RED \|\| qtype(q) == Q_RIO)
	168	#define q_is_suspended(q) (qstate(q) == QS_SUSPENDED)
	169
	170	#define PKTCNTR_ADD(_cntr, _pkt, _len) do { \
	171	(_cntr)->packets += (_pkt); \
	172	(_cntr)->bytes += (_len); \
316670eb A	173	} while (0)
316670eb A	174
0a7de745 A	175	#define PKTCNTR_CLEAR(_cntr) do { \
	176	(_cntr)->packets = 0; \
	177	(_cntr)->bytes = 0; \
316670eb A	178	} while (0)
	179
	180	/* flags for mark_ecn() */
0a7de745 A	181	#define CLASSQF_ECN4 0x01 /* use packet marking for IPv4 packets */
	182	#define CLASSQF_ECN6 0x02 /* use packet marking for IPv6 packets */
	183	#define CLASSQF_ECN (CLASSQF_ECN4 \| CLASSQF_ECN6)
316670eb A	184
	185	extern u_int32_t classq_verbose;
	186
	187	SYSCTL_DECL(_net_classq);
	188
5ba3f43e	189	extern void _qinit(class_queue_t *, int, int, classq_pkt_type_t);
cb323159 A	190	extern void _addq(class_queue_t , classq_pkt_t );
	191	extern void _addq_multi(class_queue_t , classq_pkt_t , classq_pkt_t *,
	192	u_int32_t, u_int32_t);
	193	extern void _getq(class_queue_t , classq_pkt_t );
	194	extern void _getq_all(class_queue_t , classq_pkt_t , classq_pkt_t *,
	195	u_int32_t , u_int64_t );
	196	extern void _getq_tail(class_queue_t , classq_pkt_t );
	197	extern void _getq_random(class_queue_t , classq_pkt_t );
	198	extern void _getq_flow(class_queue_t , classq_pkt_t , u_int32_t);
	199	extern void _getq_scidx_lt(class_queue_t , classq_pkt_t , u_int32_t);
	200	extern void _removeq(class_queue_t , classq_pkt_t );
316670eb A	201	extern void _flushq(class_queue_t *);
	202	extern void _flushq_flow(class_queue_t , u_int32_t, u_int32_t , u_int32_t *);
	203
	204	extern void classq_init(void);
	205
39236c6e	206	#if PF_ECN
316670eb	207	extern u_int8_t read_dsfield(struct mbuf , struct pf_mtag );
0a7de745 A	208	extern void write_dsfield(struct mbuf , struct pf_mtag , u_int8_t);
0a7de745 A	209	extern int mark_ecn(struct mbuf , struct pf_mtag , int);
39236c6e	210	#endif /* PF_ECN */
316670eb A	211	#endif /* BSD_KERNEL_PRIVATE */
	212
	213	#ifdef __cplusplus
	214	}
	215	#endif
	216	#endif /* PRIVATE */
	217	#endif /* _NET_CLASSQ_CLASSQ_H_ */