Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
13d2a1d2 PM |
2 | /* |
3 | * net/sched/sch_drr.c Deficit Round Robin scheduler | |
4 | * | |
5 | * Copyright (c) 2008 Patrick McHardy <kaber@trash.net> | |
13d2a1d2 PM |
6 | */ |
7 | ||
8 | #include <linux/module.h> | |
5a0e3ad6 | 9 | #include <linux/slab.h> |
13d2a1d2 PM |
10 | #include <linux/init.h> |
11 | #include <linux/errno.h> | |
12 | #include <linux/netdevice.h> | |
13 | #include <linux/pkt_sched.h> | |
14 | #include <net/sch_generic.h> | |
15 | #include <net/pkt_sched.h> | |
16 | #include <net/pkt_cls.h> | |
17 | ||
18 | struct drr_class { | |
19 | struct Qdisc_class_common common; | |
13d2a1d2 PM |
20 | unsigned int filter_cnt; |
21 | ||
c1a8f1f1 | 22 | struct gnet_stats_basic_packed bstats; |
13d2a1d2 | 23 | struct gnet_stats_queue qstats; |
1c0d32fd | 24 | struct net_rate_estimator __rcu *rate_est; |
13d2a1d2 PM |
25 | struct list_head alist; |
26 | struct Qdisc *qdisc; | |
27 | ||
28 | u32 quantum; | |
29 | u32 deficit; | |
30 | }; | |
31 | ||
32 | struct drr_sched { | |
33 | struct list_head active; | |
25d8c0d5 | 34 | struct tcf_proto __rcu *filter_list; |
6529eaba | 35 | struct tcf_block *block; |
13d2a1d2 PM |
36 | struct Qdisc_class_hash clhash; |
37 | }; | |
38 | ||
39 | static struct drr_class *drr_find_class(struct Qdisc *sch, u32 classid) | |
40 | { | |
41 | struct drr_sched *q = qdisc_priv(sch); | |
42 | struct Qdisc_class_common *clc; | |
43 | ||
44 | clc = qdisc_class_find(&q->clhash, classid); | |
45 | if (clc == NULL) | |
46 | return NULL; | |
47 | return container_of(clc, struct drr_class, common); | |
48 | } | |
49 | ||
13d2a1d2 PM |
50 | static const struct nla_policy drr_policy[TCA_DRR_MAX + 1] = { |
51 | [TCA_DRR_QUANTUM] = { .type = NLA_U32 }, | |
52 | }; | |
53 | ||
54 | static int drr_change_class(struct Qdisc *sch, u32 classid, u32 parentid, | |
793d81d6 AA |
55 | struct nlattr **tca, unsigned long *arg, |
56 | struct netlink_ext_ack *extack) | |
13d2a1d2 PM |
57 | { |
58 | struct drr_sched *q = qdisc_priv(sch); | |
59 | struct drr_class *cl = (struct drr_class *)*arg; | |
1844f747 | 60 | struct nlattr *opt = tca[TCA_OPTIONS]; |
13d2a1d2 PM |
61 | struct nlattr *tb[TCA_DRR_MAX + 1]; |
62 | u32 quantum; | |
63 | int err; | |
64 | ||
a7c31693 AA |
65 | if (!opt) { |
66 | NL_SET_ERR_MSG(extack, "DRR options are required for this operation"); | |
1844f747 | 67 | return -EINVAL; |
a7c31693 | 68 | } |
1844f747 | 69 | |
8cb08174 JB |
70 | err = nla_parse_nested_deprecated(tb, TCA_DRR_MAX, opt, drr_policy, |
71 | extack); | |
13d2a1d2 PM |
72 | if (err < 0) |
73 | return err; | |
74 | ||
75 | if (tb[TCA_DRR_QUANTUM]) { | |
76 | quantum = nla_get_u32(tb[TCA_DRR_QUANTUM]); | |
a7c31693 AA |
77 | if (quantum == 0) { |
78 | NL_SET_ERR_MSG(extack, "Specified DRR quantum cannot be zero"); | |
13d2a1d2 | 79 | return -EINVAL; |
a7c31693 | 80 | } |
13d2a1d2 PM |
81 | } else |
82 | quantum = psched_mtu(qdisc_dev(sch)); | |
83 | ||
84 | if (cl != NULL) { | |
71bcb09a | 85 | if (tca[TCA_RATE]) { |
22e0f8b9 JF |
86 | err = gen_replace_estimator(&cl->bstats, NULL, |
87 | &cl->rate_est, | |
edb09eb1 ED |
88 | NULL, |
89 | qdisc_root_sleeping_running(sch), | |
71bcb09a | 90 | tca[TCA_RATE]); |
a7c31693 AA |
91 | if (err) { |
92 | NL_SET_ERR_MSG(extack, "Failed to replace estimator"); | |
71bcb09a | 93 | return err; |
a7c31693 | 94 | } |
71bcb09a SH |
95 | } |
96 | ||
13d2a1d2 PM |
97 | sch_tree_lock(sch); |
98 | if (tb[TCA_DRR_QUANTUM]) | |
99 | cl->quantum = quantum; | |
100 | sch_tree_unlock(sch); | |
101 | ||
13d2a1d2 PM |
102 | return 0; |
103 | } | |
104 | ||
105 | cl = kzalloc(sizeof(struct drr_class), GFP_KERNEL); | |
106 | if (cl == NULL) | |
107 | return -ENOBUFS; | |
108 | ||
13d2a1d2 PM |
109 | cl->common.classid = classid; |
110 | cl->quantum = quantum; | |
3511c913 | 111 | cl->qdisc = qdisc_create_dflt(sch->dev_queue, |
a38a9882 AA |
112 | &pfifo_qdisc_ops, classid, |
113 | NULL); | |
13d2a1d2 PM |
114 | if (cl->qdisc == NULL) |
115 | cl->qdisc = &noop_qdisc; | |
49b49971 JK |
116 | else |
117 | qdisc_hash_add(cl->qdisc, true); | |
13d2a1d2 | 118 | |
71bcb09a | 119 | if (tca[TCA_RATE]) { |
22e0f8b9 | 120 | err = gen_replace_estimator(&cl->bstats, NULL, &cl->rate_est, |
edb09eb1 ED |
121 | NULL, |
122 | qdisc_root_sleeping_running(sch), | |
71bcb09a SH |
123 | tca[TCA_RATE]); |
124 | if (err) { | |
a7c31693 | 125 | NL_SET_ERR_MSG(extack, "Failed to replace estimator"); |
86bd446b | 126 | qdisc_put(cl->qdisc); |
71bcb09a SH |
127 | kfree(cl); |
128 | return err; | |
129 | } | |
130 | } | |
13d2a1d2 PM |
131 | |
132 | sch_tree_lock(sch); | |
133 | qdisc_class_hash_insert(&q->clhash, &cl->common); | |
134 | sch_tree_unlock(sch); | |
135 | ||
136 | qdisc_class_hash_grow(sch, &q->clhash); | |
137 | ||
138 | *arg = (unsigned long)cl; | |
139 | return 0; | |
140 | } | |
141 | ||
142 | static void drr_destroy_class(struct Qdisc *sch, struct drr_class *cl) | |
143 | { | |
1c0d32fd | 144 | gen_kill_estimator(&cl->rate_est); |
86bd446b | 145 | qdisc_put(cl->qdisc); |
13d2a1d2 PM |
146 | kfree(cl); |
147 | } | |
148 | ||
149 | static int drr_delete_class(struct Qdisc *sch, unsigned long arg) | |
150 | { | |
151 | struct drr_sched *q = qdisc_priv(sch); | |
152 | struct drr_class *cl = (struct drr_class *)arg; | |
153 | ||
154 | if (cl->filter_cnt > 0) | |
155 | return -EBUSY; | |
156 | ||
157 | sch_tree_lock(sch); | |
158 | ||
e5f0e8f8 | 159 | qdisc_purge_queue(cl->qdisc); |
13d2a1d2 PM |
160 | qdisc_class_hash_remove(&q->clhash, &cl->common); |
161 | ||
13d2a1d2 | 162 | sch_tree_unlock(sch); |
13d2a1d2 | 163 | |
143976ce WC |
164 | drr_destroy_class(sch, cl); |
165 | return 0; | |
13d2a1d2 PM |
166 | } |
167 | ||
143976ce | 168 | static unsigned long drr_search_class(struct Qdisc *sch, u32 classid) |
13d2a1d2 | 169 | { |
143976ce | 170 | return (unsigned long)drr_find_class(sch, classid); |
13d2a1d2 PM |
171 | } |
172 | ||
cbaacc4e AA |
173 | static struct tcf_block *drr_tcf_block(struct Qdisc *sch, unsigned long cl, |
174 | struct netlink_ext_ack *extack) | |
13d2a1d2 PM |
175 | { |
176 | struct drr_sched *q = qdisc_priv(sch); | |
177 | ||
a7c31693 AA |
178 | if (cl) { |
179 | NL_SET_ERR_MSG(extack, "DRR classid must be zero"); | |
13d2a1d2 | 180 | return NULL; |
a7c31693 | 181 | } |
13d2a1d2 | 182 | |
6529eaba | 183 | return q->block; |
13d2a1d2 PM |
184 | } |
185 | ||
186 | static unsigned long drr_bind_tcf(struct Qdisc *sch, unsigned long parent, | |
187 | u32 classid) | |
188 | { | |
189 | struct drr_class *cl = drr_find_class(sch, classid); | |
190 | ||
191 | if (cl != NULL) | |
192 | cl->filter_cnt++; | |
193 | ||
194 | return (unsigned long)cl; | |
195 | } | |
196 | ||
197 | static void drr_unbind_tcf(struct Qdisc *sch, unsigned long arg) | |
198 | { | |
199 | struct drr_class *cl = (struct drr_class *)arg; | |
200 | ||
201 | cl->filter_cnt--; | |
202 | } | |
203 | ||
204 | static int drr_graft_class(struct Qdisc *sch, unsigned long arg, | |
653d6fd6 AA |
205 | struct Qdisc *new, struct Qdisc **old, |
206 | struct netlink_ext_ack *extack) | |
13d2a1d2 PM |
207 | { |
208 | struct drr_class *cl = (struct drr_class *)arg; | |
209 | ||
210 | if (new == NULL) { | |
a38a9882 AA |
211 | new = qdisc_create_dflt(sch->dev_queue, &pfifo_qdisc_ops, |
212 | cl->common.classid, NULL); | |
13d2a1d2 PM |
213 | if (new == NULL) |
214 | new = &noop_qdisc; | |
215 | } | |
216 | ||
86a7996c | 217 | *old = qdisc_replace(sch, new, &cl->qdisc); |
13d2a1d2 PM |
218 | return 0; |
219 | } | |
220 | ||
221 | static struct Qdisc *drr_class_leaf(struct Qdisc *sch, unsigned long arg) | |
222 | { | |
223 | struct drr_class *cl = (struct drr_class *)arg; | |
224 | ||
225 | return cl->qdisc; | |
226 | } | |
227 | ||
228 | static void drr_qlen_notify(struct Qdisc *csh, unsigned long arg) | |
229 | { | |
230 | struct drr_class *cl = (struct drr_class *)arg; | |
231 | ||
95946658 | 232 | list_del(&cl->alist); |
13d2a1d2 PM |
233 | } |
234 | ||
235 | static int drr_dump_class(struct Qdisc *sch, unsigned long arg, | |
236 | struct sk_buff *skb, struct tcmsg *tcm) | |
237 | { | |
238 | struct drr_class *cl = (struct drr_class *)arg; | |
239 | struct nlattr *nest; | |
240 | ||
241 | tcm->tcm_parent = TC_H_ROOT; | |
242 | tcm->tcm_handle = cl->common.classid; | |
243 | tcm->tcm_info = cl->qdisc->handle; | |
244 | ||
ae0be8de | 245 | nest = nla_nest_start_noflag(skb, TCA_OPTIONS); |
13d2a1d2 PM |
246 | if (nest == NULL) |
247 | goto nla_put_failure; | |
1b34ec43 DM |
248 | if (nla_put_u32(skb, TCA_DRR_QUANTUM, cl->quantum)) |
249 | goto nla_put_failure; | |
13d2a1d2 PM |
250 | return nla_nest_end(skb, nest); |
251 | ||
252 | nla_put_failure: | |
253 | nla_nest_cancel(skb, nest); | |
254 | return -EMSGSIZE; | |
255 | } | |
256 | ||
257 | static int drr_dump_class_stats(struct Qdisc *sch, unsigned long arg, | |
258 | struct gnet_dump *d) | |
259 | { | |
260 | struct drr_class *cl = (struct drr_class *)arg; | |
5dd431b6 PA |
261 | __u32 qlen = qdisc_qlen_sum(cl->qdisc); |
262 | struct Qdisc *cl_q = cl->qdisc; | |
13d2a1d2 PM |
263 | struct tc_drr_stats xstats; |
264 | ||
265 | memset(&xstats, 0, sizeof(xstats)); | |
64015853 | 266 | if (qlen) |
13d2a1d2 PM |
267 | xstats.deficit = cl->deficit; |
268 | ||
edb09eb1 ED |
269 | if (gnet_stats_copy_basic(qdisc_root_sleeping_running(sch), |
270 | d, NULL, &cl->bstats) < 0 || | |
1c0d32fd | 271 | gnet_stats_copy_rate_est(d, &cl->rate_est) < 0 || |
5dd431b6 | 272 | gnet_stats_copy_queue(d, cl_q->cpu_qstats, &cl_q->qstats, qlen) < 0) |
13d2a1d2 PM |
273 | return -1; |
274 | ||
275 | return gnet_stats_copy_app(d, &xstats, sizeof(xstats)); | |
276 | } | |
277 | ||
278 | static void drr_walk(struct Qdisc *sch, struct qdisc_walker *arg) | |
279 | { | |
280 | struct drr_sched *q = qdisc_priv(sch); | |
281 | struct drr_class *cl; | |
13d2a1d2 PM |
282 | unsigned int i; |
283 | ||
284 | if (arg->stop) | |
285 | return; | |
286 | ||
287 | for (i = 0; i < q->clhash.hashsize; i++) { | |
b67bfe0d | 288 | hlist_for_each_entry(cl, &q->clhash.hash[i], common.hnode) { |
13d2a1d2 PM |
289 | if (arg->count < arg->skip) { |
290 | arg->count++; | |
291 | continue; | |
292 | } | |
293 | if (arg->fn(sch, (unsigned long)cl, arg) < 0) { | |
294 | arg->stop = 1; | |
295 | return; | |
296 | } | |
297 | arg->count++; | |
298 | } | |
299 | } | |
300 | } | |
301 | ||
302 | static struct drr_class *drr_classify(struct sk_buff *skb, struct Qdisc *sch, | |
303 | int *qerr) | |
304 | { | |
305 | struct drr_sched *q = qdisc_priv(sch); | |
306 | struct drr_class *cl; | |
307 | struct tcf_result res; | |
25d8c0d5 | 308 | struct tcf_proto *fl; |
13d2a1d2 PM |
309 | int result; |
310 | ||
311 | if (TC_H_MAJ(skb->priority ^ sch->handle) == 0) { | |
312 | cl = drr_find_class(sch, skb->priority); | |
313 | if (cl != NULL) | |
314 | return cl; | |
315 | } | |
316 | ||
317 | *qerr = NET_XMIT_SUCCESS | __NET_XMIT_BYPASS; | |
25d8c0d5 | 318 | fl = rcu_dereference_bh(q->filter_list); |
87d83093 | 319 | result = tcf_classify(skb, fl, &res, false); |
13d2a1d2 PM |
320 | if (result >= 0) { |
321 | #ifdef CONFIG_NET_CLS_ACT | |
322 | switch (result) { | |
323 | case TC_ACT_QUEUED: | |
324 | case TC_ACT_STOLEN: | |
e25ea21f | 325 | case TC_ACT_TRAP: |
13d2a1d2 | 326 | *qerr = NET_XMIT_SUCCESS | __NET_XMIT_STOLEN; |
f3ae608e | 327 | /* fall through */ |
13d2a1d2 PM |
328 | case TC_ACT_SHOT: |
329 | return NULL; | |
330 | } | |
331 | #endif | |
332 | cl = (struct drr_class *)res.class; | |
333 | if (cl == NULL) | |
334 | cl = drr_find_class(sch, res.classid); | |
335 | return cl; | |
336 | } | |
337 | return NULL; | |
338 | } | |
339 | ||
520ac30f ED |
340 | static int drr_enqueue(struct sk_buff *skb, struct Qdisc *sch, |
341 | struct sk_buff **to_free) | |
13d2a1d2 | 342 | { |
f6bab199 | 343 | unsigned int len = qdisc_pkt_len(skb); |
13d2a1d2 PM |
344 | struct drr_sched *q = qdisc_priv(sch); |
345 | struct drr_class *cl; | |
f54ba779 | 346 | int err = 0; |
37d9cf1a | 347 | bool first; |
13d2a1d2 PM |
348 | |
349 | cl = drr_classify(skb, sch, &err); | |
350 | if (cl == NULL) { | |
351 | if (err & __NET_XMIT_BYPASS) | |
25331d6c | 352 | qdisc_qstats_drop(sch); |
520ac30f | 353 | __qdisc_drop(skb, to_free); |
13d2a1d2 PM |
354 | return err; |
355 | } | |
356 | ||
37d9cf1a | 357 | first = !cl->qdisc->q.qlen; |
520ac30f | 358 | err = qdisc_enqueue(skb, cl->qdisc, to_free); |
13d2a1d2 PM |
359 | if (unlikely(err != NET_XMIT_SUCCESS)) { |
360 | if (net_xmit_drop_count(err)) { | |
361 | cl->qstats.drops++; | |
25331d6c | 362 | qdisc_qstats_drop(sch); |
13d2a1d2 PM |
363 | } |
364 | return err; | |
365 | } | |
366 | ||
37d9cf1a | 367 | if (first) { |
13d2a1d2 PM |
368 | list_add_tail(&cl->alist, &q->active); |
369 | cl->deficit = cl->quantum; | |
370 | } | |
371 | ||
f6bab199 | 372 | sch->qstats.backlog += len; |
13d2a1d2 PM |
373 | sch->q.qlen++; |
374 | return err; | |
375 | } | |
376 | ||
377 | static struct sk_buff *drr_dequeue(struct Qdisc *sch) | |
378 | { | |
379 | struct drr_sched *q = qdisc_priv(sch); | |
380 | struct drr_class *cl; | |
381 | struct sk_buff *skb; | |
382 | unsigned int len; | |
383 | ||
3f0947c3 PM |
384 | if (list_empty(&q->active)) |
385 | goto out; | |
386 | while (1) { | |
13d2a1d2 PM |
387 | cl = list_first_entry(&q->active, struct drr_class, alist); |
388 | skb = cl->qdisc->ops->peek(cl->qdisc); | |
6e765a00 FW |
389 | if (skb == NULL) { |
390 | qdisc_warn_nonwc(__func__, cl->qdisc); | |
3f0947c3 | 391 | goto out; |
6e765a00 | 392 | } |
13d2a1d2 PM |
393 | |
394 | len = qdisc_pkt_len(skb); | |
395 | if (len <= cl->deficit) { | |
396 | cl->deficit -= len; | |
397 | skb = qdisc_dequeue_peeked(cl->qdisc); | |
df3eb6cd BH |
398 | if (unlikely(skb == NULL)) |
399 | goto out; | |
13d2a1d2 PM |
400 | if (cl->qdisc->q.qlen == 0) |
401 | list_del(&cl->alist); | |
2dd875ff ED |
402 | |
403 | bstats_update(&cl->bstats, skb); | |
9190b3b3 | 404 | qdisc_bstats_update(sch, skb); |
6a73b571 | 405 | qdisc_qstats_backlog_dec(sch, skb); |
13d2a1d2 PM |
406 | sch->q.qlen--; |
407 | return skb; | |
408 | } | |
409 | ||
410 | cl->deficit += cl->quantum; | |
13d2a1d2 PM |
411 | list_move_tail(&cl->alist, &q->active); |
412 | } | |
3f0947c3 | 413 | out: |
13d2a1d2 PM |
414 | return NULL; |
415 | } | |
416 | ||
e63d7dfd AA |
417 | static int drr_init_qdisc(struct Qdisc *sch, struct nlattr *opt, |
418 | struct netlink_ext_ack *extack) | |
13d2a1d2 PM |
419 | { |
420 | struct drr_sched *q = qdisc_priv(sch); | |
421 | int err; | |
422 | ||
8d1a77f9 | 423 | err = tcf_block_get(&q->block, &q->filter_list, sch, extack); |
6529eaba JP |
424 | if (err) |
425 | return err; | |
13d2a1d2 PM |
426 | err = qdisc_class_hash_init(&q->clhash); |
427 | if (err < 0) | |
428 | return err; | |
429 | INIT_LIST_HEAD(&q->active); | |
430 | return 0; | |
431 | } | |
432 | ||
433 | static void drr_reset_qdisc(struct Qdisc *sch) | |
434 | { | |
435 | struct drr_sched *q = qdisc_priv(sch); | |
436 | struct drr_class *cl; | |
13d2a1d2 PM |
437 | unsigned int i; |
438 | ||
439 | for (i = 0; i < q->clhash.hashsize; i++) { | |
b67bfe0d | 440 | hlist_for_each_entry(cl, &q->clhash.hash[i], common.hnode) { |
13d2a1d2 PM |
441 | if (cl->qdisc->q.qlen) |
442 | list_del(&cl->alist); | |
443 | qdisc_reset(cl->qdisc); | |
444 | } | |
445 | } | |
6a73b571 | 446 | sch->qstats.backlog = 0; |
13d2a1d2 PM |
447 | sch->q.qlen = 0; |
448 | } | |
449 | ||
450 | static void drr_destroy_qdisc(struct Qdisc *sch) | |
451 | { | |
452 | struct drr_sched *q = qdisc_priv(sch); | |
453 | struct drr_class *cl; | |
b67bfe0d | 454 | struct hlist_node *next; |
13d2a1d2 PM |
455 | unsigned int i; |
456 | ||
6529eaba | 457 | tcf_block_put(q->block); |
13d2a1d2 PM |
458 | |
459 | for (i = 0; i < q->clhash.hashsize; i++) { | |
b67bfe0d | 460 | hlist_for_each_entry_safe(cl, next, &q->clhash.hash[i], |
13d2a1d2 PM |
461 | common.hnode) |
462 | drr_destroy_class(sch, cl); | |
463 | } | |
464 | qdisc_class_hash_destroy(&q->clhash); | |
465 | } | |
466 | ||
467 | static const struct Qdisc_class_ops drr_class_ops = { | |
468 | .change = drr_change_class, | |
469 | .delete = drr_delete_class, | |
143976ce | 470 | .find = drr_search_class, |
6529eaba | 471 | .tcf_block = drr_tcf_block, |
13d2a1d2 PM |
472 | .bind_tcf = drr_bind_tcf, |
473 | .unbind_tcf = drr_unbind_tcf, | |
474 | .graft = drr_graft_class, | |
475 | .leaf = drr_class_leaf, | |
476 | .qlen_notify = drr_qlen_notify, | |
477 | .dump = drr_dump_class, | |
478 | .dump_stats = drr_dump_class_stats, | |
479 | .walk = drr_walk, | |
480 | }; | |
481 | ||
482 | static struct Qdisc_ops drr_qdisc_ops __read_mostly = { | |
483 | .cl_ops = &drr_class_ops, | |
484 | .id = "drr", | |
485 | .priv_size = sizeof(struct drr_sched), | |
486 | .enqueue = drr_enqueue, | |
487 | .dequeue = drr_dequeue, | |
488 | .peek = qdisc_peek_dequeued, | |
13d2a1d2 PM |
489 | .init = drr_init_qdisc, |
490 | .reset = drr_reset_qdisc, | |
491 | .destroy = drr_destroy_qdisc, | |
492 | .owner = THIS_MODULE, | |
493 | }; | |
494 | ||
495 | static int __init drr_init(void) | |
496 | { | |
497 | return register_qdisc(&drr_qdisc_ops); | |
498 | } | |
499 | ||
500 | static void __exit drr_exit(void) | |
501 | { | |
502 | unregister_qdisc(&drr_qdisc_ops); | |
503 | } | |
504 | ||
505 | module_init(drr_init); | |
506 | module_exit(drr_exit); | |
507 | MODULE_LICENSE("GPL"); |