xref: /openbmc/linux/net/tipc/udp_media.c (revision eb3fcf00)
1 /* net/tipc/udp_media.c: IP bearer support for TIPC
2  *
3  * Copyright (c) 2015, Ericsson AB
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
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.
17  *
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.
21  *
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.
33  */
34 
35 #include <linux/socket.h>
36 #include <linux/ip.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>
44 #include <net/sock.h>
45 #include <net/ip.h>
46 #include <net/udp_tunnel.h>
47 #include <net/addrconf.h>
48 #include <linux/tipc_netlink.h>
49 #include "core.h"
50 #include "bearer.h"
51 
52 /* IANA assigned UDP port */
53 #define UDP_PORT_DEFAULT	6118
54 
55 static const struct nla_policy tipc_nl_udp_policy[TIPC_NLA_UDP_MAX + 1] = {
56 	[TIPC_NLA_UDP_UNSPEC]	= {.type = NLA_UNSPEC},
57 	[TIPC_NLA_UDP_LOCAL]	= {.type = NLA_BINARY,
58 				   .len = sizeof(struct sockaddr_storage)},
59 	[TIPC_NLA_UDP_REMOTE]	= {.type = NLA_BINARY,
60 				   .len = sizeof(struct sockaddr_storage)},
61 };
62 
63 /**
64  * struct udp_media_addr - IP/UDP addressing information
65  *
66  * This is the bearer level originating address used in neighbor discovery
67  * messages, and all fields should be in network byte order
68  */
69 struct udp_media_addr {
70 	__be16	proto;
71 	__be16	udp_port;
72 	union {
73 		struct in_addr ipv4;
74 		struct in6_addr ipv6;
75 	};
76 };
77 
78 /**
79  * struct udp_bearer - ip/udp bearer data structure
80  * @bearer:	associated generic tipc bearer
81  * @ubsock:	bearer associated socket
82  * @ifindex:	local address scope
83  * @work:	used to schedule deferred work on a bearer
84  */
85 struct udp_bearer {
86 	struct tipc_bearer __rcu *bearer;
87 	struct socket *ubsock;
88 	u32 ifindex;
89 	struct work_struct work;
90 };
91 
92 /* udp_media_addr_set - convert a ip/udp address to a TIPC media address */
93 static void tipc_udp_media_addr_set(struct tipc_media_addr *addr,
94 				    struct udp_media_addr *ua)
95 {
96 	memset(addr, 0, sizeof(struct tipc_media_addr));
97 	addr->media_id = TIPC_MEDIA_TYPE_UDP;
98 	memcpy(addr->value, ua, sizeof(struct udp_media_addr));
99 	if (ntohs(ua->proto) == ETH_P_IP) {
100 		if (ipv4_is_multicast(ua->ipv4.s_addr))
101 			addr->broadcast = 1;
102 	} else if (ntohs(ua->proto) == ETH_P_IPV6) {
103 		if (ipv6_addr_type(&ua->ipv6) & IPV6_ADDR_MULTICAST)
104 			addr->broadcast = 1;
105 	} else {
106 		pr_err("Invalid UDP media address\n");
107 	}
108 }
109 
110 /* tipc_udp_addr2str - convert ip/udp address to string */
111 static int tipc_udp_addr2str(struct tipc_media_addr *a, char *buf, int size)
112 {
113 	struct udp_media_addr *ua = (struct udp_media_addr *)&a->value;
114 
115 	if (ntohs(ua->proto) == ETH_P_IP)
116 		snprintf(buf, size, "%pI4:%u", &ua->ipv4, ntohs(ua->udp_port));
117 	else if (ntohs(ua->proto) == ETH_P_IPV6)
118 		snprintf(buf, size, "%pI6:%u", &ua->ipv6, ntohs(ua->udp_port));
119 	else
120 		pr_err("Invalid UDP media address\n");
121 	return 0;
122 }
123 
124 /* tipc_udp_msg2addr - extract an ip/udp address from a TIPC ndisc message */
125 static int tipc_udp_msg2addr(struct tipc_bearer *b, struct tipc_media_addr *a,
126 			     char *msg)
127 {
128 	struct udp_media_addr *ua;
129 
130 	ua = (struct udp_media_addr *) (msg + TIPC_MEDIA_ADDR_OFFSET);
131 	if (msg[TIPC_MEDIA_TYPE_OFFSET] != TIPC_MEDIA_TYPE_UDP)
132 		return -EINVAL;
133 	tipc_udp_media_addr_set(a, ua);
134 	return 0;
135 }
136 
137 /* tipc_udp_addr2msg - write an ip/udp address to a TIPC ndisc message */
138 static int tipc_udp_addr2msg(char *msg, struct tipc_media_addr *a)
139 {
140 	memset(msg, 0, TIPC_MEDIA_INFO_SIZE);
141 	msg[TIPC_MEDIA_TYPE_OFFSET] = TIPC_MEDIA_TYPE_UDP;
142 	memcpy(msg + TIPC_MEDIA_ADDR_OFFSET, a->value,
143 	       sizeof(struct udp_media_addr));
144 	return 0;
145 }
146 
147 /* tipc_send_msg - enqueue a send request */
148 static int tipc_udp_send_msg(struct net *net, struct sk_buff *skb,
149 			     struct tipc_bearer *b,
150 			     struct tipc_media_addr *dest)
151 {
152 	int ttl, err = 0;
153 	struct udp_bearer *ub;
154 	struct udp_media_addr *dst = (struct udp_media_addr *)&dest->value;
155 	struct udp_media_addr *src = (struct udp_media_addr *)&b->addr.value;
156 	struct sk_buff *clone;
157 	struct rtable *rt;
158 
159 	clone = skb_clone(skb, GFP_ATOMIC);
160 	skb_set_inner_protocol(clone, htons(ETH_P_TIPC));
161 	ub = rcu_dereference_rtnl(b->media_ptr);
162 	if (!ub) {
163 		err = -ENODEV;
164 		goto tx_error;
165 	}
166 	if (dst->proto == htons(ETH_P_IP)) {
167 		struct flowi4 fl = {
168 			.daddr = dst->ipv4.s_addr,
169 			.saddr = src->ipv4.s_addr,
170 			.flowi4_mark = clone->mark,
171 			.flowi4_proto = IPPROTO_UDP
172 		};
173 		rt = ip_route_output_key(net, &fl);
174 		if (IS_ERR(rt)) {
175 			err = PTR_ERR(rt);
176 			goto tx_error;
177 		}
178 		ttl = ip4_dst_hoplimit(&rt->dst);
179 		err = udp_tunnel_xmit_skb(rt, ub->ubsock->sk, clone,
180 					  src->ipv4.s_addr,
181 					  dst->ipv4.s_addr, 0, ttl, 0,
182 					  src->udp_port, dst->udp_port,
183 					  false, true);
184 		if (err < 0) {
185 			ip_rt_put(rt);
186 			goto tx_error;
187 		}
188 #if IS_ENABLED(CONFIG_IPV6)
189 	} else {
190 		struct dst_entry *ndst;
191 		struct flowi6 fl6 = {
192 			.flowi6_oif = ub->ifindex,
193 			.daddr = dst->ipv6,
194 			.saddr = src->ipv6,
195 			.flowi6_proto = IPPROTO_UDP
196 		};
197 		err = ipv6_stub->ipv6_dst_lookup(net, ub->ubsock->sk, &ndst,
198 						 &fl6);
199 		if (err)
200 			goto tx_error;
201 		ttl = ip6_dst_hoplimit(ndst);
202 		err = udp_tunnel6_xmit_skb(ndst, ub->ubsock->sk, clone,
203 					   ndst->dev, &src->ipv6,
204 					   &dst->ipv6, 0, ttl, src->udp_port,
205 					   dst->udp_port, false);
206 #endif
207 	}
208 	return err;
209 
210 tx_error:
211 	kfree_skb(clone);
212 	return err;
213 }
214 
215 /* tipc_udp_recv - read data from bearer socket */
216 static int tipc_udp_recv(struct sock *sk, struct sk_buff *skb)
217 {
218 	struct udp_bearer *ub;
219 	struct tipc_bearer *b;
220 
221 	ub = rcu_dereference_sk_user_data(sk);
222 	if (!ub) {
223 		pr_err_ratelimited("Failed to get UDP bearer reference");
224 		kfree_skb(skb);
225 		return 0;
226 	}
227 
228 	skb_pull(skb, sizeof(struct udphdr));
229 	rcu_read_lock();
230 	b = rcu_dereference_rtnl(ub->bearer);
231 
232 	if (b) {
233 		tipc_rcv(sock_net(sk), skb, b);
234 		rcu_read_unlock();
235 		return 0;
236 	}
237 	rcu_read_unlock();
238 	kfree_skb(skb);
239 	return 0;
240 }
241 
242 static int enable_mcast(struct udp_bearer *ub, struct udp_media_addr *remote)
243 {
244 	int err = 0;
245 	struct ip_mreqn mreqn;
246 	struct sock *sk = ub->ubsock->sk;
247 
248 	if (ntohs(remote->proto) == ETH_P_IP) {
249 		if (!ipv4_is_multicast(remote->ipv4.s_addr))
250 			return 0;
251 		mreqn.imr_multiaddr = remote->ipv4;
252 		mreqn.imr_ifindex = ub->ifindex;
253 		err = ip_mc_join_group(sk, &mreqn);
254 #if IS_ENABLED(CONFIG_IPV6)
255 	} else {
256 		if (!ipv6_addr_is_multicast(&remote->ipv6))
257 			return 0;
258 		err = ipv6_stub->ipv6_sock_mc_join(sk, ub->ifindex,
259 						   &remote->ipv6);
260 #endif
261 	}
262 	return err;
263 }
264 
265 /**
266  * parse_options - build local/remote addresses from configuration
267  * @attrs:	netlink config data
268  * @ub:		UDP bearer instance
269  * @local:	local bearer IP address/port
270  * @remote:	peer or multicast IP/port
271  */
272 static int parse_options(struct nlattr *attrs[], struct udp_bearer *ub,
273 			 struct udp_media_addr *local,
274 			 struct udp_media_addr *remote)
275 {
276 	struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
277 	struct sockaddr_storage *sa_local, *sa_remote;
278 
279 	if (!attrs[TIPC_NLA_BEARER_UDP_OPTS])
280 		goto err;
281 	if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX,
282 			     attrs[TIPC_NLA_BEARER_UDP_OPTS],
283 			     tipc_nl_udp_policy))
284 		goto err;
285 	if (opts[TIPC_NLA_UDP_LOCAL] && opts[TIPC_NLA_UDP_REMOTE]) {
286 		sa_local = nla_data(opts[TIPC_NLA_UDP_LOCAL]);
287 		sa_remote = nla_data(opts[TIPC_NLA_UDP_REMOTE]);
288 	} else {
289 err:
290 		pr_err("Invalid UDP bearer configuration");
291 		return -EINVAL;
292 	}
293 	if ((sa_local->ss_family & sa_remote->ss_family) == AF_INET) {
294 		struct sockaddr_in *ip4;
295 
296 		ip4 = (struct sockaddr_in *)sa_local;
297 		local->proto = htons(ETH_P_IP);
298 		local->udp_port = ip4->sin_port;
299 		local->ipv4.s_addr = ip4->sin_addr.s_addr;
300 
301 		ip4 = (struct sockaddr_in *)sa_remote;
302 		remote->proto = htons(ETH_P_IP);
303 		remote->udp_port = ip4->sin_port;
304 		remote->ipv4.s_addr = ip4->sin_addr.s_addr;
305 		return 0;
306 
307 #if IS_ENABLED(CONFIG_IPV6)
308 	} else if ((sa_local->ss_family & sa_remote->ss_family) == AF_INET6) {
309 		struct sockaddr_in6 *ip6;
310 
311 		ip6 = (struct sockaddr_in6 *)sa_local;
312 		local->proto = htons(ETH_P_IPV6);
313 		local->udp_port = ip6->sin6_port;
314 		local->ipv6 = ip6->sin6_addr;
315 		ub->ifindex = ip6->sin6_scope_id;
316 
317 		ip6 = (struct sockaddr_in6 *)sa_remote;
318 		remote->proto = htons(ETH_P_IPV6);
319 		remote->udp_port = ip6->sin6_port;
320 		remote->ipv6 = ip6->sin6_addr;
321 		return 0;
322 #endif
323 	}
324 	return -EADDRNOTAVAIL;
325 }
326 
327 /**
328  * tipc_udp_enable - callback to create a new udp bearer instance
329  * @net:	network namespace
330  * @b:		pointer to generic tipc_bearer
331  * @attrs:	netlink bearer configuration
332  *
333  * validate the bearer parameters and initialize the udp bearer
334  * rtnl_lock should be held
335  */
336 static int tipc_udp_enable(struct net *net, struct tipc_bearer *b,
337 			   struct nlattr *attrs[])
338 {
339 	int err = -EINVAL;
340 	struct udp_bearer *ub;
341 	struct udp_media_addr *remote;
342 	struct udp_media_addr local = {0};
343 	struct udp_port_cfg udp_conf = {0};
344 	struct udp_tunnel_sock_cfg tuncfg = {NULL};
345 
346 	ub = kzalloc(sizeof(*ub), GFP_ATOMIC);
347 	if (!ub)
348 		return -ENOMEM;
349 
350 	remote = (struct udp_media_addr *)&b->bcast_addr.value;
351 	memset(remote, 0, sizeof(struct udp_media_addr));
352 	err = parse_options(attrs, ub, &local, remote);
353 	if (err)
354 		goto err;
355 
356 	b->bcast_addr.media_id = TIPC_MEDIA_TYPE_UDP;
357 	b->bcast_addr.broadcast = 1;
358 	rcu_assign_pointer(b->media_ptr, ub);
359 	rcu_assign_pointer(ub->bearer, b);
360 	tipc_udp_media_addr_set(&b->addr, &local);
361 	if (local.proto == htons(ETH_P_IP)) {
362 		struct net_device *dev;
363 
364 		dev = __ip_dev_find(net, local.ipv4.s_addr, false);
365 		if (!dev) {
366 			err = -ENODEV;
367 			goto err;
368 		}
369 		udp_conf.family = AF_INET;
370 		udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
371 		udp_conf.use_udp_checksums = false;
372 		ub->ifindex = dev->ifindex;
373 		b->mtu = dev->mtu - sizeof(struct iphdr)
374 			- sizeof(struct udphdr);
375 #if IS_ENABLED(CONFIG_IPV6)
376 	} else if (local.proto == htons(ETH_P_IPV6)) {
377 		udp_conf.family = AF_INET6;
378 		udp_conf.use_udp6_tx_checksums = true;
379 		udp_conf.use_udp6_rx_checksums = true;
380 		udp_conf.local_ip6 = in6addr_any;
381 		b->mtu = 1280;
382 #endif
383 	} else {
384 		err = -EAFNOSUPPORT;
385 		goto err;
386 	}
387 	udp_conf.local_udp_port = local.udp_port;
388 	err = udp_sock_create(net, &udp_conf, &ub->ubsock);
389 	if (err)
390 		goto err;
391 	tuncfg.sk_user_data = ub;
392 	tuncfg.encap_type = 1;
393 	tuncfg.encap_rcv = tipc_udp_recv;
394 	tuncfg.encap_destroy = NULL;
395 	setup_udp_tunnel_sock(net, ub->ubsock, &tuncfg);
396 
397 	if (enable_mcast(ub, remote))
398 		goto err;
399 	return 0;
400 err:
401 	kfree(ub);
402 	return err;
403 }
404 
405 /* cleanup_bearer - break the socket/bearer association */
406 static void cleanup_bearer(struct work_struct *work)
407 {
408 	struct udp_bearer *ub = container_of(work, struct udp_bearer, work);
409 
410 	if (ub->ubsock)
411 		udp_tunnel_sock_release(ub->ubsock);
412 	synchronize_net();
413 	kfree(ub);
414 }
415 
416 /* tipc_udp_disable - detach bearer from socket */
417 static void tipc_udp_disable(struct tipc_bearer *b)
418 {
419 	struct udp_bearer *ub;
420 
421 	ub = rcu_dereference_rtnl(b->media_ptr);
422 	if (!ub) {
423 		pr_err("UDP bearer instance not found\n");
424 		return;
425 	}
426 	if (ub->ubsock)
427 		sock_set_flag(ub->ubsock->sk, SOCK_DEAD);
428 	RCU_INIT_POINTER(b->media_ptr, NULL);
429 	RCU_INIT_POINTER(ub->bearer, NULL);
430 
431 	/* sock_release need to be done outside of rtnl lock */
432 	INIT_WORK(&ub->work, cleanup_bearer);
433 	schedule_work(&ub->work);
434 }
435 
436 struct tipc_media udp_media_info = {
437 	.send_msg	= tipc_udp_send_msg,
438 	.enable_media	= tipc_udp_enable,
439 	.disable_media	= tipc_udp_disable,
440 	.addr2str	= tipc_udp_addr2str,
441 	.addr2msg	= tipc_udp_addr2msg,
442 	.msg2addr	= tipc_udp_msg2addr,
443 	.priority	= TIPC_DEF_LINK_PRI,
444 	.tolerance	= TIPC_DEF_LINK_TOL,
445 	.window		= TIPC_DEF_LINK_WIN,
446 	.type_id	= TIPC_MEDIA_TYPE_UDP,
447 	.hwaddr_len	= 0,
448 	.name		= "udp"
449 };
450