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 skb->dev = rt->dst.dev;
178 ttl = ip4_dst_hoplimit(&rt->dst);
179 udp_tunnel_xmit_skb(rt, ub->ubsock->sk, skb, src->ipv4.s_addr,
180 dst->ipv4.s_addr, 0, ttl, 0, src->port,
181 dst->port, false, true);
182 #if IS_ENABLED(CONFIG_IPV6)
184 struct dst_entry *ndst;
185 struct flowi6 fl6 = {
186 .flowi6_oif = ub->ifindex,
189 .flowi6_proto = IPPROTO_UDP
191 err = ipv6_stub->ipv6_dst_lookup(net, ub->ubsock->sk, &ndst,
195 ttl = ip6_dst_hoplimit(ndst);
196 err = udp_tunnel6_xmit_skb(ndst, ub->ubsock->sk, skb,
197 ndst->dev, &src->ipv6,
198 &dst->ipv6, 0, ttl, 0, src->port,
209 static int tipc_udp_send_msg(struct net *net, struct sk_buff *skb,
210 struct tipc_bearer *b,
211 struct tipc_media_addr *addr)
213 struct udp_media_addr *src = (struct udp_media_addr *)&b->addr.value;
214 struct udp_media_addr *dst = (struct udp_media_addr *)&addr->value;
215 struct udp_replicast *rcast;
216 struct udp_bearer *ub;
219 if (skb_headroom(skb) < UDP_MIN_HEADROOM) {
220 err = pskb_expand_head(skb, UDP_MIN_HEADROOM, 0, GFP_ATOMIC);
225 skb_set_inner_protocol(skb, htons(ETH_P_TIPC));
226 ub = rcu_dereference_rtnl(b->media_ptr);
232 if (!addr->broadcast || list_empty(&ub->rcast.list))
233 return tipc_udp_xmit(net, skb, ub, src, dst);
235 /* Replicast, send an skb to each configured IP address */
236 list_for_each_entry_rcu(rcast, &ub->rcast.list, list) {
237 struct sk_buff *_skb;
239 _skb = pskb_copy(skb, GFP_ATOMIC);
245 err = tipc_udp_xmit(net, _skb, ub, src, &rcast->addr);
257 static int tipc_udp_rcast_add(struct tipc_bearer *b,
258 struct udp_media_addr *addr)
260 struct udp_replicast *rcast;
261 struct udp_bearer *ub;
263 ub = rcu_dereference_rtnl(b->media_ptr);
267 rcast = kmalloc(sizeof(*rcast), GFP_ATOMIC);
271 memcpy(&rcast->addr, addr, sizeof(struct udp_media_addr));
273 if (ntohs(addr->proto) == ETH_P_IP)
274 pr_info("New replicast peer: %pI4\n", &rcast->addr.ipv4);
275 #if IS_ENABLED(CONFIG_IPV6)
276 else if (ntohs(addr->proto) == ETH_P_IPV6)
277 pr_info("New replicast peer: %pI6\n", &rcast->addr.ipv6);
280 list_add_rcu(&rcast->list, &ub->rcast.list);
284 /* tipc_udp_recv - read data from bearer socket */
285 static int tipc_udp_recv(struct sock *sk, struct sk_buff *skb)
287 struct udp_bearer *ub;
288 struct tipc_bearer *b;
290 ub = rcu_dereference_sk_user_data(sk);
292 pr_err_ratelimited("Failed to get UDP bearer reference");
297 skb_pull(skb, sizeof(struct udphdr));
299 b = rcu_dereference_rtnl(ub->bearer);
301 if (b && test_bit(0, &b->up)) {
302 tipc_rcv(sock_net(sk), skb, b);
311 static int enable_mcast(struct udp_bearer *ub, struct udp_media_addr *remote)
314 struct ip_mreqn mreqn;
315 struct sock *sk = ub->ubsock->sk;
317 if (ntohs(remote->proto) == ETH_P_IP) {
318 mreqn.imr_multiaddr = remote->ipv4;
319 mreqn.imr_ifindex = ub->ifindex;
320 err = ip_mc_join_group(sk, &mreqn);
321 #if IS_ENABLED(CONFIG_IPV6)
323 err = ipv6_stub->ipv6_sock_mc_join(sk, ub->ifindex,
331 * tipc_parse_udp_addr - build udp media address from netlink data
332 * @nlattr: netlink attribute containing sockaddr storage aligned address
333 * @addr: tipc media address to fill with address, port and protocol type
334 * @scope_id: IPv6 scope id pointer, not NULL indicates it's required
337 static int tipc_parse_udp_addr(struct nlattr *nla, struct udp_media_addr *addr,
340 struct sockaddr_storage sa;
342 nla_memcpy(&sa, nla, sizeof(sa));
343 if (sa.ss_family == AF_INET) {
344 struct sockaddr_in *ip4 = (struct sockaddr_in *)&sa;
346 addr->proto = htons(ETH_P_IP);
347 addr->port = ip4->sin_port;
348 addr->ipv4.s_addr = ip4->sin_addr.s_addr;
351 #if IS_ENABLED(CONFIG_IPV6)
352 } else if (sa.ss_family == AF_INET6) {
353 struct sockaddr_in6 *ip6 = (struct sockaddr_in6 *)&sa;
355 addr->proto = htons(ETH_P_IPV6);
356 addr->port = ip6->sin6_port;
357 memcpy(&addr->ipv6, &ip6->sin6_addr, sizeof(struct in6_addr));
359 /* Scope ID is only interesting for local addresses */
363 atype = ipv6_addr_type(&ip6->sin6_addr);
364 if (__ipv6_addr_needs_scope_id(atype) &&
365 !ip6->sin6_scope_id) {
369 *scope_id = ip6->sin6_scope_id ? : 0;
375 return -EADDRNOTAVAIL;
378 int tipc_udp_nl_bearer_add(struct tipc_bearer *b, struct nlattr *attr)
381 struct udp_media_addr addr = {0};
382 struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
383 struct udp_media_addr *dst;
385 if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX, attr, tipc_nl_udp_policy))
388 if (!opts[TIPC_NLA_UDP_REMOTE])
391 err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_REMOTE], &addr, NULL);
395 dst = (struct udp_media_addr *)&b->bcast_addr.value;
396 if (tipc_udp_is_mcast_addr(dst)) {
397 pr_err("Can't add remote ip to TIPC UDP multicast bearer\n");
401 return tipc_udp_rcast_add(b, &addr);
405 * tipc_udp_enable - callback to create a new udp bearer instance
406 * @net: network namespace
407 * @b: pointer to generic tipc_bearer
408 * @attrs: netlink bearer configuration
410 * validate the bearer parameters and initialize the udp bearer
411 * rtnl_lock should be held
413 static int tipc_udp_enable(struct net *net, struct tipc_bearer *b,
414 struct nlattr *attrs[])
417 struct udp_bearer *ub;
418 struct udp_media_addr remote = {0};
419 struct udp_media_addr local = {0};
420 struct udp_port_cfg udp_conf = {0};
421 struct udp_tunnel_sock_cfg tuncfg = {NULL};
422 struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
424 ub = kzalloc(sizeof(*ub), GFP_ATOMIC);
428 INIT_LIST_HEAD(&ub->rcast.list);
430 if (!attrs[TIPC_NLA_BEARER_UDP_OPTS])
433 if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX,
434 attrs[TIPC_NLA_BEARER_UDP_OPTS],
438 if (!opts[TIPC_NLA_UDP_LOCAL] || !opts[TIPC_NLA_UDP_REMOTE]) {
439 pr_err("Invalid UDP bearer configuration");
443 err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_LOCAL], &local,
448 err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_REMOTE], &remote, NULL);
452 b->bcast_addr.media_id = TIPC_MEDIA_TYPE_UDP;
453 b->bcast_addr.broadcast = 1;
454 rcu_assign_pointer(b->media_ptr, ub);
455 rcu_assign_pointer(ub->bearer, b);
456 tipc_udp_media_addr_set(&b->addr, &local);
457 if (local.proto == htons(ETH_P_IP)) {
458 struct net_device *dev;
460 dev = __ip_dev_find(net, local.ipv4.s_addr, false);
465 udp_conf.family = AF_INET;
466 udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
467 udp_conf.use_udp_checksums = false;
468 ub->ifindex = dev->ifindex;
469 b->mtu = dev->mtu - sizeof(struct iphdr)
470 - sizeof(struct udphdr);
471 #if IS_ENABLED(CONFIG_IPV6)
472 } else if (local.proto == htons(ETH_P_IPV6)) {
473 udp_conf.family = AF_INET6;
474 udp_conf.use_udp6_tx_checksums = true;
475 udp_conf.use_udp6_rx_checksums = true;
476 udp_conf.local_ip6 = in6addr_any;
483 udp_conf.local_udp_port = local.port;
484 err = udp_sock_create(net, &udp_conf, &ub->ubsock);
487 tuncfg.sk_user_data = ub;
488 tuncfg.encap_type = 1;
489 tuncfg.encap_rcv = tipc_udp_recv;
490 tuncfg.encap_destroy = NULL;
491 setup_udp_tunnel_sock(net, ub->ubsock, &tuncfg);
494 * The bcast media address port is used for all peers and the ip
495 * is used if it's a multicast address.
497 memcpy(&b->bcast_addr.value, &remote, sizeof(remote));
498 if (tipc_udp_is_mcast_addr(&remote))
499 err = enable_mcast(ub, &remote);
501 err = tipc_udp_rcast_add(b, &remote);
511 /* cleanup_bearer - break the socket/bearer association */
512 static void cleanup_bearer(struct work_struct *work)
514 struct udp_bearer *ub = container_of(work, struct udp_bearer, work);
515 struct udp_replicast *rcast, *tmp;
517 list_for_each_entry_safe(rcast, tmp, &ub->rcast.list, list) {
518 list_del_rcu(&rcast->list);
519 kfree_rcu(rcast, rcu);
523 udp_tunnel_sock_release(ub->ubsock);
528 /* tipc_udp_disable - detach bearer from socket */
529 static void tipc_udp_disable(struct tipc_bearer *b)
531 struct udp_bearer *ub;
533 ub = rcu_dereference_rtnl(b->media_ptr);
535 pr_err("UDP bearer instance not found\n");
539 sock_set_flag(ub->ubsock->sk, SOCK_DEAD);
540 RCU_INIT_POINTER(ub->bearer, NULL);
542 /* sock_release need to be done outside of rtnl lock */
543 INIT_WORK(&ub->work, cleanup_bearer);
544 schedule_work(&ub->work);
547 struct tipc_media udp_media_info = {
548 .send_msg = tipc_udp_send_msg,
549 .enable_media = tipc_udp_enable,
550 .disable_media = tipc_udp_disable,
551 .addr2str = tipc_udp_addr2str,
552 .addr2msg = tipc_udp_addr2msg,
553 .msg2addr = tipc_udp_msg2addr,
554 .priority = TIPC_DEF_LINK_PRI,
555 .tolerance = TIPC_DEF_LINK_TOL,
556 .window = TIPC_DEF_LINK_WIN,
557 .type_id = TIPC_MEDIA_TYPE_UDP,