]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/ip_fib.h
workqueue: use put_device() instead of kfree()
[mirror_ubuntu-bionic-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;
aee06da6 62 __be32 fnhe_gw;
4895c771 63 unsigned long fnhe_expires;
2ffae99d
TT
64 struct rtable __rcu *fnhe_rth_input;
65 struct rtable __rcu *fnhe_rth_output;
4895c771 66 unsigned long fnhe_stamp;
deed49df 67 struct rcu_head rcu;
4895c771
DM
68};
69
70struct fnhe_hash_bucket {
71 struct fib_nh_exception __rcu *chain;
72};
73
d546c621
ED
74#define FNHE_HASH_SHIFT 11
75#define FNHE_HASH_SIZE (1 << FNHE_HASH_SHIFT)
4895c771
DM
76#define FNHE_RECLAIM_DEPTH 5
77
1da177e4
LT
78struct fib_nh {
79 struct net_device *nh_dev;
80 struct hlist_node nh_hash;
81 struct fib_info *nh_parent;
95c96174 82 unsigned int nh_flags;
1da177e4
LT
83 unsigned char nh_scope;
84#ifdef CONFIG_IP_ROUTE_MULTIPATH
85 int nh_weight;
0e884c78 86 atomic_t nh_upper_bound;
1da177e4 87#endif
c7066f70 88#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4
LT
89 __u32 nh_tclassid;
90#endif
91 int nh_oif;
ed49e3ca 92 __be32 nh_gw;
1fc050a1 93 __be32 nh_saddr;
436c3b66 94 int nh_saddr_genid;
d26b3a7c 95 struct rtable __rcu * __percpu *nh_pcpu_rth_output;
54764bb6 96 struct rtable __rcu *nh_rth_input;
caa41527 97 struct fnhe_hash_bucket __rcu *nh_exceptions;
571e7226 98 struct lwtunnel_state *nh_lwtstate;
1da177e4
LT
99};
100
101/*
102 * This structure contains data shared by many of routes.
103 */
104
105struct fib_info {
106 struct hlist_node fib_hash;
107 struct hlist_node fib_lhash;
7462bd74 108 struct net *fib_net;
1da177e4 109 int fib_treeref;
0029c0de 110 refcount_t fib_clntref;
95c96174 111 unsigned int fib_flags;
37e826c5
DM
112 unsigned char fib_dead;
113 unsigned char fib_protocol;
114 unsigned char fib_scope;
f4ef85bb 115 unsigned char fib_type;
b83738ae 116 __be32 fib_prefsrc;
5a56a0b3 117 u32 fib_tb_id;
1da177e4 118 u32 fib_priority;
3fb07daf
ED
119 struct dst_metrics *fib_metrics;
120#define fib_mtu fib_metrics->metrics[RTAX_MTU-1]
121#define fib_window fib_metrics->metrics[RTAX_WINDOW-1]
122#define fib_rtt fib_metrics->metrics[RTAX_RTT-1]
123#define fib_advmss fib_metrics->metrics[RTAX_ADVMSS-1]
1da177e4 124 int fib_nhs;
ebc0ffae 125 struct rcu_head rcu;
1da177e4
LT
126 struct fib_nh fib_nh[0];
127#define fib_dev fib_nh[0].nh_dev
128};
129
130
131#ifdef CONFIG_IP_MULTIPLE_TABLES
132struct fib_rule;
133#endif
134
5b470441 135struct fib_table;
1da177e4 136struct fib_result {
6ffd9034 137 __be32 prefix;
1da177e4
LT
138 unsigned char prefixlen;
139 unsigned char nh_sel;
140 unsigned char type;
141 unsigned char scope;
85b91b03 142 u32 tclassid;
1da177e4 143 struct fib_info *fi;
5b470441 144 struct fib_table *table;
56315f9e 145 struct hlist_head *fa_head;
1da177e4
LT
146};
147
246955fe 148struct fib_result_nl {
80e856e1 149 __be32 fl_addr; /* To be looked up*/
5f300893 150 u32 fl_mark;
246955fe
RO
151 unsigned char fl_tos;
152 unsigned char fl_scope;
153 unsigned char tb_id_in;
154
155 unsigned char tb_id; /* Results */
156 unsigned char prefixlen;
157 unsigned char nh_sel;
158 unsigned char type;
159 unsigned char scope;
160 int err;
161};
1da177e4
LT
162
163#ifdef CONFIG_IP_ROUTE_MULTIPATH
1da177e4 164#define FIB_RES_NH(res) ((res).fi->fib_nh[(res).nh_sel])
1da177e4 165#else /* CONFIG_IP_ROUTE_MULTIPATH */
1da177e4 166#define FIB_RES_NH(res) ((res).fi->fib_nh[0])
5b9e12db 167#endif /* CONFIG_IP_ROUTE_MULTIPATH */
1da177e4 168
5b9e12db 169#ifdef CONFIG_IP_MULTIPLE_TABLES
93456b6d 170#define FIB_TABLE_HASHSZ 256
5b9e12db
DL
171#else
172#define FIB_TABLE_HASHSZ 2
173#endif
1da177e4 174
5c3a0fd7 175__be32 fib_info_update_nh_saddr(struct net *net, struct fib_nh *nh);
436c3b66
DM
176
177#define FIB_RES_SADDR(net, res) \
178 ((FIB_RES_NH(res).nh_saddr_genid == \
179 atomic_read(&(net)->ipv4.dev_addr_genid)) ? \
180 FIB_RES_NH(res).nh_saddr : \
181 fib_info_update_nh_saddr((net), &FIB_RES_NH(res)))
1da177e4
LT
182#define FIB_RES_GW(res) (FIB_RES_NH(res).nh_gw)
183#define FIB_RES_DEV(res) (FIB_RES_NH(res).nh_dev)
184#define FIB_RES_OIF(res) (FIB_RES_NH(res).nh_oif)
185
436c3b66
DM
186#define FIB_RES_PREFSRC(net, res) ((res).fi->fib_prefsrc ? : \
187 FIB_RES_SADDR(net, res))
1fc050a1 188
b90eb754
JP
189struct fib_entry_notifier_info {
190 struct fib_notifier_info info; /* must be first */
191 u32 dst;
192 int dst_len;
193 struct fib_info *fi;
194 u8 tos;
195 u8 type;
196 u32 tb_id;
b90eb754
JP
197};
198
982acb97
IS
199struct fib_nh_notifier_info {
200 struct fib_notifier_info info; /* must be first */
201 struct fib_nh *fib_nh;
202};
203
04b1d4e5
IS
204int call_fib4_notifier(struct notifier_block *nb, struct net *net,
205 enum fib_event_type event_type,
b90eb754 206 struct fib_notifier_info *info);
04b1d4e5
IS
207int call_fib4_notifiers(struct net *net, enum fib_event_type event_type,
208 struct fib_notifier_info *info);
209
210int __net_init fib4_notifier_init(struct net *net);
211void __net_exit fib4_notifier_exit(struct net *net);
b90eb754 212
d05f7a7d 213void fib_notify(struct net *net, struct notifier_block *nb);
c0243892 214
1da177e4 215struct fib_table {
8e773277
DM
216 struct hlist_node tb_hlist;
217 u32 tb_id;
8e773277 218 int tb_num_default;
a7e53531 219 struct rcu_head rcu;
0ddcf43d
AD
220 unsigned long *tb_data;
221 unsigned long __data[0];
1da177e4
LT
222};
223
5c3a0fd7
JP
224int fib_table_lookup(struct fib_table *tb, const struct flowi4 *flp,
225 struct fib_result *res, int fib_flags);
6d8422a1
DA
226int fib_table_insert(struct net *, struct fib_table *, struct fib_config *,
227 struct netlink_ext_ack *extack);
78055998
DA
228int fib_table_delete(struct net *, struct fib_table *, struct fib_config *,
229 struct netlink_ext_ack *extack);
5c3a0fd7
JP
230int fib_table_dump(struct fib_table *table, struct sk_buff *skb,
231 struct netlink_callback *cb);
b90eb754 232int fib_table_flush(struct net *net, struct fib_table *table);
0ddcf43d 233struct fib_table *fib_trie_unmerge(struct fib_table *main_tb);
3b709334 234void fib_table_flush_external(struct fib_table *table);
5c3a0fd7 235void fib_free_table(struct fib_table *tb);
4aa2c466 236
1da177e4
LT
237#ifndef CONFIG_IP_MULTIPLE_TABLES
238
a5a519b2
AD
239#define TABLE_LOCAL_INDEX (RT_TABLE_LOCAL & (FIB_TABLE_HASHSZ - 1))
240#define TABLE_MAIN_INDEX (RT_TABLE_MAIN & (FIB_TABLE_HASHSZ - 1))
1da177e4 241
8ad4942c 242static inline struct fib_table *fib_get_table(struct net *net, u32 id)
1da177e4 243{
a7e53531 244 struct hlist_node *tb_hlist;
93456b6d
DL
245 struct hlist_head *ptr;
246
247 ptr = id == RT_TABLE_LOCAL ?
e4aef8ae
DL
248 &net->ipv4.fib_table_hash[TABLE_LOCAL_INDEX] :
249 &net->ipv4.fib_table_hash[TABLE_MAIN_INDEX];
a7e53531
AD
250
251 tb_hlist = rcu_dereference_rtnl(hlist_first_rcu(ptr));
252
253 return hlist_entry(tb_hlist, struct fib_table, tb_hlist);
1da177e4
LT
254}
255
8ad4942c 256static inline struct fib_table *fib_new_table(struct net *net, u32 id)
1da177e4 257{
8ad4942c 258 return fib_get_table(net, id);
1da177e4
LT
259}
260
22bd5b9b 261static inline int fib_lookup(struct net *net, const struct flowi4 *flp,
0eeb075f 262 struct fib_result *res, unsigned int flags)
1da177e4 263{
a7e53531 264 struct fib_table *tb;
0ddcf43d 265 int err = -ENETUNREACH;
345e9b54
AD
266
267 rcu_read_lock();
268
0ddcf43d 269 tb = fib_get_table(net, RT_TABLE_MAIN);
0315e382
NF
270 if (tb)
271 err = fib_table_lookup(tb, flp, res, flags | FIB_LOOKUP_NOREF);
272
273 if (err == -EAGAIN)
274 err = -ENETUNREACH;
93456b6d 275
345e9b54 276 rcu_read_unlock();
93456b6d 277
345e9b54 278 return err;
1da177e4
LT
279}
280
3c71006d
IS
281static inline bool fib4_rule_default(const struct fib_rule *rule)
282{
283 return true;
284}
285
1b2a4440
IS
286static inline int fib4_rules_dump(struct net *net, struct notifier_block *nb)
287{
288 return 0;
289}
290
291static inline unsigned int fib4_rules_seq_read(struct net *net)
292{
293 return 0;
294}
295
1da177e4 296#else /* CONFIG_IP_MULTIPLE_TABLES */
5c3a0fd7
JP
297int __net_init fib4_rules_init(struct net *net);
298void __net_exit fib4_rules_exit(struct net *net);
c3e9a353 299
5c3a0fd7
JP
300struct fib_table *fib_new_table(struct net *net, u32 id);
301struct fib_table *fib_get_table(struct net *net, u32 id);
1da177e4 302
0eeb075f
AG
303int __fib_lookup(struct net *net, struct flowi4 *flp,
304 struct fib_result *res, unsigned int flags);
f4530fa5
DM
305
306static inline int fib_lookup(struct net *net, struct flowi4 *flp,
0eeb075f 307 struct fib_result *res, unsigned int flags)
f4530fa5 308{
a7e53531 309 struct fib_table *tb;
0315e382 310 int err = -ENETUNREACH;
a7e53531 311
0eeb075f 312 flags |= FIB_LOOKUP_NOREF;
a7e53531 313 if (net->ipv4.fib_has_custom_rules)
0eeb075f 314 return __fib_lookup(net, flp, res, flags);
a7e53531
AD
315
316 rcu_read_lock();
317
318 res->tclassid = 0;
319
0315e382
NF
320 tb = rcu_dereference_rtnl(net->ipv4.fib_main);
321 if (tb)
322 err = fib_table_lookup(tb, flp, res, flags);
323
324 if (!err)
325 goto out;
326
327 tb = rcu_dereference_rtnl(net->ipv4.fib_default);
328 if (tb)
329 err = fib_table_lookup(tb, flp, res, flags);
a7e53531 330
0315e382
NF
331out:
332 if (err == -EAGAIN)
333 err = -ENETUNREACH;
a7e53531
AD
334
335 rcu_read_unlock();
336
337 return err;
f4530fa5
DM
338}
339
3c71006d 340bool fib4_rule_default(const struct fib_rule *rule);
1b2a4440
IS
341int fib4_rules_dump(struct net *net, struct notifier_block *nb);
342unsigned int fib4_rules_seq_read(struct net *net);
3c71006d 343
1da177e4
LT
344#endif /* CONFIG_IP_MULTIPLE_TABLES */
345
346/* Exported by fib_frontend.c */
ef7c79ed 347extern const struct nla_policy rtm_ipv4_policy[];
5c3a0fd7
JP
348void ip_fib_init(void);
349__be32 fib_compute_spec_dst(struct sk_buff *skb);
350int fib_validate_source(struct sk_buff *skb, __be32 src, __be32 dst,
351 u8 tos, int oif, struct net_device *dev,
352 struct in_device *idev, u32 *itag);
7a9bc9b8 353#ifdef CONFIG_IP_ROUTE_CLASSID
f4530fa5
DM
354static inline int fib_num_tclassid_users(struct net *net)
355{
356 return net->ipv4.fib_num_tclassid_users;
357}
7a9bc9b8 358#else
f4530fa5
DM
359static inline int fib_num_tclassid_users(struct net *net)
360{
361 return 0;
362}
7a9bc9b8 363#endif
0ddcf43d 364int fib_unmerge(struct net *net);
14c85021 365
1da177e4 366/* Exported by fib_semantics.c */
5c3a0fd7 367int ip_fib_check_default(__be32 gw, struct net_device *dev);
4f823def 368int fib_sync_down_dev(struct net_device *dev, unsigned long event, bool force);
5a56a0b3 369int fib_sync_down_addr(struct net_device *dev, __be32 local);
8a3d0316 370int fib_sync_up(struct net_device *dev, unsigned int nh_flags);
0e884c78 371
bf4e0a3d
NA
372#ifdef CONFIG_IP_ROUTE_MULTIPATH
373int fib_multipath_hash(const struct fib_info *fi, const struct flowi4 *fl4,
374 const struct sk_buff *skb);
375#endif
0e884c78 376void fib_select_multipath(struct fib_result *res, int hash);
3ce58d84 377void fib_select_path(struct net *net, struct fib_result *res,
bf4e0a3d 378 struct flowi4 *fl4, const struct sk_buff *skb);
1da177e4 379
5348ba85 380/* Exported by fib_trie.c */
5c3a0fd7 381void fib_trie_init(void);
0ddcf43d 382struct fib_table *fib_trie_table(u32 id, struct fib_table *alias);
1da177e4 383
b6bf3ca0 384static inline void fib_combine_itag(u32 *itag, const struct fib_result *res)
1da177e4 385{
c7066f70 386#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4
LT
387#ifdef CONFIG_IP_MULTIPLE_TABLES
388 u32 rtag;
389#endif
390 *itag = FIB_RES_NH(*res).nh_tclassid<<16;
391#ifdef CONFIG_IP_MULTIPLE_TABLES
85b91b03 392 rtag = res->tclassid;
1da177e4
LT
393 if (*itag == 0)
394 *itag = (rtag<<16);
395 *itag |= (rtag>>16);
396#endif
397#endif
398}
399
5c3a0fd7 400void free_fib_info(struct fib_info *fi);
1da177e4 401
1c677b3d
IS
402static inline void fib_info_hold(struct fib_info *fi)
403{
0029c0de 404 refcount_inc(&fi->fib_clntref);
1c677b3d
IS
405}
406
1da177e4
LT
407static inline void fib_info_put(struct fib_info *fi)
408{
0029c0de 409 if (refcount_dec_and_test(&fi->fib_clntref))
1da177e4
LT
410 free_fib_info(fi);
411}
412
20380731 413#ifdef CONFIG_PROC_FS
5c3a0fd7
JP
414int __net_init fib_proc_init(struct net *net);
415void __net_exit fib_proc_exit(struct net *net);
cc8274f5
LZ
416#else
417static inline int fib_proc_init(struct net *net)
418{
419 return 0;
420}
421static inline void fib_proc_exit(struct net *net)
422{
423}
20380731
ACM
424#endif
425
1da177e4 426#endif /* _NET_FIB_H */