tipc: introduce UDP replicast
[cascardo/linux.git] / net / tipc / udp_media.c
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 #include "netlink.h"
52 #include "msg.h"
53
54 /* IANA assigned UDP port */
55 #define UDP_PORT_DEFAULT        6118
56
57 #define UDP_MIN_HEADROOM        48
58
59 /**
60  * struct udp_media_addr - IP/UDP addressing information
61  *
62  * This is the bearer level originating address used in neighbor discovery
63  * messages, and all fields should be in network byte order
64  */
65 struct udp_media_addr {
66         __be16  proto;
67         __be16  port;
68         union {
69                 struct in_addr ipv4;
70                 struct in6_addr ipv6;
71         };
72 };
73
74 /* struct udp_replicast - container for UDP remote addresses */
75 struct udp_replicast {
76         struct udp_media_addr addr;
77         struct rcu_head rcu;
78         struct list_head list;
79 };
80
81 /**
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
87  */
88 struct udp_bearer {
89         struct tipc_bearer __rcu *bearer;
90         struct socket *ubsock;
91         u32 ifindex;
92         struct work_struct work;
93         struct udp_replicast rcast;
94 };
95
96 static int tipc_udp_is_mcast_addr(struct udp_media_addr *addr)
97 {
98         if (ntohs(addr->proto) == ETH_P_IP)
99                 return ipv4_is_multicast(addr->ipv4.s_addr);
100 #if IS_ENABLED(CONFIG_IPV6)
101         else
102                 return ipv6_addr_is_multicast(&addr->ipv6);
103 #endif
104         return 0;
105 }
106
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)
110 {
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));
114
115         if (tipc_udp_is_mcast_addr(ua))
116                 addr->broadcast = 1;
117 }
118
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)
121 {
122         struct udp_media_addr *ua = (struct udp_media_addr *)&a->value;
123
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));
128         else
129                 pr_err("Invalid UDP media address\n");
130         return 0;
131 }
132
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,
135                              char *msg)
136 {
137         struct udp_media_addr *ua;
138
139         ua = (struct udp_media_addr *) (msg + TIPC_MEDIA_ADDR_OFFSET);
140         if (msg[TIPC_MEDIA_TYPE_OFFSET] != TIPC_MEDIA_TYPE_UDP)
141                 return -EINVAL;
142         tipc_udp_media_addr_set(a, ua);
143         return 0;
144 }
145
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)
148 {
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));
153         return 0;
154 }
155
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)
160 {
161         int ttl, err = 0;
162         struct rtable *rt;
163
164         if (dst->proto == htons(ETH_P_IP)) {
165                 struct flowi4 fl = {
166                         .daddr = dst->ipv4.s_addr,
167                         .saddr = src->ipv4.s_addr,
168                         .flowi4_mark = skb->mark,
169                         .flowi4_proto = IPPROTO_UDP
170                 };
171                 rt = ip_route_output_key(net, &fl);
172                 if (IS_ERR(rt)) {
173                         err = PTR_ERR(rt);
174                         goto tx_error;
175                 }
176
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)
183         } else {
184                 struct dst_entry *ndst;
185                 struct flowi6 fl6 = {
186                         .flowi6_oif = ub->ifindex,
187                         .daddr = dst->ipv6,
188                         .saddr = src->ipv6,
189                         .flowi6_proto = IPPROTO_UDP
190                 };
191                 err = ipv6_stub->ipv6_dst_lookup(net, ub->ubsock->sk, &ndst,
192                                                  &fl6);
193                 if (err)
194                         goto tx_error;
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,
199                                            dst->port, false);
200 #endif
201         }
202         return err;
203
204 tx_error:
205         kfree_skb(skb);
206         return err;
207 }
208
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)
212 {
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;
217         int err = 0;
218
219         if (skb_headroom(skb) < UDP_MIN_HEADROOM) {
220                 err = pskb_expand_head(skb, UDP_MIN_HEADROOM, 0, GFP_ATOMIC);
221                 if (err)
222                         goto out;
223         }
224
225         skb_set_inner_protocol(skb, htons(ETH_P_TIPC));
226         ub = rcu_dereference_rtnl(b->media_ptr);
227         if (!ub) {
228                 err = -ENODEV;
229                 goto out;
230         }
231
232         if (!addr->broadcast || list_empty(&ub->rcast.list))
233                 return tipc_udp_xmit(net, skb, ub, src, dst);
234
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;
238
239                 _skb = pskb_copy(skb, GFP_ATOMIC);
240                 if (!_skb) {
241                         err = -ENOMEM;
242                         goto out;
243                 }
244
245                 err = tipc_udp_xmit(net, _skb, ub, src, &rcast->addr);
246                 if (err) {
247                         kfree_skb(_skb);
248                         goto out;
249                 }
250         }
251         err = 0;
252 out:
253         kfree_skb(skb);
254         return err;
255 }
256
257 static int tipc_udp_rcast_add(struct tipc_bearer *b,
258                               struct udp_media_addr *addr)
259 {
260         struct udp_replicast *rcast;
261         struct udp_bearer *ub;
262
263         ub = rcu_dereference_rtnl(b->media_ptr);
264         if (!ub)
265                 return -ENODEV;
266
267         rcast = kmalloc(sizeof(*rcast), GFP_ATOMIC);
268         if (!rcast)
269                 return -ENOMEM;
270
271         memcpy(&rcast->addr, addr, sizeof(struct udp_media_addr));
272
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);
278 #endif
279
280         list_add_rcu(&rcast->list, &ub->rcast.list);
281         return 0;
282 }
283
284 /* tipc_udp_recv - read data from bearer socket */
285 static int tipc_udp_recv(struct sock *sk, struct sk_buff *skb)
286 {
287         struct udp_bearer *ub;
288         struct tipc_bearer *b;
289
290         ub = rcu_dereference_sk_user_data(sk);
291         if (!ub) {
292                 pr_err_ratelimited("Failed to get UDP bearer reference");
293                 kfree_skb(skb);
294                 return 0;
295         }
296
297         skb_pull(skb, sizeof(struct udphdr));
298         rcu_read_lock();
299         b = rcu_dereference_rtnl(ub->bearer);
300
301         if (b && test_bit(0, &b->up)) {
302                 tipc_rcv(sock_net(sk), skb, b);
303                 rcu_read_unlock();
304                 return 0;
305         }
306         rcu_read_unlock();
307         kfree_skb(skb);
308         return 0;
309 }
310
311 static int enable_mcast(struct udp_bearer *ub, struct udp_media_addr *remote)
312 {
313         int err = 0;
314         struct ip_mreqn mreqn;
315         struct sock *sk = ub->ubsock->sk;
316
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)
322         } else {
323                 err = ipv6_stub->ipv6_sock_mc_join(sk, ub->ifindex,
324                                                    &remote->ipv6);
325 #endif
326         }
327         return err;
328 }
329
330 /**
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
335  */
336
337 static int tipc_parse_udp_addr(struct nlattr *nla, struct udp_media_addr *addr,
338                                u32 *scope_id)
339 {
340         struct sockaddr_storage sa;
341
342         nla_memcpy(&sa, nla, sizeof(sa));
343         if (sa.ss_family == AF_INET) {
344                 struct sockaddr_in *ip4 = (struct sockaddr_in *)&sa;
345
346                 addr->proto = htons(ETH_P_IP);
347                 addr->port = ip4->sin_port;
348                 addr->ipv4.s_addr = ip4->sin_addr.s_addr;
349                 return 0;
350
351 #if IS_ENABLED(CONFIG_IPV6)
352         } else if (sa.ss_family == AF_INET6) {
353                 struct sockaddr_in6 *ip6 = (struct sockaddr_in6 *)&sa;
354
355                 addr->proto = htons(ETH_P_IPV6);
356                 addr->port = ip6->sin6_port;
357                 memcpy(&addr->ipv6, &ip6->sin6_addr, sizeof(struct in6_addr));
358
359                 /* Scope ID is only interesting for local addresses */
360                 if (scope_id) {
361                         int atype;
362
363                         atype = ipv6_addr_type(&ip6->sin6_addr);
364                         if (__ipv6_addr_needs_scope_id(atype) &&
365                             !ip6->sin6_scope_id) {
366                                 return -EINVAL;
367                         }
368
369                         *scope_id = ip6->sin6_scope_id ? : 0;
370                 }
371
372                 return 0;
373 #endif
374         }
375         return -EADDRNOTAVAIL;
376 }
377
378 int tipc_udp_nl_bearer_add(struct tipc_bearer *b, struct nlattr *attr)
379 {
380         int err;
381         struct udp_media_addr addr = {0};
382         struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
383         struct udp_media_addr *dst;
384
385         if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX, attr, tipc_nl_udp_policy))
386                 return -EINVAL;
387
388         if (!opts[TIPC_NLA_UDP_REMOTE])
389                 return -EINVAL;
390
391         err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_REMOTE], &addr, NULL);
392         if (err)
393                 return err;
394
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");
398                 return -EINVAL;
399         }
400
401         return tipc_udp_rcast_add(b, &addr);
402 }
403
404 /**
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
409  *
410  * validate the bearer parameters and initialize the udp bearer
411  * rtnl_lock should be held
412  */
413 static int tipc_udp_enable(struct net *net, struct tipc_bearer *b,
414                            struct nlattr *attrs[])
415 {
416         int err = -EINVAL;
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];
423
424         ub = kzalloc(sizeof(*ub), GFP_ATOMIC);
425         if (!ub)
426                 return -ENOMEM;
427
428         INIT_LIST_HEAD(&ub->rcast.list);
429
430         if (!attrs[TIPC_NLA_BEARER_UDP_OPTS])
431                 goto err;
432
433         if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX,
434                              attrs[TIPC_NLA_BEARER_UDP_OPTS],
435                              tipc_nl_udp_policy))
436                 goto err;
437
438         if (!opts[TIPC_NLA_UDP_LOCAL] || !opts[TIPC_NLA_UDP_REMOTE]) {
439                 pr_err("Invalid UDP bearer configuration");
440                 return -EINVAL;
441         }
442
443         err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_LOCAL], &local,
444                                   &ub->ifindex);
445         if (err)
446                 goto err;
447
448         err = tipc_parse_udp_addr(opts[TIPC_NLA_UDP_REMOTE], &remote, NULL);
449         if (err)
450                 goto err;
451
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;
459
460                 dev = __ip_dev_find(net, local.ipv4.s_addr, false);
461                 if (!dev) {
462                         err = -ENODEV;
463                         goto err;
464                 }
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;
477                 b->mtu = 1280;
478 #endif
479         } else {
480                 err = -EAFNOSUPPORT;
481                 goto err;
482         }
483         udp_conf.local_udp_port = local.port;
484         err = udp_sock_create(net, &udp_conf, &ub->ubsock);
485         if (err)
486                 goto err;
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);
492
493         /**
494          * The bcast media address port is used for all peers and the ip
495          * is used if it's a multicast address.
496          */
497         memcpy(&b->bcast_addr.value, &remote, sizeof(remote));
498         if (tipc_udp_is_mcast_addr(&remote))
499                 err = enable_mcast(ub, &remote);
500         else
501                 err = tipc_udp_rcast_add(b, &remote);
502         if (err)
503                 goto err;
504
505         return 0;
506 err:
507         kfree(ub);
508         return err;
509 }
510
511 /* cleanup_bearer - break the socket/bearer association */
512 static void cleanup_bearer(struct work_struct *work)
513 {
514         struct udp_bearer *ub = container_of(work, struct udp_bearer, work);
515         struct udp_replicast *rcast, *tmp;
516
517         list_for_each_entry_safe(rcast, tmp, &ub->rcast.list, list) {
518                 list_del_rcu(&rcast->list);
519                 kfree_rcu(rcast, rcu);
520         }
521
522         if (ub->ubsock)
523                 udp_tunnel_sock_release(ub->ubsock);
524         synchronize_net();
525         kfree(ub);
526 }
527
528 /* tipc_udp_disable - detach bearer from socket */
529 static void tipc_udp_disable(struct tipc_bearer *b)
530 {
531         struct udp_bearer *ub;
532
533         ub = rcu_dereference_rtnl(b->media_ptr);
534         if (!ub) {
535                 pr_err("UDP bearer instance not found\n");
536                 return;
537         }
538         if (ub->ubsock)
539                 sock_set_flag(ub->ubsock->sk, SOCK_DEAD);
540         RCU_INIT_POINTER(ub->bearer, NULL);
541
542         /* sock_release need to be done outside of rtnl lock */
543         INIT_WORK(&ub->work, cleanup_bearer);
544         schedule_work(&ub->work);
545 }
546
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,
558         .hwaddr_len     = 0,
559         .name           = "udp"
560 };