GNU Linux-libre 4.14.259-gnu1
[releases.git] / net / sched / sch_dsmark.c
1 /* net/sched/sch_dsmark.c - Differentiated Services field marker */
2
3 /* Written 1998-2000 by Werner Almesberger, EPFL ICA */
4
5
6 #include <linux/module.h>
7 #include <linux/init.h>
8 #include <linux/slab.h>
9 #include <linux/types.h>
10 #include <linux/string.h>
11 #include <linux/errno.h>
12 #include <linux/skbuff.h>
13 #include <linux/rtnetlink.h>
14 #include <linux/bitops.h>
15 #include <net/pkt_sched.h>
16 #include <net/pkt_cls.h>
17 #include <net/dsfield.h>
18 #include <net/inet_ecn.h>
19 #include <asm/byteorder.h>
20
21 /*
22  * classid      class           marking
23  * -------      -----           -------
24  *   n/a          0             n/a
25  *   x:0          1             use entry [0]
26  *   ...         ...            ...
27  *   x:y y>0     y+1            use entry [y]
28  *   ...         ...            ...
29  * x:indices-1  indices         use entry [indices-1]
30  *   ...         ...            ...
31  *   x:y         y+1            use entry [y & (indices-1)]
32  *   ...         ...            ...
33  * 0xffff       0x10000         use entry [indices-1]
34  */
35
36
37 #define NO_DEFAULT_INDEX        (1 << 16)
38
39 struct mask_value {
40         u8                      mask;
41         u8                      value;
42 };
43
44 struct dsmark_qdisc_data {
45         struct Qdisc            *q;
46         struct tcf_proto __rcu  *filter_list;
47         struct tcf_block        *block;
48         struct mask_value       *mv;
49         u16                     indices;
50         u8                      set_tc_index;
51         u32                     default_index;  /* index range is 0...0xffff */
52 #define DSMARK_EMBEDDED_SZ      16
53         struct mask_value       embedded[DSMARK_EMBEDDED_SZ];
54 };
55
56 static inline int dsmark_valid_index(struct dsmark_qdisc_data *p, u16 index)
57 {
58         return index <= p->indices && index > 0;
59 }
60
61 /* ------------------------- Class/flow operations ------------------------- */
62
63 static int dsmark_graft(struct Qdisc *sch, unsigned long arg,
64                         struct Qdisc *new, struct Qdisc **old)
65 {
66         struct dsmark_qdisc_data *p = qdisc_priv(sch);
67
68         pr_debug("%s(sch %p,[qdisc %p],new %p,old %p)\n",
69                  __func__, sch, p, new, old);
70
71         if (new == NULL) {
72                 new = qdisc_create_dflt(sch->dev_queue, &pfifo_qdisc_ops,
73                                         sch->handle);
74                 if (new == NULL)
75                         new = &noop_qdisc;
76         }
77
78         *old = qdisc_replace(sch, new, &p->q);
79         return 0;
80 }
81
82 static struct Qdisc *dsmark_leaf(struct Qdisc *sch, unsigned long arg)
83 {
84         struct dsmark_qdisc_data *p = qdisc_priv(sch);
85         return p->q;
86 }
87
88 static unsigned long dsmark_find(struct Qdisc *sch, u32 classid)
89 {
90         return TC_H_MIN(classid) + 1;
91 }
92
93 static unsigned long dsmark_bind_filter(struct Qdisc *sch,
94                                         unsigned long parent, u32 classid)
95 {
96         pr_debug("%s(sch %p,[qdisc %p],classid %x)\n",
97                  __func__, sch, qdisc_priv(sch), classid);
98
99         return dsmark_find(sch, classid);
100 }
101
102 static void dsmark_unbind_filter(struct Qdisc *sch, unsigned long cl)
103 {
104 }
105
106 static const struct nla_policy dsmark_policy[TCA_DSMARK_MAX + 1] = {
107         [TCA_DSMARK_INDICES]            = { .type = NLA_U16 },
108         [TCA_DSMARK_DEFAULT_INDEX]      = { .type = NLA_U16 },
109         [TCA_DSMARK_SET_TC_INDEX]       = { .type = NLA_FLAG },
110         [TCA_DSMARK_MASK]               = { .type = NLA_U8 },
111         [TCA_DSMARK_VALUE]              = { .type = NLA_U8 },
112 };
113
114 static int dsmark_change(struct Qdisc *sch, u32 classid, u32 parent,
115                          struct nlattr **tca, unsigned long *arg)
116 {
117         struct dsmark_qdisc_data *p = qdisc_priv(sch);
118         struct nlattr *opt = tca[TCA_OPTIONS];
119         struct nlattr *tb[TCA_DSMARK_MAX + 1];
120         int err = -EINVAL;
121
122         pr_debug("%s(sch %p,[qdisc %p],classid %x,parent %x), arg 0x%lx\n",
123                  __func__, sch, p, classid, parent, *arg);
124
125         if (!dsmark_valid_index(p, *arg)) {
126                 err = -ENOENT;
127                 goto errout;
128         }
129
130         if (!opt)
131                 goto errout;
132
133         err = nla_parse_nested(tb, TCA_DSMARK_MAX, opt, dsmark_policy, NULL);
134         if (err < 0)
135                 goto errout;
136
137         if (tb[TCA_DSMARK_VALUE])
138                 p->mv[*arg - 1].value = nla_get_u8(tb[TCA_DSMARK_VALUE]);
139
140         if (tb[TCA_DSMARK_MASK])
141                 p->mv[*arg - 1].mask = nla_get_u8(tb[TCA_DSMARK_MASK]);
142
143         err = 0;
144
145 errout:
146         return err;
147 }
148
149 static int dsmark_delete(struct Qdisc *sch, unsigned long arg)
150 {
151         struct dsmark_qdisc_data *p = qdisc_priv(sch);
152
153         if (!dsmark_valid_index(p, arg))
154                 return -EINVAL;
155
156         p->mv[arg - 1].mask = 0xff;
157         p->mv[arg - 1].value = 0;
158
159         return 0;
160 }
161
162 static void dsmark_walk(struct Qdisc *sch, struct qdisc_walker *walker)
163 {
164         struct dsmark_qdisc_data *p = qdisc_priv(sch);
165         int i;
166
167         pr_debug("%s(sch %p,[qdisc %p],walker %p)\n",
168                  __func__, sch, p, walker);
169
170         if (walker->stop)
171                 return;
172
173         for (i = 0; i < p->indices; i++) {
174                 if (p->mv[i].mask == 0xff && !p->mv[i].value)
175                         goto ignore;
176                 if (walker->count >= walker->skip) {
177                         if (walker->fn(sch, i + 1, walker) < 0) {
178                                 walker->stop = 1;
179                                 break;
180                         }
181                 }
182 ignore:
183                 walker->count++;
184         }
185 }
186
187 static struct tcf_block *dsmark_tcf_block(struct Qdisc *sch, unsigned long cl)
188 {
189         struct dsmark_qdisc_data *p = qdisc_priv(sch);
190
191         return p->block;
192 }
193
194 /* --------------------------- Qdisc operations ---------------------------- */
195
196 static int dsmark_enqueue(struct sk_buff *skb, struct Qdisc *sch,
197                           struct sk_buff **to_free)
198 {
199         struct dsmark_qdisc_data *p = qdisc_priv(sch);
200         int err;
201
202         pr_debug("%s(skb %p,sch %p,[qdisc %p])\n", __func__, skb, sch, p);
203
204         if (p->set_tc_index) {
205                 int wlen = skb_network_offset(skb);
206
207                 switch (tc_skb_protocol(skb)) {
208                 case htons(ETH_P_IP):
209                         wlen += sizeof(struct iphdr);
210                         if (!pskb_may_pull(skb, wlen) ||
211                             skb_try_make_writable(skb, wlen))
212                                 goto drop;
213
214                         skb->tc_index = ipv4_get_dsfield(ip_hdr(skb))
215                                 & ~INET_ECN_MASK;
216                         break;
217
218                 case htons(ETH_P_IPV6):
219                         wlen += sizeof(struct ipv6hdr);
220                         if (!pskb_may_pull(skb, wlen) ||
221                             skb_try_make_writable(skb, wlen))
222                                 goto drop;
223
224                         skb->tc_index = ipv6_get_dsfield(ipv6_hdr(skb))
225                                 & ~INET_ECN_MASK;
226                         break;
227                 default:
228                         skb->tc_index = 0;
229                         break;
230                 }
231         }
232
233         if (TC_H_MAJ(skb->priority) == sch->handle)
234                 skb->tc_index = TC_H_MIN(skb->priority);
235         else {
236                 struct tcf_result res;
237                 struct tcf_proto *fl = rcu_dereference_bh(p->filter_list);
238                 int result = tcf_classify(skb, fl, &res, false);
239
240                 pr_debug("result %d class 0x%04x\n", result, res.classid);
241
242                 switch (result) {
243 #ifdef CONFIG_NET_CLS_ACT
244                 case TC_ACT_QUEUED:
245                 case TC_ACT_STOLEN:
246                 case TC_ACT_TRAP:
247                         __qdisc_drop(skb, to_free);
248                         return NET_XMIT_SUCCESS | __NET_XMIT_STOLEN;
249
250                 case TC_ACT_SHOT:
251                         goto drop;
252 #endif
253                 case TC_ACT_OK:
254                         skb->tc_index = TC_H_MIN(res.classid);
255                         break;
256
257                 default:
258                         if (p->default_index != NO_DEFAULT_INDEX)
259                                 skb->tc_index = p->default_index;
260                         break;
261                 }
262         }
263
264         err = qdisc_enqueue(skb, p->q, to_free);
265         if (err != NET_XMIT_SUCCESS) {
266                 if (net_xmit_drop_count(err))
267                         qdisc_qstats_drop(sch);
268                 return err;
269         }
270
271         qdisc_qstats_backlog_inc(sch, skb);
272         sch->q.qlen++;
273
274         return NET_XMIT_SUCCESS;
275
276 drop:
277         qdisc_drop(skb, sch, to_free);
278         return NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
279 }
280
281 static struct sk_buff *dsmark_dequeue(struct Qdisc *sch)
282 {
283         struct dsmark_qdisc_data *p = qdisc_priv(sch);
284         struct sk_buff *skb;
285         u32 index;
286
287         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
288
289         skb = qdisc_dequeue_peeked(p->q);
290         if (skb == NULL)
291                 return NULL;
292
293         qdisc_bstats_update(sch, skb);
294         qdisc_qstats_backlog_dec(sch, skb);
295         sch->q.qlen--;
296
297         index = skb->tc_index & (p->indices - 1);
298         pr_debug("index %d->%d\n", skb->tc_index, index);
299
300         switch (tc_skb_protocol(skb)) {
301         case htons(ETH_P_IP):
302                 ipv4_change_dsfield(ip_hdr(skb), p->mv[index].mask,
303                                     p->mv[index].value);
304                         break;
305         case htons(ETH_P_IPV6):
306                 ipv6_change_dsfield(ipv6_hdr(skb), p->mv[index].mask,
307                                     p->mv[index].value);
308                         break;
309         default:
310                 /*
311                  * Only complain if a change was actually attempted.
312                  * This way, we can send non-IP traffic through dsmark
313                  * and don't need yet another qdisc as a bypass.
314                  */
315                 if (p->mv[index].mask != 0xff || p->mv[index].value)
316                         pr_warn("%s: unsupported protocol %d\n",
317                                 __func__, ntohs(tc_skb_protocol(skb)));
318                 break;
319         }
320
321         return skb;
322 }
323
324 static struct sk_buff *dsmark_peek(struct Qdisc *sch)
325 {
326         struct dsmark_qdisc_data *p = qdisc_priv(sch);
327
328         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
329
330         return p->q->ops->peek(p->q);
331 }
332
333 static int dsmark_init(struct Qdisc *sch, struct nlattr *opt)
334 {
335         struct dsmark_qdisc_data *p = qdisc_priv(sch);
336         struct nlattr *tb[TCA_DSMARK_MAX + 1];
337         int err = -EINVAL;
338         u32 default_index = NO_DEFAULT_INDEX;
339         u16 indices;
340         int i;
341
342         pr_debug("%s(sch %p,[qdisc %p],opt %p)\n", __func__, sch, p, opt);
343
344         if (!opt)
345                 goto errout;
346
347         err = tcf_block_get(&p->block, &p->filter_list);
348         if (err)
349                 return err;
350
351         err = nla_parse_nested(tb, TCA_DSMARK_MAX, opt, dsmark_policy, NULL);
352         if (err < 0)
353                 goto errout;
354
355         err = -EINVAL;
356         if (!tb[TCA_DSMARK_INDICES])
357                 goto errout;
358         indices = nla_get_u16(tb[TCA_DSMARK_INDICES]);
359
360         if (hweight32(indices) != 1)
361                 goto errout;
362
363         if (tb[TCA_DSMARK_DEFAULT_INDEX])
364                 default_index = nla_get_u16(tb[TCA_DSMARK_DEFAULT_INDEX]);
365
366         if (indices <= DSMARK_EMBEDDED_SZ)
367                 p->mv = p->embedded;
368         else
369                 p->mv = kmalloc_array(indices, sizeof(*p->mv), GFP_KERNEL);
370         if (!p->mv) {
371                 err = -ENOMEM;
372                 goto errout;
373         }
374         for (i = 0; i < indices; i++) {
375                 p->mv[i].mask = 0xff;
376                 p->mv[i].value = 0;
377         }
378         p->indices = indices;
379         p->default_index = default_index;
380         p->set_tc_index = nla_get_flag(tb[TCA_DSMARK_SET_TC_INDEX]);
381
382         p->q = qdisc_create_dflt(sch->dev_queue, &pfifo_qdisc_ops, sch->handle);
383         if (p->q == NULL)
384                 p->q = &noop_qdisc;
385         else
386                 qdisc_hash_add(p->q, true);
387
388         pr_debug("%s: qdisc %p\n", __func__, p->q);
389
390         err = 0;
391 errout:
392         return err;
393 }
394
395 static void dsmark_reset(struct Qdisc *sch)
396 {
397         struct dsmark_qdisc_data *p = qdisc_priv(sch);
398
399         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
400         if (p->q)
401                 qdisc_reset(p->q);
402         sch->qstats.backlog = 0;
403         sch->q.qlen = 0;
404 }
405
406 static void dsmark_destroy(struct Qdisc *sch)
407 {
408         struct dsmark_qdisc_data *p = qdisc_priv(sch);
409
410         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
411
412         tcf_block_put(p->block);
413         qdisc_destroy(p->q);
414         if (p->mv != p->embedded)
415                 kfree(p->mv);
416 }
417
418 static int dsmark_dump_class(struct Qdisc *sch, unsigned long cl,
419                              struct sk_buff *skb, struct tcmsg *tcm)
420 {
421         struct dsmark_qdisc_data *p = qdisc_priv(sch);
422         struct nlattr *opts = NULL;
423
424         pr_debug("%s(sch %p,[qdisc %p],class %ld\n", __func__, sch, p, cl);
425
426         if (!dsmark_valid_index(p, cl))
427                 return -EINVAL;
428
429         tcm->tcm_handle = TC_H_MAKE(TC_H_MAJ(sch->handle), cl - 1);
430         tcm->tcm_info = p->q->handle;
431
432         opts = nla_nest_start(skb, TCA_OPTIONS);
433         if (opts == NULL)
434                 goto nla_put_failure;
435         if (nla_put_u8(skb, TCA_DSMARK_MASK, p->mv[cl - 1].mask) ||
436             nla_put_u8(skb, TCA_DSMARK_VALUE, p->mv[cl - 1].value))
437                 goto nla_put_failure;
438
439         return nla_nest_end(skb, opts);
440
441 nla_put_failure:
442         nla_nest_cancel(skb, opts);
443         return -EMSGSIZE;
444 }
445
446 static int dsmark_dump(struct Qdisc *sch, struct sk_buff *skb)
447 {
448         struct dsmark_qdisc_data *p = qdisc_priv(sch);
449         struct nlattr *opts = NULL;
450
451         opts = nla_nest_start(skb, TCA_OPTIONS);
452         if (opts == NULL)
453                 goto nla_put_failure;
454         if (nla_put_u16(skb, TCA_DSMARK_INDICES, p->indices))
455                 goto nla_put_failure;
456
457         if (p->default_index != NO_DEFAULT_INDEX &&
458             nla_put_u16(skb, TCA_DSMARK_DEFAULT_INDEX, p->default_index))
459                 goto nla_put_failure;
460
461         if (p->set_tc_index &&
462             nla_put_flag(skb, TCA_DSMARK_SET_TC_INDEX))
463                 goto nla_put_failure;
464
465         return nla_nest_end(skb, opts);
466
467 nla_put_failure:
468         nla_nest_cancel(skb, opts);
469         return -EMSGSIZE;
470 }
471
472 static const struct Qdisc_class_ops dsmark_class_ops = {
473         .graft          =       dsmark_graft,
474         .leaf           =       dsmark_leaf,
475         .find           =       dsmark_find,
476         .change         =       dsmark_change,
477         .delete         =       dsmark_delete,
478         .walk           =       dsmark_walk,
479         .tcf_block      =       dsmark_tcf_block,
480         .bind_tcf       =       dsmark_bind_filter,
481         .unbind_tcf     =       dsmark_unbind_filter,
482         .dump           =       dsmark_dump_class,
483 };
484
485 static struct Qdisc_ops dsmark_qdisc_ops __read_mostly = {
486         .next           =       NULL,
487         .cl_ops         =       &dsmark_class_ops,
488         .id             =       "dsmark",
489         .priv_size      =       sizeof(struct dsmark_qdisc_data),
490         .enqueue        =       dsmark_enqueue,
491         .dequeue        =       dsmark_dequeue,
492         .peek           =       dsmark_peek,
493         .init           =       dsmark_init,
494         .reset          =       dsmark_reset,
495         .destroy        =       dsmark_destroy,
496         .change         =       NULL,
497         .dump           =       dsmark_dump,
498         .owner          =       THIS_MODULE,
499 };
500
501 static int __init dsmark_module_init(void)
502 {
503         return register_qdisc(&dsmark_qdisc_ops);
504 }
505
506 static void __exit dsmark_module_exit(void)
507 {
508         unregister_qdisc(&dsmark_qdisc_ops);
509 }
510
511 module_init(dsmark_module_init)
512 module_exit(dsmark_module_exit)
513
514 MODULE_LICENSE("GPL");