[deliverable/linux.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>
#include <net/inetpeer.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 int		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;
	__be32			nh_saddr;
	int			nh_saddr_genid;
};

/*
 * 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;
	unsigned int		fib_flags;
	unsigned char		fib_dead;
	unsigned char		fib_protocol;
	unsigned char		fib_scope;
	__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 */

extern __be32 fib_info_update_nh_saddr(struct net *net, struct fib_nh *nh);

#define FIB_RES_SADDR(net, res)				\
	((FIB_RES_NH(res).nh_saddr_genid ==		\
	  atomic_read(&(net)->ipv4.dev_addr_genid)) ?	\
	 FIB_RES_NH(res).nh_saddr :			\
	 fib_info_update_nh_saddr((net), &FIB_RES_NH(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)

#define FIB_RES_PREFSRC(net, res)	((res).fi->fib_prefsrc ? : \
					 FIB_RES_SADDR(net, res))

struct fib_table {
	struct hlist_node	tb_hlist;
	u32			tb_id;
	int			tb_default;
	int			tb_num_default;
	struct inet_peer_base	tb_peers;
	unsigned long		tb_data[0];
};

extern int fib_table_lookup(struct fib_table *tb, const struct flowi4 *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_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 flowi4 *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(const struct fib_result *res);
#endif

extern int fib_lookup(struct net *n, struct flowi4 *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 __be32 fib_compute_spec_dst(struct sk_buff *skb);
extern int fib_validate_source(struct sk_buff *skb, __be32 src, __be32 dst,
			       u8 tos, int oif, struct net_device *dev,
			       struct in_device *idev, u32 *itag);
extern void fib_select_default(struct fib_result *res);
#ifdef CONFIG_IP_ROUTE_CLASSID
extern int fib_num_tclassid_users;
#else
#define fib_num_tclassid_users 0
#endif

/* 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 void fib_update_nh_saddrs(struct net_device *dev);
extern int fib_sync_up(struct net_device *dev);
extern void fib_select_multipath(struct fib_result *res);

/* Exported by fib_trie.c */
extern void fib_trie_init(void);
extern struct fib_table *fib_trie_table(u32 id);

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