1 /*
2 * Copyright (c) 2011-2020 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
34 extern "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_FQ_CODEL 7 /* Flow queues with CoDel */
46 #define PKTSCHEDT_FQ_CODEL_NEW 8 /* Flow queues with RFC compliant CoDel */
47 #define PKTSCHEDT_MAX 9 /* should be max sched type + 1 */
48
49 #ifdef BSD_KERNEL_PRIVATE
50 #include <mach/mach_time.h>
51 #include <sys/sysctl.h>
52 #include <libkern/libkern.h>
53
54 /* flags for pktsched_setup */
55 #define PKTSCHEDF_QALG_ECN 0x01 /* enable ECN */
56 #define PKTSCHEDF_QALG_FLOWCTL 0x02 /* enable flow control advisories */
57 #define PKTSCHEDF_QALG_DELAYBASED 0x04 /* Delay based queueing */
58 #define PKTSCHEDF_QALG_DRIVER_MANAGED 0x08 /* driver managed */
59
60 typedef struct _pktsched_pkt_ {
61 classq_pkt_t __pkt;
62 classq_pkt_t __tail;
63 uint32_t __plen;
64 uint32_t __pcnt;
65 #define pktsched_ptype __pkt.cp_ptype
66 #define pktsched_plen __plen
67 #define pktsched_pcnt __pcnt
68 #define pktsched_pkt __pkt
69 #define pktsched_pkt_mbuf __pkt.cp_mbuf
70 #define pktsched_pkt_kpkt __pkt.cp_kpkt
71 #define pktsched_tail __tail
72 #define pktsched_tail_mbuf __tail.cp_mbuf
73 #define pktsched_tail_kpkt __tail.cp_kpkt
74 } pktsched_pkt_t;
75
76 #define _PKTSCHED_PKT_INIT(_p) do { \
77 (_p)->pktsched_pkt = CLASSQ_PKT_INITIALIZER((_p)->pktsched_pkt);\
78 (_p)->pktsched_tail = CLASSQ_PKT_INITIALIZER((_p)->pktsched_tail);\
79 (_p)->pktsched_plen = 0; \
80 (_p)->pktsched_pcnt = 0; \
81 } while (0)
82
83 /* macro for timeout/untimeout */
84 /* use old-style timeout/untimeout */
85 /* dummy callout structure */
86 struct callout {
87 void *c_arg; /* function argument */
88 void (*c_func)(void *); /* function to call */
89 };
90
91 #define CALLOUT_INIT(c) do { \
92 (void) memset((c), 0, sizeof (*(c))); \
93 } while ( /*CONSTCOND*/ 0)
94
95 #define CALLOUT_RESET(c, t, f, a) do { \
96 (c)->c_arg = (a); \
97 (c)->c_func = (f); \
98 timeout((f), (a), (t)); \
99 } while ( /*CONSTCOND*/ 0)
100
101 #define CALLOUT_STOP(c) untimeout((c)->c_func, (c)->c_arg)
102 #define CALLOUT_INITIALIZER { NULL, NULL }
103
104 typedef void (timeout_t)(void *);
105
106 /*
107 * Bitmap operations
108 */
109 typedef u_int32_t pktsched_bitmap_t;
110
111 static inline boolean_t
pktsched_bit_tst(u_int32_t ix,pktsched_bitmap_t * pData)112 pktsched_bit_tst(u_int32_t ix, pktsched_bitmap_t *pData)
113 {
114 return (boolean_t)(*pData & (1 << ix));
115 }
116
117 static inline void
pktsched_bit_set(u_int32_t ix,pktsched_bitmap_t * pData)118 pktsched_bit_set(u_int32_t ix, pktsched_bitmap_t *pData)
119 {
120 *pData |= (1 << ix);
121 }
122
123 static inline void
pktsched_bit_clr(u_int32_t ix,pktsched_bitmap_t * pData)124 pktsched_bit_clr(u_int32_t ix, pktsched_bitmap_t *pData)
125 {
126 *pData &= ~(1 << ix);
127 }
128
129 static inline void
pktsched_bit_cpy(u_int32_t ix,pktsched_bitmap_t * pData_dst,pktsched_bitmap_t * pData_src)130 pktsched_bit_cpy(u_int32_t ix, pktsched_bitmap_t *pData_dst,
131 pktsched_bitmap_t *pData_src)
132 {
133 *pData_dst ^= (-(*pData_src & (1 << ix)) ^ *pData_dst) & (1 << ix);
134 }
135
136 static inline pktsched_bitmap_t
pktsched_ffs(pktsched_bitmap_t pData)137 pktsched_ffs(pktsched_bitmap_t pData)
138 {
139 return (pktsched_bitmap_t)ffs(pData);
140 }
141
142 static inline pktsched_bitmap_t
pktsched_fls(pktsched_bitmap_t pData)143 pktsched_fls(pktsched_bitmap_t pData)
144 {
145 return (pktsched_bitmap_t)((sizeof(pktsched_bitmap_t) << 3) - (unsigned long)clz(pData));
146 }
147
148 static inline pktsched_bitmap_t
__fls(pktsched_bitmap_t word)149 __fls(pktsched_bitmap_t word)
150 {
151 VERIFY(word != 0);
152 return pktsched_fls(word) - 1;
153 }
154
155 static inline uint32_t
pktsched_get_pkt_len(pktsched_pkt_t * pkt)156 pktsched_get_pkt_len(pktsched_pkt_t *pkt)
157 {
158 return pkt->pktsched_plen;
159 }
160
161 static inline void
pktsched_bit_move(u_int32_t ix,pktsched_bitmap_t * pData_dst,pktsched_bitmap_t * pData_src)162 pktsched_bit_move(u_int32_t ix, pktsched_bitmap_t *pData_dst,
163 pktsched_bitmap_t *pData_src)
164 {
165 *pData_dst |= (*pData_src & (1 << ix));
166 }
167
168 /*
169 * We can use mach_absolute_time which returns a 64-bit value with
170 * granularity less than a microsecond even on the slowest processor.
171 */
172 #define read_machclk() mach_absolute_time()
173
174 /*
175 * machine dependent clock
176 * a 64bit high resolution time counter.
177 */
178 extern uint32_t machclk_freq;
179 extern uint64_t machclk_per_sec;
180 extern uint32_t pktsched_verbose;
181
182 SYSCTL_DECL(_net_pktsched);
183
184 struct if_ifclassq_stats;
185
186 extern void pktsched_register_m_tag(void);
187
188 extern void pktsched_init(void);
189 extern int pktsched_setup(struct ifclassq *, u_int8_t, u_int32_t,
190 classq_pkt_type_t);
191 extern void pktsched_teardown(struct ifclassq *);
192 extern int pktsched_getqstats(struct ifclassq *, u_int32_t, u_int32_t,
193 struct if_ifclassq_stats *);
194 extern u_int64_t pktsched_abs_to_nsecs(u_int64_t);
195 extern u_int64_t pktsched_nsecs_to_abstime(u_int64_t);
196 extern void pktsched_free_pkt(pktsched_pkt_t *);
197 extern void pktsched_drop_pkt(pktsched_pkt_t *, struct ifnet *, uint32_t, const char *, uint16_t,
198 uint16_t);
199 extern int pktsched_clone_pkt(pktsched_pkt_t *, pktsched_pkt_t *);
200 extern void pktsched_corrupt_packet(pktsched_pkt_t *pkt);
201 extern void pktsched_get_pkt_vars(pktsched_pkt_t *, volatile uint32_t **,
202 uint64_t **, uint32_t *, uint8_t *, uint8_t *, uint32_t *, uint64_t *);
203 extern void pktsched_pkt_encap(pktsched_pkt_t *, classq_pkt_t *);
204 extern void pktsched_pkt_encap_chain(pktsched_pkt_t *, classq_pkt_t *,
205 classq_pkt_t *, uint32_t, uint32_t);
206 extern mbuf_svc_class_t pktsched_get_pkt_svc(pktsched_pkt_t *);
207 extern struct flowadv_fcentry *pktsched_alloc_fcentry(pktsched_pkt_t *,
208 struct ifnet *, int);
209 extern int pktsched_mark_ecn(pktsched_pkt_t *pkt);
210 extern boolean_t pktsched_is_pkt_l4s(pktsched_pkt_t *pkt);
211 #endif /* BSD_KERNEL_PRIVATE */
212
213 #ifdef __cplusplus
214 }
215 #endif
216 #endif /* PRIVATE */
217 #endif /* _PKTSCHED_PKTSCHED_H_ */
218