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 <net/dsfield.h>
11 #include <net/gro_cells.h>
12 #include <net/inet_ecn.h>
13 #include <net/netns/generic.h>
14 #include <net/rtnetlink.h>
15 #include <net/lwtunnel.h>
16 #include <net/dst_cache.h>
18 #if IS_ENABLED(CONFIG_IPV6)
20 #include <net/ip6_fib.h>
21 #include <net/ip6_route.h>
24 /* Keep error state on tunnel for 30 sec */
25 #define IPTUNNEL_ERR_TIMEO (30*HZ)
27 /* Used to memset ip_tunnel padding. */
28 #define IP_TUNNEL_KEY_SIZE offsetofend(struct ip_tunnel_key, tp_dst)
30 /* Used to memset ipv4 address padding. */
31 #define IP_TUNNEL_KEY_IPV4_PAD offsetofend(struct ip_tunnel_key, u.ipv4.dst)
32 #define IP_TUNNEL_KEY_IPV4_PAD_LEN \
33 (FIELD_SIZEOF(struct ip_tunnel_key, u) - \
34 FIELD_SIZEOF(struct ip_tunnel_key, u.ipv4))
36 struct ip_tunnel_key {
49 u8 tos; /* TOS for IPv4, TC for IPv6 */
50 u8 ttl; /* TTL for IPv4, HL for IPv6 */
55 /* Flags for ip_tunnel_info mode. */
56 #define IP_TUNNEL_INFO_TX 0x01 /* represents tx tunnel parameters */
57 #define IP_TUNNEL_INFO_IPV6 0x02 /* key contains IPv6 addresses */
59 struct ip_tunnel_info {
60 struct ip_tunnel_key key;
65 /* 6rd prefix/relay information */
66 #ifdef CONFIG_IPV6_SIT_6RD
67 struct ip_tunnel_6rd_parm {
68 struct in6_addr prefix;
75 struct ip_tunnel_encap {
82 struct ip_tunnel_prl_entry {
83 struct ip_tunnel_prl_entry __rcu *next;
86 struct rcu_head rcu_head;
92 struct ip_tunnel __rcu *next;
93 struct hlist_node hash_node;
94 struct net_device *dev;
95 struct net *net; /* netns for packet i/o */
97 int err_count; /* Number of arrived ICMP errors */
98 unsigned long err_time; /* Time when the last ICMP error
101 /* These four fields used only by GRE */
102 u32 i_seqno; /* The last seen seqno */
103 u32 o_seqno; /* The last output seqno */
104 int tun_hlen; /* Precalculated header length */
107 struct dst_cache dst_cache;
109 struct ip_tunnel_parm parms;
111 int encap_hlen; /* Encap header length (FOU,GUE) */
112 struct ip_tunnel_encap encap;
114 int hlen; /* tun_hlen + encap_hlen */
117 #ifdef CONFIG_IPV6_SIT_6RD
118 struct ip_tunnel_6rd_parm ip6rd;
120 struct ip_tunnel_prl_entry __rcu *prl; /* potential router list */
121 unsigned int prl_count; /* # of entries in PRL */
123 struct gro_cells gro_cells;
127 #define TUNNEL_CSUM __cpu_to_be16(0x01)
128 #define TUNNEL_ROUTING __cpu_to_be16(0x02)
129 #define TUNNEL_KEY __cpu_to_be16(0x04)
130 #define TUNNEL_SEQ __cpu_to_be16(0x08)
131 #define TUNNEL_STRICT __cpu_to_be16(0x10)
132 #define TUNNEL_REC __cpu_to_be16(0x20)
133 #define TUNNEL_VERSION __cpu_to_be16(0x40)
134 #define TUNNEL_NO_KEY __cpu_to_be16(0x80)
135 #define TUNNEL_DONT_FRAGMENT __cpu_to_be16(0x0100)
136 #define TUNNEL_OAM __cpu_to_be16(0x0200)
137 #define TUNNEL_CRIT_OPT __cpu_to_be16(0x0400)
138 #define TUNNEL_GENEVE_OPT __cpu_to_be16(0x0800)
139 #define TUNNEL_VXLAN_OPT __cpu_to_be16(0x1000)
141 #define TUNNEL_OPTIONS_PRESENT (TUNNEL_GENEVE_OPT | TUNNEL_VXLAN_OPT)
143 struct tnl_ptk_info {
150 #define PACKET_RCVD 0
151 #define PACKET_REJECT 1
153 #define IP_TNL_HASH_BITS 7
154 #define IP_TNL_HASH_SIZE (1 << IP_TNL_HASH_BITS)
156 struct ip_tunnel_net {
157 struct net_device *fb_tunnel_dev;
158 struct hlist_head tunnels[IP_TNL_HASH_SIZE];
159 struct ip_tunnel __rcu *collect_md_tun;
162 struct ip_tunnel_encap_ops {
163 size_t (*encap_hlen)(struct ip_tunnel_encap *e);
164 int (*build_header)(struct sk_buff *skb, struct ip_tunnel_encap *e,
165 u8 *protocol, struct flowi4 *fl4);
168 #define MAX_IPTUN_ENCAP_OPS 8
170 extern const struct ip_tunnel_encap_ops __rcu *
171 iptun_encaps[MAX_IPTUN_ENCAP_OPS];
173 int ip_tunnel_encap_add_ops(const struct ip_tunnel_encap_ops *op,
175 int ip_tunnel_encap_del_ops(const struct ip_tunnel_encap_ops *op,
178 static inline void ip_tunnel_key_init(struct ip_tunnel_key *key,
179 __be32 saddr, __be32 daddr,
181 __be16 tp_src, __be16 tp_dst,
182 __be64 tun_id, __be16 tun_flags)
184 key->tun_id = tun_id;
185 key->u.ipv4.src = saddr;
186 key->u.ipv4.dst = daddr;
187 memset((unsigned char *)key + IP_TUNNEL_KEY_IPV4_PAD,
188 0, IP_TUNNEL_KEY_IPV4_PAD_LEN);
191 key->tun_flags = tun_flags;
193 /* For the tunnel types on the top of IPsec, the tp_src and tp_dst of
194 * the upper tunnel are used.
195 * E.g: GRE over IPSEC, the tp_src and tp_port are zero.
197 key->tp_src = tp_src;
198 key->tp_dst = tp_dst;
200 /* Clear struct padding. */
201 if (sizeof(*key) != IP_TUNNEL_KEY_SIZE)
202 memset((unsigned char *)key + IP_TUNNEL_KEY_SIZE,
203 0, sizeof(*key) - IP_TUNNEL_KEY_SIZE);
206 static inline unsigned short ip_tunnel_info_af(const struct ip_tunnel_info
209 return tun_info->mode & IP_TUNNEL_INFO_IPV6 ? AF_INET6 : AF_INET;
214 int ip_tunnel_init(struct net_device *dev);
215 void ip_tunnel_uninit(struct net_device *dev);
216 void ip_tunnel_dellink(struct net_device *dev, struct list_head *head);
217 struct net *ip_tunnel_get_link_net(const struct net_device *dev);
218 int ip_tunnel_get_iflink(const struct net_device *dev);
219 int ip_tunnel_init_net(struct net *net, int ip_tnl_net_id,
220 struct rtnl_link_ops *ops, char *devname);
222 void ip_tunnel_delete_net(struct ip_tunnel_net *itn, struct rtnl_link_ops *ops);
224 void ip_tunnel_xmit(struct sk_buff *skb, struct net_device *dev,
225 const struct iphdr *tnl_params, const u8 protocol);
226 int ip_tunnel_ioctl(struct net_device *dev, struct ip_tunnel_parm *p, int cmd);
227 int ip_tunnel_encap(struct sk_buff *skb, struct ip_tunnel *t,
228 u8 *protocol, struct flowi4 *fl4);
229 int __ip_tunnel_change_mtu(struct net_device *dev, int new_mtu, bool strict);
230 int ip_tunnel_change_mtu(struct net_device *dev, int new_mtu);
232 struct rtnl_link_stats64 *ip_tunnel_get_stats64(struct net_device *dev,
233 struct rtnl_link_stats64 *tot);
234 struct ip_tunnel *ip_tunnel_lookup(struct ip_tunnel_net *itn,
235 int link, __be16 flags,
236 __be32 remote, __be32 local,
239 int ip_tunnel_rcv(struct ip_tunnel *tunnel, struct sk_buff *skb,
240 const struct tnl_ptk_info *tpi, struct metadata_dst *tun_dst,
242 int ip_tunnel_changelink(struct net_device *dev, struct nlattr *tb[],
243 struct ip_tunnel_parm *p);
244 int ip_tunnel_newlink(struct net_device *dev, struct nlattr *tb[],
245 struct ip_tunnel_parm *p);
246 void ip_tunnel_setup(struct net_device *dev, int net_id);
247 int ip_tunnel_encap_setup(struct ip_tunnel *t,
248 struct ip_tunnel_encap *ipencap);
250 /* Extract dsfield from inner protocol */
251 static inline u8 ip_tunnel_get_dsfield(const struct iphdr *iph,
252 const struct sk_buff *skb)
254 if (skb->protocol == htons(ETH_P_IP))
256 else if (skb->protocol == htons(ETH_P_IPV6))
257 return ipv6_get_dsfield((const struct ipv6hdr *)iph);
262 /* Propogate ECN bits out */
263 static inline u8 ip_tunnel_ecn_encap(u8 tos, const struct iphdr *iph,
264 const struct sk_buff *skb)
266 u8 inner = ip_tunnel_get_dsfield(iph, skb);
268 return INET_ECN_encapsulate(tos, inner);
271 int iptunnel_pull_header(struct sk_buff *skb, int hdr_len, __be16 inner_proto);
272 int iptunnel_xmit(struct sock *sk, struct rtable *rt, struct sk_buff *skb,
273 __be32 src, __be32 dst, u8 proto,
274 u8 tos, u8 ttl, __be16 df, bool xnet);
275 struct metadata_dst *iptunnel_metadata_reply(struct metadata_dst *md,
278 struct sk_buff *iptunnel_handle_offloads(struct sk_buff *skb, bool gre_csum,
281 static inline int iptunnel_pull_offloads(struct sk_buff *skb)
283 if (skb_is_gso(skb)) {
286 err = skb_unclone(skb, GFP_ATOMIC);
289 skb_shinfo(skb)->gso_type &= ~(NETIF_F_GSO_ENCAP_ALL >>
293 skb->encapsulation = 0;
297 static inline void iptunnel_xmit_stats(int err,
298 struct net_device_stats *err_stats,
299 struct pcpu_sw_netstats __percpu *stats)
302 struct pcpu_sw_netstats *tstats = get_cpu_ptr(stats);
304 u64_stats_update_begin(&tstats->syncp);
305 tstats->tx_bytes += err;
306 tstats->tx_packets++;
307 u64_stats_update_end(&tstats->syncp);
309 } else if (err < 0) {
310 err_stats->tx_errors++;
311 err_stats->tx_aborted_errors++;
313 err_stats->tx_dropped++;
317 static inline void *ip_tunnel_info_opts(struct ip_tunnel_info *info)
322 static inline void ip_tunnel_info_opts_get(void *to,
323 const struct ip_tunnel_info *info)
325 memcpy(to, info + 1, info->options_len);
328 static inline void ip_tunnel_info_opts_set(struct ip_tunnel_info *info,
329 const void *from, int len)
331 memcpy(ip_tunnel_info_opts(info), from, len);
332 info->options_len = len;
335 static inline struct ip_tunnel_info *lwt_tun_info(struct lwtunnel_state *lwtstate)
337 return (struct ip_tunnel_info *)lwtstate->data;
340 extern struct static_key ip_tunnel_metadata_cnt;
342 /* Returns > 0 if metadata should be collected */
343 static inline int ip_tunnel_collect_metadata(void)
345 return static_key_false(&ip_tunnel_metadata_cnt);
348 void __init ip_tunnel_core_init(void);
350 void ip_tunnel_need_metadata(void);
351 void ip_tunnel_unneed_metadata(void);
353 #else /* CONFIG_INET */
355 static inline struct ip_tunnel_info *lwt_tun_info(struct lwtunnel_state *lwtstate)
360 static inline void ip_tunnel_need_metadata(void)
364 static inline void ip_tunnel_unneed_metadata(void)
368 #endif /* CONFIG_INET */
370 #endif /* __NET_IP_TUNNELS_H */