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