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

	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;

	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;

	/*
	 * 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;

	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;
	u32				rt6i_peer_genid;

	struct inet6_dev		*rt6i_idev;
	unsigned long			_rt6i_peer;

#ifdef CONFIG_XFRM
	u32				rt6i_flow_cache_genid;
#endif
	/* 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);
}

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;
	40
	41	struct in6_addr fc_dst;
	42	struct in6_addr fc_src;
c3968a85	43	struct in6_addr fc_prefsrc;
86872cb5 TG	44	struct in6_addr fc_gateway;
	45
	46	unsigned long fc_expires;
	47	struct nlattr *fc_mx;
	48	int fc_mx_len;
	49
	50	struct nl_info fc_nlinfo;
	51	};
	52
fd2c3ef7	53	struct fib6_node {
1da177e4 LT	54	struct fib6_node *parent;
	55	struct fib6_node *left;
	56	struct fib6_node *right;
8bce65b9	57	#ifdef CONFIG_IPV6_SUBTREES
1da177e4	58	struct fib6_node *subtree;
8bce65b9	59	#endif
1da177e4 LT	60	struct rt6_info *leaf;
	61
	62	__u16 fn_bit; /* bit key */
	63	__u16 fn_flags;
	64	__u32 fn_sernum;
f11e6659	65	struct rt6_info *rr_ptr;
1da177e4 LT	66	};
1da177e4 LT	67
7fc33165 YH	68	#ifndef CONFIG_IPV6_SUBTREES
	69	#define FIB6_SUBTREE(fn) NULL
	70	#else
	71	#define FIB6_SUBTREE(fn) ((fn)->subtree)
	72	#endif
1da177e4 LT	73
	74	/*
	75	* routing information
	76	*
	77	*/
	78
fd2c3ef7	79	struct rt6key {
1da177e4 LT	80	struct in6_addr addr;
	81	int plen;
	82	};
	83
c71099ac TG	84	struct fib6_table;
c71099ac TG	85
fd2c3ef7	86	struct rt6_info {
d8d1f30b	87	struct dst_entry dst;
1da177e4	88
bd2c77a0 YH	89	/*
	90	* Tail elements of dst_entry (__refcnt etc.)
	91	* and these elements (rarely used in hot path) are in
	92	* the same cache line.
	93	*/
	94	struct fib6_table *rt6i_table;
1da177e4 LT	95	struct fib6_node *rt6i_node;
	96
	97	struct in6_addr rt6i_gateway;
1da177e4	98
bd2c77a0	99	atomic_t rt6i_ref;
a47ed4cd	100
bd2c77a0 YH	101	/* These are in a separate cache line. */
	102	struct rt6key rt6i_dst ____cacheline_aligned_in_smp;
	103	u32 rt6i_flags;
	104	struct rt6key rt6i_src;
c3968a85	105	struct rt6key rt6i_prefsrc;
bd2c77a0	106	u32 rt6i_metric;
6431cbc2	107	u32 rt6i_peer_genid;
b4ce9277	108
bd2c77a0	109	struct inet6_dev *rt6i_idev;
97bab73f	110	unsigned long _rt6i_peer;
b4ce9277	111
a47ed4cd NT	112	#ifdef CONFIG_XFRM
	113	u32 rt6i_flow_cache_genid;
	114	#endif
bd2c77a0 YH	115	/* more non-fragment space at head required */
bd2c77a0 YH	116	unsigned short rt6i_nfheader_len;
b4ce9277	117
bd2c77a0	118	u8 rt6i_protocol;
1da177e4 LT	119	};
1da177e4 LT	120
97bab73f DM	121	static inline struct inet_peer rt6_peer_ptr(struct rt6_info rt)
	122	{
	123	return inetpeer_ptr(rt->_rt6i_peer);
	124	}
	125
	126	static inline bool rt6_has_peer(struct rt6_info *rt)
	127	{
	128	return inetpeer_ptr_is_peer(rt->_rt6i_peer);
	129	}
	130
	131	static inline void __rt6_set_peer(struct rt6_info rt, struct inet_peer peer)
	132	{
	133	__inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
	134	}
	135
	136	static inline bool rt6_set_peer(struct rt6_info rt, struct inet_peer peer)
	137	{
	138	return inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
	139	}
	140
	141	static inline void rt6_init_peer(struct rt6_info rt, struct inet_peer_base base)
	142	{
	143	inetpeer_init_ptr(&rt->_rt6i_peer, base);
	144	}
	145
	146	static inline void rt6_transfer_peer(struct rt6_info rt, struct rt6_info ort)
	147	{
	148	inetpeer_transfer_peer(&rt->_rt6i_peer, &ort->_rt6i_peer);
	149	}
	150
7a3025b1 YH	151	static inline struct inet6_dev ip6_dst_idev(struct dst_entry dst)
	152	{
	153	return ((struct rt6_info *)dst)->rt6i_idev;
	154	}
	155
1716a961 G	156	static inline void rt6_clean_expires(struct rt6_info *rt)
	157	{
	158	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
	159	dst_release(rt->dst.from);
	160
	161	rt->rt6i_flags &= ~RTF_EXPIRES;
cda31e10	162	rt->dst.from = NULL;
1716a961 G	163	}
	164
	165	static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
	166	{
	167	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
	168	dst_release(rt->dst.from);
	169
	170	rt->rt6i_flags \|= RTF_EXPIRES;
	171	rt->dst.expires = expires;
	172	}
	173
	174	static inline void rt6_update_expires(struct rt6_info *rt, int timeout)
	175	{
edfb5d46 JB	176	if (!(rt->rt6i_flags & RTF_EXPIRES)) {
	177	if (rt->dst.from)
	178	dst_release(rt->dst.from);
	179	/* dst_set_expires relies on expires == 0
	180	* if it has not been set previously.
	181	*/
	182	rt->dst.expires = 0;
	183	}
1716a961 G	184
	185	dst_set_expires(&rt->dst, timeout);
	186	rt->rt6i_flags \|= RTF_EXPIRES;
	187	}
	188
	189	static inline void rt6_set_from(struct rt6_info rt, struct rt6_info from)
	190	{
	191	struct dst_entry new = (struct dst_entry ) from;
	192
	193	if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from) {
	194	if (new == rt->dst.from)
	195	return;
	196	dst_release(rt->dst.from);
	197	}
	198
	199	rt->rt6i_flags &= ~RTF_EXPIRES;
	200	rt->dst.from = new;
	201	dst_hold(new);
	202	}
	203
fd2c3ef7	204	struct fib6_walker_t {
bbef49da	205	struct list_head lh;
1da177e4 LT	206	struct fib6_node root, node;
	207	struct rt6_info *leaf;
	208	unsigned char state;
	209	unsigned char prune;
2bec5a36 PM	210	unsigned int skip;
2bec5a36 PM	211	unsigned int count;
1da177e4 LT	212	int (func)(struct fib6_walker_t );
	213	void *args;
	214	};
	215
1da177e4 LT	216	struct rt6_statistics {
	217	__u32 fib_nodes;
	218	__u32 fib_route_nodes;
	219	__u32 fib_rt_alloc; /* permanent routes */
	220	__u32 fib_rt_entries; /* rt entries in table */
	221	__u32 fib_rt_cache; /* cache routes */
	222	__u32 fib_discarded_routes;
	223	};
	224
	225	#define RTN_TL_ROOT 0x0001
	226	#define RTN_ROOT 0x0002 /* tree root node */
	227	#define RTN_RTINFO 0x0004 /* node with valid routing info */
	228
	229	/*
	230	* priority levels (or metrics)
	231	*
	232	*/
	233
1da177e4	234
c71099ac TG	235	struct fib6_table {
	236	struct hlist_node tb6_hlist;
	237	u32 tb6_id;
	238	rwlock_t tb6_lock;
	239	struct fib6_node tb6_root;
8e773277	240	struct inet_peer_base tb6_peers;
c71099ac TG	241	};
	242
	243	#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
	244	#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac TG	245	#define RT6_TABLE_DFLT RT6_TABLE_MAIN
	246	#define RT6_TABLE_INFO RT6_TABLE_MAIN
	247	#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
	248
	249	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	250	#define FIB6_TABLE_MIN 1
	251	#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2	252	#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac TG	253	#else
	254	#define FIB6_TABLE_MIN RT_TABLE_MAIN
	255	#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2	256	#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac TG	257	#endif
c71099ac TG	258
8ed67789 DL	259	typedef struct rt6_info (pol_lookup_t)(struct net *,
8ed67789 DL	260	struct fib6_table *,
4c9483b2	261	struct flowi6 *, int);
1da177e4 LT	262
	263	/*
	264	* exported functions
	265	*/
	266
58f09b78 DL	267	extern struct fib6_table fib6_get_table(struct net net, u32 id);
	268	extern struct fib6_table fib6_new_table(struct net net, u32 id);
	269	extern struct dst_entry fib6_rule_lookup(struct net net,
4c9483b2	270	struct flowi6 *fl6, int flags,
58f09b78	271	pol_lookup_t lookup);
c71099ac	272
1da177e4	273	extern struct fib6_node fib6_lookup(struct fib6_node root,
b71d1d42 ED	274	const struct in6_addr *daddr,
b71d1d42 ED	275	const struct in6_addr *saddr);
1da177e4 LT	276
1da177e4 LT	277	struct fib6_node fib6_locate(struct fib6_node root,
b71d1d42 ED	278	const struct in6_addr *daddr, int dst_len,
b71d1d42 ED	279	const struct in6_addr *saddr, int src_len);
1da177e4	280
32b293a5 JH	281	extern void fib6_clean_all_ro(struct net *net,
	282	int (func)(struct rt6_info , void *arg),
	283	int prune, void *arg);
	284
f3db4851 DL	285	extern void fib6_clean_all(struct net *net,
f3db4851 DL	286	int (func)(struct rt6_info , void *arg),
c71099ac TG	287	int prune, void *arg);
c71099ac TG	288
1da177e4 LT	289	extern int fib6_add(struct fib6_node *root,
1da177e4 LT	290	struct rt6_info *rt,
86872cb5	291	struct nl_info *info);
1da177e4 LT	292
1da177e4 LT	293	extern int fib6_del(struct rt6_info *rt,
86872cb5	294	struct nl_info *info);
1da177e4 LT	295
1da177e4 LT	296	extern void inet6_rt_notify(int event, struct rt6_info *rt,
86872cb5	297	struct nl_info *info);
1da177e4	298
5b7c931d DL	299	extern void fib6_run_gc(unsigned long expires,
5b7c931d DL	300	struct net *net);
1da177e4 LT	301
	302	extern void fib6_gc_cleanup(void);
	303
d63bddbe	304	extern int fib6_init(void);
101367c2	305
7e5449c2	306	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
9eb87f3f	307	extern int fib6_rules_init(void);
101367c2	308	extern void fib6_rules_cleanup(void);
7e5449c2 DL	309	#else
	310	static inline int fib6_rules_init(void)
	311	{
	312	return 0;
	313	}
	314	static inline void fib6_rules_cleanup(void)
	315	{
	316	return ;
	317	}
	318	#endif
1da177e4	319	#endif