Mention branches and keyring.
[releases.git] / sched / act_pedit.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * net/sched/act_pedit.c        Generic packet editor
4  *
5  * Authors:     Jamal Hadi Salim (2002-4)
6  */
7
8 #include <linux/types.h>
9 #include <linux/kernel.h>
10 #include <linux/string.h>
11 #include <linux/errno.h>
12 #include <linux/skbuff.h>
13 #include <linux/rtnetlink.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/ip.h>
17 #include <linux/ipv6.h>
18 #include <linux/slab.h>
19 #include <net/ipv6.h>
20 #include <net/netlink.h>
21 #include <net/pkt_sched.h>
22 #include <linux/tc_act/tc_pedit.h>
23 #include <net/tc_act/tc_pedit.h>
24 #include <uapi/linux/tc_act/tc_pedit.h>
25 #include <net/pkt_cls.h>
26
27 static struct tc_action_ops act_pedit_ops;
28
29 static const struct nla_policy pedit_policy[TCA_PEDIT_MAX + 1] = {
30         [TCA_PEDIT_PARMS]       = { .len = sizeof(struct tc_pedit) },
31         [TCA_PEDIT_PARMS_EX]    = { .len = sizeof(struct tc_pedit) },
32         [TCA_PEDIT_KEYS_EX]   = { .type = NLA_NESTED },
33 };
34
35 static const struct nla_policy pedit_key_ex_policy[TCA_PEDIT_KEY_EX_MAX + 1] = {
36         [TCA_PEDIT_KEY_EX_HTYPE]  = { .type = NLA_U16 },
37         [TCA_PEDIT_KEY_EX_CMD]    = { .type = NLA_U16 },
38 };
39
40 static struct tcf_pedit_key_ex *tcf_pedit_keys_ex_parse(struct nlattr *nla,
41                                                         u8 n)
42 {
43         struct tcf_pedit_key_ex *keys_ex;
44         struct tcf_pedit_key_ex *k;
45         const struct nlattr *ka;
46         int err = -EINVAL;
47         int rem;
48
49         if (!nla)
50                 return NULL;
51
52         keys_ex = kcalloc(n, sizeof(*k), GFP_KERNEL);
53         if (!keys_ex)
54                 return ERR_PTR(-ENOMEM);
55
56         k = keys_ex;
57
58         nla_for_each_nested(ka, nla, rem) {
59                 struct nlattr *tb[TCA_PEDIT_KEY_EX_MAX + 1];
60
61                 if (!n) {
62                         err = -EINVAL;
63                         goto err_out;
64                 }
65                 n--;
66
67                 if (nla_type(ka) != TCA_PEDIT_KEY_EX) {
68                         err = -EINVAL;
69                         goto err_out;
70                 }
71
72                 err = nla_parse_nested_deprecated(tb, TCA_PEDIT_KEY_EX_MAX,
73                                                   ka, pedit_key_ex_policy,
74                                                   NULL);
75                 if (err)
76                         goto err_out;
77
78                 if (!tb[TCA_PEDIT_KEY_EX_HTYPE] ||
79                     !tb[TCA_PEDIT_KEY_EX_CMD]) {
80                         err = -EINVAL;
81                         goto err_out;
82                 }
83
84                 k->htype = nla_get_u16(tb[TCA_PEDIT_KEY_EX_HTYPE]);
85                 k->cmd = nla_get_u16(tb[TCA_PEDIT_KEY_EX_CMD]);
86
87                 if (k->htype > TCA_PEDIT_HDR_TYPE_MAX ||
88                     k->cmd > TCA_PEDIT_CMD_MAX) {
89                         err = -EINVAL;
90                         goto err_out;
91                 }
92
93                 k++;
94         }
95
96         if (n) {
97                 err = -EINVAL;
98                 goto err_out;
99         }
100
101         return keys_ex;
102
103 err_out:
104         kfree(keys_ex);
105         return ERR_PTR(err);
106 }
107
108 static int tcf_pedit_key_ex_dump(struct sk_buff *skb,
109                                  struct tcf_pedit_key_ex *keys_ex, int n)
110 {
111         struct nlattr *keys_start = nla_nest_start_noflag(skb,
112                                                           TCA_PEDIT_KEYS_EX);
113
114         if (!keys_start)
115                 goto nla_failure;
116         for (; n > 0; n--) {
117                 struct nlattr *key_start;
118
119                 key_start = nla_nest_start_noflag(skb, TCA_PEDIT_KEY_EX);
120                 if (!key_start)
121                         goto nla_failure;
122
123                 if (nla_put_u16(skb, TCA_PEDIT_KEY_EX_HTYPE, keys_ex->htype) ||
124                     nla_put_u16(skb, TCA_PEDIT_KEY_EX_CMD, keys_ex->cmd))
125                         goto nla_failure;
126
127                 nla_nest_end(skb, key_start);
128
129                 keys_ex++;
130         }
131
132         nla_nest_end(skb, keys_start);
133
134         return 0;
135 nla_failure:
136         nla_nest_cancel(skb, keys_start);
137         return -EINVAL;
138 }
139
140 static void tcf_pedit_cleanup_rcu(struct rcu_head *head)
141 {
142         struct tcf_pedit_parms *parms =
143                 container_of(head, struct tcf_pedit_parms, rcu);
144
145         kfree(parms->tcfp_keys_ex);
146         kfree(parms->tcfp_keys);
147
148         kfree(parms);
149 }
150
151 static int tcf_pedit_init(struct net *net, struct nlattr *nla,
152                           struct nlattr *est, struct tc_action **a,
153                           struct tcf_proto *tp, u32 flags,
154                           struct netlink_ext_ack *extack)
155 {
156         struct tc_action_net *tn = net_generic(net, act_pedit_ops.net_id);
157         bool bind = flags & TCA_ACT_FLAGS_BIND;
158         struct tcf_chain *goto_ch = NULL;
159         struct tcf_pedit_parms *oparms, *nparms;
160         struct nlattr *tb[TCA_PEDIT_MAX + 1];
161         struct tc_pedit *parm;
162         struct nlattr *pattr;
163         struct tcf_pedit *p;
164         int ret = 0, err;
165         int i, ksize;
166         u32 index;
167
168         if (!nla) {
169                 NL_SET_ERR_MSG_MOD(extack, "Pedit requires attributes to be passed");
170                 return -EINVAL;
171         }
172
173         err = nla_parse_nested_deprecated(tb, TCA_PEDIT_MAX, nla,
174                                           pedit_policy, NULL);
175         if (err < 0)
176                 return err;
177
178         pattr = tb[TCA_PEDIT_PARMS];
179         if (!pattr)
180                 pattr = tb[TCA_PEDIT_PARMS_EX];
181         if (!pattr) {
182                 NL_SET_ERR_MSG_MOD(extack, "Missing required TCA_PEDIT_PARMS or TCA_PEDIT_PARMS_EX pedit attribute");
183                 return -EINVAL;
184         }
185
186         parm = nla_data(pattr);
187
188         index = parm->index;
189         err = tcf_idr_check_alloc(tn, &index, a, bind);
190         if (!err) {
191                 ret = tcf_idr_create_from_flags(tn, index, est, a,
192                                                 &act_pedit_ops, bind, flags);
193                 if (ret) {
194                         tcf_idr_cleanup(tn, index);
195                         return ret;
196                 }
197                 ret = ACT_P_CREATED;
198         } else if (err > 0) {
199                 if (bind)
200                         return 0;
201                 if (!(flags & TCA_ACT_FLAGS_REPLACE)) {
202                         ret = -EEXIST;
203                         goto out_release;
204                 }
205         } else {
206                 return err;
207         }
208
209         if (!parm->nkeys) {
210                 NL_SET_ERR_MSG_MOD(extack, "Pedit requires keys to be passed");
211                 ret = -EINVAL;
212                 goto out_release;
213         }
214         ksize = parm->nkeys * sizeof(struct tc_pedit_key);
215         if (nla_len(pattr) < sizeof(*parm) + ksize) {
216                 NL_SET_ERR_MSG_ATTR(extack, pattr, "Length of TCA_PEDIT_PARMS or TCA_PEDIT_PARMS_EX pedit attribute is invalid");
217                 ret = -EINVAL;
218                 goto out_release;
219         }
220
221         nparms = kzalloc(sizeof(*nparms), GFP_KERNEL);
222         if (!nparms) {
223                 ret = -ENOMEM;
224                 goto out_release;
225         }
226
227         nparms->tcfp_keys_ex =
228                 tcf_pedit_keys_ex_parse(tb[TCA_PEDIT_KEYS_EX], parm->nkeys);
229         if (IS_ERR(nparms->tcfp_keys_ex)) {
230                 ret = PTR_ERR(nparms->tcfp_keys_ex);
231                 goto out_free;
232         }
233
234         err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
235         if (err < 0) {
236                 ret = err;
237                 goto out_free_ex;
238         }
239
240         nparms->tcfp_off_max_hint = 0;
241         nparms->tcfp_flags = parm->flags;
242         nparms->tcfp_nkeys = parm->nkeys;
243
244         nparms->tcfp_keys = kmalloc(ksize, GFP_KERNEL);
245         if (!nparms->tcfp_keys) {
246                 ret = -ENOMEM;
247                 goto put_chain;
248         }
249
250         memcpy(nparms->tcfp_keys, parm->keys, ksize);
251
252         for (i = 0; i < nparms->tcfp_nkeys; ++i) {
253                 u32 cur = nparms->tcfp_keys[i].off;
254
255                 /* sanitize the shift value for any later use */
256                 nparms->tcfp_keys[i].shift = min_t(size_t,
257                                                    BITS_PER_TYPE(int) - 1,
258                                                    nparms->tcfp_keys[i].shift);
259
260                 /* The AT option can read a single byte, we can bound the actual
261                  * value with uchar max.
262                  */
263                 cur += (0xff & nparms->tcfp_keys[i].offmask) >> nparms->tcfp_keys[i].shift;
264
265                 /* Each key touches 4 bytes starting from the computed offset */
266                 nparms->tcfp_off_max_hint =
267                         max(nparms->tcfp_off_max_hint, cur + 4);
268         }
269
270         p = to_pedit(*a);
271
272         spin_lock_bh(&p->tcf_lock);
273         goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
274         oparms = rcu_replace_pointer(p->parms, nparms, 1);
275         spin_unlock_bh(&p->tcf_lock);
276
277         if (oparms)
278                 call_rcu(&oparms->rcu, tcf_pedit_cleanup_rcu);
279
280         if (goto_ch)
281                 tcf_chain_put_by_act(goto_ch);
282
283         return ret;
284
285 put_chain:
286         if (goto_ch)
287                 tcf_chain_put_by_act(goto_ch);
288 out_free_ex:
289         kfree(nparms->tcfp_keys_ex);
290 out_free:
291         kfree(nparms);
292 out_release:
293         tcf_idr_release(*a, bind);
294         return ret;
295 }
296
297 static void tcf_pedit_cleanup(struct tc_action *a)
298 {
299         struct tcf_pedit *p = to_pedit(a);
300         struct tcf_pedit_parms *parms;
301
302         parms = rcu_dereference_protected(p->parms, 1);
303
304         if (parms)
305                 call_rcu(&parms->rcu, tcf_pedit_cleanup_rcu);
306 }
307
308 static bool offset_valid(struct sk_buff *skb, int offset)
309 {
310         if (offset > 0 && offset > skb->len)
311                 return false;
312
313         if  (offset < 0 && -offset > skb_headroom(skb))
314                 return false;
315
316         return true;
317 }
318
319 static int pedit_l4_skb_offset(struct sk_buff *skb, int *hoffset, const int header_type)
320 {
321         const int noff = skb_network_offset(skb);
322         int ret = -EINVAL;
323         struct iphdr _iph;
324
325         switch (skb->protocol) {
326         case htons(ETH_P_IP): {
327                 const struct iphdr *iph = skb_header_pointer(skb, noff, sizeof(_iph), &_iph);
328
329                 if (!iph)
330                         goto out;
331                 *hoffset = noff + iph->ihl * 4;
332                 ret = 0;
333                 break;
334         }
335         case htons(ETH_P_IPV6):
336                 ret = ipv6_find_hdr(skb, hoffset, header_type, NULL, NULL) == header_type ? 0 : -EINVAL;
337                 break;
338         }
339 out:
340         return ret;
341 }
342
343 static int pedit_skb_hdr_offset(struct sk_buff *skb,
344                                  enum pedit_header_type htype, int *hoffset)
345 {
346         int ret = -EINVAL;
347         /* 'htype' is validated in the netlink parsing */
348         switch (htype) {
349         case TCA_PEDIT_KEY_EX_HDR_TYPE_ETH:
350                 if (skb_mac_header_was_set(skb)) {
351                         *hoffset = skb_mac_offset(skb);
352                         ret = 0;
353                 }
354                 break;
355         case TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK:
356         case TCA_PEDIT_KEY_EX_HDR_TYPE_IP4:
357         case TCA_PEDIT_KEY_EX_HDR_TYPE_IP6:
358                 *hoffset = skb_network_offset(skb);
359                 ret = 0;
360                 break;
361         case TCA_PEDIT_KEY_EX_HDR_TYPE_TCP:
362                 ret = pedit_l4_skb_offset(skb, hoffset, IPPROTO_TCP);
363                 break;
364         case TCA_PEDIT_KEY_EX_HDR_TYPE_UDP:
365                 ret = pedit_l4_skb_offset(skb, hoffset, IPPROTO_UDP);
366                 break;
367         default:
368                 break;
369         }
370         return ret;
371 }
372
373 static int tcf_pedit_act(struct sk_buff *skb, const struct tc_action *a,
374                          struct tcf_result *res)
375 {
376         enum pedit_header_type htype = TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK;
377         enum pedit_cmd cmd = TCA_PEDIT_KEY_EX_CMD_SET;
378         struct tcf_pedit *p = to_pedit(a);
379         struct tcf_pedit_key_ex *tkey_ex;
380         struct tcf_pedit_parms *parms;
381         struct tc_pedit_key *tkey;
382         u32 max_offset;
383         int i;
384
385         parms = rcu_dereference_bh(p->parms);
386
387         max_offset = (skb_transport_header_was_set(skb) ?
388                       skb_transport_offset(skb) :
389                       skb_network_offset(skb)) +
390                      parms->tcfp_off_max_hint;
391         if (skb_ensure_writable(skb, min(skb->len, max_offset)))
392                 goto done;
393
394         tcf_lastuse_update(&p->tcf_tm);
395         tcf_action_update_bstats(&p->common, skb);
396
397         tkey = parms->tcfp_keys;
398         tkey_ex = parms->tcfp_keys_ex;
399
400         for (i = parms->tcfp_nkeys; i > 0; i--, tkey++) {
401                 int offset = tkey->off;
402                 int hoffset = 0;
403                 u32 *ptr, hdata;
404                 u32 val;
405                 int rc;
406
407                 if (tkey_ex) {
408                         htype = tkey_ex->htype;
409                         cmd = tkey_ex->cmd;
410
411                         tkey_ex++;
412                 }
413
414                 rc = pedit_skb_hdr_offset(skb, htype, &hoffset);
415                 if (rc) {
416                         pr_info_ratelimited("tc action pedit unable to extract header offset for header type (0x%x)\n", htype);
417                         goto bad;
418                 }
419
420                 if (tkey->offmask) {
421                         u8 *d, _d;
422
423                         if (!offset_valid(skb, hoffset + tkey->at)) {
424                                 pr_info("tc action pedit 'at' offset %d out of bounds\n",
425                                         hoffset + tkey->at);
426                                 goto bad;
427                         }
428                         d = skb_header_pointer(skb, hoffset + tkey->at,
429                                                sizeof(_d), &_d);
430                         if (!d)
431                                 goto bad;
432                         offset += (*d & tkey->offmask) >> tkey->shift;
433                 }
434
435                 if (offset % 4) {
436                         pr_info("tc action pedit offset must be on 32 bit boundaries\n");
437                         goto bad;
438                 }
439
440                 if (!offset_valid(skb, hoffset + offset)) {
441                         pr_info("tc action pedit offset %d out of bounds\n",
442                                 hoffset + offset);
443                         goto bad;
444                 }
445
446                 ptr = skb_header_pointer(skb, hoffset + offset,
447                                          sizeof(hdata), &hdata);
448                 if (!ptr)
449                         goto bad;
450                 /* just do it, baby */
451                 switch (cmd) {
452                 case TCA_PEDIT_KEY_EX_CMD_SET:
453                         val = tkey->val;
454                         break;
455                 case TCA_PEDIT_KEY_EX_CMD_ADD:
456                         val = (*ptr + tkey->val) & ~tkey->mask;
457                         break;
458                 default:
459                         pr_info("tc action pedit bad command (%d)\n",
460                                 cmd);
461                         goto bad;
462                 }
463
464                 *ptr = ((*ptr & tkey->mask) ^ val);
465                 if (ptr == &hdata)
466                         skb_store_bits(skb, hoffset + offset, ptr, 4);
467         }
468
469         goto done;
470
471 bad:
472         spin_lock(&p->tcf_lock);
473         p->tcf_qstats.overlimits++;
474         spin_unlock(&p->tcf_lock);
475 done:
476         return p->tcf_action;
477 }
478
479 static void tcf_pedit_stats_update(struct tc_action *a, u64 bytes, u64 packets,
480                                    u64 drops, u64 lastuse, bool hw)
481 {
482         struct tcf_pedit *d = to_pedit(a);
483         struct tcf_t *tm = &d->tcf_tm;
484
485         tcf_action_update_stats(a, bytes, packets, drops, hw);
486         tm->lastuse = max_t(u64, tm->lastuse, lastuse);
487 }
488
489 static int tcf_pedit_dump(struct sk_buff *skb, struct tc_action *a,
490                           int bind, int ref)
491 {
492         unsigned char *b = skb_tail_pointer(skb);
493         struct tcf_pedit *p = to_pedit(a);
494         struct tcf_pedit_parms *parms;
495         struct tc_pedit *opt;
496         struct tcf_t t;
497         int s;
498
499         spin_lock_bh(&p->tcf_lock);
500         parms = rcu_dereference_protected(p->parms, 1);
501         s = struct_size(opt, keys, parms->tcfp_nkeys);
502
503         opt = kzalloc(s, GFP_ATOMIC);
504         if (unlikely(!opt)) {
505                 spin_unlock_bh(&p->tcf_lock);
506                 return -ENOBUFS;
507         }
508
509         memcpy(opt->keys, parms->tcfp_keys,
510                flex_array_size(opt, keys, parms->tcfp_nkeys));
511         opt->index = p->tcf_index;
512         opt->nkeys = parms->tcfp_nkeys;
513         opt->flags = parms->tcfp_flags;
514         opt->action = p->tcf_action;
515         opt->refcnt = refcount_read(&p->tcf_refcnt) - ref;
516         opt->bindcnt = atomic_read(&p->tcf_bindcnt) - bind;
517
518         if (parms->tcfp_keys_ex) {
519                 if (tcf_pedit_key_ex_dump(skb, parms->tcfp_keys_ex,
520                                           parms->tcfp_nkeys))
521                         goto nla_put_failure;
522
523                 if (nla_put(skb, TCA_PEDIT_PARMS_EX, s, opt))
524                         goto nla_put_failure;
525         } else {
526                 if (nla_put(skb, TCA_PEDIT_PARMS, s, opt))
527                         goto nla_put_failure;
528         }
529
530         tcf_tm_dump(&t, &p->tcf_tm);
531         if (nla_put_64bit(skb, TCA_PEDIT_TM, sizeof(t), &t, TCA_PEDIT_PAD))
532                 goto nla_put_failure;
533         spin_unlock_bh(&p->tcf_lock);
534
535         kfree(opt);
536         return skb->len;
537
538 nla_put_failure:
539         spin_unlock_bh(&p->tcf_lock);
540         nlmsg_trim(skb, b);
541         kfree(opt);
542         return -1;
543 }
544
545 static int tcf_pedit_offload_act_setup(struct tc_action *act, void *entry_data,
546                                        u32 *index_inc, bool bind,
547                                        struct netlink_ext_ack *extack)
548 {
549         if (bind) {
550                 struct flow_action_entry *entry = entry_data;
551                 int k;
552
553                 for (k = 0; k < tcf_pedit_nkeys(act); k++) {
554                         switch (tcf_pedit_cmd(act, k)) {
555                         case TCA_PEDIT_KEY_EX_CMD_SET:
556                                 entry->id = FLOW_ACTION_MANGLE;
557                                 break;
558                         case TCA_PEDIT_KEY_EX_CMD_ADD:
559                                 entry->id = FLOW_ACTION_ADD;
560                                 break;
561                         default:
562                                 NL_SET_ERR_MSG_MOD(extack, "Unsupported pedit command offload");
563                                 return -EOPNOTSUPP;
564                         }
565                         entry->mangle.htype = tcf_pedit_htype(act, k);
566                         entry->mangle.mask = tcf_pedit_mask(act, k);
567                         entry->mangle.val = tcf_pedit_val(act, k);
568                         entry->mangle.offset = tcf_pedit_offset(act, k);
569                         entry->hw_stats = tc_act_hw_stats(act->hw_stats);
570                         entry++;
571                 }
572                 *index_inc = k;
573         } else {
574                 return -EOPNOTSUPP;
575         }
576
577         return 0;
578 }
579
580 static struct tc_action_ops act_pedit_ops = {
581         .kind           =       "pedit",
582         .id             =       TCA_ID_PEDIT,
583         .owner          =       THIS_MODULE,
584         .act            =       tcf_pedit_act,
585         .stats_update   =       tcf_pedit_stats_update,
586         .dump           =       tcf_pedit_dump,
587         .cleanup        =       tcf_pedit_cleanup,
588         .init           =       tcf_pedit_init,
589         .offload_act_setup =    tcf_pedit_offload_act_setup,
590         .size           =       sizeof(struct tcf_pedit),
591 };
592
593 static __net_init int pedit_init_net(struct net *net)
594 {
595         struct tc_action_net *tn = net_generic(net, act_pedit_ops.net_id);
596
597         return tc_action_net_init(net, tn, &act_pedit_ops);
598 }
599
600 static void __net_exit pedit_exit_net(struct list_head *net_list)
601 {
602         tc_action_net_exit(net_list, act_pedit_ops.net_id);
603 }
604
605 static struct pernet_operations pedit_net_ops = {
606         .init = pedit_init_net,
607         .exit_batch = pedit_exit_net,
608         .id   = &act_pedit_ops.net_id,
609         .size = sizeof(struct tc_action_net),
610 };
611
612 MODULE_AUTHOR("Jamal Hadi Salim(2002-4)");
613 MODULE_DESCRIPTION("Generic Packet Editor actions");
614 MODULE_LICENSE("GPL");
615
616 static int __init pedit_init_module(void)
617 {
618         return tcf_register_action(&act_pedit_ops, &pedit_net_ops);
619 }
620
621 static void __exit pedit_cleanup_module(void)
622 {
623         tcf_unregister_action(&act_pedit_ops, &pedit_net_ops);
624 }
625
626 module_init(pedit_init_module);
627 module_exit(pedit_cleanup_module);