1/*
2 * Copyright (c) 2016 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 _NET_PKTSCHED_FQ_CODEL_H_
30#define _NET_PKTSCHED_FQ_CODEL_H_
31
32#ifdef PRIVATE
33#include <sys/types.h>
34#include <sys/param.h>
35
36#ifdef BSD_KERNEL_PRIVATE
37#include <net/flowadv.h>
38#endif /* BSD_KERNEL_PRIVATE */
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44#ifdef BSD_KERNEL_PRIVATE
45struct fcl_stat {
46 u_int32_t fcl_flow_control;
47 u_int32_t fcl_flow_feedback;
48 u_int32_t fcl_dequeue_stall;
49 u_int32_t fcl_flow_control_fail;
50 u_int64_t fcl_drop_overflow;
51 u_int64_t fcl_drop_early;
52 u_int32_t fcl_drop_memfailure;
53 u_int32_t fcl_flows_cnt;
54 u_int32_t fcl_newflows_cnt;
55 u_int32_t fcl_oldflows_cnt;
56 u_int64_t fcl_pkt_cnt;
57 u_int64_t fcl_dequeue;
58 u_int64_t fcl_dequeue_bytes;
59 u_int64_t fcl_byte_cnt;
60 u_int32_t fcl_throttle_on;
61 u_int32_t fcl_throttle_off;
62 u_int32_t fcl_throttle_drops;
63 u_int32_t fcl_dup_rexmts;
64};
65
66/*
67 * Use the top most 8 bits of flow id as the tag for set associative
68 * hashing
69 */
70
71#define FQ_IF_HASH_TAG_SIZE 8
72#define FQ_IF_HASH_TAG_SHIFT 24
73#define FQ_IF_HASH_TAG_MASK 0xFF
74#define FQ_IF_HASH_TABLE_SIZE (1 << FQ_IF_HASH_TAG_SIZE)
75
76/* Set the quantum to be one MTU */
77#define FQ_IF_DEFAULT_QUANTUM 1500
78
79/* Max number of service classes currently supported */
80#define FQ_IF_MAX_CLASSES 10
81
82#define FQ_IF_LARGE_FLOW_BYTE_LIMIT 15000
83
84struct flowq;
85typedef u_int32_t pktsched_bitmap_t;
86struct if_ifclassq_stats;
87
88enum fq_if_state {
89 FQ_IF_ER = 0, /* eligible, ready */
90 FQ_IF_IR = 1, /* ineligible, ready */
91 FQ_IF_EB = 2, /* eligible blocked */
92 FQ_IF_IB = 3, /* ineligible, blocked */
93 FQ_IF_MAX_STATE
94};
95
96/*
97 * This priority index is used for QFQ state bitmaps, lower index gets
98 * higher priority
99 */
100#define FQ_IF_BK_SYS_INDEX 9
101#define FQ_IF_BK_INDEX 8
102#define FQ_IF_BE_INDEX 7
103#define FQ_IF_RD_INDEX 6
104#define FQ_IF_OAM_INDEX 5
105#define FQ_IF_AV_INDEX 4
106#define FQ_IF_RV_INDEX 3
107#define FQ_IF_VI_INDEX 2
108#define FQ_IF_SIG_INDEX 2
109#define FQ_IF_VO_INDEX 1
110#define FQ_IF_CTL_INDEX 0
111
112typedef SLIST_HEAD(, flowq) flowq_list_t;
113typedef STAILQ_HEAD(, flowq) flowq_stailq_t;
114typedef struct fq_if_classq {
115 u_int32_t fcl_pri; /* class priority, lower the better */
116 u_int32_t fcl_service_class; /* service class */
117 u_int32_t fcl_quantum; /* quantum in bytes */
118 u_int32_t fcl_drr_max; /* max flows per class for DRR */
119 int64_t fcl_budget; /* budget for this classq */
120 flowq_stailq_t fcl_new_flows; /* List of new flows */
121 flowq_stailq_t fcl_old_flows; /* List of old flows */
122 struct fcl_stat fcl_stat;
123} fq_if_classq_t;
124
125typedef struct fq_codel_sched_data {
126 struct ifclassq *fqs_ifq; /* back pointer to ifclassq */
127 u_int64_t fqs_target_qdelay; /* Target queue delay (ns) */
128 u_int64_t fqs_update_interval; /* update interval (ns) */
129 flowq_list_t fqs_flows[FQ_IF_HASH_TABLE_SIZE]; /* flows table */
130 pktsched_bitmap_t fqs_bitmaps[FQ_IF_MAX_STATE];
131 u_int32_t fqs_pkt_droplimit; /* drop limit */
132 u_int8_t fqs_throttle; /* throttle on or off */
133 u_int8_t fqs_flags; /* flags */
134#define FQS_DRIVER_MANAGED 0x1
135 fq_if_classq_t fqs_classq[FQ_IF_MAX_CLASSES]; /* class queues */
136 struct flowadv_fclist fqs_fclist; /* flow control state */
137 struct flowq *fqs_large_flow; /* flow has highest number of bytes */
138 classq_pkt_type_t fqs_ptype;
139} fq_if_t;
140
141#endif /* BSD_KERNEL_PRIVATE */
142
143struct fq_codel_flowstats {
144 u_int32_t fqst_min_qdelay;
145#define FQ_FLOWSTATS_OLD_FLOW 0x1
146#define FQ_FLOWSTATS_NEW_FLOW 0x2
147#define FQ_FLOWSTATS_LARGE_FLOW 0x4
148#define FQ_FLOWSTATS_DELAY_HIGH 0x8
149#define FQ_FLOWSTATS_FLOWCTL_ON 0x10
150 u_int32_t fqst_flags;
151 u_int32_t fqst_bytes;
152 u_int32_t fqst_flowhash;
153};
154
155#define FQ_IF_MAX_FLOWSTATS 20
156
157struct fq_codel_classstats {
158 u_int32_t fcls_pri;
159 u_int32_t fcls_service_class;
160 u_int32_t fcls_quantum;
161 u_int32_t fcls_drr_max;
162 int64_t fcls_budget;
163 u_int64_t fcls_target_qdelay;
164 u_int64_t fcls_update_interval;
165 u_int32_t fcls_flow_control;
166 u_int32_t fcls_flow_feedback;
167 u_int32_t fcls_dequeue_stall;
168 u_int32_t fcls_flow_control_fail;
169 u_int64_t fcls_drop_overflow;
170 u_int64_t fcls_drop_early;
171 u_int32_t fcls_drop_memfailure;
172 u_int32_t fcls_flows_cnt;
173 u_int32_t fcls_newflows_cnt;
174 u_int32_t fcls_oldflows_cnt;
175 u_int64_t fcls_pkt_cnt;
176 u_int64_t fcls_dequeue;
177 u_int64_t fcls_dequeue_bytes;
178 u_int64_t fcls_byte_cnt;
179 u_int32_t fcls_throttle_on;
180 u_int32_t fcls_throttle_off;
181 u_int32_t fcls_throttle_drops;
182 u_int32_t fcls_dup_rexmts;
183 u_int32_t fcls_flowstats_cnt;
184 struct fq_codel_flowstats fcls_flowstats[FQ_IF_MAX_FLOWSTATS];
185};
186
187#ifdef BSD_KERNEL_PRIVATE
188
189extern void fq_codel_scheduler_init(void);
190extern struct flowq *fq_if_hash_pkt(fq_if_t *, u_int32_t, mbuf_svc_class_t,
191 u_int64_t, boolean_t, classq_pkt_type_t);
192extern boolean_t fq_if_at_drop_limit(fq_if_t *);
193extern void fq_if_drop_packet(fq_if_t *);
194extern void fq_if_is_flow_heavy(fq_if_t *, struct flowq *);
195extern boolean_t fq_if_add_fcentry(fq_if_t *, pktsched_pkt_t *, uint32_t,
196 uint8_t, fq_if_classq_t *);
197extern void fq_if_flow_feedback(fq_if_t *, struct flowq *, fq_if_classq_t *);
198extern int fq_if_setup_ifclassq(struct ifclassq *ifq, u_int32_t flags,
199 classq_pkt_type_t ptype);
200extern int fq_if_teardown_ifclassq(struct ifclassq *ifq);
201extern int fq_if_getqstats_ifclassq(struct ifclassq *ifq, u_int32_t qid,
202 struct if_ifclassq_stats *ifqs);
203extern void fq_if_destroy_flow(fq_if_t *, fq_if_classq_t *,
204 struct flowq *);
205
206
207#endif /* BSD_KERNEL_PRIVATE */
208
209#ifdef __cplusplus
210}
211#endif
212
213#endif /* PRIVATE */
214#endif /* _NET_PKTSCHED_PKTSCHED_FQ_CODEL_H_ */
215