1 #ifndef __NET_IP_TUNNELS_H
2 #define __NET_IP_TUNNELS_H 1
4 #include <linux/if_tunnel.h>
5 #include <linux/netdevice.h>
6 #include <linux/skbuff.h>
7 #include <linux/socket.h>
8 #include <linux/types.h>
9 #include <linux/u64_stats_sync.h>
10 #include <linux/bitops.h>
12 #include <net/dsfield.h>
13 #include <net/gro_cells.h>
14 #include <net/inet_ecn.h>
15 #include <net/netns/generic.h>
16 #include <net/rtnetlink.h>
17 #include <net/lwtunnel.h>
18 #include <net/dst_cache.h>
20 #if IS_ENABLED(CONFIG_IPV6)
22 #include <net/ip6_fib.h>
23 #include <net/ip6_route.h>
26 /* Keep error state on tunnel for 30 sec */
27 #define IPTUNNEL_ERR_TIMEO (30*HZ)
29 /* Used to memset ip_tunnel padding. */
30 #define IP_TUNNEL_KEY_SIZE offsetofend(struct ip_tunnel_key, tp_dst)
32 /* Used to memset ipv4 address padding. */
33 #define IP_TUNNEL_KEY_IPV4_PAD offsetofend(struct ip_tunnel_key, u.ipv4.dst)
34 #define IP_TUNNEL_KEY_IPV4_PAD_LEN \
35 (FIELD_SIZEOF(struct ip_tunnel_key, u) - \
36 FIELD_SIZEOF(struct ip_tunnel_key, u.ipv4))
38 struct ip_tunnel_key
{
51 u8 tos
; /* TOS for IPv4, TC for IPv6 */
52 u8 ttl
; /* TTL for IPv4, HL for IPv6 */
53 __be32 label
; /* Flow Label for IPv6 */
58 /* Flags for ip_tunnel_info mode. */
59 #define IP_TUNNEL_INFO_TX 0x01 /* represents tx tunnel parameters */
60 #define IP_TUNNEL_INFO_IPV6 0x02 /* key contains IPv6 addresses */
62 /* Maximum tunnel options length. */
63 #define IP_TUNNEL_OPTS_MAX \
64 GENMASK((FIELD_SIZEOF(struct ip_tunnel_info, \
65 options_len) * BITS_PER_BYTE) - 1, 0)
67 struct ip_tunnel_info
{
68 struct ip_tunnel_key key
;
69 #ifdef CONFIG_DST_CACHE
70 struct dst_cache dst_cache
;
76 /* 6rd prefix/relay information */
77 #ifdef CONFIG_IPV6_SIT_6RD
78 struct ip_tunnel_6rd_parm
{
79 struct in6_addr prefix
;
86 struct ip_tunnel_encap
{
93 struct ip_tunnel_prl_entry
{
94 struct ip_tunnel_prl_entry __rcu
*next
;
97 struct rcu_head rcu_head
;
103 struct ip_tunnel __rcu
*next
;
104 struct hlist_node hash_node
;
105 struct net_device
*dev
;
106 struct net
*net
; /* netns for packet i/o */
108 unsigned long err_time
; /* Time when the last ICMP error
110 int err_count
; /* Number of arrived ICMP errors */
112 /* These four fields used only by GRE */
113 u32 i_seqno
; /* The last seen seqno */
114 u32 o_seqno
; /* The last output seqno */
115 int tun_hlen
; /* Precalculated header length */
117 struct dst_cache dst_cache
;
119 struct ip_tunnel_parm parms
;
122 int encap_hlen
; /* Encap header length (FOU,GUE) */
123 int hlen
; /* tun_hlen + encap_hlen */
124 struct ip_tunnel_encap encap
;
127 #ifdef CONFIG_IPV6_SIT_6RD
128 struct ip_tunnel_6rd_parm ip6rd
;
130 struct ip_tunnel_prl_entry __rcu
*prl
; /* potential router list */
131 unsigned int prl_count
; /* # of entries in PRL */
133 struct gro_cells gro_cells
;
138 #define TUNNEL_CSUM __cpu_to_be16(0x01)
139 #define TUNNEL_ROUTING __cpu_to_be16(0x02)
140 #define TUNNEL_KEY __cpu_to_be16(0x04)
141 #define TUNNEL_SEQ __cpu_to_be16(0x08)
142 #define TUNNEL_STRICT __cpu_to_be16(0x10)
143 #define TUNNEL_REC __cpu_to_be16(0x20)
144 #define TUNNEL_VERSION __cpu_to_be16(0x40)
145 #define TUNNEL_NO_KEY __cpu_to_be16(0x80)
146 #define TUNNEL_DONT_FRAGMENT __cpu_to_be16(0x0100)
147 #define TUNNEL_OAM __cpu_to_be16(0x0200)
148 #define TUNNEL_CRIT_OPT __cpu_to_be16(0x0400)
149 #define TUNNEL_GENEVE_OPT __cpu_to_be16(0x0800)
150 #define TUNNEL_VXLAN_OPT __cpu_to_be16(0x1000)
151 #define TUNNEL_NOCACHE __cpu_to_be16(0x2000)
153 #define TUNNEL_OPTIONS_PRESENT (TUNNEL_GENEVE_OPT | TUNNEL_VXLAN_OPT)
155 struct tnl_ptk_info
{
163 #define PACKET_RCVD 0
164 #define PACKET_REJECT 1
165 #define PACKET_NEXT 2
167 #define IP_TNL_HASH_BITS 7
168 #define IP_TNL_HASH_SIZE (1 << IP_TNL_HASH_BITS)
170 struct ip_tunnel_net
{
171 struct net_device
*fb_tunnel_dev
;
172 struct hlist_head tunnels
[IP_TNL_HASH_SIZE
];
173 struct ip_tunnel __rcu
*collect_md_tun
;
176 static inline void ip_tunnel_key_init(struct ip_tunnel_key
*key
,
177 __be32 saddr
, __be32 daddr
,
178 u8 tos
, u8 ttl
, __be32 label
,
179 __be16 tp_src
, __be16 tp_dst
,
180 __be64 tun_id
, __be16 tun_flags
)
182 key
->tun_id
= tun_id
;
183 key
->u
.ipv4
.src
= saddr
;
184 key
->u
.ipv4
.dst
= daddr
;
185 memset((unsigned char *)key
+ IP_TUNNEL_KEY_IPV4_PAD
,
186 0, IP_TUNNEL_KEY_IPV4_PAD_LEN
);
190 key
->tun_flags
= tun_flags
;
192 /* For the tunnel types on the top of IPsec, the tp_src and tp_dst of
193 * the upper tunnel are used.
194 * E.g: GRE over IPSEC, the tp_src and tp_port are zero.
196 key
->tp_src
= tp_src
;
197 key
->tp_dst
= tp_dst
;
199 /* Clear struct padding. */
200 if (sizeof(*key
) != IP_TUNNEL_KEY_SIZE
)
201 memset((unsigned char *)key
+ IP_TUNNEL_KEY_SIZE
,
202 0, sizeof(*key
) - IP_TUNNEL_KEY_SIZE
);
206 ip_tunnel_dst_cache_usable(const struct sk_buff
*skb
,
207 const struct ip_tunnel_info
*info
)
213 if (info
->key
.tun_flags
& TUNNEL_NOCACHE
)
219 static inline unsigned short ip_tunnel_info_af(const struct ip_tunnel_info
222 return tun_info
->mode
& IP_TUNNEL_INFO_IPV6
? AF_INET6
: AF_INET
;
225 static inline __be64
key32_to_tunnel_id(__be32 key
)
228 return (__force __be64
)key
;
230 return (__force __be64
)((__force u64
)key
<< 32);
234 /* Returns the least-significant 32 bits of a __be64. */
235 static inline __be32
tunnel_id_to_key32(__be64 tun_id
)
238 return (__force __be32
)tun_id
;
240 return (__force __be32
)((__force u64
)tun_id
>> 32);
246 int ip_tunnel_init(struct net_device
*dev
);
247 void ip_tunnel_uninit(struct net_device
*dev
);
248 void ip_tunnel_dellink(struct net_device
*dev
, struct list_head
*head
);
249 struct net
*ip_tunnel_get_link_net(const struct net_device
*dev
);
250 int ip_tunnel_get_iflink(const struct net_device
*dev
);
251 int ip_tunnel_init_net(struct net
*net
, int ip_tnl_net_id
,
252 struct rtnl_link_ops
*ops
, char *devname
);
254 void ip_tunnel_delete_net(struct ip_tunnel_net
*itn
, struct rtnl_link_ops
*ops
);
256 void ip_tunnel_xmit(struct sk_buff
*skb
, struct net_device
*dev
,
257 const struct iphdr
*tnl_params
, const u8 protocol
);
258 int ip_tunnel_ioctl(struct net_device
*dev
, struct ip_tunnel_parm
*p
, int cmd
);
259 int __ip_tunnel_change_mtu(struct net_device
*dev
, int new_mtu
, bool strict
);
260 int ip_tunnel_change_mtu(struct net_device
*dev
, int new_mtu
);
262 struct rtnl_link_stats64
*ip_tunnel_get_stats64(struct net_device
*dev
,
263 struct rtnl_link_stats64
*tot
);
264 struct ip_tunnel
*ip_tunnel_lookup(struct ip_tunnel_net
*itn
,
265 int link
, __be16 flags
,
266 __be32 remote
, __be32 local
,
269 int ip_tunnel_rcv(struct ip_tunnel
*tunnel
, struct sk_buff
*skb
,
270 const struct tnl_ptk_info
*tpi
, struct metadata_dst
*tun_dst
,
272 int ip_tunnel_changelink(struct net_device
*dev
, struct nlattr
*tb
[],
273 struct ip_tunnel_parm
*p
);
274 int ip_tunnel_newlink(struct net_device
*dev
, struct nlattr
*tb
[],
275 struct ip_tunnel_parm
*p
);
276 void ip_tunnel_setup(struct net_device
*dev
, int net_id
);
278 struct ip_tunnel_encap_ops
{
279 size_t (*encap_hlen
)(struct ip_tunnel_encap
*e
);
280 int (*build_header
)(struct sk_buff
*skb
, struct ip_tunnel_encap
*e
,
281 u8
*protocol
, struct flowi4
*fl4
);
284 #define MAX_IPTUN_ENCAP_OPS 8
286 extern const struct ip_tunnel_encap_ops __rcu
*
287 iptun_encaps
[MAX_IPTUN_ENCAP_OPS
];
289 int ip_tunnel_encap_add_ops(const struct ip_tunnel_encap_ops
*op
,
291 int ip_tunnel_encap_del_ops(const struct ip_tunnel_encap_ops
*op
,
294 int ip_tunnel_encap_setup(struct ip_tunnel
*t
,
295 struct ip_tunnel_encap
*ipencap
);
297 static inline int ip_encap_hlen(struct ip_tunnel_encap
*e
)
299 const struct ip_tunnel_encap_ops
*ops
;
302 if (e
->type
== TUNNEL_ENCAP_NONE
)
305 if (e
->type
>= MAX_IPTUN_ENCAP_OPS
)
309 ops
= rcu_dereference(iptun_encaps
[e
->type
]);
310 if (likely(ops
&& ops
->encap_hlen
))
311 hlen
= ops
->encap_hlen(e
);
317 static inline int ip_tunnel_encap(struct sk_buff
*skb
, struct ip_tunnel
*t
,
318 u8
*protocol
, struct flowi4
*fl4
)
320 const struct ip_tunnel_encap_ops
*ops
;
323 if (t
->encap
.type
== TUNNEL_ENCAP_NONE
)
326 if (t
->encap
.type
>= MAX_IPTUN_ENCAP_OPS
)
330 ops
= rcu_dereference(iptun_encaps
[t
->encap
.type
]);
331 if (likely(ops
&& ops
->build_header
))
332 ret
= ops
->build_header(skb
, &t
->encap
, protocol
, fl4
);
338 /* Extract dsfield from inner protocol */
339 static inline u8
ip_tunnel_get_dsfield(const struct iphdr
*iph
,
340 const struct sk_buff
*skb
)
342 if (skb
->protocol
== htons(ETH_P_IP
))
344 else if (skb
->protocol
== htons(ETH_P_IPV6
))
345 return ipv6_get_dsfield((const struct ipv6hdr
*)iph
);
350 /* Propogate ECN bits out */
351 static inline u8
ip_tunnel_ecn_encap(u8 tos
, const struct iphdr
*iph
,
352 const struct sk_buff
*skb
)
354 u8 inner
= ip_tunnel_get_dsfield(iph
, skb
);
356 return INET_ECN_encapsulate(tos
, inner
);
359 int __iptunnel_pull_header(struct sk_buff
*skb
, int hdr_len
,
360 __be16 inner_proto
, bool raw_proto
, bool xnet
);
362 static inline int iptunnel_pull_header(struct sk_buff
*skb
, int hdr_len
,
363 __be16 inner_proto
, bool xnet
)
365 return __iptunnel_pull_header(skb
, hdr_len
, inner_proto
, false, xnet
);
368 void iptunnel_xmit(struct sock
*sk
, struct rtable
*rt
, struct sk_buff
*skb
,
369 __be32 src
, __be32 dst
, u8 proto
,
370 u8 tos
, u8 ttl
, __be16 df
, bool xnet
);
371 struct metadata_dst
*iptunnel_metadata_reply(struct metadata_dst
*md
,
374 int iptunnel_handle_offloads(struct sk_buff
*skb
, int gso_type_mask
);
376 static inline int iptunnel_pull_offloads(struct sk_buff
*skb
)
378 if (skb_is_gso(skb
)) {
381 err
= skb_unclone(skb
, GFP_ATOMIC
);
384 skb_shinfo(skb
)->gso_type
&= ~(NETIF_F_GSO_ENCAP_ALL
>>
388 skb
->encapsulation
= 0;
392 static inline void iptunnel_xmit_stats(struct net_device
*dev
, int pkt_len
)
395 struct pcpu_sw_netstats
*tstats
= get_cpu_ptr(dev
->tstats
);
397 u64_stats_update_begin(&tstats
->syncp
);
398 tstats
->tx_bytes
+= pkt_len
;
399 tstats
->tx_packets
++;
400 u64_stats_update_end(&tstats
->syncp
);
403 struct net_device_stats
*err_stats
= &dev
->stats
;
406 err_stats
->tx_errors
++;
407 err_stats
->tx_aborted_errors
++;
409 err_stats
->tx_dropped
++;
414 static inline void *ip_tunnel_info_opts(struct ip_tunnel_info
*info
)
419 static inline void ip_tunnel_info_opts_get(void *to
,
420 const struct ip_tunnel_info
*info
)
422 memcpy(to
, info
+ 1, info
->options_len
);
425 static inline void ip_tunnel_info_opts_set(struct ip_tunnel_info
*info
,
426 const void *from
, int len
)
428 memcpy(ip_tunnel_info_opts(info
), from
, len
);
429 info
->options_len
= len
;
432 static inline struct ip_tunnel_info
*lwt_tun_info(struct lwtunnel_state
*lwtstate
)
434 return (struct ip_tunnel_info
*)lwtstate
->data
;
437 extern struct static_key ip_tunnel_metadata_cnt
;
439 /* Returns > 0 if metadata should be collected */
440 static inline int ip_tunnel_collect_metadata(void)
442 return static_key_false(&ip_tunnel_metadata_cnt
);
445 void __init
ip_tunnel_core_init(void);
447 void ip_tunnel_need_metadata(void);
448 void ip_tunnel_unneed_metadata(void);
450 #else /* CONFIG_INET */
452 static inline struct ip_tunnel_info
*lwt_tun_info(struct lwtunnel_state
*lwtstate
)
457 static inline void ip_tunnel_need_metadata(void)
461 static inline void ip_tunnel_unneed_metadata(void)
465 static inline void ip_tunnel_info_opts_get(void *to
,
466 const struct ip_tunnel_info
*info
)
470 static inline void ip_tunnel_info_opts_set(struct ip_tunnel_info
*info
,
471 const void *from
, int len
)
473 info
->options_len
= 0;
476 #endif /* CONFIG_INET */
478 #endif /* __NET_IP_TUNNELS_H */