[deliverable/linux.git] / include / net / ip6_fib.h

/*
 *	Linux INET6 implementation 
 *
 *	Authors:
 *	Pedro Roque		<roque@di.fc.ul.pt>	
 *
 *	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 _IP6_FIB_H
#define _IP6_FIB_H

#include <linux/ipv6_route.h>
#include <linux/rtnetlink.h>
#include <linux/spinlock.h>
#include <net/dst.h>
#include <net/flow.h>
#include <net/netlink.h>
#include <net/inetpeer.h>

#ifdef CONFIG_IPV6_MULTIPLE_TABLES
#define FIB6_TABLE_HASHSZ 256
#else
#define FIB6_TABLE_HASHSZ 1
#endif

struct rt6_info;

struct fib6_config {
	u32		fc_table;
	u32		fc_metric;
	int		fc_dst_len;
	int		fc_src_len;
	int		fc_ifindex;
	u32		fc_flags;
	u32		fc_protocol;
	u32		fc_type;	/* only 8 bits are used */

	struct in6_addr	fc_dst;
	struct in6_addr	fc_src;
	struct in6_addr	fc_prefsrc;
	struct in6_addr	fc_gateway;

	unsigned long	fc_expires;
	struct nlattr	*fc_mx;
	int		fc_mx_len;
	int		fc_mp_len;
	struct nlattr	*fc_mp;

	struct nl_info	fc_nlinfo;
};

struct fib6_node {
	struct fib6_node	*parent;
	struct fib6_node	*left;
	struct fib6_node	*right;
#ifdef CONFIG_IPV6_SUBTREES
	struct fib6_node	*subtree;
#endif
	struct rt6_info		*leaf;

	__u16			fn_bit;		/* bit key */
	__u16			fn_flags;
	__u32			fn_sernum;
	struct rt6_info		*rr_ptr;
};

#ifndef CONFIG_IPV6_SUBTREES
#define FIB6_SUBTREE(fn)	NULL
#else
#define FIB6_SUBTREE(fn)	((fn)->subtree)
#endif

/*
 *	routing information
 *
 */

struct rt6key {
	struct in6_addr	addr;
	int		plen;
};

struct fib6_table;

struct rt6_info {
	struct dst_entry		dst;

	struct neighbour		*n;

	/*
	 * Tail elements of dst_entry (__refcnt etc.)
	 * and these elements (rarely used in hot path) are in
	 * the same cache line.
	 */
	struct fib6_table		*rt6i_table;
	struct fib6_node		*rt6i_node;

	struct in6_addr			rt6i_gateway;

	/* Multipath routes:
	 * siblings is a list of rt6_info that have the the same metric/weight,
	 * destination, but not the same gateway. nsiblings is just a cache
	 * to speed up lookup.
	 */
	struct list_head		rt6i_siblings;
	unsigned int			rt6i_nsiblings;

	atomic_t			rt6i_ref;

	/* These are in a separate cache line. */
	struct rt6key			rt6i_dst ____cacheline_aligned_in_smp;
	u32				rt6i_flags;
	struct rt6key			rt6i_src;
	struct rt6key			rt6i_prefsrc;
	u32				rt6i_metric;

	struct inet6_dev		*rt6i_idev;
	unsigned long			_rt6i_peer;

	u32				rt6i_genid;

	/* more non-fragment space at head required */
	unsigned short			rt6i_nfheader_len;

	u8				rt6i_protocol;
};

static inline struct inet_peer *rt6_peer_ptr(struct rt6_info *rt)
{
	return inetpeer_ptr(rt->_rt6i_peer);
}

static inline bool rt6_has_peer(struct rt6_info *rt)
{
	return inetpeer_ptr_is_peer(rt->_rt6i_peer);
}

static inline void __rt6_set_peer(struct rt6_info *rt, struct inet_peer *peer)
{
	__inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
}

static inline bool rt6_set_peer(struct rt6_info *rt, struct inet_peer *peer)
{
	return inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
}

static inline void rt6_init_peer(struct rt6_info *rt, struct inet_peer_base *base)
{
	inetpeer_init_ptr(&rt->_rt6i_peer, base);
}

static inline void rt6_transfer_peer(struct rt6_info *rt, struct rt6_info *ort)
{
	inetpeer_transfer_peer(&rt->_rt6i_peer, &ort->_rt6i_peer);
}

static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
{
	return ((struct rt6_info *)dst)->rt6i_idev;
}

static inline void rt6_clean_expires(struct rt6_info *rt)
{
	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
		dst_release(rt->dst.from);

	rt->rt6i_flags &= ~RTF_EXPIRES;
	rt->dst.from = NULL;
}

static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
{
	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
		dst_release(rt->dst.from);

	rt->rt6i_flags |= RTF_EXPIRES;
	rt->dst.expires = expires;
}

static inline void rt6_update_expires(struct rt6_info *rt, int timeout)
{
	if (!(rt->rt6i_flags & RTF_EXPIRES)) {
		if (rt->dst.from)
			dst_release(rt->dst.from);
		/* dst_set_expires relies on expires == 0 
		 * if it has not been set previously.
		 */
		rt->dst.expires = 0;
	}

	dst_set_expires(&rt->dst, timeout);
	rt->rt6i_flags |= RTF_EXPIRES;
}

static inline void rt6_set_from(struct rt6_info *rt, struct rt6_info *from)
{
	struct dst_entry *new = (struct dst_entry *) from;

	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from) {
		if (new == rt->dst.from)
			return;
		dst_release(rt->dst.from);
	}

	rt->rt6i_flags &= ~RTF_EXPIRES;
	rt->dst.from = new;
	dst_hold(new);
}

static inline void ip6_rt_put(struct rt6_info *rt)
{
	/* dst_release() accepts a NULL parameter.
	 * We rely on dst being first structure in struct rt6_info
	 */
	BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
	dst_release(&rt->dst);
}

struct fib6_walker_t {
	struct list_head lh;
	struct fib6_node *root, *node;
	struct rt6_info *leaf;
	unsigned char state;
	unsigned char prune;
	unsigned int skip;
	unsigned int count;
	int (*func)(struct fib6_walker_t *);
	void *args;
};

struct rt6_statistics {
	__u32		fib_nodes;
	__u32		fib_route_nodes;
	__u32		fib_rt_alloc;		/* permanent routes	*/
	__u32		fib_rt_entries;		/* rt entries in table	*/
	__u32		fib_rt_cache;		/* cache routes		*/
	__u32		fib_discarded_routes;
};

#define RTN_TL_ROOT	0x0001
#define RTN_ROOT	0x0002		/* tree root node		*/
#define RTN_RTINFO	0x0004		/* node with valid routing info	*/

/*
 *	priority levels (or metrics)
 *
 */


struct fib6_table {
	struct hlist_node	tb6_hlist;
	u32			tb6_id;
	rwlock_t		tb6_lock;
	struct fib6_node	tb6_root;
	struct inet_peer_base	tb6_peers;
};

#define RT6_TABLE_UNSPEC	RT_TABLE_UNSPEC
#define RT6_TABLE_MAIN		RT_TABLE_MAIN
#define RT6_TABLE_DFLT		RT6_TABLE_MAIN
#define RT6_TABLE_INFO		RT6_TABLE_MAIN
#define RT6_TABLE_PREFIX	RT6_TABLE_MAIN

#ifdef CONFIG_IPV6_MULTIPLE_TABLES
#define FIB6_TABLE_MIN		1
#define FIB6_TABLE_MAX		RT_TABLE_MAX
#define RT6_TABLE_LOCAL		RT_TABLE_LOCAL
#else
#define FIB6_TABLE_MIN		RT_TABLE_MAIN
#define FIB6_TABLE_MAX		FIB6_TABLE_MIN
#define RT6_TABLE_LOCAL		RT6_TABLE_MAIN
#endif

typedef struct rt6_info *(*pol_lookup_t)(struct net *,
					 struct fib6_table *,
					 struct flowi6 *, int);

/*
 *	exported functions
 */

extern struct fib6_table        *fib6_get_table(struct net *net, u32 id);
extern struct fib6_table        *fib6_new_table(struct net *net, u32 id);
extern struct dst_entry         *fib6_rule_lookup(struct net *net,
						  struct flowi6 *fl6, int flags,
						  pol_lookup_t lookup);

extern struct fib6_node		*fib6_lookup(struct fib6_node *root,
					     const struct in6_addr *daddr,
					     const struct in6_addr *saddr);

struct fib6_node		*fib6_locate(struct fib6_node *root,
					     const struct in6_addr *daddr, int dst_len,
					     const struct in6_addr *saddr, int src_len);

extern void			fib6_clean_all_ro(struct net *net,
					       int (*func)(struct rt6_info *, void *arg),
					       int prune, void *arg);

extern void			fib6_clean_all(struct net *net,
					       int (*func)(struct rt6_info *, void *arg),
					       int prune, void *arg);

extern int			fib6_add(struct fib6_node *root,
					 struct rt6_info *rt,
					 struct nl_info *info);

extern int			fib6_del(struct rt6_info *rt,
					 struct nl_info *info);

extern void			inet6_rt_notify(int event, struct rt6_info *rt,
						struct nl_info *info);

extern void			fib6_run_gc(unsigned long expires,
					    struct net *net);

extern void			fib6_gc_cleanup(void);

extern int			fib6_init(void);

#ifdef CONFIG_IPV6_MULTIPLE_TABLES
extern int			fib6_rules_init(void);
extern void			fib6_rules_cleanup(void);
#else
static inline int               fib6_rules_init(void)
{
	return 0;
}
static inline void              fib6_rules_cleanup(void)
{
	return ;
}
#endif
#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux INET6 implementation
	3	*
	4	* Authors:
	5	* Pedro Roque <roque@di.fc.ul.pt>
	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License
	9	* as published by the Free Software Foundation; either version
	10	* 2 of the License, or (at your option) any later version.
	11	*/
	12
	13	#ifndef _IP6_FIB_H
	14	#define _IP6_FIB_H
	15
1da177e4	16	#include <linux/ipv6_route.h>
1da177e4 LT	17	#include <linux/rtnetlink.h>
1da177e4 LT	18	#include <linux/spinlock.h>
86872cb5 TG	19	#include <net/dst.h>
	20	#include <net/flow.h>
	21	#include <net/netlink.h>
b3419363	22	#include <net/inetpeer.h>
1da177e4	23
a33bc5c1 NH	24	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	25	#define FIB6_TABLE_HASHSZ 256
	26	#else
	27	#define FIB6_TABLE_HASHSZ 1
	28	#endif
	29
1da177e4 LT	30	struct rt6_info;
1da177e4 LT	31
fd2c3ef7	32	struct fib6_config {
86872cb5 TG	33	u32 fc_table;
	34	u32 fc_metric;
	35	int fc_dst_len;
	36	int fc_src_len;
	37	int fc_ifindex;
	38	u32 fc_flags;
	39	u32 fc_protocol;
ef2c7d7b	40	u32 fc_type; /* only 8 bits are used */
86872cb5 TG	41
	42	struct in6_addr fc_dst;
	43	struct in6_addr fc_src;
c3968a85	44	struct in6_addr fc_prefsrc;
86872cb5 TG	45	struct in6_addr fc_gateway;
	46
	47	unsigned long fc_expires;
	48	struct nlattr *fc_mx;
	49	int fc_mx_len;
51ebd318 ND	50	int fc_mp_len;
51ebd318 ND	51	struct nlattr *fc_mp;
86872cb5 TG	52
	53	struct nl_info fc_nlinfo;
	54	};
	55
fd2c3ef7	56	struct fib6_node {
1da177e4 LT	57	struct fib6_node *parent;
	58	struct fib6_node *left;
	59	struct fib6_node *right;
8bce65b9	60	#ifdef CONFIG_IPV6_SUBTREES
1da177e4	61	struct fib6_node *subtree;
8bce65b9	62	#endif
1da177e4 LT	63	struct rt6_info *leaf;
	64
	65	__u16 fn_bit; /* bit key */
	66	__u16 fn_flags;
	67	__u32 fn_sernum;
f11e6659	68	struct rt6_info *rr_ptr;
1da177e4 LT	69	};
1da177e4 LT	70
7fc33165 YH	71	#ifndef CONFIG_IPV6_SUBTREES
	72	#define FIB6_SUBTREE(fn) NULL
	73	#else
	74	#define FIB6_SUBTREE(fn) ((fn)->subtree)
	75	#endif
1da177e4 LT	76
	77	/*
	78	* routing information
	79	*
	80	*/
	81
fd2c3ef7	82	struct rt6key {
1da177e4 LT	83	struct in6_addr addr;
	84	int plen;
	85	};
	86
c71099ac TG	87	struct fib6_table;
c71099ac TG	88
fd2c3ef7	89	struct rt6_info {
d8d1f30b	90	struct dst_entry dst;
1da177e4	91
97cac082 DM	92	struct neighbour *n;
97cac082 DM	93
bd2c77a0 YH	94	/*
	95	* Tail elements of dst_entry (__refcnt etc.)
	96	* and these elements (rarely used in hot path) are in
	97	* the same cache line.
	98	*/
	99	struct fib6_table *rt6i_table;
1da177e4 LT	100	struct fib6_node *rt6i_node;
	101
	102	struct in6_addr rt6i_gateway;
1da177e4	103
51ebd318 ND	104	/* Multipath routes:
	105	* siblings is a list of rt6_info that have the the same metric/weight,
	106	* destination, but not the same gateway. nsiblings is just a cache
	107	* to speed up lookup.
	108	*/
	109	struct list_head rt6i_siblings;
	110	unsigned int rt6i_nsiblings;
	111
bd2c77a0	112	atomic_t rt6i_ref;
a47ed4cd	113
bd2c77a0 YH	114	/* These are in a separate cache line. */
	115	struct rt6key rt6i_dst ____cacheline_aligned_in_smp;
	116	u32 rt6i_flags;
	117	struct rt6key rt6i_src;
c3968a85	118	struct rt6key rt6i_prefsrc;
bd2c77a0	119	u32 rt6i_metric;
b4ce9277	120
bd2c77a0	121	struct inet6_dev *rt6i_idev;
97bab73f	122	unsigned long _rt6i_peer;
b4ce9277	123
6f3118b5 ND	124	u32 rt6i_genid;
6f3118b5 ND	125
bd2c77a0 YH	126	/* more non-fragment space at head required */
bd2c77a0 YH	127	unsigned short rt6i_nfheader_len;
b4ce9277	128
bd2c77a0	129	u8 rt6i_protocol;
1da177e4 LT	130	};
1da177e4 LT	131
97bab73f DM	132	static inline struct inet_peer rt6_peer_ptr(struct rt6_info rt)
	133	{
	134	return inetpeer_ptr(rt->_rt6i_peer);
	135	}
	136
	137	static inline bool rt6_has_peer(struct rt6_info *rt)
	138	{
	139	return inetpeer_ptr_is_peer(rt->_rt6i_peer);
	140	}
	141
	142	static inline void __rt6_set_peer(struct rt6_info rt, struct inet_peer peer)
	143	{
	144	__inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
	145	}
	146
	147	static inline bool rt6_set_peer(struct rt6_info rt, struct inet_peer peer)
	148	{
	149	return inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
	150	}
	151
	152	static inline void rt6_init_peer(struct rt6_info rt, struct inet_peer_base base)
	153	{
	154	inetpeer_init_ptr(&rt->_rt6i_peer, base);
	155	}
	156
	157	static inline void rt6_transfer_peer(struct rt6_info rt, struct rt6_info ort)
	158	{
	159	inetpeer_transfer_peer(&rt->_rt6i_peer, &ort->_rt6i_peer);
	160	}
	161
7a3025b1 YH	162	static inline struct inet6_dev ip6_dst_idev(struct dst_entry dst)
	163	{
	164	return ((struct rt6_info *)dst)->rt6i_idev;
	165	}
	166
1716a961 G	167	static inline void rt6_clean_expires(struct rt6_info *rt)
	168	{
	169	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
	170	dst_release(rt->dst.from);
	171
	172	rt->rt6i_flags &= ~RTF_EXPIRES;
cda31e10	173	rt->dst.from = NULL;
1716a961 G	174	}
	175
	176	static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
	177	{
	178	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
	179	dst_release(rt->dst.from);
	180
	181	rt->rt6i_flags \|= RTF_EXPIRES;
	182	rt->dst.expires = expires;
	183	}
	184
	185	static inline void rt6_update_expires(struct rt6_info *rt, int timeout)
	186	{
edfb5d46 JB	187	if (!(rt->rt6i_flags & RTF_EXPIRES)) {
	188	if (rt->dst.from)
	189	dst_release(rt->dst.from);
	190	/* dst_set_expires relies on expires == 0
	191	* if it has not been set previously.
	192	*/
	193	rt->dst.expires = 0;
	194	}
1716a961 G	195
	196	dst_set_expires(&rt->dst, timeout);
	197	rt->rt6i_flags \|= RTF_EXPIRES;
	198	}
	199
	200	static inline void rt6_set_from(struct rt6_info rt, struct rt6_info from)
	201	{
	202	struct dst_entry new = (struct dst_entry ) from;
	203
	204	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from) {
	205	if (new == rt->dst.from)
	206	return;
	207	dst_release(rt->dst.from);
	208	}
	209
	210	rt->rt6i_flags &= ~RTF_EXPIRES;
	211	rt->dst.from = new;
	212	dst_hold(new);
	213	}
	214
94e187c0 AW	215	static inline void ip6_rt_put(struct rt6_info *rt)
	216	{
	217	/* dst_release() accepts a NULL parameter.
	218	* We rely on dst being first structure in struct rt6_info
	219	*/
	220	BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
	221	dst_release(&rt->dst);
	222	}
	223
fd2c3ef7	224	struct fib6_walker_t {
bbef49da	225	struct list_head lh;
1da177e4 LT	226	struct fib6_node root, node;
	227	struct rt6_info *leaf;
	228	unsigned char state;
	229	unsigned char prune;
2bec5a36 PM	230	unsigned int skip;
2bec5a36 PM	231	unsigned int count;
1da177e4 LT	232	int (func)(struct fib6_walker_t );
	233	void *args;
	234	};
	235
1da177e4 LT	236	struct rt6_statistics {
	237	__u32 fib_nodes;
	238	__u32 fib_route_nodes;
	239	__u32 fib_rt_alloc; /* permanent routes */
	240	__u32 fib_rt_entries; /* rt entries in table */
	241	__u32 fib_rt_cache; /* cache routes */
	242	__u32 fib_discarded_routes;
	243	};
	244
	245	#define RTN_TL_ROOT 0x0001
	246	#define RTN_ROOT 0x0002 /* tree root node */
	247	#define RTN_RTINFO 0x0004 /* node with valid routing info */
	248
	249	/*
	250	* priority levels (or metrics)
	251	*
	252	*/
	253
1da177e4	254
c71099ac TG	255	struct fib6_table {
	256	struct hlist_node tb6_hlist;
	257	u32 tb6_id;
	258	rwlock_t tb6_lock;
	259	struct fib6_node tb6_root;
8e773277	260	struct inet_peer_base tb6_peers;
c71099ac TG	261	};
	262
	263	#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
	264	#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac TG	265	#define RT6_TABLE_DFLT RT6_TABLE_MAIN
	266	#define RT6_TABLE_INFO RT6_TABLE_MAIN
	267	#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
	268
	269	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	270	#define FIB6_TABLE_MIN 1
	271	#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2	272	#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac TG	273	#else
	274	#define FIB6_TABLE_MIN RT_TABLE_MAIN
	275	#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2	276	#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac TG	277	#endif
c71099ac TG	278
8ed67789 DL	279	typedef struct rt6_info (pol_lookup_t)(struct net *,
8ed67789 DL	280	struct fib6_table *,
4c9483b2	281	struct flowi6 *, int);
1da177e4 LT	282
	283	/*
	284	* exported functions
	285	*/
	286
58f09b78 DL	287	extern struct fib6_table fib6_get_table(struct net net, u32 id);
	288	extern struct fib6_table fib6_new_table(struct net net, u32 id);
	289	extern struct dst_entry fib6_rule_lookup(struct net net,
4c9483b2	290	struct flowi6 *fl6, int flags,
58f09b78	291	pol_lookup_t lookup);
c71099ac	292
1da177e4	293	extern struct fib6_node fib6_lookup(struct fib6_node root,
b71d1d42 ED	294	const struct in6_addr *daddr,
b71d1d42 ED	295	const struct in6_addr *saddr);
1da177e4 LT	296
1da177e4 LT	297	struct fib6_node fib6_locate(struct fib6_node root,
b71d1d42 ED	298	const struct in6_addr *daddr, int dst_len,
b71d1d42 ED	299	const struct in6_addr *saddr, int src_len);
1da177e4	300
32b293a5 JH	301	extern void fib6_clean_all_ro(struct net *net,
	302	int (func)(struct rt6_info , void *arg),
	303	int prune, void *arg);
	304
f3db4851 DL	305	extern void fib6_clean_all(struct net *net,
f3db4851 DL	306	int (func)(struct rt6_info , void *arg),
c71099ac TG	307	int prune, void *arg);
c71099ac TG	308
1da177e4 LT	309	extern int fib6_add(struct fib6_node *root,
1da177e4 LT	310	struct rt6_info *rt,
86872cb5	311	struct nl_info *info);
1da177e4 LT	312
1da177e4 LT	313	extern int fib6_del(struct rt6_info *rt,
86872cb5	314	struct nl_info *info);
1da177e4 LT	315
1da177e4 LT	316	extern void inet6_rt_notify(int event, struct rt6_info *rt,
86872cb5	317	struct nl_info *info);
1da177e4	318
5b7c931d DL	319	extern void fib6_run_gc(unsigned long expires,
5b7c931d DL	320	struct net *net);
1da177e4 LT	321
	322	extern void fib6_gc_cleanup(void);
	323
d63bddbe	324	extern int fib6_init(void);
101367c2	325
7e5449c2	326	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
9eb87f3f	327	extern int fib6_rules_init(void);
101367c2	328	extern void fib6_rules_cleanup(void);
7e5449c2 DL	329	#else
	330	static inline int fib6_rules_init(void)
	331	{
	332	return 0;
	333	}
	334	static inline void fib6_rules_cleanup(void)
	335	{
	336	return ;
	337	}
	338	#endif
1da177e4	339	#endif