Loading...
Note: File does not exist in v3.1.
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __NET_UDP_TUNNEL_H
3#define __NET_UDP_TUNNEL_H
4
5#include <net/ip_tunnels.h>
6#include <net/udp.h>
7
8#if IS_ENABLED(CONFIG_IPV6)
9#include <net/ipv6.h>
10#include <net/ipv6_stubs.h>
11#endif
12
13struct udp_port_cfg {
14 u8 family;
15
16 /* Used only for kernel-created sockets */
17 union {
18 struct in_addr local_ip;
19#if IS_ENABLED(CONFIG_IPV6)
20 struct in6_addr local_ip6;
21#endif
22 };
23
24 union {
25 struct in_addr peer_ip;
26#if IS_ENABLED(CONFIG_IPV6)
27 struct in6_addr peer_ip6;
28#endif
29 };
30
31 __be16 local_udp_port;
32 __be16 peer_udp_port;
33 int bind_ifindex;
34 unsigned int use_udp_checksums:1,
35 use_udp6_tx_checksums:1,
36 use_udp6_rx_checksums:1,
37 ipv6_v6only:1;
38};
39
40int udp_sock_create4(struct net *net, struct udp_port_cfg *cfg,
41 struct socket **sockp);
42
43#if IS_ENABLED(CONFIG_IPV6)
44int udp_sock_create6(struct net *net, struct udp_port_cfg *cfg,
45 struct socket **sockp);
46#else
47static inline int udp_sock_create6(struct net *net, struct udp_port_cfg *cfg,
48 struct socket **sockp)
49{
50 return 0;
51}
52#endif
53
54static inline int udp_sock_create(struct net *net,
55 struct udp_port_cfg *cfg,
56 struct socket **sockp)
57{
58 if (cfg->family == AF_INET)
59 return udp_sock_create4(net, cfg, sockp);
60
61 if (cfg->family == AF_INET6)
62 return udp_sock_create6(net, cfg, sockp);
63
64 return -EPFNOSUPPORT;
65}
66
67typedef int (*udp_tunnel_encap_rcv_t)(struct sock *sk, struct sk_buff *skb);
68typedef int (*udp_tunnel_encap_err_lookup_t)(struct sock *sk,
69 struct sk_buff *skb);
70typedef void (*udp_tunnel_encap_destroy_t)(struct sock *sk);
71typedef struct sk_buff *(*udp_tunnel_gro_receive_t)(struct sock *sk,
72 struct list_head *head,
73 struct sk_buff *skb);
74typedef int (*udp_tunnel_gro_complete_t)(struct sock *sk, struct sk_buff *skb,
75 int nhoff);
76
77struct udp_tunnel_sock_cfg {
78 void *sk_user_data; /* user data used by encap_rcv call back */
79 /* Used for setting up udp_sock fields, see udp.h for details */
80 __u8 encap_type;
81 udp_tunnel_encap_rcv_t encap_rcv;
82 udp_tunnel_encap_err_lookup_t encap_err_lookup;
83 udp_tunnel_encap_destroy_t encap_destroy;
84 udp_tunnel_gro_receive_t gro_receive;
85 udp_tunnel_gro_complete_t gro_complete;
86};
87
88/* Setup the given (UDP) sock to receive UDP encapsulated packets */
89void setup_udp_tunnel_sock(struct net *net, struct socket *sock,
90 struct udp_tunnel_sock_cfg *sock_cfg);
91
92/* -- List of parsable UDP tunnel types --
93 *
94 * Adding to this list will result in serious debate. The main issue is
95 * that this list is essentially a list of workarounds for either poorly
96 * designed tunnels, or poorly designed device offloads.
97 *
98 * The parsing supported via these types should really be used for Rx
99 * traffic only as the network stack will have already inserted offsets for
100 * the location of the headers in the skb. In addition any ports that are
101 * pushed should be kept within the namespace without leaking to other
102 * devices such as VFs or other ports on the same device.
103 *
104 * It is strongly encouraged to use CHECKSUM_COMPLETE for Rx to avoid the
105 * need to use this for Rx checksum offload. It should not be necessary to
106 * call this function to perform Tx offloads on outgoing traffic.
107 */
108enum udp_parsable_tunnel_type {
109 UDP_TUNNEL_TYPE_VXLAN = BIT(0), /* RFC 7348 */
110 UDP_TUNNEL_TYPE_GENEVE = BIT(1), /* draft-ietf-nvo3-geneve */
111 UDP_TUNNEL_TYPE_VXLAN_GPE = BIT(2), /* draft-ietf-nvo3-vxlan-gpe */
112};
113
114struct udp_tunnel_info {
115 unsigned short type;
116 sa_family_t sa_family;
117 __be16 port;
118 u8 hw_priv;
119};
120
121/* Notify network devices of offloadable types */
122void udp_tunnel_push_rx_port(struct net_device *dev, struct socket *sock,
123 unsigned short type);
124void udp_tunnel_drop_rx_port(struct net_device *dev, struct socket *sock,
125 unsigned short type);
126void udp_tunnel_notify_add_rx_port(struct socket *sock, unsigned short type);
127void udp_tunnel_notify_del_rx_port(struct socket *sock, unsigned short type);
128
129static inline void udp_tunnel_get_rx_info(struct net_device *dev)
130{
131 ASSERT_RTNL();
132 call_netdevice_notifiers(NETDEV_UDP_TUNNEL_PUSH_INFO, dev);
133}
134
135static inline void udp_tunnel_drop_rx_info(struct net_device *dev)
136{
137 ASSERT_RTNL();
138 call_netdevice_notifiers(NETDEV_UDP_TUNNEL_DROP_INFO, dev);
139}
140
141/* Transmit the skb using UDP encapsulation. */
142void udp_tunnel_xmit_skb(struct rtable *rt, struct sock *sk, struct sk_buff *skb,
143 __be32 src, __be32 dst, __u8 tos, __u8 ttl,
144 __be16 df, __be16 src_port, __be16 dst_port,
145 bool xnet, bool nocheck);
146
147int udp_tunnel6_xmit_skb(struct dst_entry *dst, struct sock *sk,
148 struct sk_buff *skb,
149 struct net_device *dev, struct in6_addr *saddr,
150 struct in6_addr *daddr,
151 __u8 prio, __u8 ttl, __be32 label,
152 __be16 src_port, __be16 dst_port, bool nocheck);
153
154void udp_tunnel_sock_release(struct socket *sock);
155
156struct metadata_dst *udp_tun_rx_dst(struct sk_buff *skb, unsigned short family,
157 __be16 flags, __be64 tunnel_id,
158 int md_size);
159
160#ifdef CONFIG_INET
161static inline int udp_tunnel_handle_offloads(struct sk_buff *skb, bool udp_csum)
162{
163 int type = udp_csum ? SKB_GSO_UDP_TUNNEL_CSUM : SKB_GSO_UDP_TUNNEL;
164
165 return iptunnel_handle_offloads(skb, type);
166}
167#endif
168
169static inline void udp_tunnel_encap_enable(struct socket *sock)
170{
171 struct udp_sock *up = udp_sk(sock->sk);
172
173 if (up->encap_enabled)
174 return;
175
176 up->encap_enabled = 1;
177#if IS_ENABLED(CONFIG_IPV6)
178 if (sock->sk->sk_family == PF_INET6)
179 ipv6_stub->udpv6_encap_enable();
180 else
181#endif
182 udp_encap_enable();
183}
184
185#define UDP_TUNNEL_NIC_MAX_TABLES 4
186
187enum udp_tunnel_nic_info_flags {
188 /* Device callbacks may sleep */
189 UDP_TUNNEL_NIC_INFO_MAY_SLEEP = BIT(0),
190 /* Device only supports offloads when it's open, all ports
191 * will be removed before close and re-added after open.
192 */
193 UDP_TUNNEL_NIC_INFO_OPEN_ONLY = BIT(1),
194 /* Device supports only IPv4 tunnels */
195 UDP_TUNNEL_NIC_INFO_IPV4_ONLY = BIT(2),
196 /* Device has hard-coded the IANA VXLAN port (4789) as VXLAN.
197 * This port must not be counted towards n_entries of any table.
198 * Driver will not receive any callback associated with port 4789.
199 */
200 UDP_TUNNEL_NIC_INFO_STATIC_IANA_VXLAN = BIT(3),
201};
202
203/**
204 * struct udp_tunnel_nic_info - driver UDP tunnel offload information
205 * @set_port: callback for adding a new port
206 * @unset_port: callback for removing a port
207 * @sync_table: callback for syncing the entire port table at once
208 * @flags: device flags from enum udp_tunnel_nic_info_flags
209 * @tables: UDP port tables this device has
210 * @tables.n_entries: number of entries in this table
211 * @tables.tunnel_types: types of tunnels this table accepts
212 *
213 * Drivers are expected to provide either @set_port and @unset_port callbacks
214 * or the @sync_table callback. Callbacks are invoked with rtnl lock held.
215 *
216 * Known limitations:
217 * - UDP tunnel port notifications are fundamentally best-effort -
218 * it is likely the driver will both see skbs which use a UDP tunnel port,
219 * while not being a tunneled skb, and tunnel skbs from other ports -
220 * drivers should only use these ports for non-critical RX-side offloads,
221 * e.g. the checksum offload;
222 * - none of the devices care about the socket family at present, so we don't
223 * track it. Please extend this code if you care.
224 */
225struct udp_tunnel_nic_info {
226 /* one-by-one */
227 int (*set_port)(struct net_device *dev,
228 unsigned int table, unsigned int entry,
229 struct udp_tunnel_info *ti);
230 int (*unset_port)(struct net_device *dev,
231 unsigned int table, unsigned int entry,
232 struct udp_tunnel_info *ti);
233
234 /* all at once */
235 int (*sync_table)(struct net_device *dev, unsigned int table);
236
237 unsigned int flags;
238
239 struct udp_tunnel_nic_table_info {
240 unsigned int n_entries;
241 unsigned int tunnel_types;
242 } tables[UDP_TUNNEL_NIC_MAX_TABLES];
243};
244
245/* UDP tunnel module dependencies
246 *
247 * Tunnel drivers are expected to have a hard dependency on the udp_tunnel
248 * module. NIC drivers are not, they just attach their
249 * struct udp_tunnel_nic_info to the netdev and wait for callbacks to come.
250 * Loading a tunnel driver will cause the udp_tunnel module to be loaded
251 * and only then will all the required state structures be allocated.
252 * Since we want a weak dependency from the drivers and the core to udp_tunnel
253 * we call things through the following stubs.
254 */
255struct udp_tunnel_nic_ops {
256 void (*get_port)(struct net_device *dev, unsigned int table,
257 unsigned int idx, struct udp_tunnel_info *ti);
258 void (*set_port_priv)(struct net_device *dev, unsigned int table,
259 unsigned int idx, u8 priv);
260 void (*add_port)(struct net_device *dev, struct udp_tunnel_info *ti);
261 void (*del_port)(struct net_device *dev, struct udp_tunnel_info *ti);
262 void (*reset_ntf)(struct net_device *dev);
263
264 size_t (*dump_size)(struct net_device *dev, unsigned int table);
265 int (*dump_write)(struct net_device *dev, unsigned int table,
266 struct sk_buff *skb);
267};
268
269#ifdef CONFIG_INET
270extern const struct udp_tunnel_nic_ops *udp_tunnel_nic_ops;
271#else
272#define udp_tunnel_nic_ops ((struct udp_tunnel_nic_ops *)NULL)
273#endif
274
275static inline void
276udp_tunnel_nic_get_port(struct net_device *dev, unsigned int table,
277 unsigned int idx, struct udp_tunnel_info *ti)
278{
279 /* This helper is used from .sync_table, we indicate empty entries
280 * by zero'ed @ti. Drivers which need to know the details of a port
281 * when it gets deleted should use the .set_port / .unset_port
282 * callbacks.
283 * Zero out here, otherwise !CONFIG_INET causes uninitilized warnings.
284 */
285 memset(ti, 0, sizeof(*ti));
286
287 if (udp_tunnel_nic_ops)
288 udp_tunnel_nic_ops->get_port(dev, table, idx, ti);
289}
290
291static inline void
292udp_tunnel_nic_set_port_priv(struct net_device *dev, unsigned int table,
293 unsigned int idx, u8 priv)
294{
295 if (udp_tunnel_nic_ops)
296 udp_tunnel_nic_ops->set_port_priv(dev, table, idx, priv);
297}
298
299static inline void
300udp_tunnel_nic_add_port(struct net_device *dev, struct udp_tunnel_info *ti)
301{
302 if (udp_tunnel_nic_ops)
303 udp_tunnel_nic_ops->add_port(dev, ti);
304}
305
306static inline void
307udp_tunnel_nic_del_port(struct net_device *dev, struct udp_tunnel_info *ti)
308{
309 if (udp_tunnel_nic_ops)
310 udp_tunnel_nic_ops->del_port(dev, ti);
311}
312
313/**
314 * udp_tunnel_nic_reset_ntf() - device-originating reset notification
315 * @dev: network interface device structure
316 *
317 * Called by the driver to inform the core that the entire UDP tunnel port
318 * state has been lost, usually due to device reset. Core will assume device
319 * forgot all the ports and issue .set_port and .sync_table callbacks as
320 * necessary.
321 *
322 * This function must be called with rtnl lock held, and will issue all
323 * the callbacks before returning.
324 */
325static inline void udp_tunnel_nic_reset_ntf(struct net_device *dev)
326{
327 if (udp_tunnel_nic_ops)
328 udp_tunnel_nic_ops->reset_ntf(dev);
329}
330
331static inline size_t
332udp_tunnel_nic_dump_size(struct net_device *dev, unsigned int table)
333{
334 if (!udp_tunnel_nic_ops)
335 return 0;
336 return udp_tunnel_nic_ops->dump_size(dev, table);
337}
338
339static inline int
340udp_tunnel_nic_dump_write(struct net_device *dev, unsigned int table,
341 struct sk_buff *skb)
342{
343 if (!udp_tunnel_nic_ops)
344 return 0;
345 return udp_tunnel_nic_ops->dump_write(dev, table, skb);
346}
347#endif