1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net/sched/act_pedit.c Generic packet editor
5 * Authors: Jamal Hadi Salim (2002-4)
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/slab.h>
17 #include <net/netlink.h>
18 #include <net/pkt_sched.h>
19 #include <linux/tc_act/tc_pedit.h>
20 #include <net/tc_act/tc_pedit.h>
21 #include <uapi/linux/tc_act/tc_pedit.h>
22 #include <net/pkt_cls.h>
23 #include <net/tc_wrapper.h>
25 static struct tc_action_ops act_pedit_ops;
27 static const struct nla_policy pedit_policy[TCA_PEDIT_MAX + 1] = {
28 [TCA_PEDIT_PARMS] = { .len = sizeof(struct tc_pedit) },
29 [TCA_PEDIT_KEYS_EX] = { .type = NLA_NESTED },
32 static const struct nla_policy pedit_key_ex_policy[TCA_PEDIT_KEY_EX_MAX + 1] = {
33 [TCA_PEDIT_KEY_EX_HTYPE] =
34 NLA_POLICY_MAX(NLA_U16, TCA_PEDIT_HDR_TYPE_MAX),
35 [TCA_PEDIT_KEY_EX_CMD] = NLA_POLICY_MAX(NLA_U16, TCA_PEDIT_CMD_MAX),
38 static struct tcf_pedit_key_ex *tcf_pedit_keys_ex_parse(struct nlattr *nla,
39 u8 n, struct netlink_ext_ack *extack)
41 struct tcf_pedit_key_ex *keys_ex;
42 struct tcf_pedit_key_ex *k;
43 const struct nlattr *ka;
50 keys_ex = kcalloc(n, sizeof(*k), GFP_KERNEL);
52 return ERR_PTR(-ENOMEM);
56 nla_for_each_nested(ka, nla, rem) {
57 struct nlattr *tb[TCA_PEDIT_KEY_EX_MAX + 1];
60 NL_SET_ERR_MSG_MOD(extack, "Can't parse more extended keys than requested");
66 if (nla_type(ka) != TCA_PEDIT_KEY_EX) {
67 NL_SET_ERR_MSG_ATTR(extack, ka, "Unknown attribute, expected extended key");
72 err = nla_parse_nested_deprecated(tb, TCA_PEDIT_KEY_EX_MAX,
73 ka, pedit_key_ex_policy,
78 if (NL_REQ_ATTR_CHECK(extack, nla, tb, TCA_PEDIT_KEY_EX_HTYPE)) {
79 NL_SET_ERR_MSG(extack, "Missing required attribute");
84 if (NL_REQ_ATTR_CHECK(extack, nla, tb, TCA_PEDIT_KEY_EX_CMD)) {
85 NL_SET_ERR_MSG(extack, "Missing required attribute");
90 k->htype = nla_get_u16(tb[TCA_PEDIT_KEY_EX_HTYPE]);
91 k->cmd = nla_get_u16(tb[TCA_PEDIT_KEY_EX_CMD]);
97 NL_SET_ERR_MSG_MOD(extack, "Not enough extended keys to parse");
109 static int tcf_pedit_key_ex_dump(struct sk_buff *skb,
110 struct tcf_pedit_key_ex *keys_ex, int n)
112 struct nlattr *keys_start = nla_nest_start_noflag(skb,
118 struct nlattr *key_start;
120 key_start = nla_nest_start_noflag(skb, TCA_PEDIT_KEY_EX);
124 if (nla_put_u16(skb, TCA_PEDIT_KEY_EX_HTYPE, keys_ex->htype) ||
125 nla_put_u16(skb, TCA_PEDIT_KEY_EX_CMD, keys_ex->cmd))
128 nla_nest_end(skb, key_start);
133 nla_nest_end(skb, keys_start);
137 nla_nest_cancel(skb, keys_start);
141 static void tcf_pedit_cleanup_rcu(struct rcu_head *head)
143 struct tcf_pedit_parms *parms =
144 container_of(head, struct tcf_pedit_parms, rcu);
146 kfree(parms->tcfp_keys_ex);
147 kfree(parms->tcfp_keys);
152 static int tcf_pedit_init(struct net *net, struct nlattr *nla,
153 struct nlattr *est, struct tc_action **a,
154 struct tcf_proto *tp, u32 flags,
155 struct netlink_ext_ack *extack)
157 struct tc_action_net *tn = net_generic(net, act_pedit_ops.net_id);
158 bool bind = flags & TCA_ACT_FLAGS_BIND;
159 struct tcf_chain *goto_ch = NULL;
160 struct tcf_pedit_parms *oparms, *nparms;
161 struct nlattr *tb[TCA_PEDIT_MAX + 1];
162 struct tc_pedit *parm;
163 struct nlattr *pattr;
170 NL_SET_ERR_MSG_MOD(extack, "Pedit requires attributes to be passed");
174 err = nla_parse_nested_deprecated(tb, TCA_PEDIT_MAX, nla,
179 pattr = tb[TCA_PEDIT_PARMS];
181 pattr = tb[TCA_PEDIT_PARMS_EX];
183 NL_SET_ERR_MSG_MOD(extack, "Missing required TCA_PEDIT_PARMS or TCA_PEDIT_PARMS_EX pedit attribute");
187 parm = nla_data(pattr);
190 err = tcf_idr_check_alloc(tn, &index, a, bind);
192 ret = tcf_idr_create_from_flags(tn, index, est, a,
193 &act_pedit_ops, bind, flags);
195 tcf_idr_cleanup(tn, index);
199 } else if (err > 0) {
202 if (!(flags & TCA_ACT_FLAGS_REPLACE)) {
211 NL_SET_ERR_MSG_MOD(extack, "Pedit requires keys to be passed");
215 ksize = parm->nkeys * sizeof(struct tc_pedit_key);
216 if (nla_len(pattr) < sizeof(*parm) + ksize) {
217 NL_SET_ERR_MSG_ATTR(extack, pattr, "Length of TCA_PEDIT_PARMS or TCA_PEDIT_PARMS_EX pedit attribute is invalid");
222 nparms = kzalloc(sizeof(*nparms), GFP_KERNEL);
228 nparms->tcfp_keys_ex =
229 tcf_pedit_keys_ex_parse(tb[TCA_PEDIT_KEYS_EX], parm->nkeys, extack);
230 if (IS_ERR(nparms->tcfp_keys_ex)) {
231 ret = PTR_ERR(nparms->tcfp_keys_ex);
235 err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
241 nparms->tcfp_off_max_hint = 0;
242 nparms->tcfp_flags = parm->flags;
243 nparms->tcfp_nkeys = parm->nkeys;
245 nparms->tcfp_keys = kmalloc(ksize, GFP_KERNEL);
246 if (!nparms->tcfp_keys) {
251 memcpy(nparms->tcfp_keys, parm->keys, ksize);
253 for (i = 0; i < nparms->tcfp_nkeys; ++i) {
254 u32 offmask = nparms->tcfp_keys[i].offmask;
255 u32 cur = nparms->tcfp_keys[i].off;
257 /* The AT option can be added to static offsets in the datapath */
258 if (!offmask && cur % 4) {
259 NL_SET_ERR_MSG_MOD(extack, "Offsets must be on 32bit boundaries");
264 /* sanitize the shift value for any later use */
265 nparms->tcfp_keys[i].shift = min_t(size_t,
266 BITS_PER_TYPE(int) - 1,
267 nparms->tcfp_keys[i].shift);
269 /* The AT option can read a single byte, we can bound the actual
270 * value with uchar max.
272 cur += (0xff & offmask) >> nparms->tcfp_keys[i].shift;
274 /* Each key touches 4 bytes starting from the computed offset */
275 nparms->tcfp_off_max_hint =
276 max(nparms->tcfp_off_max_hint, cur + 4);
281 spin_lock_bh(&p->tcf_lock);
282 goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
283 oparms = rcu_replace_pointer(p->parms, nparms, 1);
284 spin_unlock_bh(&p->tcf_lock);
287 call_rcu(&oparms->rcu, tcf_pedit_cleanup_rcu);
290 tcf_chain_put_by_act(goto_ch);
295 kfree(nparms->tcfp_keys);
298 tcf_chain_put_by_act(goto_ch);
300 kfree(nparms->tcfp_keys_ex);
304 tcf_idr_release(*a, bind);
308 static void tcf_pedit_cleanup(struct tc_action *a)
310 struct tcf_pedit *p = to_pedit(a);
311 struct tcf_pedit_parms *parms;
313 parms = rcu_dereference_protected(p->parms, 1);
316 call_rcu(&parms->rcu, tcf_pedit_cleanup_rcu);
319 static bool offset_valid(struct sk_buff *skb, int offset)
321 if (offset > 0 && offset > skb->len)
324 if (offset < 0 && -offset > skb_headroom(skb))
330 static void pedit_skb_hdr_offset(struct sk_buff *skb,
331 enum pedit_header_type htype, int *hoffset)
333 /* 'htype' is validated in the netlink parsing */
335 case TCA_PEDIT_KEY_EX_HDR_TYPE_ETH:
336 if (skb_mac_header_was_set(skb))
337 *hoffset = skb_mac_offset(skb);
339 case TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK:
340 case TCA_PEDIT_KEY_EX_HDR_TYPE_IP4:
341 case TCA_PEDIT_KEY_EX_HDR_TYPE_IP6:
342 *hoffset = skb_network_offset(skb);
344 case TCA_PEDIT_KEY_EX_HDR_TYPE_TCP:
345 case TCA_PEDIT_KEY_EX_HDR_TYPE_UDP:
346 if (skb_transport_header_was_set(skb))
347 *hoffset = skb_transport_offset(skb);
354 TC_INDIRECT_SCOPE int tcf_pedit_act(struct sk_buff *skb,
355 const struct tc_action *a,
356 struct tcf_result *res)
358 enum pedit_header_type htype = TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK;
359 enum pedit_cmd cmd = TCA_PEDIT_KEY_EX_CMD_SET;
360 struct tcf_pedit *p = to_pedit(a);
361 struct tcf_pedit_key_ex *tkey_ex;
362 struct tcf_pedit_parms *parms;
363 struct tc_pedit_key *tkey;
367 parms = rcu_dereference_bh(p->parms);
369 max_offset = (skb_transport_header_was_set(skb) ?
370 skb_transport_offset(skb) :
371 skb_network_offset(skb)) +
372 parms->tcfp_off_max_hint;
373 if (skb_ensure_writable(skb, min(skb->len, max_offset)))
376 tcf_lastuse_update(&p->tcf_tm);
377 tcf_action_update_bstats(&p->common, skb);
379 tkey = parms->tcfp_keys;
380 tkey_ex = parms->tcfp_keys_ex;
382 for (i = parms->tcfp_nkeys; i > 0; i--, tkey++) {
383 int offset = tkey->off;
389 htype = tkey_ex->htype;
395 pedit_skb_hdr_offset(skb, htype, &hoffset);
400 if (!offset_valid(skb, hoffset + tkey->at)) {
401 pr_info_ratelimited("tc action pedit 'at' offset %d out of bounds\n",
405 d = skb_header_pointer(skb, hoffset + tkey->at,
410 offset += (*d & tkey->offmask) >> tkey->shift;
412 pr_info_ratelimited("tc action pedit offset must be on 32 bit boundaries\n");
417 if (!offset_valid(skb, hoffset + offset)) {
418 pr_info_ratelimited("tc action pedit offset %d out of bounds\n", hoffset + offset);
422 ptr = skb_header_pointer(skb, hoffset + offset,
423 sizeof(hdata), &hdata);
426 /* just do it, baby */
428 case TCA_PEDIT_KEY_EX_CMD_SET:
431 case TCA_PEDIT_KEY_EX_CMD_ADD:
432 val = (*ptr + tkey->val) & ~tkey->mask;
435 pr_info_ratelimited("tc action pedit bad command (%d)\n", cmd);
439 *ptr = ((*ptr & tkey->mask) ^ val);
441 skb_store_bits(skb, hoffset + offset, ptr, 4);
447 tcf_action_inc_overlimit_qstats(&p->common);
449 return p->tcf_action;
452 static void tcf_pedit_stats_update(struct tc_action *a, u64 bytes, u64 packets,
453 u64 drops, u64 lastuse, bool hw)
455 struct tcf_pedit *d = to_pedit(a);
456 struct tcf_t *tm = &d->tcf_tm;
458 tcf_action_update_stats(a, bytes, packets, drops, hw);
459 tm->lastuse = max_t(u64, tm->lastuse, lastuse);
462 static int tcf_pedit_dump(struct sk_buff *skb, struct tc_action *a,
465 unsigned char *b = skb_tail_pointer(skb);
466 struct tcf_pedit *p = to_pedit(a);
467 struct tcf_pedit_parms *parms;
468 struct tc_pedit *opt;
472 spin_lock_bh(&p->tcf_lock);
473 parms = rcu_dereference_protected(p->parms, 1);
474 s = struct_size(opt, keys, parms->tcfp_nkeys);
476 opt = kzalloc(s, GFP_ATOMIC);
477 if (unlikely(!opt)) {
478 spin_unlock_bh(&p->tcf_lock);
482 memcpy(opt->keys, parms->tcfp_keys,
483 flex_array_size(opt, keys, parms->tcfp_nkeys));
484 opt->index = p->tcf_index;
485 opt->nkeys = parms->tcfp_nkeys;
486 opt->flags = parms->tcfp_flags;
487 opt->action = p->tcf_action;
488 opt->refcnt = refcount_read(&p->tcf_refcnt) - ref;
489 opt->bindcnt = atomic_read(&p->tcf_bindcnt) - bind;
491 if (parms->tcfp_keys_ex) {
492 if (tcf_pedit_key_ex_dump(skb, parms->tcfp_keys_ex,
494 goto nla_put_failure;
496 if (nla_put(skb, TCA_PEDIT_PARMS_EX, s, opt))
497 goto nla_put_failure;
499 if (nla_put(skb, TCA_PEDIT_PARMS, s, opt))
500 goto nla_put_failure;
503 tcf_tm_dump(&t, &p->tcf_tm);
504 if (nla_put_64bit(skb, TCA_PEDIT_TM, sizeof(t), &t, TCA_PEDIT_PAD))
505 goto nla_put_failure;
506 spin_unlock_bh(&p->tcf_lock);
512 spin_unlock_bh(&p->tcf_lock);
518 static int tcf_pedit_offload_act_setup(struct tc_action *act, void *entry_data,
519 u32 *index_inc, bool bind,
520 struct netlink_ext_ack *extack)
523 struct flow_action_entry *entry = entry_data;
526 for (k = 0; k < tcf_pedit_nkeys(act); k++) {
527 switch (tcf_pedit_cmd(act, k)) {
528 case TCA_PEDIT_KEY_EX_CMD_SET:
529 entry->id = FLOW_ACTION_MANGLE;
531 case TCA_PEDIT_KEY_EX_CMD_ADD:
532 entry->id = FLOW_ACTION_ADD;
535 NL_SET_ERR_MSG_MOD(extack, "Unsupported pedit command offload");
538 entry->mangle.htype = tcf_pedit_htype(act, k);
539 entry->mangle.mask = tcf_pedit_mask(act, k);
540 entry->mangle.val = tcf_pedit_val(act, k);
541 entry->mangle.offset = tcf_pedit_offset(act, k);
542 entry->hw_stats = tc_act_hw_stats(act->hw_stats);
547 struct flow_offload_action *fl_action = entry_data;
548 u32 cmd = tcf_pedit_cmd(act, 0);
552 case TCA_PEDIT_KEY_EX_CMD_SET:
553 fl_action->id = FLOW_ACTION_MANGLE;
555 case TCA_PEDIT_KEY_EX_CMD_ADD:
556 fl_action->id = FLOW_ACTION_ADD;
559 NL_SET_ERR_MSG_MOD(extack, "Unsupported pedit command offload");
563 for (k = 1; k < tcf_pedit_nkeys(act); k++) {
564 if (cmd != tcf_pedit_cmd(act, k)) {
565 NL_SET_ERR_MSG_MOD(extack, "Unsupported pedit command offload");
574 static struct tc_action_ops act_pedit_ops = {
577 .owner = THIS_MODULE,
578 .act = tcf_pedit_act,
579 .stats_update = tcf_pedit_stats_update,
580 .dump = tcf_pedit_dump,
581 .cleanup = tcf_pedit_cleanup,
582 .init = tcf_pedit_init,
583 .offload_act_setup = tcf_pedit_offload_act_setup,
584 .size = sizeof(struct tcf_pedit),
587 static __net_init int pedit_init_net(struct net *net)
589 struct tc_action_net *tn = net_generic(net, act_pedit_ops.net_id);
591 return tc_action_net_init(net, tn, &act_pedit_ops);
594 static void __net_exit pedit_exit_net(struct list_head *net_list)
596 tc_action_net_exit(net_list, act_pedit_ops.net_id);
599 static struct pernet_operations pedit_net_ops = {
600 .init = pedit_init_net,
601 .exit_batch = pedit_exit_net,
602 .id = &act_pedit_ops.net_id,
603 .size = sizeof(struct tc_action_net),
606 MODULE_AUTHOR("Jamal Hadi Salim(2002-4)");
607 MODULE_DESCRIPTION("Generic Packet Editor actions");
608 MODULE_LICENSE("GPL");
610 static int __init pedit_init_module(void)
612 return tcf_register_action(&act_pedit_ops, &pedit_net_ops);
615 static void __exit pedit_cleanup_module(void)
617 tcf_unregister_action(&act_pedit_ops, &pedit_net_ops);
620 module_init(pedit_init_module);
621 module_exit(pedit_cleanup_module);