]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/net/ip6_fib.h
ipv4: Create cleanup helper for fib_nh
[mirror_ubuntu-jammy-kernel.git] / include / net / ip6_fib.h
CommitLineData
1da177e4
LT
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
1da177e4 16#include <linux/ipv6_route.h>
1da177e4
LT
17#include <linux/rtnetlink.h>
18#include <linux/spinlock.h>
16ab6d7d 19#include <linux/notifier.h>
86872cb5
TG
20#include <net/dst.h>
21#include <net/flow.h>
22#include <net/netlink.h>
b3419363 23#include <net/inetpeer.h>
16ab6d7d 24#include <net/fib_notifier.h>
1da177e4 25
a33bc5c1
NH
26#ifdef CONFIG_IPV6_MULTIPLE_TABLES
27#define FIB6_TABLE_HASHSZ 256
28#else
29#define FIB6_TABLE_HASHSZ 1
30#endif
31
c757faa8
WW
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
1da177e4 40struct rt6_info;
a64efe14 41struct fib6_info;
1da177e4 42
fd2c3ef7 43struct fib6_config {
86872cb5
TG
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;
0ae81335
DA
51 u16 fc_type; /* only 8 bits are used */
52 u16 fc_delete_all_nh : 1,
c7a1ce39
DA
53 fc_ignore_dev_down:1,
54 __unused : 14;
86872cb5
TG
55
56 struct in6_addr fc_dst;
57 struct in6_addr fc_src;
c3968a85 58 struct in6_addr fc_prefsrc;
86872cb5
TG
59 struct in6_addr fc_gateway;
60
61 unsigned long fc_expires;
62 struct nlattr *fc_mx;
63 int fc_mx_len;
51ebd318
ND
64 int fc_mp_len;
65 struct nlattr *fc_mp;
86872cb5
TG
66
67 struct nl_info fc_nlinfo;
19e42e45
RP
68 struct nlattr *fc_encap;
69 u16 fc_encap_type;
86872cb5
TG
70};
71
fd2c3ef7 72struct fib6_node {
66f5d6ce
WW
73 struct fib6_node __rcu *parent;
74 struct fib6_node __rcu *left;
75 struct fib6_node __rcu *right;
8bce65b9 76#ifdef CONFIG_IPV6_SUBTREES
66f5d6ce 77 struct fib6_node __rcu *subtree;
8bce65b9 78#endif
8d1c802b 79 struct fib6_info __rcu *leaf;
1da177e4
LT
80
81 __u16 fn_bit; /* bit key */
82 __u16 fn_flags;
42b18706 83 int fn_sernum;
8d1c802b 84 struct fib6_info __rcu *rr_ptr;
c5cff856 85 struct rcu_head rcu;
1da177e4
LT
86};
87
c757faa8
WW
88struct fib6_gc_args {
89 int timeout;
90 int more;
91};
92
7fc33165
YH
93#ifndef CONFIG_IPV6_SUBTREES
94#define FIB6_SUBTREE(fn) NULL
95#else
66f5d6ce 96#define FIB6_SUBTREE(fn) (rcu_dereference_protected((fn)->subtree, 1))
7fc33165 97#endif
1da177e4
LT
98
99/*
100 * routing information
101 *
102 */
103
fd2c3ef7 104struct rt6key {
1da177e4
LT
105 struct in6_addr addr;
106 int plen;
107};
108
c71099ac
TG
109struct fib6_table;
110
35732d01
WW
111struct rt6_exception_bucket {
112 struct hlist_head chain;
113 int depth;
114};
115
116struct rt6_exception {
117 struct hlist_node hlist;
118 struct rt6_info *rt6i;
119 unsigned long stamp;
120 struct rcu_head rcu;
121};
122
123#define FIB6_EXCEPTION_BUCKET_SIZE_SHIFT 10
124#define FIB6_EXCEPTION_BUCKET_SIZE (1 << FIB6_EXCEPTION_BUCKET_SIZE_SHIFT)
125#define FIB6_MAX_DEPTH 5
126
5e670d84
DA
127struct fib6_nh {
128 struct in6_addr nh_gw;
129 struct net_device *nh_dev;
130 struct lwtunnel_state *nh_lwtstate;
1da177e4 131
5e670d84
DA
132 unsigned int nh_flags;
133 atomic_t nh_upper_bound;
134 int nh_weight;
135};
1da177e4 136
a64efe14 137struct fib6_info {
93c2fb25 138 struct fib6_table *fib6_table;
8fb11a9a 139 struct fib6_info __rcu *fib6_next;
93c2fb25 140 struct fib6_node __rcu *fib6_node;
1da177e4 141
51ebd318 142 /* Multipath routes:
a64efe14 143 * siblings is a list of fib6_info that have the the same metric/weight,
51ebd318
ND
144 * destination, but not the same gateway. nsiblings is just a cache
145 * to speed up lookup.
146 */
93c2fb25
DA
147 struct list_head fib6_siblings;
148 unsigned int fib6_nsiblings;
51ebd318 149
93c2fb25 150 atomic_t fib6_ref;
a64efe14
DA
151 unsigned long expires;
152 struct dst_metrics *fib6_metrics;
153#define fib6_pmtu fib6_metrics->metrics[RTAX_MTU-1]
a47ed4cd 154
93c2fb25
DA
155 struct rt6key fib6_dst;
156 u32 fib6_flags;
157 struct rt6key fib6_src;
158 struct rt6key fib6_prefsrc;
fe400799 159
a64efe14
DA
160 struct rt6_info * __percpu *rt6i_pcpu;
161 struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
162
f547fac6
SD
163#ifdef CONFIG_IPV6_ROUTER_PREF
164 unsigned long last_probe;
165#endif
166
93c2fb25
DA
167 u32 fib6_metric;
168 u8 fib6_protocol;
a64efe14
DA
169 u8 fib6_type;
170 u8 exception_bucket_flushed:1,
171 should_flush:1,
172 dst_nocount:1,
173 dst_nopolicy:1,
174 dst_host:1,
175 unused:3;
176
177 struct fib6_nh fib6_nh;
9b0a8da8 178 struct rcu_head rcu;
a64efe14
DA
179};
180
fd2c3ef7 181struct rt6_info {
d8d1f30b 182 struct dst_entry dst;
a68886a6 183 struct fib6_info __rcu *from;
1da177e4 184
77634cc6 185 struct rt6key rt6i_dst;
bd2c77a0 186 struct rt6key rt6i_src;
1da177e4 187 struct in6_addr rt6i_gateway;
77634cc6 188 struct inet6_dev *rt6i_idev;
bd2c77a0 189 u32 rt6i_flags;
b4ce9277 190
8d0b94af
MKL
191 struct list_head rt6i_uncached;
192 struct uncached_list *rt6i_uncached_list;
193
bd2c77a0
YH
194 /* more non-fragment space at head required */
195 unsigned short rt6i_nfheader_len;
1da177e4
LT
196};
197
66f5d6ce
WW
198#define for_each_fib6_node_rt_rcu(fn) \
199 for (rt = rcu_dereference((fn)->leaf); rt; \
8fb11a9a 200 rt = rcu_dereference(rt->fib6_next))
66f5d6ce
WW
201
202#define for_each_fib6_walker_rt(w) \
203 for (rt = (w)->leaf; rt; \
8fb11a9a 204 rt = rcu_dereference_protected(rt->fib6_next, 1))
66f5d6ce 205
7a3025b1
YH
206static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
207{
208 return ((struct rt6_info *)dst)->rt6i_idev;
209}
210
8d1c802b 211static inline void fib6_clean_expires(struct fib6_info *f6i)
1716a961 212{
93c2fb25 213 f6i->fib6_flags &= ~RTF_EXPIRES;
14895687 214 f6i->expires = 0;
1716a961
G
215}
216
8d1c802b 217static inline void fib6_set_expires(struct fib6_info *f6i,
14895687 218 unsigned long expires)
1716a961 219{
14895687 220 f6i->expires = expires;
93c2fb25 221 f6i->fib6_flags |= RTF_EXPIRES;
1716a961
G
222}
223
8d1c802b 224static inline bool fib6_check_expired(const struct fib6_info *f6i)
1716a961 225{
93c2fb25 226 if (f6i->fib6_flags & RTF_EXPIRES)
14895687
DA
227 return time_after(jiffies, f6i->expires);
228 return false;
1716a961 229}
b197df4f 230
c5cff856
WW
231/* Function to safely get fn->sernum for passed in rt
232 * and store result in passed in cookie.
233 * Return true if we can get cookie safely
234 * Return false if not
235 */
a269f1a7
DA
236static inline bool fib6_get_cookie_safe(const struct fib6_info *f6i,
237 u32 *cookie)
c5cff856
WW
238{
239 struct fib6_node *fn;
240 bool status = false;
241
93c2fb25 242 fn = rcu_dereference(f6i->fib6_node);
c5cff856
WW
243
244 if (fn) {
245 *cookie = fn->fn_sernum;
bbd63f06
WW
246 /* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
247 smp_rmb();
c5cff856
WW
248 status = true;
249 }
250
c5cff856
WW
251 return status;
252}
253
b197df4f
MKL
254static inline u32 rt6_get_cookie(const struct rt6_info *rt)
255{
a68886a6 256 struct fib6_info *from;
c5cff856
WW
257 u32 cookie = 0;
258
a87b7dc9
DA
259 rcu_read_lock();
260
a68886a6
DA
261 from = rcu_dereference(rt->from);
262 if (from && (rt->rt6i_flags & RTF_PCPU ||
263 unlikely(!list_empty(&rt->rt6i_uncached))))
264 fib6_get_cookie_safe(from, &cookie);
3da59bd9 265
a87b7dc9 266 rcu_read_unlock();
c5cff856
WW
267
268 return cookie;
b197df4f 269}
1716a961 270
94e187c0
AW
271static inline void ip6_rt_put(struct rt6_info *rt)
272{
273 /* dst_release() accepts a NULL parameter.
274 * We rely on dst being first structure in struct rt6_info
275 */
276 BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
277 dst_release(&rt->dst);
278}
279
8d1c802b 280struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
9b0a8da8 281void fib6_info_destroy_rcu(struct rcu_head *head);
a460aa83 282
8d1c802b 283static inline void fib6_info_hold(struct fib6_info *f6i)
a460aa83 284{
93c2fb25 285 atomic_inc(&f6i->fib6_ref);
a460aa83
IS
286}
287
e873e4b9
WW
288static inline bool fib6_info_hold_safe(struct fib6_info *f6i)
289{
290 return atomic_inc_not_zero(&f6i->fib6_ref);
291}
292
8d1c802b 293static inline void fib6_info_release(struct fib6_info *f6i)
a460aa83 294{
93c2fb25 295 if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
9b0a8da8 296 call_rcu(&f6i->rcu, fib6_info_destroy_rcu);
a460aa83
IS
297}
298
94b2cfe0
HFS
299enum fib6_walk_state {
300#ifdef CONFIG_IPV6_SUBTREES
301 FWS_S,
302#endif
303 FWS_L,
304 FWS_R,
305 FWS_C,
306 FWS_U
307};
308
309struct fib6_walker {
bbef49da 310 struct list_head lh;
1da177e4 311 struct fib6_node *root, *node;
8d1c802b 312 struct fib6_info *leaf;
94b2cfe0 313 enum fib6_walk_state state;
2bec5a36
PM
314 unsigned int skip;
315 unsigned int count;
94b2cfe0 316 int (*func)(struct fib6_walker *);
1da177e4
LT
317 void *args;
318};
319
1da177e4 320struct rt6_statistics {
81eb8447
WW
321 __u32 fib_nodes; /* all fib6 nodes */
322 __u32 fib_route_nodes; /* intermediate nodes */
323 __u32 fib_rt_entries; /* rt entries in fib table */
324 __u32 fib_rt_cache; /* cached rt entries in exception table */
325 __u32 fib_discarded_routes; /* total number of routes delete */
326
327 /* The following stats are not protected by any lock */
328 atomic_t fib_rt_alloc; /* total number of routes alloced */
329 atomic_t fib_rt_uncache; /* rt entries in uncached list */
1da177e4
LT
330};
331
332#define RTN_TL_ROOT 0x0001
333#define RTN_ROOT 0x0002 /* tree root node */
334#define RTN_RTINFO 0x0004 /* node with valid routing info */
335
336/*
337 * priority levels (or metrics)
338 *
339 */
340
1da177e4 341
c71099ac
TG
342struct fib6_table {
343 struct hlist_node tb6_hlist;
344 u32 tb6_id;
66f5d6ce 345 spinlock_t tb6_lock;
c71099ac 346 struct fib6_node tb6_root;
8e773277 347 struct inet_peer_base tb6_peers;
830218c1 348 unsigned int flags;
e1ee0a5b 349 unsigned int fib_seq;
830218c1 350#define RT6_TABLE_HAS_DFLT_ROUTER BIT(0)
c71099ac
TG
351};
352
353#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
354#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac
TG
355#define RT6_TABLE_DFLT RT6_TABLE_MAIN
356#define RT6_TABLE_INFO RT6_TABLE_MAIN
357#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
358
359#ifdef CONFIG_IPV6_MULTIPLE_TABLES
360#define FIB6_TABLE_MIN 1
361#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2 362#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac
TG
363#else
364#define FIB6_TABLE_MIN RT_TABLE_MAIN
365#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2 366#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac
TG
367#endif
368
8ed67789
DL
369typedef struct rt6_info *(*pol_lookup_t)(struct net *,
370 struct fib6_table *,
b75cc8f9
DA
371 struct flowi6 *,
372 const struct sk_buff *, int);
1da177e4 373
df77fe4d
IS
374struct fib6_entry_notifier_info {
375 struct fib_notifier_info info; /* must be first */
8d1c802b 376 struct fib6_info *rt;
df77fe4d
IS
377};
378
1da177e4
LT
379/*
380 * exported functions
381 */
382
5c3a0fd7
JP
383struct fib6_table *fib6_get_table(struct net *net, u32 id);
384struct fib6_table *fib6_new_table(struct net *net, u32 id);
385struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
b75cc8f9 386 const struct sk_buff *skb,
5c3a0fd7 387 int flags, pol_lookup_t lookup);
c71099ac 388
138118ec
DA
389/* called with rcu lock held; can return error pointer
390 * caller needs to select path
391 */
392struct fib6_info *fib6_lookup(struct net *net, int oif, struct flowi6 *fl6,
393 int flags);
394
1d053da9
DA
395/* called with rcu lock held; caller needs to select path */
396struct fib6_info *fib6_table_lookup(struct net *net, struct fib6_table *table,
397 int oif, struct flowi6 *fl6, int strict);
398
3b290a31
DA
399struct fib6_info *fib6_multipath_select(const struct net *net,
400 struct fib6_info *match,
401 struct flowi6 *fl6, int oif,
402 const struct sk_buff *skb, int strict);
403
6454743b
DA
404struct fib6_node *fib6_node_lookup(struct fib6_node *root,
405 const struct in6_addr *daddr,
406 const struct in6_addr *saddr);
1da177e4 407
5c3a0fd7
JP
408struct fib6_node *fib6_locate(struct fib6_node *root,
409 const struct in6_addr *daddr, int dst_len,
38fbeeee
WW
410 const struct in6_addr *saddr, int src_len,
411 bool exact_match);
1da177e4 412
8d1c802b 413void fib6_clean_all(struct net *net, int (*func)(struct fib6_info *, void *arg),
0c3584d5 414 void *arg);
7c6bb7d2
DA
415void fib6_clean_all_skip_notify(struct net *net,
416 int (*func)(struct fib6_info *, void *arg),
417 void *arg);
c71099ac 418
8d1c802b 419int fib6_add(struct fib6_node *root, struct fib6_info *rt,
d4ead6b3 420 struct nl_info *info, struct netlink_ext_ack *extack);
8d1c802b 421int fib6_del(struct fib6_info *rt, struct nl_info *info);
1da177e4 422
67edf21e
DA
423static inline
424void rt6_get_prefsrc(const struct rt6_info *rt, struct in6_addr *addr)
425{
426 const struct fib6_info *from;
427
428 rcu_read_lock();
429
430 from = rcu_dereference(rt->from);
431 if (from) {
432 *addr = from->fib6_prefsrc.addr;
433 } else {
434 struct in6_addr in6_zero = {};
435
436 *addr = in6_zero;
437 }
438
439 rcu_read_unlock();
440}
441
9ee8cbb2
DA
442static inline struct net_device *fib6_info_nh_dev(const struct fib6_info *f6i)
443{
444 return f6i->fib6_nh.nh_dev;
445}
446
901731b8
DA
447static inline
448struct lwtunnel_state *fib6_info_nh_lwt(const struct fib6_info *f6i)
449{
450 return f6i->fib6_nh.nh_lwtstate;
451}
1da177e4 452
8d1c802b 453void inet6_rt_notify(int event, struct fib6_info *rt, struct nl_info *info,
37a1d361 454 unsigned int flags);
1da177e4 455
5c3a0fd7 456void fib6_run_gc(unsigned long expires, struct net *net, bool force);
1da177e4 457
5c3a0fd7 458void fib6_gc_cleanup(void);
1da177e4 459
5c3a0fd7 460int fib6_init(void);
101367c2 461
c3506372
CH
462struct ipv6_route_iter {
463 struct seq_net_private p;
464 struct fib6_walker w;
465 loff_t skip;
466 struct fib6_table *tbl;
467 int sernum;
468};
469
470extern const struct seq_operations ipv6_route_seq_ops;
8d2ca1d7 471
16ab6d7d
IS
472int call_fib6_notifier(struct notifier_block *nb, struct net *net,
473 enum fib_event_type event_type,
474 struct fib_notifier_info *info);
475int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
476 struct fib_notifier_info *info);
477
478int __net_init fib6_notifier_init(struct net *net);
479void __net_exit fib6_notifier_exit(struct net *net);
480
e1ee0a5b
IS
481unsigned int fib6_tables_seq_read(struct net *net);
482int fib6_tables_dump(struct net *net, struct notifier_block *nb);
483
8d1c802b
DA
484void fib6_update_sernum(struct net *net, struct fib6_info *rt);
485void fib6_update_sernum_upto_root(struct net *net, struct fib6_info *rt);
180ca444 486
8d1c802b
DA
487void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
488static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
d4ead6b3
DA
489{
490 return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
491}
180ca444 492
7e5449c2 493#ifdef CONFIG_IPV6_MULTIPLE_TABLES
5c3a0fd7
JP
494int fib6_rules_init(void);
495void fib6_rules_cleanup(void);
e3ea9731 496bool fib6_rule_default(const struct fib_rule *rule);
dcb18f76
IS
497int fib6_rules_dump(struct net *net, struct notifier_block *nb);
498unsigned int fib6_rules_seq_read(struct net *net);
5e5d6fed
RP
499
500static inline bool fib6_rules_early_flow_dissect(struct net *net,
501 struct sk_buff *skb,
502 struct flowi6 *fl6,
503 struct flow_keys *flkeys)
504{
505 unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
506
507 if (!net->ipv6.fib6_rules_require_fldissect)
508 return false;
509
510 skb_flow_dissect_flow_keys(skb, flkeys, flag);
511 fl6->fl6_sport = flkeys->ports.src;
512 fl6->fl6_dport = flkeys->ports.dst;
513 fl6->flowi6_proto = flkeys->basic.ip_proto;
514
515 return true;
516}
7e5449c2
DL
517#else
518static inline int fib6_rules_init(void)
519{
520 return 0;
521}
522static inline void fib6_rules_cleanup(void)
523{
524 return ;
525}
e3ea9731
IS
526static inline bool fib6_rule_default(const struct fib_rule *rule)
527{
528 return true;
529}
dcb18f76
IS
530static inline int fib6_rules_dump(struct net *net, struct notifier_block *nb)
531{
532 return 0;
533}
534static inline unsigned int fib6_rules_seq_read(struct net *net)
535{
536 return 0;
537}
5e5d6fed
RP
538static inline bool fib6_rules_early_flow_dissect(struct net *net,
539 struct sk_buff *skb,
540 struct flowi6 *fl6,
541 struct flow_keys *flkeys)
542{
543 return false;
544}
7e5449c2 545#endif
1da177e4 546#endif