[mirror_ubuntu-bionic-kernel.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

#ifdef __KERNEL__

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

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_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
{
	union {
		struct dst_entry	dst;
	} u;

	struct inet6_dev		*rt6i_idev;

#define rt6i_dev			u.dst.dev
#define rt6i_nexthop			u.dst.neighbour
#define rt6i_expires			u.dst.expires

	struct fib6_node		*rt6i_node;

	struct in6_addr			rt6i_gateway;
	
	u32				rt6i_flags;
	u32				rt6i_metric;
	atomic_t			rt6i_ref;

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

	u8				rt6i_protocol;

	struct fib6_table		*rt6i_table;

	struct rt6key			rt6i_dst;

#ifdef CONFIG_XFRM
	u32				rt6i_flow_cache_genid;
#endif

	struct rt6key			rt6i_src;
};

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

struct fib6_walker_t
{
	struct fib6_walker_t *prev, *next;
	struct fib6_node *root, *node;
	struct rt6_info *leaf;
	unsigned char state;
	unsigned char prune;
	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)
 *
 */

#define RTPRI_FIREWALL	8		/* Firewall control information	*/
#define RTPRI_FLOW	16		/* Flow based forwarding rules	*/
#define RTPRI_KERN_CTL	32		/* Kernel control routes	*/

#define RTPRI_USER_MIN	256		/* Mimimum user priority	*/
#define RTPRI_USER_MAX	1024		/* Maximum user priority	*/

#define RTPRI_KERN_DFLT	4096		/* Kernel default routes	*/

#define	MAX_FLOW_BACKTRACE	32


typedef void			(*f_pnode)(struct fib6_node *fn, void *);

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

#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 fib6_table *,
					 struct flowi *, int);

/*
 *	exported functions
 */

extern struct fib6_table *	fib6_get_table(u32 id);
extern struct fib6_table *	fib6_new_table(u32 id);
extern struct dst_entry *	fib6_rule_lookup(struct flowi *fl, int flags,
						 pol_lookup_t lookup);

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

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

extern void			fib6_clean_all(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 dummy);

extern void			fib6_gc_cleanup(void);

extern int			fib6_init(void);

extern int			fib6_rules_init(void);
extern void			fib6_rules_cleanup(void);

#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
	16	#ifdef __KERNEL__
	17
	18	#include <linux/ipv6_route.h>
1da177e4 LT	19	#include <linux/rtnetlink.h>
1da177e4 LT	20	#include <linux/spinlock.h>
86872cb5 TG	21	#include <net/dst.h>
	22	#include <net/flow.h>
	23	#include <net/netlink.h>
1da177e4 LT	24
	25	struct rt6_info;
	26
86872cb5 TG	27	struct fib6_config
	28	{
	29	u32 fc_table;
	30	u32 fc_metric;
	31	int fc_dst_len;
	32	int fc_src_len;
	33	int fc_ifindex;
	34	u32 fc_flags;
	35	u32 fc_protocol;
	36
	37	struct in6_addr fc_dst;
	38	struct in6_addr fc_src;
	39	struct in6_addr fc_gateway;
	40
	41	unsigned long fc_expires;
	42	struct nlattr *fc_mx;
	43	int fc_mx_len;
	44
	45	struct nl_info fc_nlinfo;
	46	};
	47
1da177e4 LT	48	struct fib6_node
	49	{
	50	struct fib6_node *parent;
	51	struct fib6_node *left;
	52	struct fib6_node *right;
8bce65b9	53	#ifdef CONFIG_IPV6_SUBTREES
1da177e4	54	struct fib6_node *subtree;
8bce65b9	55	#endif
1da177e4 LT	56	struct rt6_info *leaf;
	57
	58	__u16 fn_bit; /* bit key */
	59	__u16 fn_flags;
	60	__u32 fn_sernum;
f11e6659	61	struct rt6_info *rr_ptr;
1da177e4 LT	62	};
1da177e4 LT	63
7fc33165 YH	64	#ifndef CONFIG_IPV6_SUBTREES
	65	#define FIB6_SUBTREE(fn) NULL
	66	#else
	67	#define FIB6_SUBTREE(fn) ((fn)->subtree)
	68	#endif
1da177e4 LT	69
	70	/*
	71	* routing information
	72	*
	73	*/
	74
	75	struct rt6key
	76	{
	77	struct in6_addr addr;
	78	int plen;
	79	};
	80
c71099ac TG	81	struct fib6_table;
c71099ac TG	82
1da177e4 LT	83	struct rt6_info
	84	{
	85	union {
	86	struct dst_entry dst;
1da177e4 LT	87	} u;
	88
	89	struct inet6_dev *rt6i_idev;
	90
	91	#define rt6i_dev u.dst.dev
	92	#define rt6i_nexthop u.dst.neighbour
	93	#define rt6i_expires u.dst.expires
	94
	95	struct fib6_node *rt6i_node;
	96
	97	struct in6_addr rt6i_gateway;
	98
	99	u32 rt6i_flags;
	100	u32 rt6i_metric;
	101	atomic_t rt6i_ref;
	102
b4ce9277 HX	103	/* more non-fragment space at head required */
b4ce9277 HX	104	unsigned short nfheader_len;
1da177e4 LT	105
1da177e4 LT	106	u8 rt6i_protocol;
a47ed4cd	107
b4ce9277 HX	108	struct fib6_table *rt6i_table;
	109
	110	struct rt6key rt6i_dst;
	111
a47ed4cd NT	112	#ifdef CONFIG_XFRM
	113	u32 rt6i_flow_cache_genid;
	114	#endif
b4ce9277 HX	115
b4ce9277 HX	116	struct rt6key rt6i_src;
1da177e4 LT	117	};
1da177e4 LT	118
7a3025b1 YH	119	static inline struct inet6_dev ip6_dst_idev(struct dst_entry dst)
	120	{
	121	return ((struct rt6_info *)dst)->rt6i_idev;
	122	}
	123
1da177e4 LT	124	struct fib6_walker_t
	125	{
	126	struct fib6_walker_t prev, next;
	127	struct fib6_node root, node;
	128	struct rt6_info *leaf;
	129	unsigned char state;
	130	unsigned char prune;
	131	int (func)(struct fib6_walker_t );
	132	void *args;
	133	};
	134
1da177e4 LT	135	struct rt6_statistics {
	136	__u32 fib_nodes;
	137	__u32 fib_route_nodes;
	138	__u32 fib_rt_alloc; /* permanent routes */
	139	__u32 fib_rt_entries; /* rt entries in table */
	140	__u32 fib_rt_cache; /* cache routes */
	141	__u32 fib_discarded_routes;
	142	};
	143
	144	#define RTN_TL_ROOT 0x0001
	145	#define RTN_ROOT 0x0002 /* tree root node */
	146	#define RTN_RTINFO 0x0004 /* node with valid routing info */
	147
	148	/*
	149	* priority levels (or metrics)
	150	*
	151	*/
	152
	153	#define RTPRI_FIREWALL 8 /* Firewall control information */
	154	#define RTPRI_FLOW 16 /* Flow based forwarding rules */
	155	#define RTPRI_KERN_CTL 32 /* Kernel control routes */
	156
	157	#define RTPRI_USER_MIN 256 /* Mimimum user priority */
	158	#define RTPRI_USER_MAX 1024 /* Maximum user priority */
	159
	160	#define RTPRI_KERN_DFLT 4096 /* Kernel default routes */
	161
	162	#define MAX_FLOW_BACKTRACE 32
	163
	164
	165	typedef void (f_pnode)(struct fib6_node fn, void *);
	166
c71099ac TG	167	struct fib6_table {
	168	struct hlist_node tb6_hlist;
	169	u32 tb6_id;
	170	rwlock_t tb6_lock;
	171	struct fib6_node tb6_root;
	172	};
	173
	174	#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
	175	#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac TG	176	#define RT6_TABLE_DFLT RT6_TABLE_MAIN
	177	#define RT6_TABLE_INFO RT6_TABLE_MAIN
	178	#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
	179
	180	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	181	#define FIB6_TABLE_MIN 1
	182	#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2	183	#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac TG	184	#else
	185	#define FIB6_TABLE_MIN RT_TABLE_MAIN
	186	#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2	187	#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac TG	188	#endif
c71099ac TG	189
c71099ac TG	190	typedef struct rt6_info (pol_lookup_t)(struct fib6_table *,
c71099ac TG	191	struct flowi *, int);
1da177e4 LT	192
	193	/*
	194	* exported functions
	195	*/
	196
c71099ac TG	197	extern struct fib6_table * fib6_get_table(u32 id);
	198	extern struct fib6_table * fib6_new_table(u32 id);
	199	extern struct dst_entry * fib6_rule_lookup(struct flowi *fl, int flags,
	200	pol_lookup_t lookup);
	201
1da177e4 LT	202	extern struct fib6_node fib6_lookup(struct fib6_node root,
	203	struct in6_addr *daddr,
	204	struct in6_addr *saddr);
	205
	206	struct fib6_node fib6_locate(struct fib6_node root,
	207	struct in6_addr *daddr, int dst_len,
	208	struct in6_addr *saddr, int src_len);
	209
c71099ac TG	210	extern void fib6_clean_all(int (func)(struct rt6_info , void *arg),
	211	int prune, void *arg);
	212
1da177e4 LT	213	extern int fib6_add(struct fib6_node *root,
1da177e4 LT	214	struct rt6_info *rt,
86872cb5	215	struct nl_info *info);
1da177e4 LT	216
1da177e4 LT	217	extern int fib6_del(struct rt6_info *rt,
86872cb5	218	struct nl_info *info);
1da177e4 LT	219
1da177e4 LT	220	extern void inet6_rt_notify(int event, struct rt6_info *rt,
86872cb5	221	struct nl_info *info);
1da177e4 LT	222
	223	extern void fib6_run_gc(unsigned long dummy);
	224
	225	extern void fib6_gc_cleanup(void);
	226
d63bddbe	227	extern int fib6_init(void);
101367c2	228
9eb87f3f	229	extern int fib6_rules_init(void);
101367c2	230	extern void fib6_rules_cleanup(void);
101367c2	231
1da177e4 LT	232	#endif
1da177e4 LT	233	#endif