net/ipv6: Rename rt6_multipath_select
[linux-block.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,
53 __unused : 15;
86872cb5
TG
54
55 struct in6_addr fc_dst;
56 struct in6_addr fc_src;
c3968a85 57 struct in6_addr fc_prefsrc;
86872cb5
TG
58 struct in6_addr fc_gateway;
59
60 unsigned long fc_expires;
61 struct nlattr *fc_mx;
62 int fc_mx_len;
51ebd318
ND
63 int fc_mp_len;
64 struct nlattr *fc_mp;
86872cb5
TG
65
66 struct nl_info fc_nlinfo;
19e42e45
RP
67 struct nlattr *fc_encap;
68 u16 fc_encap_type;
86872cb5
TG
69};
70
fd2c3ef7 71struct fib6_node {
66f5d6ce
WW
72 struct fib6_node __rcu *parent;
73 struct fib6_node __rcu *left;
74 struct fib6_node __rcu *right;
8bce65b9 75#ifdef CONFIG_IPV6_SUBTREES
66f5d6ce 76 struct fib6_node __rcu *subtree;
8bce65b9 77#endif
8d1c802b 78 struct fib6_info __rcu *leaf;
1da177e4
LT
79
80 __u16 fn_bit; /* bit key */
81 __u16 fn_flags;
42b18706 82 int fn_sernum;
8d1c802b 83 struct fib6_info __rcu *rr_ptr;
c5cff856 84 struct rcu_head rcu;
1da177e4
LT
85};
86
c757faa8
WW
87struct fib6_gc_args {
88 int timeout;
89 int more;
90};
91
7fc33165
YH
92#ifndef CONFIG_IPV6_SUBTREES
93#define FIB6_SUBTREE(fn) NULL
94#else
66f5d6ce 95#define FIB6_SUBTREE(fn) (rcu_dereference_protected((fn)->subtree, 1))
7fc33165 96#endif
1da177e4
LT
97
98/*
99 * routing information
100 *
101 */
102
fd2c3ef7 103struct rt6key {
1da177e4
LT
104 struct in6_addr addr;
105 int plen;
106};
107
c71099ac
TG
108struct fib6_table;
109
35732d01
WW
110struct rt6_exception_bucket {
111 struct hlist_head chain;
112 int depth;
113};
114
115struct 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
5e670d84
DA
126struct 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
a64efe14 136struct fib6_info {
93c2fb25 137 struct fib6_table *fib6_table;
8fb11a9a 138 struct fib6_info __rcu *fib6_next;
93c2fb25 139 struct fib6_node __rcu *fib6_node;
a64efe14
DA
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 */
93c2fb25
DA
146 struct list_head fib6_siblings;
147 unsigned int fib6_nsiblings;
a64efe14 148
93c2fb25 149 atomic_t fib6_ref;
a64efe14
DA
150 unsigned long expires;
151 struct dst_metrics *fib6_metrics;
152#define fib6_pmtu fib6_metrics->metrics[RTAX_MTU-1]
153
93c2fb25
DA
154 struct rt6key fib6_dst;
155 u32 fib6_flags;
156 struct rt6key fib6_src;
157 struct rt6key fib6_prefsrc;
a64efe14
DA
158
159 struct rt6_info * __percpu *rt6i_pcpu;
160 struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
161
93c2fb25
DA
162 u32 fib6_metric;
163 u8 fib6_protocol;
a64efe14
DA
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
fd2c3ef7 175struct rt6_info {
d8d1f30b 176 struct dst_entry dst;
a68886a6 177 struct fib6_info __rcu *from;
1da177e4 178
77634cc6
DA
179 struct rt6key rt6i_dst;
180 struct rt6key rt6i_src;
1da177e4 181 struct in6_addr rt6i_gateway;
77634cc6 182 struct inet6_dev *rt6i_idev;
bd2c77a0 183 u32 rt6i_flags;
c3968a85 184 struct rt6key rt6i_prefsrc;
b4ce9277 185
8d0b94af
MKL
186 struct list_head rt6i_uncached;
187 struct uncached_list *rt6i_uncached_list;
188
bd2c77a0
YH
189 /* more non-fragment space at head required */
190 unsigned short rt6i_nfheader_len;
1da177e4
LT
191};
192
66f5d6ce
WW
193#define for_each_fib6_node_rt_rcu(fn) \
194 for (rt = rcu_dereference((fn)->leaf); rt; \
8fb11a9a 195 rt = rcu_dereference(rt->fib6_next))
66f5d6ce
WW
196
197#define for_each_fib6_walker_rt(w) \
198 for (rt = (w)->leaf; rt; \
8fb11a9a 199 rt = rcu_dereference_protected(rt->fib6_next, 1))
66f5d6ce 200
7a3025b1
YH
201static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
202{
203 return ((struct rt6_info *)dst)->rt6i_idev;
204}
205
8d1c802b 206static inline void fib6_clean_expires(struct fib6_info *f6i)
14895687 207{
93c2fb25 208 f6i->fib6_flags &= ~RTF_EXPIRES;
14895687
DA
209 f6i->expires = 0;
210}
211
8d1c802b 212static inline void fib6_set_expires(struct fib6_info *f6i,
14895687
DA
213 unsigned long expires)
214{
215 f6i->expires = expires;
93c2fb25 216 f6i->fib6_flags |= RTF_EXPIRES;
14895687
DA
217}
218
8d1c802b 219static inline bool fib6_check_expired(const struct fib6_info *f6i)
14895687 220{
93c2fb25 221 if (f6i->fib6_flags & RTF_EXPIRES)
14895687
DA
222 return time_after(jiffies, f6i->expires);
223 return false;
224}
225
c5cff856
WW
226/* Function to safely get fn->sernum for passed in rt
227 * and store result in passed in cookie.
228 * Return true if we can get cookie safely
229 * Return false if not
230 */
a269f1a7
DA
231static inline bool fib6_get_cookie_safe(const struct fib6_info *f6i,
232 u32 *cookie)
c5cff856
WW
233{
234 struct fib6_node *fn;
235 bool status = false;
236
93c2fb25 237 fn = rcu_dereference(f6i->fib6_node);
c5cff856
WW
238
239 if (fn) {
240 *cookie = fn->fn_sernum;
bbd63f06
WW
241 /* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
242 smp_rmb();
c5cff856
WW
243 status = true;
244 }
245
c5cff856
WW
246 return status;
247}
248
b197df4f
MKL
249static inline u32 rt6_get_cookie(const struct rt6_info *rt)
250{
a68886a6 251 struct fib6_info *from;
c5cff856
WW
252 u32 cookie = 0;
253
a87b7dc9
DA
254 rcu_read_lock();
255
a68886a6
DA
256 from = rcu_dereference(rt->from);
257 if (from && (rt->rt6i_flags & RTF_PCPU ||
258 unlikely(!list_empty(&rt->rt6i_uncached))))
259 fib6_get_cookie_safe(from, &cookie);
c5cff856 260
a87b7dc9
DA
261 rcu_read_unlock();
262
c5cff856 263 return cookie;
b197df4f 264}
1716a961 265
94e187c0
AW
266static inline void ip6_rt_put(struct rt6_info *rt)
267{
268 /* dst_release() accepts a NULL parameter.
269 * We rely on dst being first structure in struct rt6_info
270 */
271 BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
272 dst_release(&rt->dst);
273}
274
8d1c802b
DA
275struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
276void fib6_info_destroy(struct fib6_info *f6i);
a64efe14 277
8d1c802b 278static inline void fib6_info_hold(struct fib6_info *f6i)
a64efe14 279{
93c2fb25 280 atomic_inc(&f6i->fib6_ref);
a64efe14
DA
281}
282
8d1c802b 283static inline void fib6_info_release(struct fib6_info *f6i)
a64efe14 284{
93c2fb25 285 if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
a64efe14
DA
286 fib6_info_destroy(f6i);
287}
288
94b2cfe0
HFS
289enum fib6_walk_state {
290#ifdef CONFIG_IPV6_SUBTREES
291 FWS_S,
292#endif
293 FWS_L,
294 FWS_R,
295 FWS_C,
296 FWS_U
297};
298
299struct fib6_walker {
bbef49da 300 struct list_head lh;
1da177e4 301 struct fib6_node *root, *node;
8d1c802b 302 struct fib6_info *leaf;
94b2cfe0 303 enum fib6_walk_state state;
2bec5a36
PM
304 unsigned int skip;
305 unsigned int count;
94b2cfe0 306 int (*func)(struct fib6_walker *);
1da177e4
LT
307 void *args;
308};
309
1da177e4 310struct rt6_statistics {
81eb8447
WW
311 __u32 fib_nodes; /* all fib6 nodes */
312 __u32 fib_route_nodes; /* intermediate nodes */
313 __u32 fib_rt_entries; /* rt entries in fib table */
314 __u32 fib_rt_cache; /* cached rt entries in exception table */
315 __u32 fib_discarded_routes; /* total number of routes delete */
316
317 /* The following stats are not protected by any lock */
318 atomic_t fib_rt_alloc; /* total number of routes alloced */
319 atomic_t fib_rt_uncache; /* rt entries in uncached list */
1da177e4
LT
320};
321
322#define RTN_TL_ROOT 0x0001
323#define RTN_ROOT 0x0002 /* tree root node */
324#define RTN_RTINFO 0x0004 /* node with valid routing info */
325
326/*
327 * priority levels (or metrics)
328 *
329 */
330
1da177e4 331
c71099ac
TG
332struct fib6_table {
333 struct hlist_node tb6_hlist;
334 u32 tb6_id;
66f5d6ce 335 spinlock_t tb6_lock;
c71099ac 336 struct fib6_node tb6_root;
8e773277 337 struct inet_peer_base tb6_peers;
830218c1 338 unsigned int flags;
e1ee0a5b 339 unsigned int fib_seq;
830218c1 340#define RT6_TABLE_HAS_DFLT_ROUTER BIT(0)
c71099ac
TG
341};
342
343#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
344#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac
TG
345#define RT6_TABLE_DFLT RT6_TABLE_MAIN
346#define RT6_TABLE_INFO RT6_TABLE_MAIN
347#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
348
349#ifdef CONFIG_IPV6_MULTIPLE_TABLES
350#define FIB6_TABLE_MIN 1
351#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2 352#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac
TG
353#else
354#define FIB6_TABLE_MIN RT_TABLE_MAIN
355#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2 356#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac
TG
357#endif
358
8ed67789
DL
359typedef struct rt6_info *(*pol_lookup_t)(struct net *,
360 struct fib6_table *,
b75cc8f9
DA
361 struct flowi6 *,
362 const struct sk_buff *, int);
1da177e4 363
df77fe4d
IS
364struct fib6_entry_notifier_info {
365 struct fib_notifier_info info; /* must be first */
8d1c802b 366 struct fib6_info *rt;
df77fe4d
IS
367};
368
1da177e4
LT
369/*
370 * exported functions
371 */
372
5c3a0fd7
JP
373struct fib6_table *fib6_get_table(struct net *net, u32 id);
374struct fib6_table *fib6_new_table(struct net *net, u32 id);
375struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
b75cc8f9 376 const struct sk_buff *skb,
5c3a0fd7 377 int flags, pol_lookup_t lookup);
c71099ac 378
3b290a31
DA
379struct fib6_info *fib6_multipath_select(const struct net *net,
380 struct fib6_info *match,
381 struct flowi6 *fl6, int oif,
382 const struct sk_buff *skb, int strict);
383
6454743b
DA
384struct fib6_node *fib6_node_lookup(struct fib6_node *root,
385 const struct in6_addr *daddr,
386 const struct in6_addr *saddr);
1da177e4 387
5c3a0fd7
JP
388struct fib6_node *fib6_locate(struct fib6_node *root,
389 const struct in6_addr *daddr, int dst_len,
38fbeeee
WW
390 const struct in6_addr *saddr, int src_len,
391 bool exact_match);
1da177e4 392
8d1c802b 393void fib6_clean_all(struct net *net, int (*func)(struct fib6_info *, void *arg),
0c3584d5 394 void *arg);
c71099ac 395
8d1c802b 396int fib6_add(struct fib6_node *root, struct fib6_info *rt,
d4ead6b3 397 struct nl_info *info, struct netlink_ext_ack *extack);
8d1c802b 398int fib6_del(struct fib6_info *rt, struct nl_info *info);
1da177e4 399
9ee8cbb2
DA
400static inline struct net_device *fib6_info_nh_dev(const struct fib6_info *f6i)
401{
402 return f6i->fib6_nh.nh_dev;
403}
404
8d1c802b 405void inet6_rt_notify(int event, struct fib6_info *rt, struct nl_info *info,
37a1d361 406 unsigned int flags);
1da177e4 407
5c3a0fd7 408void fib6_run_gc(unsigned long expires, struct net *net, bool force);
1da177e4 409
5c3a0fd7 410void fib6_gc_cleanup(void);
1da177e4 411
5c3a0fd7 412int fib6_init(void);
101367c2 413
8d2ca1d7
HFS
414int ipv6_route_open(struct inode *inode, struct file *file);
415
16ab6d7d
IS
416int call_fib6_notifier(struct notifier_block *nb, struct net *net,
417 enum fib_event_type event_type,
418 struct fib_notifier_info *info);
419int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
420 struct fib_notifier_info *info);
421
422int __net_init fib6_notifier_init(struct net *net);
423void __net_exit fib6_notifier_exit(struct net *net);
424
e1ee0a5b
IS
425unsigned int fib6_tables_seq_read(struct net *net);
426int fib6_tables_dump(struct net *net, struct notifier_block *nb);
427
8d1c802b
DA
428void fib6_update_sernum(struct net *net, struct fib6_info *rt);
429void fib6_update_sernum_upto_root(struct net *net, struct fib6_info *rt);
180ca444 430
8d1c802b
DA
431void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
432static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
d4ead6b3
DA
433{
434 return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
435}
436
7e5449c2 437#ifdef CONFIG_IPV6_MULTIPLE_TABLES
5c3a0fd7
JP
438int fib6_rules_init(void);
439void fib6_rules_cleanup(void);
e3ea9731 440bool fib6_rule_default(const struct fib_rule *rule);
dcb18f76
IS
441int fib6_rules_dump(struct net *net, struct notifier_block *nb);
442unsigned int fib6_rules_seq_read(struct net *net);
5e5d6fed
RP
443
444static inline bool fib6_rules_early_flow_dissect(struct net *net,
445 struct sk_buff *skb,
446 struct flowi6 *fl6,
447 struct flow_keys *flkeys)
448{
449 unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
450
451 if (!net->ipv6.fib6_rules_require_fldissect)
452 return false;
453
454 skb_flow_dissect_flow_keys(skb, flkeys, flag);
455 fl6->fl6_sport = flkeys->ports.src;
456 fl6->fl6_dport = flkeys->ports.dst;
457 fl6->flowi6_proto = flkeys->basic.ip_proto;
458
459 return true;
460}
7e5449c2
DL
461#else
462static inline int fib6_rules_init(void)
463{
464 return 0;
465}
466static inline void fib6_rules_cleanup(void)
467{
468 return ;
469}
e3ea9731
IS
470static inline bool fib6_rule_default(const struct fib_rule *rule)
471{
472 return true;
473}
dcb18f76
IS
474static inline int fib6_rules_dump(struct net *net, struct notifier_block *nb)
475{
476 return 0;
477}
478static inline unsigned int fib6_rules_seq_read(struct net *net)
479{
480 return 0;
481}
5e5d6fed
RP
482static inline bool fib6_rules_early_flow_dissect(struct net *net,
483 struct sk_buff *skb,
484 struct flowi6 *fl6,
485 struct flow_keys *flkeys)
486{
487 return false;
488}
7e5449c2 489#endif
1da177e4 490#endif