1 // SPDX-License-Identifier: GPL-2.0-only
3 * net/sched/act_sample.c - Packet sampling tc action
4 * Copyright (c) 2017 Yotam Gigi <yotamg@mellanox.com>
7 #include <linux/types.h>
8 #include <linux/kernel.h>
9 #include <linux/string.h>
10 #include <linux/errno.h>
11 #include <linux/skbuff.h>
12 #include <linux/rtnetlink.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/gfp.h>
16 #include <net/net_namespace.h>
17 #include <net/netlink.h>
18 #include <net/pkt_sched.h>
19 #include <linux/tc_act/tc_sample.h>
20 #include <net/tc_act/tc_sample.h>
21 #include <net/psample.h>
22 #include <net/pkt_cls.h>
24 #include <linux/if_arp.h>
26 static unsigned int sample_net_id;
27 static struct tc_action_ops act_sample_ops;
29 static const struct nla_policy sample_policy[TCA_SAMPLE_MAX + 1] = {
30 [TCA_SAMPLE_PARMS] = { .len = sizeof(struct tc_sample) },
31 [TCA_SAMPLE_RATE] = { .type = NLA_U32 },
32 [TCA_SAMPLE_TRUNC_SIZE] = { .type = NLA_U32 },
33 [TCA_SAMPLE_PSAMPLE_GROUP] = { .type = NLA_U32 },
36 static int tcf_sample_init(struct net *net, struct nlattr *nla,
37 struct nlattr *est, struct tc_action **a, int ovr,
38 int bind, bool rtnl_held, struct tcf_proto *tp,
39 u32 flags, struct netlink_ext_ack *extack)
41 struct tc_action_net *tn = net_generic(net, sample_net_id);
42 struct nlattr *tb[TCA_SAMPLE_MAX + 1];
43 struct psample_group *psample_group;
44 u32 psample_group_num, rate, index;
45 struct tcf_chain *goto_ch = NULL;
46 struct tc_sample *parm;
53 ret = nla_parse_nested_deprecated(tb, TCA_SAMPLE_MAX, nla,
57 if (!tb[TCA_SAMPLE_PARMS] || !tb[TCA_SAMPLE_RATE] ||
58 !tb[TCA_SAMPLE_PSAMPLE_GROUP])
61 parm = nla_data(tb[TCA_SAMPLE_PARMS]);
63 err = tcf_idr_check_alloc(tn, &index, a, bind);
71 ret = tcf_idr_create(tn, index, est, a,
72 &act_sample_ops, bind, true, 0);
74 tcf_idr_cleanup(tn, index);
79 tcf_idr_release(*a, bind);
82 err = tcf_action_check_ctrlact(parm->action, tp, &goto_ch, extack);
86 rate = nla_get_u32(tb[TCA_SAMPLE_RATE]);
88 NL_SET_ERR_MSG(extack, "invalid sample rate");
92 psample_group_num = nla_get_u32(tb[TCA_SAMPLE_PSAMPLE_GROUP]);
93 psample_group = psample_group_get(net, psample_group_num);
101 spin_lock_bh(&s->tcf_lock);
102 goto_ch = tcf_action_set_ctrlact(*a, parm->action, goto_ch);
104 s->psample_group_num = psample_group_num;
105 psample_group = rcu_replace_pointer(s->psample_group, psample_group,
106 lockdep_is_held(&s->tcf_lock));
108 if (tb[TCA_SAMPLE_TRUNC_SIZE]) {
110 s->trunc_size = nla_get_u32(tb[TCA_SAMPLE_TRUNC_SIZE]);
112 spin_unlock_bh(&s->tcf_lock);
115 psample_group_put(psample_group);
117 tcf_chain_put_by_act(goto_ch);
122 tcf_chain_put_by_act(goto_ch);
124 tcf_idr_release(*a, bind);
128 static void tcf_sample_cleanup(struct tc_action *a)
130 struct tcf_sample *s = to_sample(a);
131 struct psample_group *psample_group;
133 /* last reference to action, no need to lock */
134 psample_group = rcu_dereference_protected(s->psample_group, 1);
135 RCU_INIT_POINTER(s->psample_group, NULL);
137 psample_group_put(psample_group);
140 static bool tcf_sample_dev_ok_push(struct net_device *dev)
156 static int tcf_sample_act(struct sk_buff *skb, const struct tc_action *a,
157 struct tcf_result *res)
159 struct tcf_sample *s = to_sample(a);
160 struct psample_group *psample_group;
161 struct psample_metadata md = {};
164 tcf_lastuse_update(&s->tcf_tm);
165 bstats_cpu_update(this_cpu_ptr(s->common.cpu_bstats), skb);
166 retval = READ_ONCE(s->tcf_action);
168 psample_group = rcu_dereference_bh(s->psample_group);
170 /* randomly sample packets according to rate */
171 if (psample_group && (prandom_u32() % s->rate == 0)) {
172 if (!skb_at_tc_ingress(skb)) {
173 md.in_ifindex = skb->skb_iif;
174 md.out_ifindex = skb->dev->ifindex;
176 md.in_ifindex = skb->dev->ifindex;
179 /* on ingress, the mac header gets popped, so push it back */
180 if (skb_at_tc_ingress(skb) && tcf_sample_dev_ok_push(skb->dev))
181 skb_push(skb, skb->mac_len);
183 md.trunc_size = s->truncate ? s->trunc_size : skb->len;
184 psample_sample_packet(psample_group, skb, s->rate, &md);
186 if (skb_at_tc_ingress(skb) && tcf_sample_dev_ok_push(skb->dev))
187 skb_pull(skb, skb->mac_len);
193 static void tcf_sample_stats_update(struct tc_action *a, u64 bytes, u64 packets,
194 u64 drops, u64 lastuse, bool hw)
196 struct tcf_sample *s = to_sample(a);
197 struct tcf_t *tm = &s->tcf_tm;
199 tcf_action_update_stats(a, bytes, packets, drops, hw);
200 tm->lastuse = max_t(u64, tm->lastuse, lastuse);
203 static int tcf_sample_dump(struct sk_buff *skb, struct tc_action *a,
206 unsigned char *b = skb_tail_pointer(skb);
207 struct tcf_sample *s = to_sample(a);
208 struct tc_sample opt = {
209 .index = s->tcf_index,
210 .refcnt = refcount_read(&s->tcf_refcnt) - ref,
211 .bindcnt = atomic_read(&s->tcf_bindcnt) - bind,
215 spin_lock_bh(&s->tcf_lock);
216 opt.action = s->tcf_action;
217 if (nla_put(skb, TCA_SAMPLE_PARMS, sizeof(opt), &opt))
218 goto nla_put_failure;
220 tcf_tm_dump(&t, &s->tcf_tm);
221 if (nla_put_64bit(skb, TCA_SAMPLE_TM, sizeof(t), &t, TCA_SAMPLE_PAD))
222 goto nla_put_failure;
224 if (nla_put_u32(skb, TCA_SAMPLE_RATE, s->rate))
225 goto nla_put_failure;
228 if (nla_put_u32(skb, TCA_SAMPLE_TRUNC_SIZE, s->trunc_size))
229 goto nla_put_failure;
231 if (nla_put_u32(skb, TCA_SAMPLE_PSAMPLE_GROUP, s->psample_group_num))
232 goto nla_put_failure;
233 spin_unlock_bh(&s->tcf_lock);
238 spin_unlock_bh(&s->tcf_lock);
243 static int tcf_sample_walker(struct net *net, struct sk_buff *skb,
244 struct netlink_callback *cb, int type,
245 const struct tc_action_ops *ops,
246 struct netlink_ext_ack *extack)
248 struct tc_action_net *tn = net_generic(net, sample_net_id);
250 return tcf_generic_walker(tn, skb, cb, type, ops, extack);
253 static int tcf_sample_search(struct net *net, struct tc_action **a, u32 index)
255 struct tc_action_net *tn = net_generic(net, sample_net_id);
257 return tcf_idr_search(tn, a, index);
260 static void tcf_psample_group_put(void *priv)
262 struct psample_group *group = priv;
264 psample_group_put(group);
267 static struct psample_group *
268 tcf_sample_get_group(const struct tc_action *a,
269 tc_action_priv_destructor *destructor)
271 struct tcf_sample *s = to_sample(a);
272 struct psample_group *group;
274 group = rcu_dereference_protected(s->psample_group,
275 lockdep_is_held(&s->tcf_lock));
277 psample_group_take(group);
278 *destructor = tcf_psample_group_put;
284 static struct tc_action_ops act_sample_ops = {
287 .owner = THIS_MODULE,
288 .act = tcf_sample_act,
289 .stats_update = tcf_sample_stats_update,
290 .dump = tcf_sample_dump,
291 .init = tcf_sample_init,
292 .cleanup = tcf_sample_cleanup,
293 .walk = tcf_sample_walker,
294 .lookup = tcf_sample_search,
295 .get_psample_group = tcf_sample_get_group,
296 .size = sizeof(struct tcf_sample),
299 static __net_init int sample_init_net(struct net *net)
301 struct tc_action_net *tn = net_generic(net, sample_net_id);
303 return tc_action_net_init(net, tn, &act_sample_ops);
306 static void __net_exit sample_exit_net(struct list_head *net_list)
308 tc_action_net_exit(net_list, sample_net_id);
311 static struct pernet_operations sample_net_ops = {
312 .init = sample_init_net,
313 .exit_batch = sample_exit_net,
314 .id = &sample_net_id,
315 .size = sizeof(struct tc_action_net),
318 static int __init sample_init_module(void)
320 return tcf_register_action(&act_sample_ops, &sample_net_ops);
323 static void __exit sample_cleanup_module(void)
325 tcf_unregister_action(&act_sample_ops, &sample_net_ops);
328 module_init(sample_init_module);
329 module_exit(sample_cleanup_module);
331 MODULE_AUTHOR("Yotam Gigi <yotam.gi@gmail.com>");
332 MODULE_DESCRIPTION("Packet sampling action");
333 MODULE_LICENSE("GPL v2");