]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - include/net/ip_fib.h
net: add net available in build_state
[mirror_ubuntu-hirsute-kernel.git] / include / net / ip_fib.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4
LT
2/*
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. INET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
6 *
7 * Definitions for the Forwarding Information Base.
8 *
9 * Authors: A.N.Kuznetsov, <kuznet@ms2.inr.ac.ru>
1da177e4
LT
10 */
11
12#ifndef _NET_IP_FIB_H
13#define _NET_IP_FIB_H
14
1da177e4
LT
15#include <net/flow.h>
16#include <linux/seq_file.h>
4895c771 17#include <linux/rcupdate.h>
04b1d4e5 18#include <net/fib_notifier.h>
e1ef4bf2 19#include <net/fib_rules.h>
8e773277 20#include <net/inetpeer.h>
d26b3a7c 21#include <linux/percpu.h>
b90eb754 22#include <linux/notifier.h>
0029c0de 23#include <linux/refcount.h>
1da177e4 24
4e902c57 25struct fib_config {
4e902c57 26 u8 fc_dst_len;
4e902c57
TG
27 u8 fc_tos;
28 u8 fc_protocol;
29 u8 fc_scope;
30 u8 fc_type;
f35b794b
DA
31 u8 fc_gw_family;
32 /* 2 bytes unused */
4e902c57 33 u32 fc_table;
6d85c10a 34 __be32 fc_dst;
a4ea5d43
DA
35 union {
36 __be32 fc_gw4;
37 struct in6_addr fc_gw6;
38 };
4e902c57
TG
39 int fc_oif;
40 u32 fc_flags;
41 u32 fc_priority;
6d85c10a 42 __be32 fc_prefsrc;
493ced1a 43 u32 fc_nh_id;
4e902c57
TG
44 struct nlattr *fc_mx;
45 struct rtnexthop *fc_mp;
46 int fc_mx_len;
47 int fc_mp_len;
48 u32 fc_flow;
4e902c57
TG
49 u32 fc_nlflags;
50 struct nl_info fc_nlinfo;
571e7226
RP
51 struct nlattr *fc_encap;
52 u16 fc_encap_type;
53};
1da177e4
LT
54
55struct fib_info;
f2bb4bed 56struct rtable;
1da177e4 57
4895c771
DM
58struct fib_nh_exception {
59 struct fib_nh_exception __rcu *fnhe_next;
5aad1de5 60 int fnhe_genid;
4895c771
DM
61 __be32 fnhe_daddr;
62 u32 fnhe_pmtu;
d52e5a7e 63 bool fnhe_mtu_locked;
aee06da6 64 __be32 fnhe_gw;
4895c771 65 unsigned long fnhe_expires;
2ffae99d
TT
66 struct rtable __rcu *fnhe_rth_input;
67 struct rtable __rcu *fnhe_rth_output;
4895c771 68 unsigned long fnhe_stamp;
deed49df 69 struct rcu_head rcu;
4895c771
DM
70};
71
72struct fnhe_hash_bucket {
73 struct fib_nh_exception __rcu *chain;
74};
75
d546c621
ED
76#define FNHE_HASH_SHIFT 11
77#define FNHE_HASH_SIZE (1 << FNHE_HASH_SHIFT)
4895c771
DM
78#define FNHE_RECLAIM_DEPTH 5
79
f1741730
DA
80struct fib_nh_common {
81 struct net_device *nhc_dev;
82 int nhc_oif;
f1741730
DA
83 unsigned char nhc_scope;
84 u8 nhc_family;
bdf00467 85 u8 nhc_gw_family;
ecc5663c
DA
86 unsigned char nhc_flags;
87 struct lwtunnel_state *nhc_lwtstate;
bdf00467 88
f1741730
DA
89 union {
90 __be32 ipv4;
91 struct in6_addr ipv6;
92 } nhc_gw;
93
94 int nhc_weight;
95 atomic_t nhc_upper_bound;
0f457a36
DA
96
97 /* v4 specific, but allows fib6_nh with v4 routes */
98 struct rtable __rcu * __percpu *nhc_pcpu_rth_output;
99 struct rtable __rcu *nhc_rth_input;
a5995e71 100 struct fnhe_hash_bucket __rcu *nhc_exceptions;
f1741730
DA
101};
102
1da177e4 103struct fib_nh {
f1741730 104 struct fib_nh_common nh_common;
1da177e4
LT
105 struct hlist_node nh_hash;
106 struct fib_info *nh_parent;
c7066f70 107#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4
LT
108 __u32 nh_tclassid;
109#endif
1fc050a1 110 __be32 nh_saddr;
436c3b66 111 int nh_saddr_genid;
f1741730
DA
112#define fib_nh_family nh_common.nhc_family
113#define fib_nh_dev nh_common.nhc_dev
114#define fib_nh_oif nh_common.nhc_oif
115#define fib_nh_flags nh_common.nhc_flags
116#define fib_nh_lws nh_common.nhc_lwtstate
117#define fib_nh_scope nh_common.nhc_scope
bdf00467 118#define fib_nh_gw_family nh_common.nhc_gw_family
f1741730
DA
119#define fib_nh_gw4 nh_common.nhc_gw.ipv4
120#define fib_nh_gw6 nh_common.nhc_gw.ipv6
121#define fib_nh_weight nh_common.nhc_weight
122#define fib_nh_upper_bound nh_common.nhc_upper_bound
1da177e4
LT
123};
124
125/*
126 * This structure contains data shared by many of routes.
127 */
128
4c7e8084
DA
129struct nexthop;
130
1da177e4
LT
131struct fib_info {
132 struct hlist_node fib_hash;
133 struct hlist_node fib_lhash;
4c7e8084 134 struct list_head nh_list;
7462bd74 135 struct net *fib_net;
1da177e4 136 int fib_treeref;
0029c0de 137 refcount_t fib_clntref;
95c96174 138 unsigned int fib_flags;
37e826c5
DM
139 unsigned char fib_dead;
140 unsigned char fib_protocol;
141 unsigned char fib_scope;
f4ef85bb 142 unsigned char fib_type;
b83738ae 143 __be32 fib_prefsrc;
5a56a0b3 144 u32 fib_tb_id;
1da177e4 145 u32 fib_priority;
3fb07daf
ED
146 struct dst_metrics *fib_metrics;
147#define fib_mtu fib_metrics->metrics[RTAX_MTU-1]
148#define fib_window fib_metrics->metrics[RTAX_WINDOW-1]
149#define fib_rtt fib_metrics->metrics[RTAX_RTT-1]
150#define fib_advmss fib_metrics->metrics[RTAX_ADVMSS-1]
1da177e4 151 int fib_nhs;
19a9d136 152 bool fib_nh_is_v6;
1bff1a0c 153 bool nh_updated;
4c7e8084 154 struct nexthop *nh;
ebc0ffae 155 struct rcu_head rcu;
a5311060 156 struct fib_nh fib_nh[];
1da177e4
LT
157};
158
159
160#ifdef CONFIG_IP_MULTIPLE_TABLES
161struct fib_rule;
162#endif
163
5b470441 164struct fib_table;
1da177e4 165struct fib_result {
eba618ab
DA
166 __be32 prefix;
167 unsigned char prefixlen;
168 unsigned char nh_sel;
169 unsigned char type;
170 unsigned char scope;
171 u32 tclassid;
172 struct fib_nh_common *nhc;
173 struct fib_info *fi;
174 struct fib_table *table;
175 struct hlist_head *fa_head;
1da177e4
LT
176};
177
246955fe 178struct fib_result_nl {
80e856e1 179 __be32 fl_addr; /* To be looked up*/
5f300893 180 u32 fl_mark;
246955fe
RO
181 unsigned char fl_tos;
182 unsigned char fl_scope;
183 unsigned char tb_id_in;
184
185 unsigned char tb_id; /* Results */
186 unsigned char prefixlen;
187 unsigned char nh_sel;
188 unsigned char type;
189 unsigned char scope;
82695b30 190 int err;
246955fe 191};
1da177e4 192
5b9e12db 193#ifdef CONFIG_IP_MULTIPLE_TABLES
93456b6d 194#define FIB_TABLE_HASHSZ 256
5b9e12db
DL
195#else
196#define FIB_TABLE_HASHSZ 2
197#endif
1da177e4 198
dcb1ecb5
DA
199__be32 fib_info_update_nhc_saddr(struct net *net, struct fib_nh_common *nhc,
200 unsigned char scope);
eba618ab 201__be32 fib_result_prefsrc(struct net *net, struct fib_result *res);
436c3b66 202
eba618ab
DA
203#define FIB_RES_NHC(res) ((res).nhc)
204#define FIB_RES_DEV(res) (FIB_RES_NHC(res)->nhc_dev)
205#define FIB_RES_OIF(res) (FIB_RES_NHC(res)->nhc_oif)
1fc050a1 206
1e301fd0
IS
207struct fib_rt_info {
208 struct fib_info *fi;
209 u32 tb_id;
210 __be32 dst;
211 int dst_len;
212 u8 tos;
213 u8 type;
90b93f1b
IS
214 u8 offload:1,
215 trap:1,
216 unused:6;
1e301fd0
IS
217};
218
b90eb754
JP
219struct fib_entry_notifier_info {
220 struct fib_notifier_info info; /* must be first */
221 u32 dst;
222 int dst_len;
223 struct fib_info *fi;
224 u8 tos;
225 u8 type;
226 u32 tb_id;
b90eb754
JP
227};
228
982acb97
IS
229struct fib_nh_notifier_info {
230 struct fib_notifier_info info; /* must be first */
231 struct fib_nh *fib_nh;
232};
233
7c550daf 234int call_fib4_notifier(struct notifier_block *nb,
04b1d4e5 235 enum fib_event_type event_type,
b90eb754 236 struct fib_notifier_info *info);
04b1d4e5
IS
237int call_fib4_notifiers(struct net *net, enum fib_event_type event_type,
238 struct fib_notifier_info *info);
239
240int __net_init fib4_notifier_init(struct net *net);
241void __net_exit fib4_notifier_exit(struct net *net);
b90eb754 242
1bff1a0c 243void fib_info_notify_update(struct net *net, struct nl_info *info);
b7a59557
JP
244int fib_notify(struct net *net, struct notifier_block *nb,
245 struct netlink_ext_ack *extack);
c0243892 246
1da177e4 247struct fib_table {
8e773277
DM
248 struct hlist_node tb_hlist;
249 u32 tb_id;
8e773277 250 int tb_num_default;
a7e53531 251 struct rcu_head rcu;
0ddcf43d 252 unsigned long *tb_data;
a5311060 253 unsigned long __data[];
1da177e4
LT
254};
255
4724676d
DA
256struct fib_dump_filter {
257 u32 table_id;
258 /* filter_set is an optimization that an entry is set */
259 bool filter_set;
ae677bbb 260 bool dump_all_families;
564c91f7
SB
261 bool dump_routes;
262 bool dump_exceptions;
4724676d
DA
263 unsigned char protocol;
264 unsigned char rt_type;
265 unsigned int flags;
266 struct net_device *dev;
267};
268
5c3a0fd7
JP
269int fib_table_lookup(struct fib_table *tb, const struct flowi4 *flp,
270 struct fib_result *res, int fib_flags);
6d8422a1
DA
271int fib_table_insert(struct net *, struct fib_table *, struct fib_config *,
272 struct netlink_ext_ack *extack);
78055998
DA
273int fib_table_delete(struct net *, struct fib_table *, struct fib_config *,
274 struct netlink_ext_ack *extack);
5c3a0fd7 275int fib_table_dump(struct fib_table *table, struct sk_buff *skb,
18a8021a 276 struct netlink_callback *cb, struct fib_dump_filter *filter);
f97f4dd8 277int fib_table_flush(struct net *net, struct fib_table *table, bool flush_all);
0ddcf43d 278struct fib_table *fib_trie_unmerge(struct fib_table *main_tb);
3b709334 279void fib_table_flush_external(struct fib_table *table);
5c3a0fd7 280void fib_free_table(struct fib_table *tb);
4aa2c466 281
1da177e4
LT
282#ifndef CONFIG_IP_MULTIPLE_TABLES
283
a5a519b2
AD
284#define TABLE_LOCAL_INDEX (RT_TABLE_LOCAL & (FIB_TABLE_HASHSZ - 1))
285#define TABLE_MAIN_INDEX (RT_TABLE_MAIN & (FIB_TABLE_HASHSZ - 1))
1da177e4 286
8ad4942c 287static inline struct fib_table *fib_get_table(struct net *net, u32 id)
1da177e4 288{
a7e53531 289 struct hlist_node *tb_hlist;
93456b6d
DL
290 struct hlist_head *ptr;
291
292 ptr = id == RT_TABLE_LOCAL ?
e4aef8ae
DL
293 &net->ipv4.fib_table_hash[TABLE_LOCAL_INDEX] :
294 &net->ipv4.fib_table_hash[TABLE_MAIN_INDEX];
a7e53531
AD
295
296 tb_hlist = rcu_dereference_rtnl(hlist_first_rcu(ptr));
297
298 return hlist_entry(tb_hlist, struct fib_table, tb_hlist);
1da177e4
LT
299}
300
8ad4942c 301static inline struct fib_table *fib_new_table(struct net *net, u32 id)
1da177e4 302{
8ad4942c 303 return fib_get_table(net, id);
1da177e4
LT
304}
305
22bd5b9b 306static inline int fib_lookup(struct net *net, const struct flowi4 *flp,
0eeb075f 307 struct fib_result *res, unsigned int flags)
1da177e4 308{
a7e53531 309 struct fib_table *tb;
0ddcf43d 310 int err = -ENETUNREACH;
345e9b54
AD
311
312 rcu_read_lock();
313
0ddcf43d 314 tb = fib_get_table(net, RT_TABLE_MAIN);
0315e382
NF
315 if (tb)
316 err = fib_table_lookup(tb, flp, res, flags | FIB_LOOKUP_NOREF);
317
318 if (err == -EAGAIN)
319 err = -ENETUNREACH;
93456b6d 320
345e9b54 321 rcu_read_unlock();
93456b6d 322
345e9b54 323 return err;
1da177e4
LT
324}
325
c43c3d76
PA
326static inline bool fib4_has_custom_rules(const struct net *net)
327{
328 return false;
329}
330
3c71006d
IS
331static inline bool fib4_rule_default(const struct fib_rule *rule)
332{
333 return true;
334}
335
b7a59557
JP
336static inline int fib4_rules_dump(struct net *net, struct notifier_block *nb,
337 struct netlink_ext_ack *extack)
1b2a4440
IS
338{
339 return 0;
340}
341
342static inline unsigned int fib4_rules_seq_read(struct net *net)
343{
344 return 0;
345}
346
e37b1e97
RP
347static inline bool fib4_rules_early_flow_dissect(struct net *net,
348 struct sk_buff *skb,
349 struct flowi4 *fl4,
350 struct flow_keys *flkeys)
351{
352 return false;
353}
1da177e4 354#else /* CONFIG_IP_MULTIPLE_TABLES */
5c3a0fd7
JP
355int __net_init fib4_rules_init(struct net *net);
356void __net_exit fib4_rules_exit(struct net *net);
c3e9a353 357
5c3a0fd7
JP
358struct fib_table *fib_new_table(struct net *net, u32 id);
359struct fib_table *fib_get_table(struct net *net, u32 id);
1da177e4 360
0eeb075f
AG
361int __fib_lookup(struct net *net, struct flowi4 *flp,
362 struct fib_result *res, unsigned int flags);
f4530fa5
DM
363
364static inline int fib_lookup(struct net *net, struct flowi4 *flp,
0eeb075f 365 struct fib_result *res, unsigned int flags)
f4530fa5 366{
a7e53531 367 struct fib_table *tb;
0315e382 368 int err = -ENETUNREACH;
a7e53531 369
0eeb075f 370 flags |= FIB_LOOKUP_NOREF;
a7e53531 371 if (net->ipv4.fib_has_custom_rules)
0eeb075f 372 return __fib_lookup(net, flp, res, flags);
a7e53531
AD
373
374 rcu_read_lock();
375
376 res->tclassid = 0;
377
0315e382
NF
378 tb = rcu_dereference_rtnl(net->ipv4.fib_main);
379 if (tb)
380 err = fib_table_lookup(tb, flp, res, flags);
381
382 if (!err)
383 goto out;
384
385 tb = rcu_dereference_rtnl(net->ipv4.fib_default);
386 if (tb)
387 err = fib_table_lookup(tb, flp, res, flags);
a7e53531 388
0315e382
NF
389out:
390 if (err == -EAGAIN)
391 err = -ENETUNREACH;
a7e53531
AD
392
393 rcu_read_unlock();
394
395 return err;
f4530fa5
DM
396}
397
c43c3d76
PA
398static inline bool fib4_has_custom_rules(const struct net *net)
399{
400 return net->ipv4.fib_has_custom_rules;
401}
402
3c71006d 403bool fib4_rule_default(const struct fib_rule *rule);
b7a59557
JP
404int fib4_rules_dump(struct net *net, struct notifier_block *nb,
405 struct netlink_ext_ack *extack);
1b2a4440 406unsigned int fib4_rules_seq_read(struct net *net);
3c71006d 407
e37b1e97
RP
408static inline bool fib4_rules_early_flow_dissect(struct net *net,
409 struct sk_buff *skb,
410 struct flowi4 *fl4,
411 struct flow_keys *flkeys)
412{
413 unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
414
415 if (!net->ipv4.fib_rules_require_fldissect)
416 return false;
417
418 skb_flow_dissect_flow_keys(skb, flkeys, flag);
419 fl4->fl4_sport = flkeys->ports.src;
420 fl4->fl4_dport = flkeys->ports.dst;
421 fl4->flowi4_proto = flkeys->basic.ip_proto;
422
423 return true;
424}
425
1da177e4
LT
426#endif /* CONFIG_IP_MULTIPLE_TABLES */
427
428/* Exported by fib_frontend.c */
ef7c79ed 429extern const struct nla_policy rtm_ipv4_policy[];
5c3a0fd7 430void ip_fib_init(void);
d1566268
DA
431int fib_gw_from_via(struct fib_config *cfg, struct nlattr *nla,
432 struct netlink_ext_ack *extack);
5c3a0fd7 433__be32 fib_compute_spec_dst(struct sk_buff *skb);
78f2756c 434bool fib_info_nh_uses_dev(struct fib_info *fi, const struct net_device *dev);
5c3a0fd7
JP
435int fib_validate_source(struct sk_buff *skb, __be32 src, __be32 dst,
436 u8 tos, int oif, struct net_device *dev,
437 struct in_device *idev, u32 *itag);
7a9bc9b8 438#ifdef CONFIG_IP_ROUTE_CLASSID
f4530fa5
DM
439static inline int fib_num_tclassid_users(struct net *net)
440{
441 return net->ipv4.fib_num_tclassid_users;
442}
7a9bc9b8 443#else
f4530fa5
DM
444static inline int fib_num_tclassid_users(struct net *net)
445{
446 return 0;
447}
7a9bc9b8 448#endif
0ddcf43d 449int fib_unmerge(struct net *net);
14c85021 450
1da177e4 451/* Exported by fib_semantics.c */
5c3a0fd7 452int ip_fib_check_default(__be32 gw, struct net_device *dev);
4f823def 453int fib_sync_down_dev(struct net_device *dev, unsigned long event, bool force);
5a56a0b3 454int fib_sync_down_addr(struct net_device *dev, __be32 local);
ecc5663c 455int fib_sync_up(struct net_device *dev, unsigned char nh_flags);
af7d6cce 456void fib_sync_mtu(struct net_device *dev, u32 orig_mtu);
06c77c3e 457void fib_nhc_update_mtu(struct fib_nh_common *nhc, u32 new, u32 orig);
0e884c78 458
bf4e0a3d 459#ifdef CONFIG_IP_ROUTE_MULTIPATH
7efc0b6b 460int fib_multipath_hash(const struct net *net, const struct flowi4 *fl4,
e37b1e97 461 const struct sk_buff *skb, struct flow_keys *flkeys);
bf4e0a3d 462#endif
ac1fab2d
DA
463int fib_check_nh(struct net *net, struct fib_nh *nh, u32 table, u8 scope,
464 struct netlink_ext_ack *extack);
0e884c78 465void fib_select_multipath(struct fib_result *res, int hash);
3ce58d84 466void fib_select_path(struct net *net, struct fib_result *res,
bf4e0a3d 467 struct flowi4 *fl4, const struct sk_buff *skb);
1da177e4 468
e4516ef6
DA
469int fib_nh_init(struct net *net, struct fib_nh *fib_nh,
470 struct fib_config *cfg, int nh_weight,
471 struct netlink_ext_ack *extack);
faa041a4 472void fib_nh_release(struct net *net, struct fib_nh *fib_nh);
faee6769
AA
473int fib_nh_common_init(struct net *net, struct fib_nh_common *nhc,
474 struct nlattr *fc_encap, u16 fc_encap_type,
475 void *cfg, gfp_t gfp_flags,
979e276e
DA
476 struct netlink_ext_ack *extack);
477void fib_nh_common_release(struct fib_nh_common *nhc);
e4516ef6 478
5348ba85 479/* Exported by fib_trie.c */
90b93f1b 480void fib_alias_hw_flags_set(struct net *net, const struct fib_rt_info *fri);
5c3a0fd7 481void fib_trie_init(void);
0ddcf43d 482struct fib_table *fib_trie_table(u32 id, struct fib_table *alias);
1da177e4 483
b6bf3ca0 484static inline void fib_combine_itag(u32 *itag, const struct fib_result *res)
1da177e4 485{
c7066f70 486#ifdef CONFIG_IP_ROUTE_CLASSID
eba618ab 487 struct fib_nh_common *nhc = res->nhc;
1da177e4
LT
488#ifdef CONFIG_IP_MULTIPLE_TABLES
489 u32 rtag;
490#endif
dcb1ecb5
DA
491 if (nhc->nhc_family == AF_INET) {
492 struct fib_nh *nh;
493
494 nh = container_of(nhc, struct fib_nh, nh_common);
495 *itag = nh->nh_tclassid << 16;
496 } else {
497 *itag = 0;
498 }
499
1da177e4 500#ifdef CONFIG_IP_MULTIPLE_TABLES
85b91b03 501 rtag = res->tclassid;
1da177e4
LT
502 if (*itag == 0)
503 *itag = (rtag<<16);
504 *itag |= (rtag>>16);
505#endif
506#endif
507}
508
9bd83667 509void fib_flush(struct net *net);
5c3a0fd7 510void free_fib_info(struct fib_info *fi);
1da177e4 511
1c677b3d
IS
512static inline void fib_info_hold(struct fib_info *fi)
513{
0029c0de 514 refcount_inc(&fi->fib_clntref);
1c677b3d
IS
515}
516
1da177e4
LT
517static inline void fib_info_put(struct fib_info *fi)
518{
0029c0de 519 if (refcount_dec_and_test(&fi->fib_clntref))
1da177e4
LT
520 free_fib_info(fi);
521}
522
20380731 523#ifdef CONFIG_PROC_FS
5c3a0fd7
JP
524int __net_init fib_proc_init(struct net *net);
525void __net_exit fib_proc_exit(struct net *net);
cc8274f5
LZ
526#else
527static inline int fib_proc_init(struct net *net)
528{
529 return 0;
530}
531static inline void fib_proc_exit(struct net *net)
532{
533}
20380731
ACM
534#endif
535
50d889b1
DA
536u32 ip_mtu_from_fib_result(struct fib_result *res, __be32 daddr);
537
4724676d
DA
538int ip_valid_fib_dump_req(struct net *net, const struct nlmsghdr *nlh,
539 struct fib_dump_filter *filter,
effe6792 540 struct netlink_callback *cb);
c0a72077
DA
541
542int fib_nexthop_info(struct sk_buff *skb, const struct fib_nh_common *nh,
7bdf4de1 543 u8 rt_family, unsigned char *flags, bool skip_oif);
c0a72077 544int fib_add_nexthop(struct sk_buff *skb, const struct fib_nh_common *nh,
7bdf4de1 545 int nh_weight, u8 rt_family);
1da177e4 546#endif /* _NET_FIB_H */