1 // SPDX-License-Identifier: GPL-2.0
2 /* Bareudp: UDP tunnel encasulation for different Payload types like
4 * Copyright (c) 2019 Nokia, Inc.
5 * Authors: Martin Varghese, <martin.varghese@nokia.com>
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/etherdevice.h>
13 #include <linux/hash.h>
14 #include <net/dst_metadata.h>
15 #include <net/gro_cells.h>
16 #include <net/rtnetlink.h>
17 #include <net/protocol.h>
18 #include <net/ip6_tunnel.h>
19 #include <net/ip_tunnels.h>
20 #include <net/udp_tunnel.h>
21 #include <net/bareudp.h>
23 #define BAREUDP_BASE_HLEN sizeof(struct udphdr)
24 #define BAREUDP_IPV4_HLEN (sizeof(struct iphdr) + \
25 sizeof(struct udphdr))
26 #define BAREUDP_IPV6_HLEN (sizeof(struct ipv6hdr) + \
27 sizeof(struct udphdr))
29 static bool log_ecn_error = true;
30 module_param(log_ecn_error, bool, 0644);
31 MODULE_PARM_DESC(log_ecn_error, "Log packets received with corrupted ECN");
33 /* per-network namespace private data for this module */
35 static unsigned int bareudp_net_id;
38 struct list_head bareudp_list;
41 /* Pseudo network device */
43 struct net *net; /* netns for packet i/o */
44 struct net_device *dev; /* netdev for bareudp tunnel */
48 bool multi_proto_mode;
49 struct socket __rcu *sock;
50 struct list_head next; /* bareudp node on namespace list */
51 struct gro_cells gro_cells;
54 static int bareudp_udp_encap_recv(struct sock *sk, struct sk_buff *skb)
56 struct metadata_dst *tun_dst = NULL;
57 struct bareudp_dev *bareudp;
58 unsigned short family;
64 bareudp = rcu_dereference_sk_user_data(sk);
68 if (skb->protocol == htons(ETH_P_IP))
73 if (bareudp->ethertype == htons(ETH_P_IP)) {
76 iphdr = (struct iphdr *)(skb->data + BAREUDP_BASE_HLEN);
77 if (iphdr->version == 4) {
78 proto = bareudp->ethertype;
79 } else if (bareudp->multi_proto_mode && (iphdr->version == 6)) {
80 proto = htons(ETH_P_IPV6);
82 bareudp->dev->stats.rx_dropped++;
85 } else if (bareudp->ethertype == htons(ETH_P_MPLS_UC)) {
86 struct iphdr *tunnel_hdr;
88 tunnel_hdr = (struct iphdr *)skb_network_header(skb);
89 if (tunnel_hdr->version == 4) {
90 if (!ipv4_is_multicast(tunnel_hdr->daddr)) {
91 proto = bareudp->ethertype;
92 } else if (bareudp->multi_proto_mode &&
93 ipv4_is_multicast(tunnel_hdr->daddr)) {
94 proto = htons(ETH_P_MPLS_MC);
96 bareudp->dev->stats.rx_dropped++;
101 struct ipv6hdr *tunnel_hdr_v6;
103 tunnel_hdr_v6 = (struct ipv6hdr *)skb_network_header(skb);
105 ipv6_addr_type((struct in6_addr *)&tunnel_hdr_v6->daddr);
106 if (!(addr_type & IPV6_ADDR_MULTICAST)) {
107 proto = bareudp->ethertype;
108 } else if (bareudp->multi_proto_mode &&
109 (addr_type & IPV6_ADDR_MULTICAST)) {
110 proto = htons(ETH_P_MPLS_MC);
112 bareudp->dev->stats.rx_dropped++;
117 proto = bareudp->ethertype;
120 if (iptunnel_pull_header(skb, BAREUDP_BASE_HLEN,
122 !net_eq(bareudp->net,
123 dev_net(bareudp->dev)))) {
124 bareudp->dev->stats.rx_dropped++;
127 tun_dst = udp_tun_rx_dst(skb, family, TUNNEL_KEY, 0, 0);
129 bareudp->dev->stats.rx_dropped++;
132 skb_dst_set(skb, &tun_dst->dst);
133 skb->dev = bareudp->dev;
134 oiph = skb_network_header(skb);
135 skb_reset_network_header(skb);
137 if (!IS_ENABLED(CONFIG_IPV6) || family == AF_INET)
138 err = IP_ECN_decapsulate(oiph, skb);
140 err = IP6_ECN_decapsulate(oiph, skb);
144 if (!IS_ENABLED(CONFIG_IPV6) || family == AF_INET)
145 net_info_ratelimited("non-ECT from %pI4 "
147 &((struct iphdr *)oiph)->saddr,
148 ((struct iphdr *)oiph)->tos);
150 net_info_ratelimited("non-ECT from %pI6\n",
151 &((struct ipv6hdr *)oiph)->saddr);
154 ++bareudp->dev->stats.rx_frame_errors;
155 ++bareudp->dev->stats.rx_errors;
161 err = gro_cells_receive(&bareudp->gro_cells, skb);
162 if (likely(err == NET_RX_SUCCESS))
163 dev_sw_netstats_rx_add(bareudp->dev, len);
167 /* Consume bad packet */
173 static int bareudp_err_lookup(struct sock *sk, struct sk_buff *skb)
178 static int bareudp_init(struct net_device *dev)
180 struct bareudp_dev *bareudp = netdev_priv(dev);
183 dev->tstats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
187 err = gro_cells_init(&bareudp->gro_cells, dev);
189 free_percpu(dev->tstats);
195 static void bareudp_uninit(struct net_device *dev)
197 struct bareudp_dev *bareudp = netdev_priv(dev);
199 gro_cells_destroy(&bareudp->gro_cells);
200 free_percpu(dev->tstats);
203 static struct socket *bareudp_create_sock(struct net *net, __be16 port)
205 struct udp_port_cfg udp_conf;
209 memset(&udp_conf, 0, sizeof(udp_conf));
210 #if IS_ENABLED(CONFIG_IPV6)
211 udp_conf.family = AF_INET6;
213 udp_conf.family = AF_INET;
215 udp_conf.local_udp_port = port;
216 /* Open UDP socket */
217 err = udp_sock_create(net, &udp_conf, &sock);
224 /* Create new listen socket if needed */
225 static int bareudp_socket_create(struct bareudp_dev *bareudp, __be16 port)
227 struct udp_tunnel_sock_cfg tunnel_cfg;
230 sock = bareudp_create_sock(bareudp->net, port);
232 return PTR_ERR(sock);
234 /* Mark socket as an encapsulation socket */
235 memset(&tunnel_cfg, 0, sizeof(tunnel_cfg));
236 tunnel_cfg.sk_user_data = bareudp;
237 tunnel_cfg.encap_type = 1;
238 tunnel_cfg.encap_rcv = bareudp_udp_encap_recv;
239 tunnel_cfg.encap_err_lookup = bareudp_err_lookup;
240 tunnel_cfg.encap_destroy = NULL;
241 setup_udp_tunnel_sock(bareudp->net, sock, &tunnel_cfg);
243 /* As the setup_udp_tunnel_sock does not call udp_encap_enable if the
244 * socket type is v6 an explicit call to udp_encap_enable is needed.
246 if (sock->sk->sk_family == AF_INET6)
249 rcu_assign_pointer(bareudp->sock, sock);
253 static int bareudp_open(struct net_device *dev)
255 struct bareudp_dev *bareudp = netdev_priv(dev);
258 ret = bareudp_socket_create(bareudp, bareudp->port);
262 static void bareudp_sock_release(struct bareudp_dev *bareudp)
266 sock = bareudp->sock;
267 rcu_assign_pointer(bareudp->sock, NULL);
269 udp_tunnel_sock_release(sock);
272 static int bareudp_stop(struct net_device *dev)
274 struct bareudp_dev *bareudp = netdev_priv(dev);
276 bareudp_sock_release(bareudp);
280 static int bareudp_xmit_skb(struct sk_buff *skb, struct net_device *dev,
281 struct bareudp_dev *bareudp,
282 const struct ip_tunnel_info *info)
284 bool xnet = !net_eq(bareudp->net, dev_net(bareudp->dev));
285 bool use_cache = ip_tunnel_dst_cache_usable(skb, info);
286 struct socket *sock = rcu_dereference(bareudp->sock);
287 bool udp_sum = !!(info->key.tun_flags & TUNNEL_CSUM);
288 const struct ip_tunnel_key *key = &info->key;
299 rt = ip_route_output_tunnel(skb, dev, bareudp->net, &saddr, info,
300 IPPROTO_UDP, use_cache);
305 skb_tunnel_check_pmtu(skb, &rt->dst,
306 BAREUDP_IPV4_HLEN + info->options_len, false);
308 sport = udp_flow_src_port(bareudp->net, skb,
309 bareudp->sport_min, USHRT_MAX,
311 tos = ip_tunnel_ecn_encap(key->tos, ip_hdr(skb), skb);
313 df = key->tun_flags & TUNNEL_DONT_FRAGMENT ? htons(IP_DF) : 0;
314 skb_scrub_packet(skb, xnet);
317 if (!skb_pull(skb, skb_network_offset(skb)))
320 min_headroom = LL_RESERVED_SPACE(rt->dst.dev) + rt->dst.header_len +
321 BAREUDP_BASE_HLEN + info->options_len + sizeof(struct iphdr);
323 err = skb_cow_head(skb, min_headroom);
327 err = udp_tunnel_handle_offloads(skb, udp_sum);
331 skb_set_inner_protocol(skb, bareudp->ethertype);
332 udp_tunnel_xmit_skb(rt, sock->sk, skb, saddr, info->key.u.ipv4.dst,
333 tos, ttl, df, sport, bareudp->port,
334 !net_eq(bareudp->net, dev_net(bareudp->dev)),
335 !(info->key.tun_flags & TUNNEL_CSUM));
339 dst_release(&rt->dst);
343 static int bareudp6_xmit_skb(struct sk_buff *skb, struct net_device *dev,
344 struct bareudp_dev *bareudp,
345 const struct ip_tunnel_info *info)
347 bool xnet = !net_eq(bareudp->net, dev_net(bareudp->dev));
348 bool use_cache = ip_tunnel_dst_cache_usable(skb, info);
349 struct socket *sock = rcu_dereference(bareudp->sock);
350 bool udp_sum = !!(info->key.tun_flags & TUNNEL_CSUM);
351 const struct ip_tunnel_key *key = &info->key;
352 struct dst_entry *dst = NULL;
353 struct in6_addr saddr, daddr;
362 dst = ip6_dst_lookup_tunnel(skb, dev, bareudp->net, sock, &saddr, info,
363 IPPROTO_UDP, use_cache);
367 skb_tunnel_check_pmtu(skb, dst, BAREUDP_IPV6_HLEN + info->options_len,
370 sport = udp_flow_src_port(bareudp->net, skb,
371 bareudp->sport_min, USHRT_MAX,
373 prio = ip_tunnel_ecn_encap(key->tos, ip_hdr(skb), skb);
376 skb_scrub_packet(skb, xnet);
379 if (!skb_pull(skb, skb_network_offset(skb)))
382 min_headroom = LL_RESERVED_SPACE(dst->dev) + dst->header_len +
383 BAREUDP_BASE_HLEN + info->options_len + sizeof(struct iphdr);
385 err = skb_cow_head(skb, min_headroom);
389 err = udp_tunnel_handle_offloads(skb, udp_sum);
393 daddr = info->key.u.ipv6.dst;
394 udp_tunnel6_xmit_skb(dst, sock->sk, skb, dev,
395 &saddr, &daddr, prio, ttl,
396 info->key.label, sport, bareudp->port,
397 !(info->key.tun_flags & TUNNEL_CSUM));
405 static bool bareudp_proto_valid(struct bareudp_dev *bareudp, __be16 proto)
407 if (bareudp->ethertype == proto)
410 if (!bareudp->multi_proto_mode)
413 if (bareudp->ethertype == htons(ETH_P_MPLS_UC) &&
414 proto == htons(ETH_P_MPLS_MC))
417 if (bareudp->ethertype == htons(ETH_P_IP) &&
418 proto == htons(ETH_P_IPV6))
424 static netdev_tx_t bareudp_xmit(struct sk_buff *skb, struct net_device *dev)
426 struct bareudp_dev *bareudp = netdev_priv(dev);
427 struct ip_tunnel_info *info = NULL;
430 if (!bareudp_proto_valid(bareudp, skb->protocol)) {
435 info = skb_tunnel_info(skb);
436 if (unlikely(!info || !(info->mode & IP_TUNNEL_INFO_TX))) {
442 if (IS_ENABLED(CONFIG_IPV6) && info->mode & IP_TUNNEL_INFO_IPV6)
443 err = bareudp6_xmit_skb(skb, dev, bareudp, info);
445 err = bareudp_xmit_skb(skb, dev, bareudp, info);
455 dev->stats.collisions++;
456 else if (err == -ENETUNREACH)
457 dev->stats.tx_carrier_errors++;
459 dev->stats.tx_errors++;
463 static int bareudp_fill_metadata_dst(struct net_device *dev,
466 struct ip_tunnel_info *info = skb_tunnel_info(skb);
467 struct bareudp_dev *bareudp = netdev_priv(dev);
470 use_cache = ip_tunnel_dst_cache_usable(skb, info);
472 if (!IS_ENABLED(CONFIG_IPV6) || ip_tunnel_info_af(info) == AF_INET) {
476 rt = ip_route_output_tunnel(skb, dev, bareudp->net, &saddr,
477 info, IPPROTO_UDP, use_cache);
482 info->key.u.ipv4.src = saddr;
483 } else if (ip_tunnel_info_af(info) == AF_INET6) {
484 struct dst_entry *dst;
485 struct in6_addr saddr;
486 struct socket *sock = rcu_dereference(bareudp->sock);
488 dst = ip6_dst_lookup_tunnel(skb, dev, bareudp->net, sock,
489 &saddr, info, IPPROTO_UDP,
495 info->key.u.ipv6.src = saddr;
500 info->key.tp_src = udp_flow_src_port(bareudp->net, skb,
503 info->key.tp_dst = bareudp->port;
507 static const struct net_device_ops bareudp_netdev_ops = {
508 .ndo_init = bareudp_init,
509 .ndo_uninit = bareudp_uninit,
510 .ndo_open = bareudp_open,
511 .ndo_stop = bareudp_stop,
512 .ndo_start_xmit = bareudp_xmit,
513 .ndo_get_stats64 = dev_get_tstats64,
514 .ndo_fill_metadata_dst = bareudp_fill_metadata_dst,
517 static const struct nla_policy bareudp_policy[IFLA_BAREUDP_MAX + 1] = {
518 [IFLA_BAREUDP_PORT] = { .type = NLA_U16 },
519 [IFLA_BAREUDP_ETHERTYPE] = { .type = NLA_U16 },
520 [IFLA_BAREUDP_SRCPORT_MIN] = { .type = NLA_U16 },
521 [IFLA_BAREUDP_MULTIPROTO_MODE] = { .type = NLA_FLAG },
524 /* Info for udev, that this is a virtual tunnel endpoint */
525 static const struct device_type bareudp_type = {
529 /* Initialize the device structure. */
530 static void bareudp_setup(struct net_device *dev)
532 dev->netdev_ops = &bareudp_netdev_ops;
533 dev->needs_free_netdev = true;
534 SET_NETDEV_DEVTYPE(dev, &bareudp_type);
535 dev->features |= NETIF_F_SG | NETIF_F_HW_CSUM;
536 dev->features |= NETIF_F_RXCSUM;
537 dev->features |= NETIF_F_GSO_SOFTWARE;
538 dev->hw_features |= NETIF_F_SG | NETIF_F_HW_CSUM | NETIF_F_RXCSUM;
539 dev->hw_features |= NETIF_F_GSO_SOFTWARE;
540 dev->hard_header_len = 0;
542 dev->mtu = ETH_DATA_LEN;
543 dev->min_mtu = IPV4_MIN_MTU;
544 dev->max_mtu = IP_MAX_MTU - BAREUDP_BASE_HLEN;
545 dev->type = ARPHRD_NONE;
547 dev->priv_flags |= IFF_NO_QUEUE;
548 dev->flags = IFF_POINTOPOINT | IFF_NOARP | IFF_MULTICAST;
551 static int bareudp_validate(struct nlattr *tb[], struct nlattr *data[],
552 struct netlink_ext_ack *extack)
555 NL_SET_ERR_MSG(extack,
556 "Not enough attributes provided to perform the operation");
562 static int bareudp2info(struct nlattr *data[], struct bareudp_conf *conf,
563 struct netlink_ext_ack *extack)
565 memset(conf, 0, sizeof(*conf));
567 if (!data[IFLA_BAREUDP_PORT]) {
568 NL_SET_ERR_MSG(extack, "port not specified");
571 if (!data[IFLA_BAREUDP_ETHERTYPE]) {
572 NL_SET_ERR_MSG(extack, "ethertype not specified");
576 if (data[IFLA_BAREUDP_PORT])
577 conf->port = nla_get_u16(data[IFLA_BAREUDP_PORT]);
579 if (data[IFLA_BAREUDP_ETHERTYPE])
580 conf->ethertype = nla_get_u16(data[IFLA_BAREUDP_ETHERTYPE]);
582 if (data[IFLA_BAREUDP_SRCPORT_MIN])
583 conf->sport_min = nla_get_u16(data[IFLA_BAREUDP_SRCPORT_MIN]);
585 if (data[IFLA_BAREUDP_MULTIPROTO_MODE])
586 conf->multi_proto_mode = true;
591 static struct bareudp_dev *bareudp_find_dev(struct bareudp_net *bn,
592 const struct bareudp_conf *conf)
594 struct bareudp_dev *bareudp, *t = NULL;
596 list_for_each_entry(bareudp, &bn->bareudp_list, next) {
597 if (conf->port == bareudp->port)
603 static int bareudp_configure(struct net *net, struct net_device *dev,
604 struct bareudp_conf *conf)
606 struct bareudp_net *bn = net_generic(net, bareudp_net_id);
607 struct bareudp_dev *t, *bareudp = netdev_priv(dev);
612 t = bareudp_find_dev(bn, conf);
616 if (conf->multi_proto_mode &&
617 (conf->ethertype != htons(ETH_P_MPLS_UC) &&
618 conf->ethertype != htons(ETH_P_IP)))
621 bareudp->port = conf->port;
622 bareudp->ethertype = conf->ethertype;
623 bareudp->sport_min = conf->sport_min;
624 bareudp->multi_proto_mode = conf->multi_proto_mode;
626 err = register_netdevice(dev);
630 list_add(&bareudp->next, &bn->bareudp_list);
634 static int bareudp_link_config(struct net_device *dev,
640 err = dev_set_mtu(dev, nla_get_u32(tb[IFLA_MTU]));
647 static int bareudp_newlink(struct net *net, struct net_device *dev,
648 struct nlattr *tb[], struct nlattr *data[],
649 struct netlink_ext_ack *extack)
651 struct bareudp_conf conf;
654 err = bareudp2info(data, &conf, extack);
658 err = bareudp_configure(net, dev, &conf);
662 err = bareudp_link_config(dev, tb);
669 static void bareudp_dellink(struct net_device *dev, struct list_head *head)
671 struct bareudp_dev *bareudp = netdev_priv(dev);
673 list_del(&bareudp->next);
674 unregister_netdevice_queue(dev, head);
677 static size_t bareudp_get_size(const struct net_device *dev)
679 return nla_total_size(sizeof(__be16)) + /* IFLA_BAREUDP_PORT */
680 nla_total_size(sizeof(__be16)) + /* IFLA_BAREUDP_ETHERTYPE */
681 nla_total_size(sizeof(__u16)) + /* IFLA_BAREUDP_SRCPORT_MIN */
682 nla_total_size(0) + /* IFLA_BAREUDP_MULTIPROTO_MODE */
686 static int bareudp_fill_info(struct sk_buff *skb, const struct net_device *dev)
688 struct bareudp_dev *bareudp = netdev_priv(dev);
690 if (nla_put_be16(skb, IFLA_BAREUDP_PORT, bareudp->port))
691 goto nla_put_failure;
692 if (nla_put_be16(skb, IFLA_BAREUDP_ETHERTYPE, bareudp->ethertype))
693 goto nla_put_failure;
694 if (nla_put_u16(skb, IFLA_BAREUDP_SRCPORT_MIN, bareudp->sport_min))
695 goto nla_put_failure;
696 if (bareudp->multi_proto_mode &&
697 nla_put_flag(skb, IFLA_BAREUDP_MULTIPROTO_MODE))
698 goto nla_put_failure;
706 static struct rtnl_link_ops bareudp_link_ops __read_mostly = {
708 .maxtype = IFLA_BAREUDP_MAX,
709 .policy = bareudp_policy,
710 .priv_size = sizeof(struct bareudp_dev),
711 .setup = bareudp_setup,
712 .validate = bareudp_validate,
713 .newlink = bareudp_newlink,
714 .dellink = bareudp_dellink,
715 .get_size = bareudp_get_size,
716 .fill_info = bareudp_fill_info,
719 struct net_device *bareudp_dev_create(struct net *net, const char *name,
721 struct bareudp_conf *conf)
723 struct nlattr *tb[IFLA_MAX + 1];
724 struct net_device *dev;
725 LIST_HEAD(list_kill);
728 memset(tb, 0, sizeof(tb));
729 dev = rtnl_create_link(net, name, name_assign_type,
730 &bareudp_link_ops, tb, NULL);
734 err = bareudp_configure(net, dev, conf);
739 err = dev_set_mtu(dev, IP_MAX_MTU - BAREUDP_BASE_HLEN);
743 err = rtnl_configure_link(dev, NULL);
749 bareudp_dellink(dev, &list_kill);
750 unregister_netdevice_many(&list_kill);
753 EXPORT_SYMBOL_GPL(bareudp_dev_create);
755 static __net_init int bareudp_init_net(struct net *net)
757 struct bareudp_net *bn = net_generic(net, bareudp_net_id);
759 INIT_LIST_HEAD(&bn->bareudp_list);
763 static void bareudp_destroy_tunnels(struct net *net, struct list_head *head)
765 struct bareudp_net *bn = net_generic(net, bareudp_net_id);
766 struct bareudp_dev *bareudp, *next;
768 list_for_each_entry_safe(bareudp, next, &bn->bareudp_list, next)
769 unregister_netdevice_queue(bareudp->dev, head);
772 static void __net_exit bareudp_exit_batch_net(struct list_head *net_list)
778 list_for_each_entry(net, net_list, exit_list)
779 bareudp_destroy_tunnels(net, &list);
781 /* unregister the devices gathered above */
782 unregister_netdevice_many(&list);
786 static struct pernet_operations bareudp_net_ops = {
787 .init = bareudp_init_net,
788 .exit_batch = bareudp_exit_batch_net,
789 .id = &bareudp_net_id,
790 .size = sizeof(struct bareudp_net),
793 static int __init bareudp_init_module(void)
797 rc = register_pernet_subsys(&bareudp_net_ops);
801 rc = rtnl_link_register(&bareudp_link_ops);
807 unregister_pernet_subsys(&bareudp_net_ops);
811 late_initcall(bareudp_init_module);
813 static void __exit bareudp_cleanup_module(void)
815 rtnl_link_unregister(&bareudp_link_ops);
816 unregister_pernet_subsys(&bareudp_net_ops);
818 module_exit(bareudp_cleanup_module);
820 MODULE_ALIAS_RTNL_LINK("bareudp");
821 MODULE_LICENSE("GPL");
822 MODULE_AUTHOR("Martin Varghese <martin.varghese@nokia.com>");
823 MODULE_DESCRIPTION("Interface driver for UDP encapsulated traffic");