1 // SPDX-License-Identifier: GPL-2.0-only
3 * net/psample/psample.c - Netlink channel for packet sampling
4 * Copyright (c) 2017 Yotam Gigi <yotamg@mellanox.com>
7 #include <linux/types.h>
8 #include <linux/kernel.h>
9 #include <linux/skbuff.h>
10 #include <linux/module.h>
11 #include <net/net_namespace.h>
13 #include <net/netlink.h>
14 #include <net/genetlink.h>
15 #include <net/psample.h>
16 #include <linux/spinlock.h>
17 #include <net/ip_tunnels.h>
18 #include <net/dst_metadata.h>
20 #define PSAMPLE_MAX_PACKET_SIZE 0xffff
22 static LIST_HEAD(psample_groups_list);
23 static DEFINE_SPINLOCK(psample_groups_lock);
25 /* multicast groups */
26 enum psample_nl_multicast_groups {
27 PSAMPLE_NL_MCGRP_CONFIG,
28 PSAMPLE_NL_MCGRP_SAMPLE,
31 static const struct genl_multicast_group psample_nl_mcgrps[] = {
32 [PSAMPLE_NL_MCGRP_CONFIG] = { .name = PSAMPLE_NL_MCGRP_CONFIG_NAME },
33 [PSAMPLE_NL_MCGRP_SAMPLE] = { .name = PSAMPLE_NL_MCGRP_SAMPLE_NAME,
34 .flags = GENL_UNS_ADMIN_PERM },
37 static struct genl_family psample_nl_family __ro_after_init;
39 static int psample_group_nl_fill(struct sk_buff *msg,
40 struct psample_group *group,
41 enum psample_command cmd, u32 portid, u32 seq,
47 hdr = genlmsg_put(msg, portid, seq, &psample_nl_family, flags, cmd);
51 ret = nla_put_u32(msg, PSAMPLE_ATTR_SAMPLE_GROUP, group->group_num);
55 ret = nla_put_u32(msg, PSAMPLE_ATTR_GROUP_REFCOUNT, group->refcount);
59 ret = nla_put_u32(msg, PSAMPLE_ATTR_GROUP_SEQ, group->seq);
63 genlmsg_end(msg, hdr);
67 genlmsg_cancel(msg, hdr);
71 static int psample_nl_cmd_get_group_dumpit(struct sk_buff *msg,
72 struct netlink_callback *cb)
74 struct psample_group *group;
75 int start = cb->args[0];
79 spin_lock_bh(&psample_groups_lock);
80 list_for_each_entry(group, &psample_groups_list, list) {
81 if (!net_eq(group->net, sock_net(msg->sk)))
87 err = psample_group_nl_fill(msg, group, PSAMPLE_CMD_NEW_GROUP,
88 NETLINK_CB(cb->skb).portid,
89 cb->nlh->nlmsg_seq, NLM_F_MULTI);
95 spin_unlock_bh(&psample_groups_lock);
100 static const struct genl_small_ops psample_nl_ops[] = {
102 .cmd = PSAMPLE_CMD_GET_GROUP,
103 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
104 .dumpit = psample_nl_cmd_get_group_dumpit,
105 /* can be retrieved by unprivileged users */
109 static struct genl_family psample_nl_family __ro_after_init = {
110 .name = PSAMPLE_GENL_NAME,
111 .version = PSAMPLE_GENL_VERSION,
112 .maxattr = PSAMPLE_ATTR_MAX,
114 .module = THIS_MODULE,
115 .mcgrps = psample_nl_mcgrps,
116 .small_ops = psample_nl_ops,
117 .n_small_ops = ARRAY_SIZE(psample_nl_ops),
118 .n_mcgrps = ARRAY_SIZE(psample_nl_mcgrps),
121 static void psample_group_notify(struct psample_group *group,
122 enum psample_command cmd)
127 msg = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_ATOMIC);
131 err = psample_group_nl_fill(msg, group, cmd, 0, 0, NLM_F_MULTI);
133 genlmsg_multicast_netns(&psample_nl_family, group->net, msg, 0,
134 PSAMPLE_NL_MCGRP_CONFIG, GFP_ATOMIC);
139 static struct psample_group *psample_group_create(struct net *net,
142 struct psample_group *group;
144 group = kzalloc(sizeof(*group), GFP_ATOMIC);
149 group->group_num = group_num;
150 list_add_tail(&group->list, &psample_groups_list);
152 psample_group_notify(group, PSAMPLE_CMD_NEW_GROUP);
156 static void psample_group_destroy(struct psample_group *group)
158 psample_group_notify(group, PSAMPLE_CMD_DEL_GROUP);
159 list_del(&group->list);
160 kfree_rcu(group, rcu);
163 static struct psample_group *
164 psample_group_lookup(struct net *net, u32 group_num)
166 struct psample_group *group;
168 list_for_each_entry(group, &psample_groups_list, list)
169 if ((group->group_num == group_num) && (group->net == net))
174 struct psample_group *psample_group_get(struct net *net, u32 group_num)
176 struct psample_group *group;
178 spin_lock_bh(&psample_groups_lock);
180 group = psample_group_lookup(net, group_num);
182 group = psample_group_create(net, group_num);
189 spin_unlock_bh(&psample_groups_lock);
192 EXPORT_SYMBOL_GPL(psample_group_get);
194 void psample_group_take(struct psample_group *group)
196 spin_lock_bh(&psample_groups_lock);
198 spin_unlock_bh(&psample_groups_lock);
200 EXPORT_SYMBOL_GPL(psample_group_take);
202 void psample_group_put(struct psample_group *group)
204 spin_lock_bh(&psample_groups_lock);
206 if (--group->refcount == 0)
207 psample_group_destroy(group);
209 spin_unlock_bh(&psample_groups_lock);
211 EXPORT_SYMBOL_GPL(psample_group_put);
214 static int __psample_ip_tun_to_nlattr(struct sk_buff *skb,
215 struct ip_tunnel_info *tun_info)
217 unsigned short tun_proto = ip_tunnel_info_af(tun_info);
218 const void *tun_opts = ip_tunnel_info_opts(tun_info);
219 const struct ip_tunnel_key *tun_key = &tun_info->key;
220 int tun_opts_len = tun_info->options_len;
222 if (tun_key->tun_flags & TUNNEL_KEY &&
223 nla_put_be64(skb, PSAMPLE_TUNNEL_KEY_ATTR_ID, tun_key->tun_id,
224 PSAMPLE_TUNNEL_KEY_ATTR_PAD))
227 if (tun_info->mode & IP_TUNNEL_INFO_BRIDGE &&
228 nla_put_flag(skb, PSAMPLE_TUNNEL_KEY_ATTR_IPV4_INFO_BRIDGE))
233 if (tun_key->u.ipv4.src &&
234 nla_put_in_addr(skb, PSAMPLE_TUNNEL_KEY_ATTR_IPV4_SRC,
235 tun_key->u.ipv4.src))
237 if (tun_key->u.ipv4.dst &&
238 nla_put_in_addr(skb, PSAMPLE_TUNNEL_KEY_ATTR_IPV4_DST,
239 tun_key->u.ipv4.dst))
243 if (!ipv6_addr_any(&tun_key->u.ipv6.src) &&
244 nla_put_in6_addr(skb, PSAMPLE_TUNNEL_KEY_ATTR_IPV6_SRC,
245 &tun_key->u.ipv6.src))
247 if (!ipv6_addr_any(&tun_key->u.ipv6.dst) &&
248 nla_put_in6_addr(skb, PSAMPLE_TUNNEL_KEY_ATTR_IPV6_DST,
249 &tun_key->u.ipv6.dst))
254 nla_put_u8(skb, PSAMPLE_TUNNEL_KEY_ATTR_TOS, tun_key->tos))
256 if (nla_put_u8(skb, PSAMPLE_TUNNEL_KEY_ATTR_TTL, tun_key->ttl))
258 if ((tun_key->tun_flags & TUNNEL_DONT_FRAGMENT) &&
259 nla_put_flag(skb, PSAMPLE_TUNNEL_KEY_ATTR_DONT_FRAGMENT))
261 if ((tun_key->tun_flags & TUNNEL_CSUM) &&
262 nla_put_flag(skb, PSAMPLE_TUNNEL_KEY_ATTR_CSUM))
264 if (tun_key->tp_src &&
265 nla_put_be16(skb, PSAMPLE_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src))
267 if (tun_key->tp_dst &&
268 nla_put_be16(skb, PSAMPLE_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst))
270 if ((tun_key->tun_flags & TUNNEL_OAM) &&
271 nla_put_flag(skb, PSAMPLE_TUNNEL_KEY_ATTR_OAM))
274 if (tun_key->tun_flags & TUNNEL_GENEVE_OPT &&
275 nla_put(skb, PSAMPLE_TUNNEL_KEY_ATTR_GENEVE_OPTS,
276 tun_opts_len, tun_opts))
278 else if (tun_key->tun_flags & TUNNEL_ERSPAN_OPT &&
279 nla_put(skb, PSAMPLE_TUNNEL_KEY_ATTR_ERSPAN_OPTS,
280 tun_opts_len, tun_opts))
287 static int psample_ip_tun_to_nlattr(struct sk_buff *skb,
288 struct ip_tunnel_info *tun_info)
293 nla = nla_nest_start_noflag(skb, PSAMPLE_ATTR_TUNNEL);
297 err = __psample_ip_tun_to_nlattr(skb, tun_info);
299 nla_nest_cancel(skb, nla);
303 nla_nest_end(skb, nla);
308 static int psample_tunnel_meta_len(struct ip_tunnel_info *tun_info)
310 unsigned short tun_proto = ip_tunnel_info_af(tun_info);
311 const struct ip_tunnel_key *tun_key = &tun_info->key;
312 int tun_opts_len = tun_info->options_len;
313 int sum = nla_total_size(0); /* PSAMPLE_ATTR_TUNNEL */
315 if (tun_key->tun_flags & TUNNEL_KEY)
316 sum += nla_total_size_64bit(sizeof(u64));
318 if (tun_info->mode & IP_TUNNEL_INFO_BRIDGE)
319 sum += nla_total_size(0);
323 if (tun_key->u.ipv4.src)
324 sum += nla_total_size(sizeof(u32));
325 if (tun_key->u.ipv4.dst)
326 sum += nla_total_size(sizeof(u32));
329 if (!ipv6_addr_any(&tun_key->u.ipv6.src))
330 sum += nla_total_size(sizeof(struct in6_addr));
331 if (!ipv6_addr_any(&tun_key->u.ipv6.dst))
332 sum += nla_total_size(sizeof(struct in6_addr));
336 sum += nla_total_size(sizeof(u8));
337 sum += nla_total_size(sizeof(u8)); /* TTL */
338 if (tun_key->tun_flags & TUNNEL_DONT_FRAGMENT)
339 sum += nla_total_size(0);
340 if (tun_key->tun_flags & TUNNEL_CSUM)
341 sum += nla_total_size(0);
343 sum += nla_total_size(sizeof(u16));
345 sum += nla_total_size(sizeof(u16));
346 if (tun_key->tun_flags & TUNNEL_OAM)
347 sum += nla_total_size(0);
349 if (tun_key->tun_flags & TUNNEL_GENEVE_OPT)
350 sum += nla_total_size(tun_opts_len);
351 else if (tun_key->tun_flags & TUNNEL_ERSPAN_OPT)
352 sum += nla_total_size(tun_opts_len);
359 void psample_sample_packet(struct psample_group *group, struct sk_buff *skb,
360 u32 trunc_size, int in_ifindex, int out_ifindex,
364 struct ip_tunnel_info *tun_info;
366 struct sk_buff *nl_skb;
372 meta_len = (in_ifindex ? nla_total_size(sizeof(u16)) : 0) +
373 (out_ifindex ? nla_total_size(sizeof(u16)) : 0) +
374 nla_total_size(sizeof(u32)) + /* sample_rate */
375 nla_total_size(sizeof(u32)) + /* orig_size */
376 nla_total_size(sizeof(u32)) + /* group_num */
377 nla_total_size(sizeof(u32)); /* seq */
380 tun_info = skb_tunnel_info(skb);
382 meta_len += psample_tunnel_meta_len(tun_info);
385 data_len = min(skb->len, trunc_size);
386 if (meta_len + nla_total_size(data_len) > PSAMPLE_MAX_PACKET_SIZE)
387 data_len = PSAMPLE_MAX_PACKET_SIZE - meta_len - NLA_HDRLEN
390 nl_skb = genlmsg_new(meta_len + nla_total_size(data_len), GFP_ATOMIC);
391 if (unlikely(!nl_skb))
394 data = genlmsg_put(nl_skb, 0, 0, &psample_nl_family, 0,
400 ret = nla_put_u16(nl_skb, PSAMPLE_ATTR_IIFINDEX, in_ifindex);
401 if (unlikely(ret < 0))
406 ret = nla_put_u16(nl_skb, PSAMPLE_ATTR_OIFINDEX, out_ifindex);
407 if (unlikely(ret < 0))
411 ret = nla_put_u32(nl_skb, PSAMPLE_ATTR_SAMPLE_RATE, sample_rate);
412 if (unlikely(ret < 0))
415 ret = nla_put_u32(nl_skb, PSAMPLE_ATTR_ORIGSIZE, skb->len);
416 if (unlikely(ret < 0))
419 ret = nla_put_u32(nl_skb, PSAMPLE_ATTR_SAMPLE_GROUP, group->group_num);
420 if (unlikely(ret < 0))
423 ret = nla_put_u32(nl_skb, PSAMPLE_ATTR_GROUP_SEQ, group->seq++);
424 if (unlikely(ret < 0))
428 int nla_len = nla_total_size(data_len);
431 nla = skb_put(nl_skb, nla_len);
432 nla->nla_type = PSAMPLE_ATTR_DATA;
433 nla->nla_len = nla_attr_size(data_len);
435 if (skb_copy_bits(skb, 0, nla_data(nla), data_len))
441 ret = psample_ip_tun_to_nlattr(nl_skb, tun_info);
442 if (unlikely(ret < 0))
447 genlmsg_end(nl_skb, data);
448 genlmsg_multicast_netns(&psample_nl_family, group->net, nl_skb, 0,
449 PSAMPLE_NL_MCGRP_SAMPLE, GFP_ATOMIC);
453 pr_err_ratelimited("Could not create psample log message\n");
456 EXPORT_SYMBOL_GPL(psample_sample_packet);
458 static int __init psample_module_init(void)
460 return genl_register_family(&psample_nl_family);
463 static void __exit psample_module_exit(void)
465 genl_unregister_family(&psample_nl_family);
468 module_init(psample_module_init);
469 module_exit(psample_module_exit);
471 MODULE_AUTHOR("Yotam Gigi <yotam.gi@gmail.com>");
472 MODULE_DESCRIPTION("netlink channel for packet sampling");
473 MODULE_LICENSE("GPL v2");