xref: /linux/include/net/ip6_tunnel.h (revision 42a9fb3382fc2573e92f41d203b095d9a372cfc9)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NET_IP6_TUNNEL_H
3 #define _NET_IP6_TUNNEL_H
4 
5 #include <linux/ipv6.h>
6 #include <linux/netdevice.h>
7 #include <linux/if_tunnel.h>
8 #include <linux/ip6_tunnel.h>
9 #include <net/ip_tunnels.h>
10 #include <net/dst_cache.h>
11 
12 #define IP6TUNNEL_ERR_TIMEO (30*HZ)
13 
14 /* capable of sending packets */
15 #define IP6_TNL_F_CAP_XMIT 0x10000
16 /* capable of receiving packets */
17 #define IP6_TNL_F_CAP_RCV 0x20000
18 /* determine capability on a per-packet basis */
19 #define IP6_TNL_F_CAP_PER_PACKET 0x40000
20 
21 struct __ip6_tnl_parm {
22 	char name[IFNAMSIZ];	/* name of tunnel device */
23 	int link;		/* ifindex of underlying L2 interface */
24 	__u8 proto;		/* tunnel protocol */
25 	__u8 encap_limit;	/* encapsulation limit for tunnel */
26 	__u8 hop_limit;		/* hop limit for tunnel */
27 	bool collect_md;
28 	__be32 flowinfo;	/* traffic class and flowlabel for tunnel */
29 	__u32 flags;		/* tunnel flags */
30 	struct in6_addr laddr;	/* local tunnel end-point address */
31 	struct in6_addr raddr;	/* remote tunnel end-point address */
32 
33 	IP_TUNNEL_DECLARE_FLAGS(i_flags);
34 	IP_TUNNEL_DECLARE_FLAGS(o_flags);
35 	__be32			i_key;
36 	__be32			o_key;
37 
38 	__u32			fwmark;
39 	__u32			index;	/* ERSPAN type II index */
40 	__u8			erspan_ver;	/* ERSPAN version */
41 	__u8			dir;	/* direction */
42 	__u16			hwid;	/* hwid */
43 };
44 
45 /* IPv6 tunnel */
46 struct ip6_tnl {
47 	struct ip6_tnl __rcu *next;	/* next tunnel in list */
48 	struct hlist_node hash_node;
49 	struct net_device *dev;	/* virtual device associated with tunnel */
50 	netdevice_tracker dev_tracker;
51 	struct net *net;	/* netns for packet i/o */
52 	struct __ip6_tnl_parm parms;	/* tunnel configuration parameters */
53 	struct flowi fl;	/* flowi template for xmit */
54 	struct dst_cache dst_cache;	/* cached dst */
55 	struct gro_cells gro_cells;
56 
57 	int err_count;
58 	unsigned long err_time;
59 
60 	/* These fields used only by GRE */
61 	__u32 i_seqno;	/* The last seen seqno	*/
62 	atomic_t o_seqno;	/* The last output seqno */
63 	int hlen;       /* tun_hlen + encap_hlen */
64 	int tun_hlen;	/* Precalculated header length */
65 	int encap_hlen; /* Encap header length (FOU,GUE) */
66 	struct ip_tunnel_encap encap;
67 	int mlink;
68 };
69 
70 struct ip6_tnl_encap_ops {
71 	size_t (*encap_hlen)(struct ip_tunnel_encap *e);
72 	int (*build_header)(struct sk_buff *skb, struct ip_tunnel_encap *e,
73 			    u8 *protocol, struct flowi6 *fl6);
74 	int (*err_handler)(struct sk_buff *skb, struct inet6_skb_parm *opt,
75 			   u8 type, u8 code, int offset, __be32 info);
76 };
77 
78 #ifdef CONFIG_INET
79 
80 extern const struct ip6_tnl_encap_ops __rcu *
81 		ip6tun_encaps[MAX_IPTUN_ENCAP_OPS];
82 
83 int ip6_tnl_encap_add_ops(const struct ip6_tnl_encap_ops *ops,
84 			  unsigned int num);
85 int ip6_tnl_encap_del_ops(const struct ip6_tnl_encap_ops *ops,
86 			  unsigned int num);
87 int ip6_tnl_encap_setup(struct ip6_tnl *t,
88 			struct ip_tunnel_encap *ipencap);
89 
90 static inline int ip6_encap_hlen(struct ip_tunnel_encap *e)
91 {
92 	const struct ip6_tnl_encap_ops *ops;
93 	int hlen = -EINVAL;
94 
95 	if (e->type == TUNNEL_ENCAP_NONE)
96 		return 0;
97 
98 	if (e->type >= MAX_IPTUN_ENCAP_OPS)
99 		return -EINVAL;
100 
101 	rcu_read_lock();
102 	ops = rcu_dereference(ip6tun_encaps[e->type]);
103 	if (likely(ops && ops->encap_hlen))
104 		hlen = ops->encap_hlen(e);
105 	rcu_read_unlock();
106 
107 	return hlen;
108 }
109 
110 static inline int ip6_tnl_encap(struct sk_buff *skb, struct ip6_tnl *t,
111 				u8 *protocol, struct flowi6 *fl6)
112 {
113 	const struct ip6_tnl_encap_ops *ops;
114 	int ret = -EINVAL;
115 
116 	if (t->encap.type == TUNNEL_ENCAP_NONE)
117 		return 0;
118 
119 	if (t->encap.type >= MAX_IPTUN_ENCAP_OPS)
120 		return -EINVAL;
121 
122 	rcu_read_lock();
123 	ops = rcu_dereference(ip6tun_encaps[t->encap.type]);
124 	if (likely(ops && ops->build_header))
125 		ret = ops->build_header(skb, &t->encap, protocol, fl6);
126 	rcu_read_unlock();
127 
128 	return ret;
129 }
130 
131 /* Tunnel encapsulation limit destination sub-option */
132 
133 struct ipv6_tlv_tnl_enc_lim {
134 	__u8 type;		/* type-code for option         */
135 	__u8 length;		/* option length                */
136 	__u8 encap_limit;	/* tunnel encapsulation limit   */
137 } __packed;
138 
139 int ip6_tnl_rcv_ctl(struct ip6_tnl *t, const struct in6_addr *laddr,
140 		const struct in6_addr *raddr);
141 int ip6_tnl_rcv(struct ip6_tnl *tunnel, struct sk_buff *skb,
142 		const struct tnl_ptk_info *tpi, struct metadata_dst *tun_dst,
143 		bool log_ecn_error);
144 int ip6_tnl_xmit_ctl(struct ip6_tnl *t, const struct in6_addr *laddr,
145 		     const struct in6_addr *raddr);
146 int ip6_tnl_xmit(struct sk_buff *skb, struct net_device *dev, __u8 dsfield,
147 		 struct flowi6 *fl6, int encap_limit, __u32 *pmtu, __u8 proto);
148 __u16 ip6_tnl_parse_tlv_enc_lim(struct sk_buff *skb, __u8 *raw);
149 __u32 ip6_tnl_get_cap(struct ip6_tnl *t, const struct in6_addr *laddr,
150 			     const struct in6_addr *raddr);
151 struct net *ip6_tnl_get_link_net(const struct net_device *dev);
152 int ip6_tnl_get_iflink(const struct net_device *dev);
153 int ip6_tnl_change_mtu(struct net_device *dev, int new_mtu);
154 
155 static inline void ip6tunnel_xmit(struct sock *sk, struct sk_buff *skb,
156 				  struct net_device *dev, u16 ip6cb_flags)
157 {
158 	int pkt_len, err;
159 
160 	if (unlikely(dev_recursion_level() > IP_TUNNEL_RECURSION_LIMIT)) {
161 		if (dev) {
162 			net_crit_ratelimited("Dead loop on virtual device %s, fix it urgently!\n",
163 					     dev->name);
164 			DEV_STATS_INC(dev, tx_errors);
165 		}
166 		kfree_skb_reason(skb, SKB_DROP_REASON_RECURSION_LIMIT);
167 		return;
168 	}
169 
170 	dev_xmit_recursion_inc();
171 
172 	memset(skb->cb, 0, sizeof(struct inet6_skb_parm));
173 	IP6CB(skb)->flags = ip6cb_flags;
174 	pkt_len = skb->len - skb_inner_network_offset(skb);
175 	err = ip6_local_out(skb_dst_dev_net(skb), sk, skb);
176 
177 	if (dev) {
178 		if (unlikely(net_xmit_eval(err)))
179 			pkt_len = -1;
180 		iptunnel_xmit_stats(dev, pkt_len);
181 	}
182 
183 	dev_xmit_recursion_dec();
184 }
185 #endif
186 #endif
187