]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/net/ip_fib.h
r8152: simply the arguments
[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>
e1ef4bf2 22#include <net/fib_rules.h>
8e773277 23#include <net/inetpeer.h>
d26b3a7c 24#include <linux/percpu.h>
b90eb754 25#include <linux/notifier.h>
1da177e4 26
4e902c57 27struct fib_config {
4e902c57 28 u8 fc_dst_len;
4e902c57
TG
29 u8 fc_tos;
30 u8 fc_protocol;
31 u8 fc_scope;
32 u8 fc_type;
b52f070c 33 /* 3 bytes unused */
4e902c57 34 u32 fc_table;
6d85c10a 35 __be32 fc_dst;
6d85c10a 36 __be32 fc_gw;
4e902c57
TG
37 int fc_oif;
38 u32 fc_flags;
39 u32 fc_priority;
6d85c10a 40 __be32 fc_prefsrc;
4e902c57
TG
41 struct nlattr *fc_mx;
42 struct rtnexthop *fc_mp;
43 int fc_mx_len;
44 int fc_mp_len;
45 u32 fc_flow;
4e902c57
TG
46 u32 fc_nlflags;
47 struct nl_info fc_nlinfo;
571e7226
RP
48 struct nlattr *fc_encap;
49 u16 fc_encap_type;
50};
1da177e4
LT
51
52struct fib_info;
f2bb4bed 53struct rtable;
1da177e4 54
4895c771
DM
55struct fib_nh_exception {
56 struct fib_nh_exception __rcu *fnhe_next;
5aad1de5 57 int fnhe_genid;
4895c771
DM
58 __be32 fnhe_daddr;
59 u32 fnhe_pmtu;
aee06da6 60 __be32 fnhe_gw;
4895c771 61 unsigned long fnhe_expires;
2ffae99d
TT
62 struct rtable __rcu *fnhe_rth_input;
63 struct rtable __rcu *fnhe_rth_output;
4895c771 64 unsigned long fnhe_stamp;
deed49df 65 struct rcu_head rcu;
4895c771
DM
66};
67
68struct fnhe_hash_bucket {
69 struct fib_nh_exception __rcu *chain;
70};
71
d546c621
ED
72#define FNHE_HASH_SHIFT 11
73#define FNHE_HASH_SIZE (1 << FNHE_HASH_SHIFT)
4895c771
DM
74#define FNHE_RECLAIM_DEPTH 5
75
1da177e4
LT
76struct fib_nh {
77 struct net_device *nh_dev;
78 struct hlist_node nh_hash;
79 struct fib_info *nh_parent;
95c96174 80 unsigned int nh_flags;
1da177e4
LT
81 unsigned char nh_scope;
82#ifdef CONFIG_IP_ROUTE_MULTIPATH
83 int nh_weight;
0e884c78 84 atomic_t nh_upper_bound;
1da177e4 85#endif
c7066f70 86#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4
LT
87 __u32 nh_tclassid;
88#endif
89 int nh_oif;
ed49e3ca 90 __be32 nh_gw;
1fc050a1 91 __be32 nh_saddr;
436c3b66 92 int nh_saddr_genid;
d26b3a7c 93 struct rtable __rcu * __percpu *nh_pcpu_rth_output;
54764bb6 94 struct rtable __rcu *nh_rth_input;
caa41527 95 struct fnhe_hash_bucket __rcu *nh_exceptions;
571e7226 96 struct lwtunnel_state *nh_lwtstate;
1da177e4
LT
97};
98
99/*
100 * This structure contains data shared by many of routes.
101 */
102
103struct fib_info {
104 struct hlist_node fib_hash;
105 struct hlist_node fib_lhash;
7462bd74 106 struct net *fib_net;
1da177e4
LT
107 int fib_treeref;
108 atomic_t fib_clntref;
95c96174 109 unsigned int fib_flags;
37e826c5
DM
110 unsigned char fib_dead;
111 unsigned char fib_protocol;
112 unsigned char fib_scope;
f4ef85bb 113 unsigned char fib_type;
b83738ae 114 __be32 fib_prefsrc;
5a56a0b3 115 u32 fib_tb_id;
1da177e4 116 u32 fib_priority;
9c150e82 117 u32 *fib_metrics;
1da177e4
LT
118#define fib_mtu fib_metrics[RTAX_MTU-1]
119#define fib_window fib_metrics[RTAX_WINDOW-1]
120#define fib_rtt fib_metrics[RTAX_RTT-1]
121#define fib_advmss fib_metrics[RTAX_ADVMSS-1]
122 int fib_nhs;
123#ifdef CONFIG_IP_ROUTE_MULTIPATH
0e884c78 124 int fib_weight;
1da177e4 125#endif
c9850187 126 unsigned int fib_offload_cnt;
ebc0ffae 127 struct rcu_head rcu;
1da177e4
LT
128 struct fib_nh fib_nh[0];
129#define fib_dev fib_nh[0].nh_dev
130};
131
132
133#ifdef CONFIG_IP_MULTIPLE_TABLES
134struct fib_rule;
135#endif
136
5b470441 137struct fib_table;
1da177e4
LT
138struct fib_result {
139 unsigned char prefixlen;
140 unsigned char nh_sel;
141 unsigned char type;
142 unsigned char scope;
85b91b03 143 u32 tclassid;
1da177e4 144 struct fib_info *fi;
5b470441 145 struct fib_table *table;
56315f9e 146 struct hlist_head *fa_head;
1da177e4
LT
147};
148
246955fe 149struct fib_result_nl {
80e856e1 150 __be32 fl_addr; /* To be looked up*/
5f300893 151 u32 fl_mark;
246955fe
RO
152 unsigned char fl_tos;
153 unsigned char fl_scope;
154 unsigned char tb_id_in;
155
156 unsigned char tb_id; /* Results */
157 unsigned char prefixlen;
158 unsigned char nh_sel;
159 unsigned char type;
160 unsigned char scope;
161 int err;
162};
1da177e4
LT
163
164#ifdef CONFIG_IP_ROUTE_MULTIPATH
1da177e4 165#define FIB_RES_NH(res) ((res).fi->fib_nh[(res).nh_sel])
1da177e4 166#else /* CONFIG_IP_ROUTE_MULTIPATH */
1da177e4 167#define FIB_RES_NH(res) ((res).fi->fib_nh[0])
5b9e12db 168#endif /* CONFIG_IP_ROUTE_MULTIPATH */
1da177e4 169
5b9e12db 170#ifdef CONFIG_IP_MULTIPLE_TABLES
93456b6d 171#define FIB_TABLE_HASHSZ 256
5b9e12db
DL
172#else
173#define FIB_TABLE_HASHSZ 2
174#endif
1da177e4 175
5c3a0fd7 176__be32 fib_info_update_nh_saddr(struct net *net, struct fib_nh *nh);
436c3b66 177
c9850187
JP
178static inline void fib_info_offload_inc(struct fib_info *fi)
179{
180 fi->fib_offload_cnt++;
181 fi->fib_flags |= RTNH_F_OFFLOAD;
182}
183
184static inline void fib_info_offload_dec(struct fib_info *fi)
185{
186 if (--fi->fib_offload_cnt == 0)
187 fi->fib_flags &= ~RTNH_F_OFFLOAD;
188}
189
436c3b66
DM
190#define FIB_RES_SADDR(net, res) \
191 ((FIB_RES_NH(res).nh_saddr_genid == \
192 atomic_read(&(net)->ipv4.dev_addr_genid)) ? \
193 FIB_RES_NH(res).nh_saddr : \
194 fib_info_update_nh_saddr((net), &FIB_RES_NH(res)))
1da177e4
LT
195#define FIB_RES_GW(res) (FIB_RES_NH(res).nh_gw)
196#define FIB_RES_DEV(res) (FIB_RES_NH(res).nh_dev)
197#define FIB_RES_OIF(res) (FIB_RES_NH(res).nh_oif)
198
436c3b66
DM
199#define FIB_RES_PREFSRC(net, res) ((res).fi->fib_prefsrc ? : \
200 FIB_RES_SADDR(net, res))
1fc050a1 201
b90eb754
JP
202struct fib_notifier_info {
203 struct net *net;
204};
205
206struct fib_entry_notifier_info {
207 struct fib_notifier_info info; /* must be first */
208 u32 dst;
209 int dst_len;
210 struct fib_info *fi;
211 u8 tos;
212 u8 type;
213 u32 tb_id;
b90eb754
JP
214};
215
982acb97
IS
216struct fib_nh_notifier_info {
217 struct fib_notifier_info info; /* must be first */
218 struct fib_nh *fib_nh;
219};
220
b90eb754 221enum fib_event_type {
2f3a5272
IS
222 FIB_EVENT_ENTRY_REPLACE,
223 FIB_EVENT_ENTRY_APPEND,
b90eb754
JP
224 FIB_EVENT_ENTRY_ADD,
225 FIB_EVENT_ENTRY_DEL,
226 FIB_EVENT_RULE_ADD,
227 FIB_EVENT_RULE_DEL,
982acb97
IS
228 FIB_EVENT_NH_ADD,
229 FIB_EVENT_NH_DEL,
b90eb754
JP
230};
231
c3852ef7
IS
232int register_fib_notifier(struct notifier_block *nb,
233 void (*cb)(struct notifier_block *nb));
b90eb754 234int unregister_fib_notifier(struct notifier_block *nb);
c0243892
IS
235int call_fib_notifier(struct notifier_block *nb, struct net *net,
236 enum fib_event_type event_type,
237 struct fib_notifier_info *info);
b90eb754
JP
238int call_fib_notifiers(struct net *net, enum fib_event_type event_type,
239 struct fib_notifier_info *info);
240
d05f7a7d 241void fib_notify(struct net *net, struct notifier_block *nb);
c0243892 242#ifdef CONFIG_IP_MULTIPLE_TABLES
d05f7a7d 243void fib_rules_notify(struct net *net, struct notifier_block *nb);
c0243892 244#else
d05f7a7d 245static inline void fib_rules_notify(struct net *net, struct notifier_block *nb)
c0243892
IS
246{
247}
248#endif
249
1da177e4 250struct fib_table {
8e773277
DM
251 struct hlist_node tb_hlist;
252 u32 tb_id;
8e773277 253 int tb_num_default;
a7e53531 254 struct rcu_head rcu;
0ddcf43d
AD
255 unsigned long *tb_data;
256 unsigned long __data[0];
1da177e4
LT
257};
258
5c3a0fd7
JP
259int fib_table_lookup(struct fib_table *tb, const struct flowi4 *flp,
260 struct fib_result *res, int fib_flags);
b90eb754
JP
261int fib_table_insert(struct net *, struct fib_table *, struct fib_config *);
262int fib_table_delete(struct net *, struct fib_table *, struct fib_config *);
5c3a0fd7
JP
263int fib_table_dump(struct fib_table *table, struct sk_buff *skb,
264 struct netlink_callback *cb);
b90eb754 265int fib_table_flush(struct net *net, struct fib_table *table);
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
1da177e4 314#else /* CONFIG_IP_MULTIPLE_TABLES */
5c3a0fd7
JP
315int __net_init fib4_rules_init(struct net *net);
316void __net_exit fib4_rules_exit(struct net *net);
c3e9a353 317
5c3a0fd7
JP
318struct fib_table *fib_new_table(struct net *net, u32 id);
319struct fib_table *fib_get_table(struct net *net, u32 id);
1da177e4 320
0eeb075f
AG
321int __fib_lookup(struct net *net, struct flowi4 *flp,
322 struct fib_result *res, unsigned int flags);
f4530fa5
DM
323
324static inline int fib_lookup(struct net *net, struct flowi4 *flp,
0eeb075f 325 struct fib_result *res, unsigned int flags)
f4530fa5 326{
a7e53531 327 struct fib_table *tb;
0315e382 328 int err = -ENETUNREACH;
a7e53531 329
0eeb075f 330 flags |= FIB_LOOKUP_NOREF;
a7e53531 331 if (net->ipv4.fib_has_custom_rules)
0eeb075f 332 return __fib_lookup(net, flp, res, flags);
a7e53531
AD
333
334 rcu_read_lock();
335
336 res->tclassid = 0;
337
0315e382
NF
338 tb = rcu_dereference_rtnl(net->ipv4.fib_main);
339 if (tb)
340 err = fib_table_lookup(tb, flp, res, flags);
341
342 if (!err)
343 goto out;
344
345 tb = rcu_dereference_rtnl(net->ipv4.fib_default);
346 if (tb)
347 err = fib_table_lookup(tb, flp, res, flags);
a7e53531 348
0315e382
NF
349out:
350 if (err == -EAGAIN)
351 err = -ENETUNREACH;
a7e53531
AD
352
353 rcu_read_unlock();
354
355 return err;
f4530fa5
DM
356}
357
1da177e4
LT
358#endif /* CONFIG_IP_MULTIPLE_TABLES */
359
360/* Exported by fib_frontend.c */
ef7c79ed 361extern const struct nla_policy rtm_ipv4_policy[];
5c3a0fd7
JP
362void ip_fib_init(void);
363__be32 fib_compute_spec_dst(struct sk_buff *skb);
364int fib_validate_source(struct sk_buff *skb, __be32 src, __be32 dst,
365 u8 tos, int oif, struct net_device *dev,
366 struct in_device *idev, u32 *itag);
7a9bc9b8 367#ifdef CONFIG_IP_ROUTE_CLASSID
f4530fa5
DM
368static inline int fib_num_tclassid_users(struct net *net)
369{
370 return net->ipv4.fib_num_tclassid_users;
371}
7a9bc9b8 372#else
f4530fa5
DM
373static inline int fib_num_tclassid_users(struct net *net)
374{
375 return 0;
376}
7a9bc9b8 377#endif
0ddcf43d 378int fib_unmerge(struct net *net);
14c85021 379
1da177e4 380/* Exported by fib_semantics.c */
5c3a0fd7 381int ip_fib_check_default(__be32 gw, struct net_device *dev);
4f823def 382int fib_sync_down_dev(struct net_device *dev, unsigned long event, bool force);
5a56a0b3 383int fib_sync_down_addr(struct net_device *dev, __be32 local);
8a3d0316 384int fib_sync_up(struct net_device *dev, unsigned int nh_flags);
0e884c78
PN
385
386extern u32 fib_multipath_secret __read_mostly;
387
388static inline int fib_multipath_hash(__be32 saddr, __be32 daddr)
389{
0797cbd8
LR
390 return jhash_2words((__force u32)saddr, (__force u32)daddr,
391 fib_multipath_secret) >> 1;
0e884c78
PN
392}
393
394void fib_select_multipath(struct fib_result *res, int hash);
3ce58d84
DA
395void fib_select_path(struct net *net, struct fib_result *res,
396 struct flowi4 *fl4, int mp_hash);
1da177e4 397
5348ba85 398/* Exported by fib_trie.c */
5c3a0fd7 399void fib_trie_init(void);
0ddcf43d 400struct fib_table *fib_trie_table(u32 id, struct fib_table *alias);
1da177e4 401
b6bf3ca0 402static inline void fib_combine_itag(u32 *itag, const struct fib_result *res)
1da177e4 403{
c7066f70 404#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4
LT
405#ifdef CONFIG_IP_MULTIPLE_TABLES
406 u32 rtag;
407#endif
408 *itag = FIB_RES_NH(*res).nh_tclassid<<16;
409#ifdef CONFIG_IP_MULTIPLE_TABLES
85b91b03 410 rtag = res->tclassid;
1da177e4
LT
411 if (*itag == 0)
412 *itag = (rtag<<16);
413 *itag |= (rtag>>16);
414#endif
415#endif
416}
417
5c3a0fd7 418void free_fib_info(struct fib_info *fi);
1da177e4 419
1c677b3d
IS
420static inline void fib_info_hold(struct fib_info *fi)
421{
422 atomic_inc(&fi->fib_clntref);
423}
424
1da177e4
LT
425static inline void fib_info_put(struct fib_info *fi)
426{
427 if (atomic_dec_and_test(&fi->fib_clntref))
428 free_fib_info(fi);
429}
430
20380731 431#ifdef CONFIG_PROC_FS
5c3a0fd7
JP
432int __net_init fib_proc_init(struct net *net);
433void __net_exit fib_proc_exit(struct net *net);
cc8274f5
LZ
434#else
435static inline int fib_proc_init(struct net *net)
436{
437 return 0;
438}
439static inline void fib_proc_exit(struct net *net)
440{
441}
20380731
ACM
442#endif
443
1da177e4 444#endif /* _NET_FIB_H */