[mirror_ubuntu-bionic-kernel.git] / include / net / ip_fib.h

/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET  is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for the Forwarding Information Base.
 *
 * Authors:	A.N.Kuznetsov, <kuznet@ms2.inr.ac.ru>
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 */

#ifndef _NET_IP_FIB_H
#define _NET_IP_FIB_H

#include <net/flow.h>
#include <linux/seq_file.h>
#include <net/fib_rules.h>

struct fib_config {
	u8			fc_dst_len;
	u8			fc_tos;
	u8			fc_protocol;
	u8			fc_scope;
	u8			fc_type;
	/* 3 bytes unused */
	u32			fc_table;
	__be32			fc_dst;
	__be32			fc_gw;
	int			fc_oif;
	u32			fc_flags;
	u32			fc_priority;
	__be32			fc_prefsrc;
	struct nlattr		*fc_mx;
	struct rtnexthop	*fc_mp;
	int			fc_mx_len;
	int			fc_mp_len;
	u32			fc_flow;
	u32			fc_nlflags;
	struct nl_info		fc_nlinfo;
 };

struct fib_info;

struct fib_nh {
	struct net_device	*nh_dev;
	struct hlist_node	nh_hash;
	struct fib_info		*nh_parent;
	unsigned		nh_flags;
	unsigned char		nh_scope;
#ifdef CONFIG_IP_ROUTE_MULTIPATH
	int			nh_weight;
	int			nh_power;
#endif
#ifdef CONFIG_IP_ROUTE_CLASSID
	__u32			nh_tclassid;
#endif
	int			nh_oif;
	__be32			nh_gw;
};

/*
 * This structure contains data shared by many of routes.
 */

struct fib_info {
	struct hlist_node	fib_hash;
	struct hlist_node	fib_lhash;
	struct net		*fib_net;
	int			fib_treeref;
	atomic_t		fib_clntref;
	int			fib_dead;
	unsigned		fib_flags;
	int			fib_protocol;
	__be32			fib_prefsrc;
	u32			fib_priority;
	u32			*fib_metrics;
#define fib_mtu fib_metrics[RTAX_MTU-1]
#define fib_window fib_metrics[RTAX_WINDOW-1]
#define fib_rtt fib_metrics[RTAX_RTT-1]
#define fib_advmss fib_metrics[RTAX_ADVMSS-1]
	int			fib_nhs;
#ifdef CONFIG_IP_ROUTE_MULTIPATH
	int			fib_power;
#endif
	struct rcu_head		rcu;
	struct fib_nh		fib_nh[0];
#define fib_dev		fib_nh[0].nh_dev
};


#ifdef CONFIG_IP_MULTIPLE_TABLES
struct fib_rule;
#endif

struct fib_table;
struct fib_result {
	unsigned char	prefixlen;
	unsigned char	nh_sel;
	unsigned char	type;
	unsigned char	scope;
	struct fib_info *fi;
	struct fib_table *table;
	struct list_head *fa_head;
#ifdef CONFIG_IP_MULTIPLE_TABLES
	struct fib_rule	*r;
#endif
};

struct fib_result_nl {
	__be32		fl_addr;   /* To be looked up*/
	u32		fl_mark;
	unsigned char	fl_tos;
	unsigned char   fl_scope;
	unsigned char   tb_id_in;

	unsigned char   tb_id;      /* Results */
	unsigned char	prefixlen;
	unsigned char	nh_sel;
	unsigned char	type;
	unsigned char	scope;
	int             err;      
};

#ifdef CONFIG_IP_ROUTE_MULTIPATH

#define FIB_RES_NH(res)		((res).fi->fib_nh[(res).nh_sel])

#define FIB_TABLE_HASHSZ 2

#else /* CONFIG_IP_ROUTE_MULTIPATH */

#define FIB_RES_NH(res)		((res).fi->fib_nh[0])

#define FIB_TABLE_HASHSZ 256

#endif /* CONFIG_IP_ROUTE_MULTIPATH */

#define FIB_RES_PREFSRC(res)		((res).fi->fib_prefsrc ? : __fib_res_prefsrc(&res))
#define FIB_RES_GW(res)			(FIB_RES_NH(res).nh_gw)
#define FIB_RES_DEV(res)		(FIB_RES_NH(res).nh_dev)
#define FIB_RES_OIF(res)		(FIB_RES_NH(res).nh_oif)

struct fib_table {
	struct hlist_node tb_hlist;
	u32		tb_id;
	int		tb_default;
	unsigned char	tb_data[0];
};

extern int fib_table_lookup(struct fib_table *tb, const struct flowi *flp,
			    struct fib_result *res, int fib_flags);
extern int fib_table_insert(struct fib_table *, struct fib_config *);
extern int fib_table_delete(struct fib_table *, struct fib_config *);
extern int fib_table_dump(struct fib_table *table, struct sk_buff *skb,
			  struct netlink_callback *cb);
extern int fib_table_flush(struct fib_table *table);
extern void fib_table_select_default(struct fib_table *table,
				     const struct flowi *flp,
				     struct fib_result *res);
extern void fib_free_table(struct fib_table *tb);


#ifndef CONFIG_IP_MULTIPLE_TABLES

#define TABLE_LOCAL_INDEX	0
#define TABLE_MAIN_INDEX	1

static inline struct fib_table *fib_get_table(struct net *net, u32 id)
{
	struct hlist_head *ptr;

	ptr = id == RT_TABLE_LOCAL ?
		&net->ipv4.fib_table_hash[TABLE_LOCAL_INDEX] :
		&net->ipv4.fib_table_hash[TABLE_MAIN_INDEX];
	return hlist_entry(ptr->first, struct fib_table, tb_hlist);
}

static inline struct fib_table *fib_new_table(struct net *net, u32 id)
{
	return fib_get_table(net, id);
}

static inline int fib_lookup(struct net *net, const struct flowi *flp,
			     struct fib_result *res)
{
	struct fib_table *table;

	table = fib_get_table(net, RT_TABLE_LOCAL);
	if (!fib_table_lookup(table, flp, res, FIB_LOOKUP_NOREF))
		return 0;

	table = fib_get_table(net, RT_TABLE_MAIN);
	if (!fib_table_lookup(table, flp, res, FIB_LOOKUP_NOREF))
		return 0;
	return -ENETUNREACH;
}

#else /* CONFIG_IP_MULTIPLE_TABLES */
extern int __net_init fib4_rules_init(struct net *net);
extern void __net_exit fib4_rules_exit(struct net *net);

#ifdef CONFIG_IP_ROUTE_CLASSID
extern u32 fib_rules_tclass(struct fib_result *res);
#endif

extern int fib_lookup(struct net *n, struct flowi *flp, struct fib_result *res);

extern struct fib_table *fib_new_table(struct net *net, u32 id);
extern struct fib_table *fib_get_table(struct net *net, u32 id);

#endif /* CONFIG_IP_MULTIPLE_TABLES */

/* Exported by fib_frontend.c */
extern const struct nla_policy rtm_ipv4_policy[];
extern void		ip_fib_init(void);
extern int fib_validate_source(__be32 src, __be32 dst, u8 tos, int oif,
			       struct net_device *dev, __be32 *spec_dst,
			       u32 *itag, u32 mark);
extern void fib_select_default(struct net *net, const struct flowi *flp,
			       struct fib_result *res);

/* Exported by fib_semantics.c */
extern int ip_fib_check_default(__be32 gw, struct net_device *dev);
extern int fib_sync_down_dev(struct net_device *dev, int force);
extern int fib_sync_down_addr(struct net *net, __be32 local);
extern int fib_sync_up(struct net_device *dev);
extern __be32  __fib_res_prefsrc(struct fib_result *res);
extern void fib_select_multipath(const struct flowi *flp, struct fib_result *res);

/* Exported by fib_{hash|trie}.c */
extern void fib_hash_init(void);
extern struct fib_table *fib_hash_table(u32 id);

static inline void fib_combine_itag(u32 *itag, struct fib_result *res)
{
#ifdef CONFIG_IP_ROUTE_CLASSID
#ifdef CONFIG_IP_MULTIPLE_TABLES
	u32 rtag;
#endif
	*itag = FIB_RES_NH(*res).nh_tclassid<<16;
#ifdef CONFIG_IP_MULTIPLE_TABLES
	rtag = fib_rules_tclass(res);
	if (*itag == 0)
		*itag = (rtag<<16);
	*itag |= (rtag>>16);
#endif
#endif
}

extern void free_fib_info(struct fib_info *fi);

static inline void fib_info_put(struct fib_info *fi)
{
	if (atomic_dec_and_test(&fi->fib_clntref))
		free_fib_info(fi);
}

#ifdef CONFIG_PROC_FS
extern int __net_init  fib_proc_init(struct net *net);
extern void __net_exit fib_proc_exit(struct net *net);
#else
static inline int fib_proc_init(struct net *net)
{
	return 0;
}
static inline void fib_proc_exit(struct net *net)
{
}
#endif

#endif  /* _NET_FIB_H */
Commit	Line	Data
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>
1da177e4 LT	20	#include <linux/seq_file.h>
e1ef4bf2	21	#include <net/fib_rules.h>
1da177e4	22
4e902c57	23	struct fib_config {
4e902c57	24	u8 fc_dst_len;
4e902c57 TG	25	u8 fc_tos;
	26	u8 fc_protocol;
	27	u8 fc_scope;
	28	u8 fc_type;
b52f070c	29	/* 3 bytes unused */
4e902c57	30	u32 fc_table;
6d85c10a	31	__be32 fc_dst;
6d85c10a	32	__be32 fc_gw;
4e902c57 TG	33	int fc_oif;
	34	u32 fc_flags;
	35	u32 fc_priority;
6d85c10a	36	__be32 fc_prefsrc;
4e902c57 TG	37	struct nlattr *fc_mx;
	38	struct rtnexthop *fc_mp;
	39	int fc_mx_len;
	40	int fc_mp_len;
	41	u32 fc_flow;
4e902c57 TG	42	u32 fc_nlflags;
	43	struct nl_info fc_nlinfo;
	44	};
1da177e4 LT	45
	46	struct fib_info;
	47
	48	struct fib_nh {
	49	struct net_device *nh_dev;
	50	struct hlist_node nh_hash;
	51	struct fib_info *nh_parent;
	52	unsigned nh_flags;
	53	unsigned char nh_scope;
	54	#ifdef CONFIG_IP_ROUTE_MULTIPATH
	55	int nh_weight;
	56	int nh_power;
	57	#endif
c7066f70	58	#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4 LT	59	__u32 nh_tclassid;
	60	#endif
	61	int nh_oif;
ed49e3ca	62	__be32 nh_gw;
1da177e4 LT	63	};
	64
	65	/*
	66	* This structure contains data shared by many of routes.
	67	*/
	68
	69	struct fib_info {
	70	struct hlist_node fib_hash;
	71	struct hlist_node fib_lhash;
7462bd74	72	struct net *fib_net;
1da177e4 LT	73	int fib_treeref;
	74	atomic_t fib_clntref;
	75	int fib_dead;
	76	unsigned fib_flags;
	77	int fib_protocol;
b83738ae	78	__be32 fib_prefsrc;
1da177e4	79	u32 fib_priority;
9c150e82	80	u32 *fib_metrics;
1da177e4 LT	81	#define fib_mtu fib_metrics[RTAX_MTU-1]
	82	#define fib_window fib_metrics[RTAX_WINDOW-1]
	83	#define fib_rtt fib_metrics[RTAX_RTT-1]
	84	#define fib_advmss fib_metrics[RTAX_ADVMSS-1]
	85	int fib_nhs;
	86	#ifdef CONFIG_IP_ROUTE_MULTIPATH
	87	int fib_power;
1da177e4	88	#endif
ebc0ffae	89	struct rcu_head rcu;
1da177e4 LT	90	struct fib_nh fib_nh[0];
	91	#define fib_dev fib_nh[0].nh_dev
	92	};
	93
	94
	95	#ifdef CONFIG_IP_MULTIPLE_TABLES
	96	struct fib_rule;
	97	#endif
	98
5b470441	99	struct fib_table;
1da177e4 LT	100	struct fib_result {
	101	unsigned char prefixlen;
	102	unsigned char nh_sel;
	103	unsigned char type;
	104	unsigned char scope;
1da177e4	105	struct fib_info *fi;
5b470441 DM	106	struct fib_table *table;
5b470441 DM	107	struct list_head *fa_head;
1da177e4 LT	108	#ifdef CONFIG_IP_MULTIPLE_TABLES
	109	struct fib_rule *r;
	110	#endif
	111	};
	112
246955fe	113	struct fib_result_nl {
80e856e1	114	__be32 fl_addr; /* To be looked up*/
5f300893	115	u32 fl_mark;
246955fe RO	116	unsigned char fl_tos;
	117	unsigned char fl_scope;
	118	unsigned char tb_id_in;
	119
	120	unsigned char tb_id; /* Results */
	121	unsigned char prefixlen;
	122	unsigned char nh_sel;
	123	unsigned char type;
	124	unsigned char scope;
	125	int err;
	126	};
1da177e4 LT	127
	128	#ifdef CONFIG_IP_ROUTE_MULTIPATH
	129
	130	#define FIB_RES_NH(res) ((res).fi->fib_nh[(res).nh_sel])
1da177e4	131
93456b6d DL	132	#define FIB_TABLE_HASHSZ 2
93456b6d DL	133
1da177e4 LT	134	#else /* CONFIG_IP_ROUTE_MULTIPATH */
	135
	136	#define FIB_RES_NH(res) ((res).fi->fib_nh[0])
1da177e4	137
93456b6d DL	138	#define FIB_TABLE_HASHSZ 256
93456b6d DL	139
1da177e4 LT	140	#endif /* CONFIG_IP_ROUTE_MULTIPATH */
	141
	142	#define FIB_RES_PREFSRC(res) ((res).fi->fib_prefsrc ? : __fib_res_prefsrc(&res))
	143	#define FIB_RES_GW(res) (FIB_RES_NH(res).nh_gw)
	144	#define FIB_RES_DEV(res) (FIB_RES_NH(res).nh_dev)
	145	#define FIB_RES_OIF(res) (FIB_RES_NH(res).nh_oif)
	146
1da177e4	147	struct fib_table {
1af5a8c4	148	struct hlist_node tb_hlist;
2dfe55b4	149	u32 tb_id;
971b893e	150	int tb_default;
1da177e4 LT	151	unsigned char tb_data[0];
	152	};
	153
16c6cf8b	154	extern int fib_table_lookup(struct fib_table tb, const struct flowi flp,
ebc0ffae	155	struct fib_result *res, int fib_flags);
16c6cf8b SH	156	extern int fib_table_insert(struct fib_table , struct fib_config );
	157	extern int fib_table_delete(struct fib_table , struct fib_config );
	158	extern int fib_table_dump(struct fib_table table, struct sk_buff skb,
	159	struct netlink_callback *cb);
	160	extern int fib_table_flush(struct fib_table *table);
	161	extern void fib_table_select_default(struct fib_table *table,
	162	const struct flowi *flp,
	163	struct fib_result *res);
4aa2c466 PE	164	extern void fib_free_table(struct fib_table *tb);
4aa2c466 PE	165
16c6cf8b SH	166
16c6cf8b SH	167
1da177e4 LT	168	#ifndef CONFIG_IP_MULTIPLE_TABLES
1da177e4 LT	169
93456b6d DL	170	#define TABLE_LOCAL_INDEX 0
93456b6d DL	171	#define TABLE_MAIN_INDEX 1
1da177e4	172
8ad4942c	173	static inline struct fib_table fib_get_table(struct net net, u32 id)
1da177e4	174	{
93456b6d DL	175	struct hlist_head *ptr;
	176
	177	ptr = id == RT_TABLE_LOCAL ?
e4aef8ae DL	178	&net->ipv4.fib_table_hash[TABLE_LOCAL_INDEX] :
e4aef8ae DL	179	&net->ipv4.fib_table_hash[TABLE_MAIN_INDEX];
93456b6d	180	return hlist_entry(ptr->first, struct fib_table, tb_hlist);
1da177e4 LT	181	}
1da177e4 LT	182
8ad4942c	183	static inline struct fib_table fib_new_table(struct net net, u32 id)
1da177e4	184	{
8ad4942c	185	return fib_get_table(net, id);
1da177e4 LT	186	}
1da177e4 LT	187
da0e28cb DL	188	static inline int fib_lookup(struct net net, const struct flowi flp,
da0e28cb DL	189	struct fib_result *res)
1da177e4	190	{
93456b6d DL	191	struct fib_table *table;
93456b6d DL	192
da0e28cb	193	table = fib_get_table(net, RT_TABLE_LOCAL);
ebc0ffae	194	if (!fib_table_lookup(table, flp, res, FIB_LOOKUP_NOREF))
93456b6d DL	195	return 0;
93456b6d DL	196
da0e28cb	197	table = fib_get_table(net, RT_TABLE_MAIN);
ebc0ffae	198	if (!fib_table_lookup(table, flp, res, FIB_LOOKUP_NOREF))
93456b6d DL	199	return 0;
93456b6d DL	200	return -ENETUNREACH;
1da177e4 LT	201	}
1da177e4 LT	202
1da177e4	203	#else /* CONFIG_IP_MULTIPLE_TABLES */
7b1a74fd DL	204	extern int __net_init fib4_rules_init(struct net *net);
7b1a74fd DL	205	extern void __net_exit fib4_rules_exit(struct net *net);
c3e9a353	206
c7066f70	207	#ifdef CONFIG_IP_ROUTE_CLASSID
c3e9a353 PE	208	extern u32 fib_rules_tclass(struct fib_result *res);
	209	#endif
	210
da0e28cb	211	extern int fib_lookup(struct net n, struct flowi flp, struct fib_result *res);
1da177e4	212
8ad4942c DL	213	extern struct fib_table fib_new_table(struct net net, u32 id);
8ad4942c DL	214	extern struct fib_table fib_get_table(struct net net, u32 id);
1da177e4 LT	215
	216	#endif /* CONFIG_IP_MULTIPLE_TABLES */
	217
	218	/* Exported by fib_frontend.c */
ef7c79ed	219	extern const struct nla_policy rtm_ipv4_policy[];
1da177e4	220	extern void ip_fib_init(void);
d9c9df8c	221	extern int fib_validate_source(__be32 src, __be32 dst, u8 tos, int oif,
b0c110ca	222	struct net_device dev, __be32 spec_dst,
b0c110ca	223	u32 *itag, u32 mark);
010278ec DL	224	extern void fib_select_default(struct net net, const struct flowi flp,
010278ec DL	225	struct fib_result *res);
14c85021	226
1da177e4	227	/* Exported by fib_semantics.c */
d878e72e	228	extern int ip_fib_check_default(__be32 gw, struct net_device *dev);
85326fa5	229	extern int fib_sync_down_dev(struct net_device *dev, int force);
4814bdbd	230	extern int fib_sync_down_addr(struct net *net, __be32 local);
1da177e4	231	extern int fib_sync_up(struct net_device *dev);
b83738ae	232	extern __be32 __fib_res_prefsrc(struct fib_result *res);
e30d3a0c	233	extern void fib_select_multipath(const struct flowi flp, struct fib_result res);
1da177e4	234
7f9b8052 SH	235	/* Exported by fib_{hash\|trie}.c */
	236	extern void fib_hash_init(void);
	237	extern struct fib_table *fib_hash_table(u32 id);
1da177e4	238
1da177e4 LT	239	static inline void fib_combine_itag(u32 itag, struct fib_result res)
1da177e4 LT	240	{
c7066f70	241	#ifdef CONFIG_IP_ROUTE_CLASSID
1da177e4 LT	242	#ifdef CONFIG_IP_MULTIPLE_TABLES
	243	u32 rtag;
	244	#endif
	245	itag = FIB_RES_NH(res).nh_tclassid<<16;
	246	#ifdef CONFIG_IP_MULTIPLE_TABLES
	247	rtag = fib_rules_tclass(res);
	248	if (*itag == 0)
	249	*itag = (rtag<<16);
	250	*itag \|= (rtag>>16);
	251	#endif
	252	#endif
	253	}
	254
	255	extern void free_fib_info(struct fib_info *fi);
	256
	257	static inline void fib_info_put(struct fib_info *fi)
	258	{
	259	if (atomic_dec_and_test(&fi->fib_clntref))
	260	free_fib_info(fi);
	261	}
	262
20380731	263	#ifdef CONFIG_PROC_FS
61a02653 DL	264	extern int __net_init fib_proc_init(struct net *net);
61a02653 DL	265	extern void __net_exit fib_proc_exit(struct net *net);
cc8274f5 LZ	266	#else
	267	static inline int fib_proc_init(struct net *net)
	268	{
	269	return 0;
	270	}
	271	static inline void fib_proc_exit(struct net *net)
	272	{
	273	}
20380731 ACM	274	#endif
20380731 ACM	275
1da177e4	276	#endif /* _NET_FIB_H */