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>
53 /* IANA assigned UDP port */
54 #define UDP_PORT_DEFAULT 6118
56 #define UDP_MIN_HEADROOM 48
59 * struct udp_media_addr - IP/UDP addressing information
61 * This is the bearer level originating address used in neighbor discovery
62 * messages, and all fields should be in network byte order
64 struct udp_media_addr
{
74 * struct udp_bearer - ip/udp bearer data structure
75 * @bearer: associated generic tipc bearer
76 * @ubsock: bearer associated socket
77 * @ifindex: local address scope
78 * @work: used to schedule deferred work on a bearer
81 struct tipc_bearer __rcu
*bearer
;
82 struct socket
*ubsock
;
84 struct work_struct work
;
87 /* udp_media_addr_set - convert a ip/udp address to a TIPC media address */
88 static void tipc_udp_media_addr_set(struct tipc_media_addr
*addr
,
89 struct udp_media_addr
*ua
)
91 memset(addr
, 0, sizeof(struct tipc_media_addr
));
92 addr
->media_id
= TIPC_MEDIA_TYPE_UDP
;
93 memcpy(addr
->value
, ua
, sizeof(struct udp_media_addr
));
94 if (ntohs(ua
->proto
) == ETH_P_IP
) {
95 if (ipv4_is_multicast(ua
->ipv4
.s_addr
))
97 } else if (ntohs(ua
->proto
) == ETH_P_IPV6
) {
98 if (ipv6_addr_type(&ua
->ipv6
) & IPV6_ADDR_MULTICAST
)
101 pr_err("Invalid UDP media address\n");
105 /* tipc_udp_addr2str - convert ip/udp address to string */
106 static int tipc_udp_addr2str(struct tipc_media_addr
*a
, char *buf
, int size
)
108 struct udp_media_addr
*ua
= (struct udp_media_addr
*)&a
->value
;
110 if (ntohs(ua
->proto
) == ETH_P_IP
)
111 snprintf(buf
, size
, "%pI4:%u", &ua
->ipv4
, ntohs(ua
->udp_port
));
112 else if (ntohs(ua
->proto
) == ETH_P_IPV6
)
113 snprintf(buf
, size
, "%pI6:%u", &ua
->ipv6
, ntohs(ua
->udp_port
));
115 pr_err("Invalid UDP media address\n");
119 /* tipc_udp_msg2addr - extract an ip/udp address from a TIPC ndisc message */
120 static int tipc_udp_msg2addr(struct tipc_bearer
*b
, struct tipc_media_addr
*a
,
123 struct udp_media_addr
*ua
;
125 ua
= (struct udp_media_addr
*) (msg
+ TIPC_MEDIA_ADDR_OFFSET
);
126 if (msg
[TIPC_MEDIA_TYPE_OFFSET
] != TIPC_MEDIA_TYPE_UDP
)
128 tipc_udp_media_addr_set(a
, ua
);
132 /* tipc_udp_addr2msg - write an ip/udp address to a TIPC ndisc message */
133 static int tipc_udp_addr2msg(char *msg
, struct tipc_media_addr
*a
)
135 memset(msg
, 0, TIPC_MEDIA_INFO_SIZE
);
136 msg
[TIPC_MEDIA_TYPE_OFFSET
] = TIPC_MEDIA_TYPE_UDP
;
137 memcpy(msg
+ TIPC_MEDIA_ADDR_OFFSET
, a
->value
,
138 sizeof(struct udp_media_addr
));
142 /* tipc_send_msg - enqueue a send request */
143 static int tipc_udp_send_msg(struct net
*net
, struct sk_buff
*skb
,
144 struct tipc_bearer
*b
,
145 struct tipc_media_addr
*dest
)
148 struct udp_bearer
*ub
;
149 struct udp_media_addr
*dst
= (struct udp_media_addr
*)&dest
->value
;
150 struct udp_media_addr
*src
= (struct udp_media_addr
*)&b
->addr
.value
;
153 if (skb_headroom(skb
) < UDP_MIN_HEADROOM
) {
154 err
= pskb_expand_head(skb
, UDP_MIN_HEADROOM
, 0, GFP_ATOMIC
);
159 skb_set_inner_protocol(skb
, htons(ETH_P_TIPC
));
160 ub
= rcu_dereference_rtnl(b
->media_ptr
);
165 if (dst
->proto
== htons(ETH_P_IP
)) {
167 .daddr
= dst
->ipv4
.s_addr
,
168 .saddr
= src
->ipv4
.s_addr
,
169 .flowi4_mark
= skb
->mark
,
170 .flowi4_proto
= IPPROTO_UDP
172 rt
= ip_route_output_key(net
, &fl
);
178 skb
->dev
= rt
->dst
.dev
;
179 ttl
= ip4_dst_hoplimit(&rt
->dst
);
180 udp_tunnel_xmit_skb(rt
, ub
->ubsock
->sk
, skb
, src
->ipv4
.s_addr
,
181 dst
->ipv4
.s_addr
, 0, ttl
, 0, src
->udp_port
,
182 dst
->udp_port
, false, true);
183 #if IS_ENABLED(CONFIG_IPV6)
185 struct dst_entry
*ndst
;
186 struct flowi6 fl6
= {
187 .flowi6_oif
= ub
->ifindex
,
190 .flowi6_proto
= IPPROTO_UDP
192 err
= ipv6_stub
->ipv6_dst_lookup(net
, ub
->ubsock
->sk
, &ndst
,
196 ttl
= ip6_dst_hoplimit(ndst
);
197 err
= udp_tunnel6_xmit_skb(ndst
, ub
->ubsock
->sk
, skb
,
198 ndst
->dev
, &src
->ipv6
,
199 &dst
->ipv6
, 0, ttl
, 0, src
->udp_port
,
200 dst
->udp_port
, false);
210 /* tipc_udp_recv - read data from bearer socket */
211 static int tipc_udp_recv(struct sock
*sk
, struct sk_buff
*skb
)
213 struct udp_bearer
*ub
;
214 struct tipc_bearer
*b
;
216 ub
= rcu_dereference_sk_user_data(sk
);
218 pr_err_ratelimited("Failed to get UDP bearer reference");
223 skb_pull(skb
, sizeof(struct udphdr
));
225 b
= rcu_dereference_rtnl(ub
->bearer
);
228 tipc_rcv(sock_net(sk
), skb
, b
);
237 static int enable_mcast(struct udp_bearer
*ub
, struct udp_media_addr
*remote
)
240 struct ip_mreqn mreqn
;
241 struct sock
*sk
= ub
->ubsock
->sk
;
243 if (ntohs(remote
->proto
) == ETH_P_IP
) {
244 if (!ipv4_is_multicast(remote
->ipv4
.s_addr
))
246 mreqn
.imr_multiaddr
= remote
->ipv4
;
247 mreqn
.imr_ifindex
= ub
->ifindex
;
248 err
= ip_mc_join_group(sk
, &mreqn
);
249 #if IS_ENABLED(CONFIG_IPV6)
251 if (!ipv6_addr_is_multicast(&remote
->ipv6
))
253 err
= ipv6_stub
->ipv6_sock_mc_join(sk
, ub
->ifindex
,
261 * parse_options - build local/remote addresses from configuration
262 * @attrs: netlink config data
263 * @ub: UDP bearer instance
264 * @local: local bearer IP address/port
265 * @remote: peer or multicast IP/port
267 static int parse_options(struct nlattr
*attrs
[], struct udp_bearer
*ub
,
268 struct udp_media_addr
*local
,
269 struct udp_media_addr
*remote
)
271 struct nlattr
*opts
[TIPC_NLA_UDP_MAX
+ 1];
272 struct sockaddr_storage sa_local
, sa_remote
;
274 if (!attrs
[TIPC_NLA_BEARER_UDP_OPTS
])
276 if (nla_parse_nested(opts
, TIPC_NLA_UDP_MAX
,
277 attrs
[TIPC_NLA_BEARER_UDP_OPTS
],
280 if (opts
[TIPC_NLA_UDP_LOCAL
] && opts
[TIPC_NLA_UDP_REMOTE
]) {
281 nla_memcpy(&sa_local
, opts
[TIPC_NLA_UDP_LOCAL
],
283 nla_memcpy(&sa_remote
, opts
[TIPC_NLA_UDP_REMOTE
],
287 pr_err("Invalid UDP bearer configuration");
290 if ((sa_local
.ss_family
& sa_remote
.ss_family
) == AF_INET
) {
291 struct sockaddr_in
*ip4
;
293 ip4
= (struct sockaddr_in
*)&sa_local
;
294 local
->proto
= htons(ETH_P_IP
);
295 local
->udp_port
= ip4
->sin_port
;
296 local
->ipv4
.s_addr
= ip4
->sin_addr
.s_addr
;
298 ip4
= (struct sockaddr_in
*)&sa_remote
;
299 remote
->proto
= htons(ETH_P_IP
);
300 remote
->udp_port
= ip4
->sin_port
;
301 remote
->ipv4
.s_addr
= ip4
->sin_addr
.s_addr
;
304 #if IS_ENABLED(CONFIG_IPV6)
305 } else if ((sa_local
.ss_family
& sa_remote
.ss_family
) == AF_INET6
) {
307 struct sockaddr_in6
*ip6
;
309 ip6
= (struct sockaddr_in6
*)&sa_local
;
310 atype
= ipv6_addr_type(&ip6
->sin6_addr
);
311 if (__ipv6_addr_needs_scope_id(atype
) && !ip6
->sin6_scope_id
)
314 local
->proto
= htons(ETH_P_IPV6
);
315 local
->udp_port
= ip6
->sin6_port
;
316 memcpy(&local
->ipv6
, &ip6
->sin6_addr
, sizeof(struct in6_addr
));
317 ub
->ifindex
= ip6
->sin6_scope_id
;
319 ip6
= (struct sockaddr_in6
*)&sa_remote
;
320 remote
->proto
= htons(ETH_P_IPV6
);
321 remote
->udp_port
= ip6
->sin6_port
;
322 memcpy(&remote
->ipv6
, &ip6
->sin6_addr
, sizeof(struct in6_addr
));
326 return -EADDRNOTAVAIL
;
330 * tipc_udp_enable - callback to create a new udp bearer instance
331 * @net: network namespace
332 * @b: pointer to generic tipc_bearer
333 * @attrs: netlink bearer configuration
335 * validate the bearer parameters and initialize the udp bearer
336 * rtnl_lock should be held
338 static int tipc_udp_enable(struct net
*net
, struct tipc_bearer
*b
,
339 struct nlattr
*attrs
[])
342 struct udp_bearer
*ub
;
343 struct udp_media_addr
*remote
;
344 struct udp_media_addr local
= {0};
345 struct udp_port_cfg udp_conf
= {0};
346 struct udp_tunnel_sock_cfg tuncfg
= {NULL
};
348 ub
= kzalloc(sizeof(*ub
), GFP_ATOMIC
);
352 remote
= (struct udp_media_addr
*)&b
->bcast_addr
.value
;
353 memset(remote
, 0, sizeof(struct udp_media_addr
));
354 err
= parse_options(attrs
, ub
, &local
, remote
);
358 b
->bcast_addr
.media_id
= TIPC_MEDIA_TYPE_UDP
;
359 b
->bcast_addr
.broadcast
= 1;
360 rcu_assign_pointer(b
->media_ptr
, ub
);
361 rcu_assign_pointer(ub
->bearer
, b
);
362 tipc_udp_media_addr_set(&b
->addr
, &local
);
363 if (local
.proto
== htons(ETH_P_IP
)) {
364 struct net_device
*dev
;
366 dev
= __ip_dev_find(net
, local
.ipv4
.s_addr
, false);
371 udp_conf
.family
= AF_INET
;
372 udp_conf
.local_ip
.s_addr
= htonl(INADDR_ANY
);
373 udp_conf
.use_udp_checksums
= false;
374 ub
->ifindex
= dev
->ifindex
;
375 b
->mtu
= dev
->mtu
- sizeof(struct iphdr
)
376 - sizeof(struct udphdr
);
377 #if IS_ENABLED(CONFIG_IPV6)
378 } else if (local
.proto
== htons(ETH_P_IPV6
)) {
379 udp_conf
.family
= AF_INET6
;
380 udp_conf
.use_udp6_tx_checksums
= true;
381 udp_conf
.use_udp6_rx_checksums
= true;
382 udp_conf
.local_ip6
= in6addr_any
;
389 udp_conf
.local_udp_port
= local
.udp_port
;
390 err
= udp_sock_create(net
, &udp_conf
, &ub
->ubsock
);
393 tuncfg
.sk_user_data
= ub
;
394 tuncfg
.encap_type
= 1;
395 tuncfg
.encap_rcv
= tipc_udp_recv
;
396 tuncfg
.encap_destroy
= NULL
;
397 setup_udp_tunnel_sock(net
, ub
->ubsock
, &tuncfg
);
399 if (enable_mcast(ub
, remote
))
407 /* cleanup_bearer - break the socket/bearer association */
408 static void cleanup_bearer(struct work_struct
*work
)
410 struct udp_bearer
*ub
= container_of(work
, struct udp_bearer
, work
);
413 udp_tunnel_sock_release(ub
->ubsock
);
418 /* tipc_udp_disable - detach bearer from socket */
419 static void tipc_udp_disable(struct tipc_bearer
*b
)
421 struct udp_bearer
*ub
;
423 ub
= rcu_dereference_rtnl(b
->media_ptr
);
425 pr_err("UDP bearer instance not found\n");
429 sock_set_flag(ub
->ubsock
->sk
, SOCK_DEAD
);
430 RCU_INIT_POINTER(ub
->bearer
, NULL
);
432 /* sock_release need to be done outside of rtnl lock */
433 INIT_WORK(&ub
->work
, cleanup_bearer
);
434 schedule_work(&ub
->work
);
437 struct tipc_media udp_media_info
= {
438 .send_msg
= tipc_udp_send_msg
,
439 .enable_media
= tipc_udp_enable
,
440 .disable_media
= tipc_udp_disable
,
441 .addr2str
= tipc_udp_addr2str
,
442 .addr2msg
= tipc_udp_addr2msg
,
443 .msg2addr
= tipc_udp_msg2addr
,
444 .priority
= TIPC_DEF_LINK_PRI
,
445 .tolerance
= TIPC_DEF_LINK_TOL
,
446 .window
= TIPC_DEF_LINK_WIN
,
447 .type_id
= TIPC_MEDIA_TYPE_UDP
,