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#ifndef _PKTSCHED_PKTSCHED_H_
30#define	_PKTSCHED_PKTSCHED_H_
31
32#ifdef PRIVATE
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/* packet scheduler type */
38#define	PKTSCHEDT_NONE		0	/* reserved */
39#define	PKTSCHEDT_CBQ		1	/* cbq */
40#define	PKTSCHEDT_HFSC		2	/* hfsc */
41#define	PKTSCHEDT_PRIQ		3	/* priority queue */
42#define	PKTSCHEDT_FAIRQ		4	/* fairq */
43#define	PKTSCHEDT_TCQ		5	/* traffic class queue */
44#define	PKTSCHEDT_QFQ		6	/* quick fair queueing */
45#define	PKTSCHEDT_MAX		7	/* should be max sched type + 1 */
46
47#ifdef BSD_KERNEL_PRIVATE
48#include <mach/mach_time.h>
49#include <sys/sysctl.h>
50#include <libkern/libkern.h>
51
52/* flags for pktsched_setup */
53#define	PKTSCHEDF_QALG_RED	0x1	/* use RED */
54#define	PKTSCHEDF_QALG_RIO	0x2	/* use RIO */
55#define	PKTSCHEDF_QALG_BLUE	0x4	/* use BLUE */
56#define	PKTSCHEDF_QALG_SFB	0x8	/* use SFB */
57#define	PKTSCHEDF_QALG_ECN	0x10	/* enable ECN */
58#define	PKTSCHEDF_QALG_FLOWCTL	0x20	/* enable flow control advisories */
59
60/* macro for timeout/untimeout */
61/* use old-style timeout/untimeout */
62/* dummy callout structure */
63struct callout {
64	void		*c_arg;			/* function argument */
65	void		(*c_func)(void *);	/* function to call */
66};
67
68#define	CALLOUT_INIT(c) do {					\
69	(void) memset((c), 0, sizeof (*(c)));			\
70} while (/*CONSTCOND*/ 0)
71
72#define	CALLOUT_RESET(c, t, f, a) do {				\
73	(c)->c_arg = (a);					\
74	(c)->c_func = (f);					\
75	timeout((f), (a), (t));					\
76} while (/*CONSTCOND*/ 0)
77
78#define	CALLOUT_STOP(c)		untimeout((c)->c_func, (c)->c_arg)
79#define	CALLOUT_INITIALIZER	{ NULL, NULL }
80
81typedef void (timeout_t)(void *);
82
83/*
84 * Bitmap operations
85 */
86typedef	u_int32_t pktsched_bitmap_t;
87
88static inline boolean_t
89pktsched_bit_tst(u_int32_t ix, pktsched_bitmap_t *pData)
90{
91	return (*pData & (1 << ix));
92}
93
94static inline void
95pktsched_bit_set(u_int32_t ix, pktsched_bitmap_t *pData)
96{
97	*pData |= (1 << ix);
98}
99
100static inline void
101pktsched_bit_clr(u_int32_t ix, pktsched_bitmap_t *pData)
102{
103	*pData &= ~(1 << ix);
104}
105
106static inline pktsched_bitmap_t
107pktsched_ffs(pktsched_bitmap_t pData)
108{
109	return (ffs(pData));
110}
111
112static inline pktsched_bitmap_t
113pktsched_fls(pktsched_bitmap_t pData)
114{
115	return ((sizeof (pktsched_bitmap_t) << 3) - clz(pData));
116}
117
118static inline pktsched_bitmap_t
119__fls(pktsched_bitmap_t word)
120{
121	VERIFY(word != 0);
122	return (pktsched_fls(word) - 1);
123}
124
125/*
126 * We can use mach_absolute_time which returns a 64-bit value with
127 * granularity less than a microsecond even on the slowest processor.
128 */
129#define	read_machclk()		mach_absolute_time()
130
131/*
132 * machine dependent clock
133 * a 64bit high resolution time counter.
134 */
135extern u_int32_t machclk_freq;
136extern u_int64_t machclk_per_sec;
137extern u_int32_t pktsched_verbose;
138
139SYSCTL_DECL(_net_pktsched);
140
141struct if_ifclassq_stats;
142
143extern void pktsched_init(void);
144extern int pktsched_setup(struct ifclassq *, u_int32_t, u_int32_t);
145extern int pktsched_teardown(struct ifclassq *);
146extern int pktsched_getqstats(struct ifclassq *, u_int32_t,
147    struct if_ifclassq_stats *);
148extern u_int64_t pktsched_abs_to_nsecs(u_int64_t);
149extern u_int64_t pktsched_nsecs_to_abstime(u_int64_t);
150#endif /* BSD_KERNEL_PRIVATE */
151
152#ifdef __cplusplus
153}
154#endif
155#endif /* PRIVATE */
156#endif /* _PKTSCHED_PKTSCHED_H_ */
157