xref: /openbmc/linux/include/net/ip6_fib.h (revision 3f4fe759f0042c762e03194716c8f79f1905dc40)
1 /*
2  *	Linux INET6 implementation
3  *
4  *	Authors:
5  *	Pedro Roque		<roque@di.fc.ul.pt>
6  *
7  *	This program is free software; you can redistribute it and/or
8  *      modify it under the terms of the GNU General Public License
9  *      as published by the Free Software Foundation; either version
10  *      2 of the License, or (at your option) any later version.
11  */
12 
13 #ifndef _IP6_FIB_H
14 #define _IP6_FIB_H
15 
16 #include <linux/ipv6_route.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/spinlock.h>
19 #include <linux/notifier.h>
20 #include <net/dst.h>
21 #include <net/flow.h>
22 #include <net/netlink.h>
23 #include <net/inetpeer.h>
24 #include <net/fib_notifier.h>
25 
26 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
27 #define FIB6_TABLE_HASHSZ 256
28 #else
29 #define FIB6_TABLE_HASHSZ 1
30 #endif
31 
32 #define RT6_DEBUG 2
33 
34 #if RT6_DEBUG >= 3
35 #define RT6_TRACE(x...) pr_debug(x)
36 #else
37 #define RT6_TRACE(x...) do { ; } while (0)
38 #endif
39 
40 struct rt6_info;
41 struct fib6_info;
42 
43 struct fib6_config {
44 	u32		fc_table;
45 	u32		fc_metric;
46 	int		fc_dst_len;
47 	int		fc_src_len;
48 	int		fc_ifindex;
49 	u32		fc_flags;
50 	u32		fc_protocol;
51 	u16		fc_type;        /* only 8 bits are used */
52 	u16		fc_delete_all_nh : 1,
53 			__unused : 15;
54 
55 	struct in6_addr	fc_dst;
56 	struct in6_addr	fc_src;
57 	struct in6_addr	fc_prefsrc;
58 	struct in6_addr	fc_gateway;
59 
60 	unsigned long	fc_expires;
61 	struct nlattr	*fc_mx;
62 	int		fc_mx_len;
63 	int		fc_mp_len;
64 	struct nlattr	*fc_mp;
65 
66 	struct nl_info	fc_nlinfo;
67 	struct nlattr	*fc_encap;
68 	u16		fc_encap_type;
69 };
70 
71 struct fib6_node {
72 	struct fib6_node __rcu	*parent;
73 	struct fib6_node __rcu	*left;
74 	struct fib6_node __rcu	*right;
75 #ifdef CONFIG_IPV6_SUBTREES
76 	struct fib6_node __rcu	*subtree;
77 #endif
78 	struct fib6_info __rcu	*leaf;
79 
80 	__u16			fn_bit;		/* bit key */
81 	__u16			fn_flags;
82 	int			fn_sernum;
83 	struct fib6_info __rcu	*rr_ptr;
84 	struct rcu_head		rcu;
85 };
86 
87 struct fib6_gc_args {
88 	int			timeout;
89 	int			more;
90 };
91 
92 #ifndef CONFIG_IPV6_SUBTREES
93 #define FIB6_SUBTREE(fn)	NULL
94 #else
95 #define FIB6_SUBTREE(fn)	(rcu_dereference_protected((fn)->subtree, 1))
96 #endif
97 
98 /*
99  *	routing information
100  *
101  */
102 
103 struct rt6key {
104 	struct in6_addr	addr;
105 	int		plen;
106 };
107 
108 struct fib6_table;
109 
110 struct rt6_exception_bucket {
111 	struct hlist_head	chain;
112 	int			depth;
113 };
114 
115 struct rt6_exception {
116 	struct hlist_node	hlist;
117 	struct rt6_info		*rt6i;
118 	unsigned long		stamp;
119 	struct rcu_head		rcu;
120 };
121 
122 #define FIB6_EXCEPTION_BUCKET_SIZE_SHIFT 10
123 #define FIB6_EXCEPTION_BUCKET_SIZE (1 << FIB6_EXCEPTION_BUCKET_SIZE_SHIFT)
124 #define FIB6_MAX_DEPTH 5
125 
126 struct fib6_nh {
127 	struct in6_addr		nh_gw;
128 	struct net_device	*nh_dev;
129 	struct lwtunnel_state	*nh_lwtstate;
130 
131 	unsigned int		nh_flags;
132 	atomic_t		nh_upper_bound;
133 	int			nh_weight;
134 };
135 
136 struct fib6_info {
137 	struct fib6_table		*fib6_table;
138 	struct fib6_info __rcu		*rt6_next;
139 	struct fib6_node __rcu		*fib6_node;
140 
141 	/* Multipath routes:
142 	 * siblings is a list of fib6_info that have the the same metric/weight,
143 	 * destination, but not the same gateway. nsiblings is just a cache
144 	 * to speed up lookup.
145 	 */
146 	struct list_head		fib6_siblings;
147 	unsigned int			fib6_nsiblings;
148 
149 	atomic_t			fib6_ref;
150 	unsigned long			expires;
151 	struct dst_metrics		*fib6_metrics;
152 #define fib6_pmtu		fib6_metrics->metrics[RTAX_MTU-1]
153 
154 	struct rt6key			fib6_dst;
155 	u32				fib6_flags;
156 	struct rt6key			fib6_src;
157 	struct rt6key			fib6_prefsrc;
158 
159 	struct rt6_info * __percpu	*rt6i_pcpu;
160 	struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
161 
162 	u32				fib6_metric;
163 	u8				fib6_protocol;
164 	u8				fib6_type;
165 	u8				exception_bucket_flushed:1,
166 					should_flush:1,
167 					dst_nocount:1,
168 					dst_nopolicy:1,
169 					dst_host:1,
170 					unused:3;
171 
172 	struct fib6_nh			fib6_nh;
173 };
174 
175 struct rt6_info {
176 	struct dst_entry		dst;
177 	struct fib6_info		*from;
178 
179 	struct rt6key			rt6i_dst;
180 	struct rt6key			rt6i_src;
181 	struct in6_addr			rt6i_gateway;
182 	struct inet6_dev		*rt6i_idev;
183 	u32				rt6i_flags;
184 	struct rt6key			rt6i_prefsrc;
185 
186 	struct list_head		rt6i_uncached;
187 	struct uncached_list		*rt6i_uncached_list;
188 
189 	/* more non-fragment space at head required */
190 	unsigned short			rt6i_nfheader_len;
191 };
192 
193 #define for_each_fib6_node_rt_rcu(fn)					\
194 	for (rt = rcu_dereference((fn)->leaf); rt;			\
195 	     rt = rcu_dereference(rt->rt6_next))
196 
197 #define for_each_fib6_walker_rt(w)					\
198 	for (rt = (w)->leaf; rt;					\
199 	     rt = rcu_dereference_protected(rt->rt6_next, 1))
200 
201 static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
202 {
203 	return ((struct rt6_info *)dst)->rt6i_idev;
204 }
205 
206 static inline void fib6_clean_expires(struct fib6_info *f6i)
207 {
208 	f6i->fib6_flags &= ~RTF_EXPIRES;
209 	f6i->expires = 0;
210 }
211 
212 static inline void fib6_set_expires(struct fib6_info *f6i,
213 				    unsigned long expires)
214 {
215 	f6i->expires = expires;
216 	f6i->fib6_flags |= RTF_EXPIRES;
217 }
218 
219 static inline bool fib6_check_expired(const struct fib6_info *f6i)
220 {
221 	if (f6i->fib6_flags & RTF_EXPIRES)
222 		return time_after(jiffies, f6i->expires);
223 	return false;
224 }
225 
226 static inline void rt6_clean_expires(struct rt6_info *rt)
227 {
228 	rt->rt6i_flags &= ~RTF_EXPIRES;
229 	rt->dst.expires = 0;
230 }
231 
232 static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
233 {
234 	rt->dst.expires = expires;
235 	rt->rt6i_flags |= RTF_EXPIRES;
236 }
237 
238 static inline void rt6_update_expires(struct rt6_info *rt0, int timeout)
239 {
240 	if (!(rt0->rt6i_flags & RTF_EXPIRES) && rt0->from)
241 		rt0->dst.expires = rt0->from->expires;
242 
243 	dst_set_expires(&rt0->dst, timeout);
244 	rt0->rt6i_flags |= RTF_EXPIRES;
245 }
246 
247 /* Function to safely get fn->sernum for passed in rt
248  * and store result in passed in cookie.
249  * Return true if we can get cookie safely
250  * Return false if not
251  */
252 static inline bool rt6_get_cookie_safe(const struct fib6_info *f6i,
253 				       u32 *cookie)
254 {
255 	struct fib6_node *fn;
256 	bool status = false;
257 
258 	rcu_read_lock();
259 	fn = rcu_dereference(f6i->fib6_node);
260 
261 	if (fn) {
262 		*cookie = fn->fn_sernum;
263 		/* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
264 		smp_rmb();
265 		status = true;
266 	}
267 
268 	rcu_read_unlock();
269 	return status;
270 }
271 
272 static inline u32 rt6_get_cookie(const struct rt6_info *rt)
273 {
274 	u32 cookie = 0;
275 
276 	if (rt->rt6i_flags & RTF_PCPU ||
277 	    (unlikely(!list_empty(&rt->rt6i_uncached)) && rt->from))
278 		rt6_get_cookie_safe(rt->from, &cookie);
279 
280 	return cookie;
281 }
282 
283 static inline void ip6_rt_put(struct rt6_info *rt)
284 {
285 	/* dst_release() accepts a NULL parameter.
286 	 * We rely on dst being first structure in struct rt6_info
287 	 */
288 	BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
289 	dst_release(&rt->dst);
290 }
291 
292 struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
293 void fib6_info_destroy(struct fib6_info *f6i);
294 
295 static inline void fib6_info_hold(struct fib6_info *f6i)
296 {
297 	atomic_inc(&f6i->fib6_ref);
298 }
299 
300 static inline void fib6_info_release(struct fib6_info *f6i)
301 {
302 	if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
303 		fib6_info_destroy(f6i);
304 }
305 
306 enum fib6_walk_state {
307 #ifdef CONFIG_IPV6_SUBTREES
308 	FWS_S,
309 #endif
310 	FWS_L,
311 	FWS_R,
312 	FWS_C,
313 	FWS_U
314 };
315 
316 struct fib6_walker {
317 	struct list_head lh;
318 	struct fib6_node *root, *node;
319 	struct fib6_info *leaf;
320 	enum fib6_walk_state state;
321 	unsigned int skip;
322 	unsigned int count;
323 	int (*func)(struct fib6_walker *);
324 	void *args;
325 };
326 
327 struct rt6_statistics {
328 	__u32		fib_nodes;		/* all fib6 nodes */
329 	__u32		fib_route_nodes;	/* intermediate nodes */
330 	__u32		fib_rt_entries;		/* rt entries in fib table */
331 	__u32		fib_rt_cache;		/* cached rt entries in exception table */
332 	__u32		fib_discarded_routes;	/* total number of routes delete */
333 
334 	/* The following stats are not protected by any lock */
335 	atomic_t	fib_rt_alloc;		/* total number of routes alloced */
336 	atomic_t	fib_rt_uncache;		/* rt entries in uncached list */
337 };
338 
339 #define RTN_TL_ROOT	0x0001
340 #define RTN_ROOT	0x0002		/* tree root node		*/
341 #define RTN_RTINFO	0x0004		/* node with valid routing info	*/
342 
343 /*
344  *	priority levels (or metrics)
345  *
346  */
347 
348 
349 struct fib6_table {
350 	struct hlist_node	tb6_hlist;
351 	u32			tb6_id;
352 	spinlock_t		tb6_lock;
353 	struct fib6_node	tb6_root;
354 	struct inet_peer_base	tb6_peers;
355 	unsigned int		flags;
356 	unsigned int		fib_seq;
357 #define RT6_TABLE_HAS_DFLT_ROUTER	BIT(0)
358 };
359 
360 #define RT6_TABLE_UNSPEC	RT_TABLE_UNSPEC
361 #define RT6_TABLE_MAIN		RT_TABLE_MAIN
362 #define RT6_TABLE_DFLT		RT6_TABLE_MAIN
363 #define RT6_TABLE_INFO		RT6_TABLE_MAIN
364 #define RT6_TABLE_PREFIX	RT6_TABLE_MAIN
365 
366 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
367 #define FIB6_TABLE_MIN		1
368 #define FIB6_TABLE_MAX		RT_TABLE_MAX
369 #define RT6_TABLE_LOCAL		RT_TABLE_LOCAL
370 #else
371 #define FIB6_TABLE_MIN		RT_TABLE_MAIN
372 #define FIB6_TABLE_MAX		FIB6_TABLE_MIN
373 #define RT6_TABLE_LOCAL		RT6_TABLE_MAIN
374 #endif
375 
376 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
377 					 struct fib6_table *,
378 					 struct flowi6 *,
379 					 const struct sk_buff *, int);
380 
381 struct fib6_entry_notifier_info {
382 	struct fib_notifier_info info; /* must be first */
383 	struct fib6_info *rt;
384 };
385 
386 /*
387  *	exported functions
388  */
389 
390 struct fib6_table *fib6_get_table(struct net *net, u32 id);
391 struct fib6_table *fib6_new_table(struct net *net, u32 id);
392 struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
393 				   const struct sk_buff *skb,
394 				   int flags, pol_lookup_t lookup);
395 
396 struct fib6_node *fib6_lookup(struct fib6_node *root,
397 			      const struct in6_addr *daddr,
398 			      const struct in6_addr *saddr);
399 
400 struct fib6_node *fib6_locate(struct fib6_node *root,
401 			      const struct in6_addr *daddr, int dst_len,
402 			      const struct in6_addr *saddr, int src_len,
403 			      bool exact_match);
404 
405 void fib6_clean_all(struct net *net, int (*func)(struct fib6_info *, void *arg),
406 		    void *arg);
407 
408 int fib6_add(struct fib6_node *root, struct fib6_info *rt,
409 	     struct nl_info *info, struct netlink_ext_ack *extack);
410 int fib6_del(struct fib6_info *rt, struct nl_info *info);
411 
412 static inline struct net_device *fib6_info_nh_dev(const struct fib6_info *f6i)
413 {
414 	return f6i->fib6_nh.nh_dev;
415 }
416 
417 void inet6_rt_notify(int event, struct fib6_info *rt, struct nl_info *info,
418 		     unsigned int flags);
419 
420 void fib6_run_gc(unsigned long expires, struct net *net, bool force);
421 
422 void fib6_gc_cleanup(void);
423 
424 int fib6_init(void);
425 
426 int ipv6_route_open(struct inode *inode, struct file *file);
427 
428 int call_fib6_notifier(struct notifier_block *nb, struct net *net,
429 		       enum fib_event_type event_type,
430 		       struct fib_notifier_info *info);
431 int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
432 			struct fib_notifier_info *info);
433 
434 int __net_init fib6_notifier_init(struct net *net);
435 void __net_exit fib6_notifier_exit(struct net *net);
436 
437 unsigned int fib6_tables_seq_read(struct net *net);
438 int fib6_tables_dump(struct net *net, struct notifier_block *nb);
439 
440 void fib6_update_sernum(struct net *net, struct fib6_info *rt);
441 void fib6_update_sernum_upto_root(struct net *net, struct fib6_info *rt);
442 
443 void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
444 static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
445 {
446 	return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
447 }
448 
449 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
450 int fib6_rules_init(void);
451 void fib6_rules_cleanup(void);
452 bool fib6_rule_default(const struct fib_rule *rule);
453 int fib6_rules_dump(struct net *net, struct notifier_block *nb);
454 unsigned int fib6_rules_seq_read(struct net *net);
455 
456 static inline bool fib6_rules_early_flow_dissect(struct net *net,
457 						 struct sk_buff *skb,
458 						 struct flowi6 *fl6,
459 						 struct flow_keys *flkeys)
460 {
461 	unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
462 
463 	if (!net->ipv6.fib6_rules_require_fldissect)
464 		return false;
465 
466 	skb_flow_dissect_flow_keys(skb, flkeys, flag);
467 	fl6->fl6_sport = flkeys->ports.src;
468 	fl6->fl6_dport = flkeys->ports.dst;
469 	fl6->flowi6_proto = flkeys->basic.ip_proto;
470 
471 	return true;
472 }
473 #else
474 static inline int               fib6_rules_init(void)
475 {
476 	return 0;
477 }
478 static inline void              fib6_rules_cleanup(void)
479 {
480 	return ;
481 }
482 static inline bool fib6_rule_default(const struct fib_rule *rule)
483 {
484 	return true;
485 }
486 static inline int fib6_rules_dump(struct net *net, struct notifier_block *nb)
487 {
488 	return 0;
489 }
490 static inline unsigned int fib6_rules_seq_read(struct net *net)
491 {
492 	return 0;
493 }
494 static inline bool fib6_rules_early_flow_dissect(struct net *net,
495 						 struct sk_buff *skb,
496 						 struct flowi6 *fl6,
497 						 struct flow_keys *flkeys)
498 {
499 	return false;
500 }
501 #endif
502 #endif
503