1 /* net/tipc/udp_media.c: IP bearer support for TIPC
3 * Copyright (c) 2015, Ericsson AB
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. Neither the names of the copyright holders nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * Alternatively, this software may be distributed under the terms of the
19 * GNU General Public License ("GPL") version 2 as published by the Free
20 * Software Foundation.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
35 #include <linux/socket.h>
37 #include <linux/udp.h>
38 #include <linux/inet.h>
39 #include <linux/inetdevice.h>
40 #include <linux/igmp.h>
41 #include <linux/kernel.h>
42 #include <linux/workqueue.h>
43 #include <linux/list.h>
46 #include <net/udp_tunnel.h>
47 #include <net/addrconf.h>
48 #include <linux/tipc_netlink.h>
54 /* IANA assigned UDP port */
55 #define UDP_PORT_DEFAULT 6118
57 #define UDP_MIN_HEADROOM 48
60 * struct udp_media_addr - IP/UDP addressing information
62 * This is the bearer level originating address used in neighbor discovery
63 * messages, and all fields should be in network byte order
65 struct udp_media_addr {
74 /* struct udp_replicast - container for UDP remote addresses */
75 struct udp_replicast {
76 struct udp_media_addr addr;
78 struct list_head list;
82 * struct udp_bearer - ip/udp bearer data structure
83 * @bearer: associated generic tipc bearer
84 * @ubsock: bearer associated socket
85 * @ifindex: local address scope
86 * @work: used to schedule deferred work on a bearer
89 struct tipc_bearer __rcu *bearer;
90 struct socket *ubsock;
92 struct work_struct work;
93 struct udp_replicast rcast;
96 static int tipc_udp_is_mcast_addr(struct udp_media_addr *addr)
98 if (ntohs(addr->proto) == ETH_P_IP)
99 return ipv4_is_multicast(addr->ipv4.s_addr);
100 #if IS_ENABLED(CONFIG_IPV6)
102 return ipv6_addr_is_multicast(&addr->ipv6);
107 /* udp_media_addr_set - convert a ip/udp address to a TIPC media address */
108 static void tipc_udp_media_addr_set(struct tipc_media_addr *addr,
109 struct udp_media_addr *ua)
111 memset(addr, 0, sizeof(struct tipc_media_addr));
112 addr->media_id = TIPC_MEDIA_TYPE_UDP;
113 memcpy(addr->value, ua, sizeof(struct udp_media_addr));
115 if (tipc_udp_is_mcast_addr(ua))
119 /* tipc_udp_addr2str - convert ip/udp address to string */
120 static int tipc_udp_addr2str(struct tipc_media_addr *a, char *buf, int size)
122 struct udp_media_addr *ua = (struct udp_media_addr *)&a->value;
124 if (ntohs(ua->proto) == ETH_P_IP)
125 snprintf(buf, size, "%pI4:%u", &ua->ipv4, ntohs(ua->port));
126 else if (ntohs(ua->proto) == ETH_P_IPV6)
127 snprintf(buf, size, "%pI6:%u", &ua->ipv6, ntohs(ua->port));
129 pr_err("Invalid UDP media address\n");
133 /* tipc_udp_msg2addr - extract an ip/udp address from a TIPC ndisc message */
134 static int tipc_udp_msg2addr(struct tipc_bearer *b, struct tipc_media_addr *a,
137 struct udp_media_addr *ua;
139 ua = (struct udp_media_addr *) (msg + TIPC_MEDIA_ADDR_OFFSET);
140 if (msg[TIPC_MEDIA_TYPE_OFFSET] != TIPC_MEDIA_TYPE_UDP)
142 tipc_udp_media_addr_set(a, ua);
146 /* tipc_udp_addr2msg - write an ip/udp address to a TIPC ndisc message */
147 static int tipc_udp_addr2msg(char *msg, struct tipc_media_addr *a)
149 memset(msg, 0, TIPC_MEDIA_INFO_SIZE);
150 msg[TIPC_MEDIA_TYPE_OFFSET] = TIPC_MEDIA_TYPE_UDP;
151 memcpy(msg + TIPC_MEDIA_ADDR_OFFSET, a->value,
152 sizeof(struct udp_media_addr));
156 /* tipc_send_msg - enqueue a send request */
157 static int tipc_udp_xmit(struct net *net, struct sk_buff *skb,
158 struct udp_bearer *ub, struct udp_media_addr *src,
159 struct udp_media_addr *dst)
164 if (dst->proto == htons(ETH_P_IP)) {
166 .daddr = dst->ipv4.s_addr,
167 .saddr = src->ipv4.s_addr,
168 .flowi4_mark = skb->mark,
169 .flowi4_proto = IPPROTO_UDP
171 rt = ip_route_output_key(net, &fl);
177 ttl = ip4_dst_hoplimit(&rt->dst);
178 udp_tunnel_xmit_skb(rt, ub->ubsock->sk, skb, src->ipv4.s_addr,
179 dst->ipv4.s_addr, 0, ttl, 0, src->port,
180 dst->port, false, true);
181 #if IS_ENABLED(CONFIG_IPV6)
183 struct dst_entry *ndst;
184 struct flowi6 fl6 = {
185 .flowi6_oif = ub->ifindex,
188 .flowi6_proto = IPPROTO_UDP
190 ndst = ipv6_stub->ipv6_dst_lookup_flow(net,
197 ttl = ip6_dst_hoplimit(ndst);
198 err = udp_tunnel6_xmit_skb(ndst, ub->ubsock->sk, skb, NULL,
199 &src->ipv6, &dst->ipv6, 0, ttl, 0,
200 src->port, dst->port, false);
210 static int tipc_udp_send_msg(struct net *net, struct sk_buff *skb,
211 struct tipc_bearer *b,
212 struct tipc_media_addr *addr)
214 struct udp_media_addr *src = (struct udp_media_addr *)&b->addr.value;
215 struct udp_media_addr *dst = (struct udp_media_addr *)&addr->value;
216 struct udp_replicast *rcast;
217 struct udp_bearer *ub;
220 if (skb_headroom(skb) < UDP_MIN_HEADROOM) {
221 err = pskb_expand_head(skb, UDP_MIN_HEADROOM, 0, GFP_ATOMIC);
226 skb_set_inner_protocol(skb, htons(ETH_P_TIPC));
227 ub = rcu_dereference_rtnl(b->media_ptr);
233 if (!addr->broadcast || list_empty(&ub->rcast.list))
234 return tipc_udp_xmit(net, skb, ub, src, dst);
236 /* Replicast, send an skb to each configured IP address */
237 list_for_each_entry_rcu(rcast, &ub->rcast.list, list) {
238 struct sk_buff *_skb;
240 _skb = pskb_copy(skb, GFP_ATOMIC);
246 err = tipc_udp_xmit(net, _skb, ub, src, &rcast->addr);
256 static bool tipc_udp_is_known_peer(struct tipc_bearer *b,
257 struct udp_media_addr *addr)
259 struct udp_replicast *rcast, *tmp;
260 struct udp_bearer *ub;
262 ub = rcu_dereference_rtnl(b->media_ptr);
264 pr_err_ratelimited("UDP bearer instance not found\n");
268 list_for_each_entry_safe(rcast, tmp, &ub->rcast.list, list) {
269 if (!memcmp(&rcast->addr, addr, sizeof(struct udp_media_addr)))
276 static int tipc_udp_rcast_add(struct tipc_bearer *b,
277 struct udp_media_addr *addr)
279 struct udp_replicast *rcast;
280 struct udp_bearer *ub;
282 ub = rcu_dereference_rtnl(b->media_ptr);
286 rcast = kmalloc(sizeof(*rcast), GFP_ATOMIC);
290 memcpy(&rcast->addr, addr, sizeof(struct udp_media_addr));
292 if (ntohs(addr->proto) == ETH_P_IP)
293 pr_info("New replicast peer: %pI4\n", &rcast->addr.ipv4);
294 #if IS_ENABLED(CONFIG_IPV6)
295 else if (ntohs(addr->proto) == ETH_P_IPV6)
296 pr_info("New replicast peer: %pI6\n", &rcast->addr.ipv6);
299 list_add_rcu(&rcast->list, &ub->rcast.list);
303 static int tipc_udp_rcast_disc(struct tipc_bearer *b, struct sk_buff *skb)
305 struct udp_media_addr src = {0};
306 struct udp_media_addr *dst;
308 dst = (struct udp_media_addr *)&b->bcast_addr.value;
309 if (tipc_udp_is_mcast_addr(dst))
312 src.port = udp_hdr(skb)->source;
314 if (ip_hdr(skb)->version == 4) {
315 struct iphdr *iphdr = ip_hdr(skb);
317 src.proto = htons(ETH_P_IP);
318 src.ipv4.s_addr = iphdr->saddr;
319 if (ipv4_is_multicast(iphdr->daddr))
321 #if IS_ENABLED(CONFIG_IPV6)
322 } else if (ip_hdr(skb)->version == 6) {
323 struct ipv6hdr *iphdr = ipv6_hdr(skb);
325 src.proto = htons(ETH_P_IPV6);
326 src.ipv6 = iphdr->saddr;
327 if (ipv6_addr_is_multicast(&iphdr->daddr))
334 if (likely(tipc_udp_is_known_peer(b, &src)))
337 return tipc_udp_rcast_add(b, &src);
340 /* tipc_udp_recv - read data from bearer socket */
341 static int tipc_udp_recv(struct sock *sk, struct sk_buff *skb)
343 struct udp_bearer *ub;
344 struct tipc_bearer *b;
345 struct tipc_msg *hdr;
348 ub = rcu_dereference_sk_user_data(sk);
350 pr_err_ratelimited("Failed to get UDP bearer reference");
353 skb_pull(skb, sizeof(struct udphdr));
357 b = rcu_dereference_rtnl(ub->bearer);
361 if (b && test_bit(0, &b->up)) {
362 tipc_rcv(sock_net(sk), skb, b);
367 if (unlikely(msg_user(hdr) == LINK_CONFIG)) {
368 err = tipc_udp_rcast_disc(b, skb);
380 static int enable_mcast(struct udp_bearer *ub, struct udp_media_addr *remote)
383 struct ip_mreqn mreqn;
384 struct sock *sk = ub->ubsock->sk;
386 if (ntohs(remote->proto) == ETH_P_IP) {
387 mreqn.imr_multiaddr = remote->ipv4;
388 mreqn.imr_ifindex = ub->ifindex;
389 err = ip_mc_join_group(sk, &mreqn);
390 #if IS_ENABLED(CONFIG_IPV6)
392 err = ipv6_stub->ipv6_sock_mc_join(sk, ub->ifindex,
399 static int __tipc_nl_add_udp_addr(struct sk_buff *skb,
400 struct udp_media_addr *addr, int nla_t)
402 if (ntohs(addr->proto) == ETH_P_IP) {
403 struct sockaddr_in ip4;
405 memset(&ip4, 0, sizeof(ip4));
406 ip4.sin_family = AF_INET;
407 ip4.sin_port = addr->port;
408 ip4.sin_addr.s_addr = addr->ipv4.s_addr;
409 if (nla_put(skb, nla_t, sizeof(ip4), &ip4))
412 #if IS_ENABLED(CONFIG_IPV6)
413 } else if (ntohs(addr->proto) == ETH_P_IPV6) {
414 struct sockaddr_in6 ip6;
416 memset(&ip6, 0, sizeof(ip6));
417 ip6.sin6_family = AF_INET6;
418 ip6.sin6_port = addr->port;
419 memcpy(&ip6.sin6_addr, &addr->ipv6, sizeof(struct in6_addr));
420 if (nla_put(skb, nla_t, sizeof(ip6), &ip6))
428 int tipc_udp_nl_dump_remoteip(struct sk_buff *skb, struct netlink_callback *cb)
430 u32 bid = cb->args[0];
431 u32 skip_cnt = cb->args[1];
432 u32 portid = NETLINK_CB(cb->skb).portid;
433 struct udp_replicast *rcast, *tmp;
434 struct tipc_bearer *b;
435 struct udp_bearer *ub;
440 if (!bid && !skip_cnt) {
441 struct net *net = sock_net(skb->sk);
442 struct nlattr *battrs[TIPC_NLA_BEARER_MAX + 1];
443 struct nlattr **attrs;
446 err = tipc_nlmsg_parse(cb->nlh, &attrs);
450 if (!attrs[TIPC_NLA_BEARER])
453 err = nla_parse_nested(battrs, TIPC_NLA_BEARER_MAX,
454 attrs[TIPC_NLA_BEARER],
455 tipc_nl_bearer_policy);
459 if (!battrs[TIPC_NLA_BEARER_NAME])
462 bname = nla_data(battrs[TIPC_NLA_BEARER_NAME]);
465 b = tipc_bearer_find(net, bname);
472 struct net *net = sock_net(skb->sk);
473 struct tipc_net *tn = net_generic(net, tipc_net_id);
476 b = rtnl_dereference(tn->bearer_list[bid]);
483 ub = rcu_dereference_rtnl(b->media_ptr);
490 list_for_each_entry_safe(rcast, tmp, &ub->rcast.list, list) {
494 hdr = genlmsg_put(skb, portid, cb->nlh->nlmsg_seq,
495 &tipc_genl_family, NLM_F_MULTI,
500 err = __tipc_nl_add_udp_addr(skb, &rcast->addr,
501 TIPC_NLA_UDP_REMOTE);
503 genlmsg_cancel(skb, hdr);
506 genlmsg_end(skb, hdr);
518 int tipc_udp_nl_add_bearer_data(struct tipc_nl_msg *msg, struct tipc_bearer *b)
520 struct udp_media_addr *src = (struct udp_media_addr *)&b->addr.value;
521 struct udp_media_addr *dst;
522 struct udp_bearer *ub;
525 ub = rcu_dereference_rtnl(b->media_ptr);
529 nest = nla_nest_start(msg->skb, TIPC_NLA_BEARER_UDP_OPTS);
533 if (__tipc_nl_add_udp_addr(msg->skb, src, TIPC_NLA_UDP_LOCAL))
536 dst = (struct udp_media_addr *)&b->bcast_addr.value;
537 if (__tipc_nl_add_udp_addr(msg->skb, dst, TIPC_NLA_UDP_REMOTE))
540 if (!list_empty(&ub->rcast.list)) {
541 if (nla_put_flag(msg->skb, TIPC_NLA_UDP_MULTI_REMOTEIP))
545 nla_nest_end(msg->skb, nest);
548 nla_nest_cancel(msg->skb, nest);
553 * tipc_parse_udp_addr - build udp media address from netlink data
554 * @nlattr: netlink attribute containing sockaddr storage aligned address
555 * @addr: tipc media address to fill with address, port and protocol type
556 * @scope_id: IPv6 scope id pointer, not NULL indicates it's required
559 static int tipc_parse_udp_addr(struct nlattr *nla, struct udp_media_addr *addr,
562 struct sockaddr_storage sa;
564 nla_memcpy(&sa, nla, sizeof(sa));
565 if (sa.ss_family == AF_INET) {
566 struct sockaddr_in *ip4 = (struct sockaddr_in *)&sa;
568 addr->proto = htons(ETH_P_IP);
569 addr->port = ip4->sin_port;
570 addr->ipv4.s_addr = ip4->sin_addr.s_addr;
573 #if IS_ENABLED(CONFIG_IPV6)
574 } else if (sa.ss_family == AF_INET6) {
575 struct sockaddr_in6 *ip6 = (struct sockaddr_in6 *)&sa;
577 addr->proto = htons(ETH_P_IPV6);
578 addr->port = ip6->sin6_port;
579 memcpy(&addr->ipv6, &ip6->sin6_addr, sizeof(struct in6_addr));
581 /* Scope ID is only interesting for local addresses */
585 atype = ipv6_addr_type(&ip6->sin6_addr);
586 if (__ipv6_addr_needs_scope_id(atype) &&
587 !ip6->sin6_scope_id) {
591 *scope_id = ip6->sin6_scope_id ? : 0;
597 return -EADDRNOTAVAIL;
600 int tipc_udp_nl_bearer_add(struct tipc_bearer *b, struct nlattr *attr)
603 struct udp_media_addr addr = {0};
604 struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
605 struct udp_media_addr *dst;
607 if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX, attr, tipc_nl_udp_policy))
610 if (!opts[TIPC_NLA_UDP_REMOTE])
613 err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_REMOTE], &addr, NULL);
617 dst = (struct udp_media_addr *)&b->bcast_addr.value;
618 if (tipc_udp_is_mcast_addr(dst)) {
619 pr_err("Can't add remote ip to TIPC UDP multicast bearer\n");
623 if (tipc_udp_is_known_peer(b, &addr))
626 return tipc_udp_rcast_add(b, &addr);
630 * tipc_udp_enable - callback to create a new udp bearer instance
631 * @net: network namespace
632 * @b: pointer to generic tipc_bearer
633 * @attrs: netlink bearer configuration
635 * validate the bearer parameters and initialize the udp bearer
636 * rtnl_lock should be held
638 static int tipc_udp_enable(struct net *net, struct tipc_bearer *b,
639 struct nlattr *attrs[])
642 struct udp_bearer *ub;
643 struct udp_media_addr remote = {0};
644 struct udp_media_addr local = {0};
645 struct udp_port_cfg udp_conf = {0};
646 struct udp_tunnel_sock_cfg tuncfg = {NULL};
647 struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
649 ub = kzalloc(sizeof(*ub), GFP_ATOMIC);
653 INIT_LIST_HEAD(&ub->rcast.list);
655 if (!attrs[TIPC_NLA_BEARER_UDP_OPTS])
658 if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX,
659 attrs[TIPC_NLA_BEARER_UDP_OPTS],
663 if (!opts[TIPC_NLA_UDP_LOCAL] || !opts[TIPC_NLA_UDP_REMOTE]) {
664 pr_err("Invalid UDP bearer configuration");
669 err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_LOCAL], &local,
674 err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_REMOTE], &remote, NULL);
678 if (remote.proto != local.proto) {
683 b->bcast_addr.media_id = TIPC_MEDIA_TYPE_UDP;
684 b->bcast_addr.broadcast = 1;
685 rcu_assign_pointer(b->media_ptr, ub);
686 rcu_assign_pointer(ub->bearer, b);
687 tipc_udp_media_addr_set(&b->addr, &local);
688 if (local.proto == htons(ETH_P_IP)) {
689 struct net_device *dev;
691 dev = __ip_dev_find(net, local.ipv4.s_addr, false);
696 udp_conf.family = AF_INET;
697 udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
698 udp_conf.use_udp_checksums = false;
699 ub->ifindex = dev->ifindex;
700 if (tipc_mtu_bad(dev, sizeof(struct iphdr) +
701 sizeof(struct udphdr))) {
705 b->mtu = dev->mtu - sizeof(struct iphdr)
706 - sizeof(struct udphdr);
707 #if IS_ENABLED(CONFIG_IPV6)
708 } else if (local.proto == htons(ETH_P_IPV6)) {
709 udp_conf.family = AF_INET6;
710 udp_conf.use_udp6_tx_checksums = true;
711 udp_conf.use_udp6_rx_checksums = true;
712 udp_conf.local_ip6 = in6addr_any;
719 udp_conf.local_udp_port = local.port;
720 err = udp_sock_create(net, &udp_conf, &ub->ubsock);
723 tuncfg.sk_user_data = ub;
724 tuncfg.encap_type = 1;
725 tuncfg.encap_rcv = tipc_udp_recv;
726 tuncfg.encap_destroy = NULL;
727 setup_udp_tunnel_sock(net, ub->ubsock, &tuncfg);
730 * The bcast media address port is used for all peers and the ip
731 * is used if it's a multicast address.
733 memcpy(&b->bcast_addr.value, &remote, sizeof(remote));
734 if (tipc_udp_is_mcast_addr(&remote))
735 err = enable_mcast(ub, &remote);
737 err = tipc_udp_rcast_add(b, &remote);
744 udp_tunnel_sock_release(ub->ubsock);
749 /* cleanup_bearer - break the socket/bearer association */
750 static void cleanup_bearer(struct work_struct *work)
752 struct udp_bearer *ub = container_of(work, struct udp_bearer, work);
753 struct udp_replicast *rcast, *tmp;
755 list_for_each_entry_safe(rcast, tmp, &ub->rcast.list, list) {
756 list_del_rcu(&rcast->list);
757 kfree_rcu(rcast, rcu);
761 udp_tunnel_sock_release(ub->ubsock);
766 /* tipc_udp_disable - detach bearer from socket */
767 static void tipc_udp_disable(struct tipc_bearer *b)
769 struct udp_bearer *ub;
771 ub = rcu_dereference_rtnl(b->media_ptr);
773 pr_err("UDP bearer instance not found\n");
777 sock_set_flag(ub->ubsock->sk, SOCK_DEAD);
778 RCU_INIT_POINTER(ub->bearer, NULL);
780 /* sock_release need to be done outside of rtnl lock */
781 INIT_WORK(&ub->work, cleanup_bearer);
782 schedule_work(&ub->work);
785 struct tipc_media udp_media_info = {
786 .send_msg = tipc_udp_send_msg,
787 .enable_media = tipc_udp_enable,
788 .disable_media = tipc_udp_disable,
789 .addr2str = tipc_udp_addr2str,
790 .addr2msg = tipc_udp_addr2msg,
791 .msg2addr = tipc_udp_msg2addr,
792 .priority = TIPC_DEF_LINK_PRI,
793 .tolerance = TIPC_DEF_LINK_TOL,
794 .window = TIPC_DEF_LINK_WIN,
795 .type_id = TIPC_MEDIA_TYPE_UDP,