xref: /linux-6.15/include/net/ip6_fib.h (revision c4125400)
1 /*
2  *	Linux INET6 implementation
3  *
4  *	Authors:
5  *	Pedro Roque		<[email protected]>
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 <net/dst.h>
20 #include <net/flow.h>
21 #include <net/netlink.h>
22 #include <net/inetpeer.h>
23 
24 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
25 #define FIB6_TABLE_HASHSZ 256
26 #else
27 #define FIB6_TABLE_HASHSZ 1
28 #endif
29 
30 struct rt6_info;
31 
32 struct fib6_config {
33 	u32		fc_table;
34 	u32		fc_metric;
35 	int		fc_dst_len;
36 	int		fc_src_len;
37 	int		fc_ifindex;
38 	u32		fc_flags;
39 	u32		fc_protocol;
40 
41 	struct in6_addr	fc_dst;
42 	struct in6_addr	fc_src;
43 	struct in6_addr	fc_prefsrc;
44 	struct in6_addr	fc_gateway;
45 
46 	unsigned long	fc_expires;
47 	struct nlattr	*fc_mx;
48 	int		fc_mx_len;
49 
50 	struct nl_info	fc_nlinfo;
51 };
52 
53 struct fib6_node {
54 	struct fib6_node	*parent;
55 	struct fib6_node	*left;
56 	struct fib6_node	*right;
57 #ifdef CONFIG_IPV6_SUBTREES
58 	struct fib6_node	*subtree;
59 #endif
60 	struct rt6_info		*leaf;
61 
62 	__u16			fn_bit;		/* bit key */
63 	__u16			fn_flags;
64 	__u32			fn_sernum;
65 	struct rt6_info		*rr_ptr;
66 };
67 
68 #ifndef CONFIG_IPV6_SUBTREES
69 #define FIB6_SUBTREE(fn)	NULL
70 #else
71 #define FIB6_SUBTREE(fn)	((fn)->subtree)
72 #endif
73 
74 /*
75  *	routing information
76  *
77  */
78 
79 struct rt6key {
80 	struct in6_addr	addr;
81 	int		plen;
82 };
83 
84 struct fib6_table;
85 
86 struct rt6_info {
87 	struct dst_entry		dst;
88 
89 	/*
90 	 * Tail elements of dst_entry (__refcnt etc.)
91 	 * and these elements (rarely used in hot path) are in
92 	 * the same cache line.
93 	 */
94 	struct fib6_table		*rt6i_table;
95 	struct fib6_node		*rt6i_node;
96 
97 	struct in6_addr			rt6i_gateway;
98 
99 	atomic_t			rt6i_ref;
100 
101 	/* These are in a separate cache line. */
102 	struct rt6key			rt6i_dst ____cacheline_aligned_in_smp;
103 	u32				rt6i_flags;
104 	struct rt6key			rt6i_src;
105 	struct rt6key			rt6i_prefsrc;
106 	u32				rt6i_metric;
107 	u32				rt6i_peer_genid;
108 
109 	struct inet6_dev		*rt6i_idev;
110 	unsigned long			_rt6i_peer;
111 
112 #ifdef CONFIG_XFRM
113 	u32				rt6i_flow_cache_genid;
114 #endif
115 	/* more non-fragment space at head required */
116 	unsigned short			rt6i_nfheader_len;
117 
118 	u8				rt6i_protocol;
119 };
120 
121 static inline struct inet_peer *rt6_peer_ptr(struct rt6_info *rt)
122 {
123 	return inetpeer_ptr(rt->_rt6i_peer);
124 }
125 
126 static inline bool rt6_has_peer(struct rt6_info *rt)
127 {
128 	return inetpeer_ptr_is_peer(rt->_rt6i_peer);
129 }
130 
131 static inline void __rt6_set_peer(struct rt6_info *rt, struct inet_peer *peer)
132 {
133 	__inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
134 }
135 
136 static inline bool rt6_set_peer(struct rt6_info *rt, struct inet_peer *peer)
137 {
138 	return inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
139 }
140 
141 static inline void rt6_init_peer(struct rt6_info *rt, struct inet_peer_base *base)
142 {
143 	inetpeer_init_ptr(&rt->_rt6i_peer, base);
144 }
145 
146 static inline void rt6_transfer_peer(struct rt6_info *rt, struct rt6_info *ort)
147 {
148 	inetpeer_transfer_peer(&rt->_rt6i_peer, &ort->_rt6i_peer);
149 }
150 
151 static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
152 {
153 	return ((struct rt6_info *)dst)->rt6i_idev;
154 }
155 
156 static inline void rt6_clean_expires(struct rt6_info *rt)
157 {
158 	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
159 		dst_release(rt->dst.from);
160 
161 	rt->rt6i_flags &= ~RTF_EXPIRES;
162 	rt->dst.from = NULL;
163 }
164 
165 static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
166 {
167 	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
168 		dst_release(rt->dst.from);
169 
170 	rt->rt6i_flags |= RTF_EXPIRES;
171 	rt->dst.expires = expires;
172 }
173 
174 static inline void rt6_update_expires(struct rt6_info *rt, int timeout)
175 {
176 	if (!(rt->rt6i_flags & RTF_EXPIRES)) {
177 		if (rt->dst.from)
178 			dst_release(rt->dst.from);
179 		/* dst_set_expires relies on expires == 0
180 		 * if it has not been set previously.
181 		 */
182 		rt->dst.expires = 0;
183 	}
184 
185 	dst_set_expires(&rt->dst, timeout);
186 	rt->rt6i_flags |= RTF_EXPIRES;
187 }
188 
189 static inline void rt6_set_from(struct rt6_info *rt, struct rt6_info *from)
190 {
191 	struct dst_entry *new = (struct dst_entry *) from;
192 
193 	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from) {
194 		if (new == rt->dst.from)
195 			return;
196 		dst_release(rt->dst.from);
197 	}
198 
199 	rt->rt6i_flags &= ~RTF_EXPIRES;
200 	rt->dst.from = new;
201 	dst_hold(new);
202 }
203 
204 struct fib6_walker_t {
205 	struct list_head lh;
206 	struct fib6_node *root, *node;
207 	struct rt6_info *leaf;
208 	unsigned char state;
209 	unsigned char prune;
210 	unsigned int skip;
211 	unsigned int count;
212 	int (*func)(struct fib6_walker_t *);
213 	void *args;
214 };
215 
216 struct rt6_statistics {
217 	__u32		fib_nodes;
218 	__u32		fib_route_nodes;
219 	__u32		fib_rt_alloc;		/* permanent routes	*/
220 	__u32		fib_rt_entries;		/* rt entries in table	*/
221 	__u32		fib_rt_cache;		/* cache routes		*/
222 	__u32		fib_discarded_routes;
223 };
224 
225 #define RTN_TL_ROOT	0x0001
226 #define RTN_ROOT	0x0002		/* tree root node		*/
227 #define RTN_RTINFO	0x0004		/* node with valid routing info	*/
228 
229 /*
230  *	priority levels (or metrics)
231  *
232  */
233 
234 
235 struct fib6_table {
236 	struct hlist_node	tb6_hlist;
237 	u32			tb6_id;
238 	rwlock_t		tb6_lock;
239 	struct fib6_node	tb6_root;
240 	struct inet_peer_base	tb6_peers;
241 };
242 
243 #define RT6_TABLE_UNSPEC	RT_TABLE_UNSPEC
244 #define RT6_TABLE_MAIN		RT_TABLE_MAIN
245 #define RT6_TABLE_DFLT		RT6_TABLE_MAIN
246 #define RT6_TABLE_INFO		RT6_TABLE_MAIN
247 #define RT6_TABLE_PREFIX	RT6_TABLE_MAIN
248 
249 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
250 #define FIB6_TABLE_MIN		1
251 #define FIB6_TABLE_MAX		RT_TABLE_MAX
252 #define RT6_TABLE_LOCAL		RT_TABLE_LOCAL
253 #else
254 #define FIB6_TABLE_MIN		RT_TABLE_MAIN
255 #define FIB6_TABLE_MAX		FIB6_TABLE_MIN
256 #define RT6_TABLE_LOCAL		RT6_TABLE_MAIN
257 #endif
258 
259 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
260 					 struct fib6_table *,
261 					 struct flowi6 *, int);
262 
263 /*
264  *	exported functions
265  */
266 
267 extern struct fib6_table        *fib6_get_table(struct net *net, u32 id);
268 extern struct fib6_table        *fib6_new_table(struct net *net, u32 id);
269 extern struct dst_entry         *fib6_rule_lookup(struct net *net,
270 						  struct flowi6 *fl6, int flags,
271 						  pol_lookup_t lookup);
272 
273 extern struct fib6_node		*fib6_lookup(struct fib6_node *root,
274 					     const struct in6_addr *daddr,
275 					     const struct in6_addr *saddr);
276 
277 struct fib6_node		*fib6_locate(struct fib6_node *root,
278 					     const struct in6_addr *daddr, int dst_len,
279 					     const struct in6_addr *saddr, int src_len);
280 
281 extern void			fib6_clean_all_ro(struct net *net,
282 					       int (*func)(struct rt6_info *, void *arg),
283 					       int prune, void *arg);
284 
285 extern void			fib6_clean_all(struct net *net,
286 					       int (*func)(struct rt6_info *, void *arg),
287 					       int prune, void *arg);
288 
289 extern int			fib6_add(struct fib6_node *root,
290 					 struct rt6_info *rt,
291 					 struct nl_info *info);
292 
293 extern int			fib6_del(struct rt6_info *rt,
294 					 struct nl_info *info);
295 
296 extern void			inet6_rt_notify(int event, struct rt6_info *rt,
297 						struct nl_info *info);
298 
299 extern void			fib6_run_gc(unsigned long expires,
300 					    struct net *net);
301 
302 extern void			fib6_gc_cleanup(void);
303 
304 extern int			fib6_init(void);
305 
306 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
307 extern int			fib6_rules_init(void);
308 extern void			fib6_rules_cleanup(void);
309 #else
310 static inline int               fib6_rules_init(void)
311 {
312 	return 0;
313 }
314 static inline void              fib6_rules_cleanup(void)
315 {
316 	return ;
317 }
318 #endif
319 #endif
320