xref: /linux/include/net/ip6_route.h (revision 5e3992fe72748ed3892be876f09d4d990548b7af)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NET_IP6_ROUTE_H
3 #define _NET_IP6_ROUTE_H
4 
5 #include <net/addrconf.h>
6 #include <net/flow.h>
7 #include <net/ip6_fib.h>
8 #include <net/sock.h>
9 #include <net/lwtunnel.h>
10 #include <linux/ip.h>
11 #include <linux/ipv6.h>
12 #include <linux/route.h>
13 #include <net/nexthop.h>
14 
15 struct route_info {
16 	__u8			type;
17 	__u8			length;
18 	__u8			prefix_len;
19 #if defined(__BIG_ENDIAN_BITFIELD)
20 	__u8			reserved_h:3,
21 				route_pref:2,
22 				reserved_l:3;
23 #elif defined(__LITTLE_ENDIAN_BITFIELD)
24 	__u8			reserved_l:3,
25 				route_pref:2,
26 				reserved_h:3;
27 #endif
28 	__be32			lifetime;
29 	__u8			prefix[];	/* 0,8 or 16 */
30 };
31 
32 #define RT6_LOOKUP_F_IFACE		0x00000001
33 #define RT6_LOOKUP_F_REACHABLE		0x00000002
34 #define RT6_LOOKUP_F_HAS_SADDR		0x00000004
35 #define RT6_LOOKUP_F_SRCPREF_TMP	0x00000008
36 #define RT6_LOOKUP_F_SRCPREF_PUBLIC	0x00000010
37 #define RT6_LOOKUP_F_SRCPREF_COA	0x00000020
38 #define RT6_LOOKUP_F_IGNORE_LINKSTATE	0x00000040
39 #define RT6_LOOKUP_F_DST_NOREF		0x00000080
40 
41 /* We do not (yet ?) support IPv6 jumbograms (RFC 2675)
42  * Unlike IPv4, hdr->seg_len doesn't include the IPv6 header
43  */
44 #define IP6_MAX_MTU (0xFFFF + sizeof(struct ipv6hdr))
45 
46 /*
47  * rt6_srcprefs2flags() and rt6_flags2srcprefs() translate
48  * between IPV6_ADDR_PREFERENCES socket option values
49  *	IPV6_PREFER_SRC_TMP    = 0x1
50  *	IPV6_PREFER_SRC_PUBLIC = 0x2
51  *	IPV6_PREFER_SRC_COA    = 0x4
52  * and above RT6_LOOKUP_F_SRCPREF_xxx flags.
53  */
54 static inline int rt6_srcprefs2flags(unsigned int srcprefs)
55 {
56 	/* No need to bitmask because srcprefs have only 3 bits. */
57 	return srcprefs << 3;
58 }
59 
60 static inline unsigned int rt6_flags2srcprefs(int flags)
61 {
62 	return (flags >> 3) & 7;
63 }
64 
65 static inline bool rt6_need_strict(const struct in6_addr *daddr)
66 {
67 	return ipv6_addr_type(daddr) &
68 		(IPV6_ADDR_MULTICAST | IPV6_ADDR_LINKLOCAL | IPV6_ADDR_LOOPBACK);
69 }
70 
71 /* fib entries using a nexthop object can not be coalesced into
72  * a multipath route
73  */
74 static inline bool rt6_qualify_for_ecmp(const struct fib6_info *f6i)
75 {
76 	/* the RTF_ADDRCONF flag filters out RA's */
77 	return !(f6i->fib6_flags & RTF_ADDRCONF) && !f6i->nh &&
78 		f6i->fib6_nh->fib_nh_gw_family;
79 }
80 
81 void ip6_route_input(struct sk_buff *skb);
82 struct dst_entry *ip6_route_input_lookup(struct net *net,
83 					 struct net_device *dev,
84 					 struct flowi6 *fl6,
85 					 const struct sk_buff *skb, int flags);
86 
87 struct dst_entry *ip6_route_output_flags(struct net *net, const struct sock *sk,
88 					 struct flowi6 *fl6, int flags);
89 
90 static inline struct dst_entry *ip6_route_output(struct net *net,
91 						 const struct sock *sk,
92 						 struct flowi6 *fl6)
93 {
94 	return ip6_route_output_flags(net, sk, fl6, 0);
95 }
96 
97 /* Only conditionally release dst if flags indicates
98  * !RT6_LOOKUP_F_DST_NOREF or dst is in uncached_list.
99  */
100 static inline void ip6_rt_put_flags(struct rt6_info *rt, int flags)
101 {
102 	if (!(flags & RT6_LOOKUP_F_DST_NOREF) ||
103 	    !list_empty(&rt->dst.rt_uncached))
104 		ip6_rt_put(rt);
105 }
106 
107 struct dst_entry *ip6_route_lookup(struct net *net, struct flowi6 *fl6,
108 				   const struct sk_buff *skb, int flags);
109 struct rt6_info *ip6_pol_route(struct net *net, struct fib6_table *table,
110 			       int ifindex, struct flowi6 *fl6,
111 			       const struct sk_buff *skb, int flags);
112 
113 void ip6_route_init_special_entries(void);
114 int ip6_route_init(void);
115 void ip6_route_cleanup(void);
116 
117 int ipv6_route_ioctl(struct net *net, unsigned int cmd,
118 		struct in6_rtmsg *rtmsg);
119 
120 int ip6_route_add(struct fib6_config *cfg, gfp_t gfp_flags,
121 		  struct netlink_ext_ack *extack);
122 int ip6_ins_rt(struct net *net, struct fib6_info *f6i);
123 int ip6_del_rt(struct net *net, struct fib6_info *f6i, bool skip_notify);
124 
125 void rt6_flush_exceptions(struct fib6_info *f6i);
126 void rt6_age_exceptions(struct fib6_info *f6i, struct fib6_gc_args *gc_args,
127 			unsigned long now);
128 
129 static inline int ip6_route_get_saddr(struct net *net, struct fib6_info *f6i,
130 				      const struct in6_addr *daddr,
131 				      unsigned int prefs,
132 				      struct in6_addr *saddr)
133 {
134 	int err = 0;
135 
136 	if (f6i && f6i->fib6_prefsrc.plen) {
137 		*saddr = f6i->fib6_prefsrc.addr;
138 	} else {
139 		struct net_device *dev = f6i ? fib6_info_nh_dev(f6i) : NULL;
140 
141 		err = ipv6_dev_get_saddr(net, dev, daddr, prefs, saddr);
142 	}
143 
144 	return err;
145 }
146 
147 struct rt6_info *rt6_lookup(struct net *net, const struct in6_addr *daddr,
148 			    const struct in6_addr *saddr, int oif,
149 			    const struct sk_buff *skb, int flags);
150 u32 rt6_multipath_hash(const struct net *net, const struct flowi6 *fl6,
151 		       const struct sk_buff *skb, struct flow_keys *hkeys);
152 
153 struct dst_entry *icmp6_dst_alloc(struct net_device *dev, struct flowi6 *fl6);
154 
155 void fib6_force_start_gc(struct net *net);
156 
157 struct fib6_info *addrconf_f6i_alloc(struct net *net, struct inet6_dev *idev,
158 				     const struct in6_addr *addr, bool anycast,
159 				     gfp_t gfp_flags);
160 
161 struct rt6_info *ip6_dst_alloc(struct net *net, struct net_device *dev,
162 			       int flags);
163 
164 /*
165  *	support functions for ND
166  *
167  */
168 struct fib6_info *rt6_get_dflt_router(struct net *net,
169 				     const struct in6_addr *addr,
170 				     struct net_device *dev);
171 struct fib6_info *rt6_add_dflt_router(struct net *net,
172 				     const struct in6_addr *gwaddr,
173 				     struct net_device *dev, unsigned int pref,
174 				     u32 defrtr_usr_metric);
175 
176 void rt6_purge_dflt_routers(struct net *net);
177 
178 int rt6_route_rcv(struct net_device *dev, u8 *opt, int len,
179 		  const struct in6_addr *gwaddr);
180 
181 void ip6_update_pmtu(struct sk_buff *skb, struct net *net, __be32 mtu, int oif,
182 		     u32 mark, kuid_t uid);
183 void ip6_sk_update_pmtu(struct sk_buff *skb, struct sock *sk, __be32 mtu);
184 void ip6_redirect(struct sk_buff *skb, struct net *net, int oif, u32 mark,
185 		  kuid_t uid);
186 void ip6_redirect_no_header(struct sk_buff *skb, struct net *net, int oif);
187 void ip6_sk_redirect(struct sk_buff *skb, struct sock *sk);
188 
189 struct netlink_callback;
190 
191 struct rt6_rtnl_dump_arg {
192 	struct sk_buff *skb;
193 	struct netlink_callback *cb;
194 	struct net *net;
195 	struct fib_dump_filter filter;
196 };
197 
198 int rt6_dump_route(struct fib6_info *f6i, void *p_arg, unsigned int skip);
199 void rt6_mtu_change(struct net_device *dev, unsigned int mtu);
200 void rt6_remove_prefsrc(struct inet6_ifaddr *ifp);
201 void rt6_clean_tohost(struct net *net, struct in6_addr *gateway);
202 void rt6_sync_up(struct net_device *dev, unsigned char nh_flags);
203 void rt6_disable_ip(struct net_device *dev, unsigned long event);
204 void rt6_sync_down_dev(struct net_device *dev, unsigned long event);
205 void rt6_multipath_rebalance(struct fib6_info *f6i);
206 
207 void rt6_uncached_list_add(struct rt6_info *rt);
208 void rt6_uncached_list_del(struct rt6_info *rt);
209 
210 static inline const struct rt6_info *skb_rt6_info(const struct sk_buff *skb)
211 {
212 	const struct dst_entry *dst = skb_dst(skb);
213 	const struct rt6_info *rt6 = NULL;
214 
215 	if (dst)
216 		rt6 = container_of(dst, struct rt6_info, dst);
217 
218 	return rt6;
219 }
220 
221 /*
222  *	Store a destination cache entry in a socket
223  */
224 static inline void ip6_dst_store(struct sock *sk, struct dst_entry *dst,
225 				 const struct in6_addr *daddr,
226 				 const struct in6_addr *saddr)
227 {
228 	struct ipv6_pinfo *np = inet6_sk(sk);
229 
230 	np->dst_cookie = rt6_get_cookie((struct rt6_info *)dst);
231 	sk_setup_caps(sk, dst);
232 	np->daddr_cache = daddr;
233 #ifdef CONFIG_IPV6_SUBTREES
234 	np->saddr_cache = saddr;
235 #endif
236 }
237 
238 void ip6_sk_dst_store_flow(struct sock *sk, struct dst_entry *dst,
239 			   const struct flowi6 *fl6);
240 
241 static inline bool ipv6_unicast_destination(const struct sk_buff *skb)
242 {
243 	struct rt6_info *rt = (struct rt6_info *) skb_dst(skb);
244 
245 	return rt->rt6i_flags & RTF_LOCAL;
246 }
247 
248 static inline bool ipv6_anycast_destination(const struct dst_entry *dst,
249 					    const struct in6_addr *daddr)
250 {
251 	struct rt6_info *rt = (struct rt6_info *)dst;
252 
253 	return rt->rt6i_flags & RTF_ANYCAST ||
254 		(rt->rt6i_dst.plen < 127 &&
255 		 !(rt->rt6i_flags & (RTF_GATEWAY | RTF_NONEXTHOP)) &&
256 		 ipv6_addr_equal(&rt->rt6i_dst.addr, daddr));
257 }
258 
259 int ip6_fragment(struct net *net, struct sock *sk, struct sk_buff *skb,
260 		 int (*output)(struct net *, struct sock *, struct sk_buff *));
261 
262 static inline unsigned int ip6_skb_dst_mtu(const struct sk_buff *skb)
263 {
264 	const struct ipv6_pinfo *np = skb->sk && !dev_recursion_level() ?
265 				inet6_sk(skb->sk) : NULL;
266 	const struct dst_entry *dst = skb_dst(skb);
267 	unsigned int mtu;
268 
269 	if (np && np->pmtudisc >= IPV6_PMTUDISC_PROBE) {
270 		mtu = READ_ONCE(dst->dev->mtu);
271 		mtu -= lwtunnel_headroom(dst->lwtstate, mtu);
272 	} else {
273 		mtu = dst_mtu(dst);
274 	}
275 	return mtu;
276 }
277 
278 static inline bool ip6_sk_accept_pmtu(const struct sock *sk)
279 {
280 	return inet6_sk(sk)->pmtudisc != IPV6_PMTUDISC_INTERFACE &&
281 	       inet6_sk(sk)->pmtudisc != IPV6_PMTUDISC_OMIT;
282 }
283 
284 static inline bool ip6_sk_ignore_df(const struct sock *sk)
285 {
286 	return inet6_sk(sk)->pmtudisc < IPV6_PMTUDISC_DO ||
287 	       inet6_sk(sk)->pmtudisc == IPV6_PMTUDISC_OMIT;
288 }
289 
290 static inline const struct in6_addr *rt6_nexthop(const struct rt6_info *rt,
291 						 const struct in6_addr *daddr)
292 {
293 	if (rt->rt6i_flags & RTF_GATEWAY)
294 		return &rt->rt6i_gateway;
295 	else if (unlikely(rt->rt6i_flags & RTF_CACHE))
296 		return &rt->rt6i_dst.addr;
297 	else
298 		return daddr;
299 }
300 
301 static inline bool rt6_duplicate_nexthop(struct fib6_info *a, struct fib6_info *b)
302 {
303 	struct fib6_nh *nha, *nhb;
304 
305 	if (a->nh || b->nh)
306 		return nexthop_cmp(a->nh, b->nh);
307 
308 	nha = a->fib6_nh;
309 	nhb = b->fib6_nh;
310 	return nha->fib_nh_dev == nhb->fib_nh_dev &&
311 	       ipv6_addr_equal(&nha->fib_nh_gw6, &nhb->fib_nh_gw6) &&
312 	       !lwtunnel_cmp_encap(nha->fib_nh_lws, nhb->fib_nh_lws);
313 }
314 
315 static inline unsigned int ip6_dst_mtu_maybe_forward(const struct dst_entry *dst,
316 						     bool forwarding)
317 {
318 	struct inet6_dev *idev;
319 	unsigned int mtu;
320 
321 	if (!forwarding || dst_metric_locked(dst, RTAX_MTU)) {
322 		mtu = dst_metric_raw(dst, RTAX_MTU);
323 		if (mtu)
324 			goto out;
325 	}
326 
327 	mtu = IPV6_MIN_MTU;
328 	rcu_read_lock();
329 	idev = __in6_dev_get(dst->dev);
330 	if (idev)
331 		mtu = idev->cnf.mtu6;
332 	rcu_read_unlock();
333 
334 out:
335 	return mtu - lwtunnel_headroom(dst->lwtstate, mtu);
336 }
337 
338 u32 ip6_mtu_from_fib6(const struct fib6_result *res,
339 		      const struct in6_addr *daddr,
340 		      const struct in6_addr *saddr);
341 
342 struct neighbour *ip6_neigh_lookup(const struct in6_addr *gw,
343 				   struct net_device *dev, struct sk_buff *skb,
344 				   const void *daddr);
345 #endif
346