[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>

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_NET_CLS_ROUTE
	__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;
	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[RTAX_MAX];
#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 fib_nh		fib_nh[0];
#define fib_dev		fib_nh[0].nh_dev
};


#ifdef CONFIG_IP_MULTIPLE_TABLES
struct fib_rule;
#endif

struct fib_result {
	unsigned char	prefixlen;
	unsigned char	nh_sel;
	unsigned char	type;
	unsigned char	scope;
	struct fib_info *fi;
#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_RES_RESET(res)	((res).nh_sel = 0)

#else /* CONFIG_IP_ROUTE_MULTIPATH */

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

#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;
	unsigned	tb_stamp;
	int		tb_default;
	int		(*tb_lookup)(struct fib_table *tb, const struct flowi *flp, struct fib_result *res);
	int		(*tb_insert)(struct fib_table *, struct fib_config *);
	int		(*tb_delete)(struct fib_table *, struct fib_config *);
	int		(*tb_dump)(struct fib_table *table, struct sk_buff *skb,
				     struct netlink_callback *cb);
	int		(*tb_flush)(struct fib_table *table);
	void		(*tb_select_default)(struct fib_table *table,
					     const struct flowi *flp, struct fib_result *res);

	unsigned char	tb_data[0];
};

#ifndef CONFIG_IP_MULTIPLE_TABLES

extern struct fib_table *ip_fib_local_table;
extern struct fib_table *ip_fib_main_table;

static inline struct fib_table *fib_get_table(u32 id)
{
	if (id != RT_TABLE_LOCAL)
		return ip_fib_main_table;
	return ip_fib_local_table;
}

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

static inline int fib_lookup(const struct flowi *flp, struct fib_result *res)
{
	if (ip_fib_local_table->tb_lookup(ip_fib_local_table, flp, res) &&
	    ip_fib_main_table->tb_lookup(ip_fib_main_table, flp, res))
		return -ENETUNREACH;
	return 0;
}

static inline void fib_select_default(const struct flowi *flp, struct fib_result *res)
{
	if (FIB_RES_GW(*res) && FIB_RES_NH(*res).nh_scope == RT_SCOPE_LINK)
		ip_fib_main_table->tb_select_default(ip_fib_main_table, flp, res);
}

#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_NET_CLS_ROUTE
extern u32 fib_rules_tclass(struct fib_result *res);
#endif

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

extern struct fib_table *fib_new_table(u32 id);
extern struct fib_table *fib_get_table(u32 id);
extern void fib_select_default(const struct flowi *flp, struct fib_result *res);

#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);
extern void fib_select_multipath(const struct flowi *flp, struct fib_result *res);

struct rtentry;

/* Exported by fib_semantics.c */
extern int ip_fib_check_default(__be32 gw, struct net_device *dev);
extern int fib_sync_down(__be32 local, struct net_device *dev, int force);
extern int fib_sync_up(struct net_device *dev);
extern __be32  __fib_res_prefsrc(struct fib_result *res);

/* Exported by fib_hash.c */
extern struct fib_table *fib_hash_init(u32 id);

static inline void fib_combine_itag(u32 *itag, struct fib_result *res)
{
#ifdef CONFIG_NET_CLS_ROUTE
#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);
}

static inline void fib_res_put(struct fib_result *res)
{
	if (res->fi)
		fib_info_put(res->fi);
#ifdef CONFIG_IP_MULTIPLE_TABLES
	if (res->r)
		fib_rule_put(res->r);
#endif
}

#ifdef CONFIG_PROC_FS
extern int __net_init  fib_proc_init(struct net *net);
extern void __net_exit 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
	58	#ifdef CONFIG_NET_CLS_ROUTE
	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;
	72	int fib_treeref;
	73	atomic_t fib_clntref;
	74	int fib_dead;
	75	unsigned fib_flags;
	76	int fib_protocol;
b83738ae	77	__be32 fib_prefsrc;
1da177e4 LT	78	u32 fib_priority;
	79	u32 fib_metrics[RTAX_MAX];
	80	#define fib_mtu fib_metrics[RTAX_MTU-1]
	81	#define fib_window fib_metrics[RTAX_WINDOW-1]
	82	#define fib_rtt fib_metrics[RTAX_RTT-1]
	83	#define fib_advmss fib_metrics[RTAX_ADVMSS-1]
	84	int fib_nhs;
	85	#ifdef CONFIG_IP_ROUTE_MULTIPATH
	86	int fib_power;
1da177e4 LT	87	#endif
	88	struct fib_nh fib_nh[0];
	89	#define fib_dev fib_nh[0].nh_dev
	90	};
	91
	92
	93	#ifdef CONFIG_IP_MULTIPLE_TABLES
	94	struct fib_rule;
	95	#endif
	96
	97	struct fib_result {
	98	unsigned char prefixlen;
	99	unsigned char nh_sel;
	100	unsigned char type;
	101	unsigned char scope;
1da177e4 LT	102	struct fib_info *fi;
	103	#ifdef CONFIG_IP_MULTIPLE_TABLES
	104	struct fib_rule *r;
	105	#endif
	106	};
	107
246955fe	108	struct fib_result_nl {
80e856e1	109	__be32 fl_addr; /* To be looked up*/
5f300893	110	u32 fl_mark;
246955fe RO	111	unsigned char fl_tos;
	112	unsigned char fl_scope;
	113	unsigned char tb_id_in;
	114
	115	unsigned char tb_id; /* Results */
	116	unsigned char prefixlen;
	117	unsigned char nh_sel;
	118	unsigned char type;
	119	unsigned char scope;
	120	int err;
	121	};
1da177e4 LT	122
	123	#ifdef CONFIG_IP_ROUTE_MULTIPATH
	124
	125	#define FIB_RES_NH(res) ((res).fi->fib_nh[(res).nh_sel])
	126	#define FIB_RES_RESET(res) ((res).nh_sel = 0)
	127
	128	#else /* CONFIG_IP_ROUTE_MULTIPATH */
	129
	130	#define FIB_RES_NH(res) ((res).fi->fib_nh[0])
	131	#define FIB_RES_RESET(res)
	132
	133	#endif /* CONFIG_IP_ROUTE_MULTIPATH */
	134
	135	#define FIB_RES_PREFSRC(res) ((res).fi->fib_prefsrc ? : __fib_res_prefsrc(&res))
	136	#define FIB_RES_GW(res) (FIB_RES_NH(res).nh_gw)
	137	#define FIB_RES_DEV(res) (FIB_RES_NH(res).nh_dev)
	138	#define FIB_RES_OIF(res) (FIB_RES_NH(res).nh_oif)
	139
1da177e4	140	struct fib_table {
1af5a8c4	141	struct hlist_node tb_hlist;
2dfe55b4	142	u32 tb_id;
1da177e4	143	unsigned tb_stamp;
971b893e	144	int tb_default;
1da177e4	145	int (tb_lookup)(struct fib_table tb, const struct flowi flp, struct fib_result res);
4e902c57 TG	146	int (tb_insert)(struct fib_table , struct fib_config *);
4e902c57 TG	147	int (tb_delete)(struct fib_table , struct fib_config *);
1da177e4 LT	148	int (tb_dump)(struct fib_table table, struct sk_buff *skb,
	149	struct netlink_callback *cb);
	150	int (tb_flush)(struct fib_table table);
	151	void (tb_select_default)(struct fib_table table,
	152	const struct flowi flp, struct fib_result res);
	153
	154	unsigned char tb_data[0];
	155	};
	156
	157	#ifndef CONFIG_IP_MULTIPLE_TABLES
	158
	159	extern struct fib_table *ip_fib_local_table;
	160	extern struct fib_table *ip_fib_main_table;
	161
2dfe55b4	162	static inline struct fib_table *fib_get_table(u32 id)
1da177e4 LT	163	{
	164	if (id != RT_TABLE_LOCAL)
	165	return ip_fib_main_table;
	166	return ip_fib_local_table;
	167	}
	168
2dfe55b4	169	static inline struct fib_table *fib_new_table(u32 id)
1da177e4 LT	170	{
	171	return fib_get_table(id);
	172	}
	173
	174	static inline int fib_lookup(const struct flowi flp, struct fib_result res)
	175	{
	176	if (ip_fib_local_table->tb_lookup(ip_fib_local_table, flp, res) &&
	177	ip_fib_main_table->tb_lookup(ip_fib_main_table, flp, res))
	178	return -ENETUNREACH;
	179	return 0;
	180	}
	181
	182	static inline void fib_select_default(const struct flowi flp, struct fib_result res)
	183	{
	184	if (FIB_RES_GW(res) && FIB_RES_NH(res).nh_scope == RT_SCOPE_LINK)
	185	ip_fib_main_table->tb_select_default(ip_fib_main_table, flp, res);
	186	}
	187
	188	#else /* CONFIG_IP_MULTIPLE_TABLES */
7b1a74fd DL	189	extern int __net_init fib4_rules_init(struct net *net);
7b1a74fd DL	190	extern void __net_exit fib4_rules_exit(struct net *net);
c3e9a353 PE	191
	192	#ifdef CONFIG_NET_CLS_ROUTE
	193	extern u32 fib_rules_tclass(struct fib_result *res);
	194	#endif
	195
e1ef4bf2	196	extern int fib_lookup(struct flowi flp, struct fib_result res);
1da177e4	197
1af5a8c4 PM	198	extern struct fib_table *fib_new_table(u32 id);
1af5a8c4 PM	199	extern struct fib_table *fib_get_table(u32 id);
1da177e4 LT	200	extern void fib_select_default(const struct flowi flp, struct fib_result res);
	201
	202	#endif /* CONFIG_IP_MULTIPLE_TABLES */
	203
	204	/* Exported by fib_frontend.c */
ef7c79ed	205	extern const struct nla_policy rtm_ipv4_policy[];
1da177e4	206	extern void ip_fib_init(void);
d9c9df8c AV	207	extern int fib_validate_source(__be32 src, __be32 dst, u8 tos, int oif,
d9c9df8c AV	208	struct net_device dev, __be32 spec_dst, u32 *itag);
1da177e4 LT	209	extern void fib_select_multipath(const struct flowi flp, struct fib_result res);
1da177e4 LT	210
14c85021 ACM	211	struct rtentry;
14c85021 ACM	212
1da177e4	213	/* Exported by fib_semantics.c */
d878e72e	214	extern int ip_fib_check_default(__be32 gw, struct net_device *dev);
81f7bf6c	215	extern int fib_sync_down(__be32 local, struct net_device *dev, int force);
1da177e4	216	extern int fib_sync_up(struct net_device *dev);
b83738ae	217	extern __be32 __fib_res_prefsrc(struct fib_result *res);
1da177e4 LT	218
1da177e4 LT	219	/* Exported by fib_hash.c */
2dfe55b4	220	extern struct fib_table *fib_hash_init(u32 id);
1da177e4	221
1da177e4 LT	222	static inline void fib_combine_itag(u32 itag, struct fib_result res)
	223	{
	224	#ifdef CONFIG_NET_CLS_ROUTE
	225	#ifdef CONFIG_IP_MULTIPLE_TABLES
	226	u32 rtag;
	227	#endif
	228	itag = FIB_RES_NH(res).nh_tclassid<<16;
	229	#ifdef CONFIG_IP_MULTIPLE_TABLES
	230	rtag = fib_rules_tclass(res);
	231	if (*itag == 0)
	232	*itag = (rtag<<16);
	233	*itag \|= (rtag>>16);
	234	#endif
	235	#endif
	236	}
	237
	238	extern void free_fib_info(struct fib_info *fi);
	239
	240	static inline void fib_info_put(struct fib_info *fi)
	241	{
	242	if (atomic_dec_and_test(&fi->fib_clntref))
	243	free_fib_info(fi);
	244	}
	245
	246	static inline void fib_res_put(struct fib_result *res)
	247	{
	248	if (res->fi)
	249	fib_info_put(res->fi);
	250	#ifdef CONFIG_IP_MULTIPLE_TABLES
	251	if (res->r)
	252	fib_rule_put(res->r);
	253	#endif
	254	}
	255
20380731	256	#ifdef CONFIG_PROC_FS
61a02653 DL	257	extern int __net_init fib_proc_init(struct net *net);
61a02653 DL	258	extern void __net_exit fib_proc_exit(struct net *net);
20380731 ACM	259	#endif
20380731 ACM	260
1da177e4	261	#endif /* _NET_FIB_H */