[mirror_ubuntu-bionic-kernel.git] / include / net / route.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 IP router.
 *
 * Version:	@(#)route.h	1.0.4	05/27/93
 *
 * Authors:	Ross Biro
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 * Fixes:
 *		Alan Cox	:	Reformatted. Added ip_rt_local()
 *		Alan Cox	:	Support for TCP parameters.
 *		Alexey Kuznetsov:	Major changes for new routing code.
 *		Mike McLagan    :	Routing by source
 *		Robert Olsson   :	Added rt_cache statistics
 *
 *		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 _ROUTE_H
#define _ROUTE_H

#include <net/dst.h>
#include <net/inetpeer.h>
#include <net/flow.h>
#include <linux/in_route.h>
#include <linux/rtnetlink.h>
#include <linux/route.h>
#include <linux/ip.h>
#include <linux/cache.h>
#include <linux/security.h>

#ifndef __KERNEL__
#warning This file is not supposed to be used outside of kernel.
#endif

#define RTO_ONLINK	0x01

#define RTO_CONN	0
/* RTO_CONN is not used (being alias for 0), but preserved not to break
 * some modules referring to it. */

#define RT_CONN_FLAGS(sk)   (RT_TOS(inet_sk(sk)->tos) | sock_flag(sk, SOCK_LOCALROUTE))

struct fib_nh;
struct inet_peer;
struct rtable
{
	union
	{
		struct dst_entry	dst;
	} u;

	/* Cache lookup keys */
	struct flowi		fl;

	struct in_device	*idev;
	
	unsigned		rt_flags;
	__u16			rt_type;
	__u16			rt_multipath_alg;

	__be32			rt_dst;	/* Path destination	*/
	__be32			rt_src;	/* Path source		*/
	int			rt_iif;

	/* Info on neighbour */
	__be32			rt_gateway;

	/* Miscellaneous cached information */
	__be32			rt_spec_dst; /* RFC1122 specific destination */
	struct inet_peer	*peer; /* long-living peer info */
};

struct ip_rt_acct
{
	__u32 	o_bytes;
	__u32 	o_packets;
	__u32 	i_bytes;
	__u32 	i_packets;
};

struct rt_cache_stat 
{
        unsigned int in_hit;
        unsigned int in_slow_tot;
        unsigned int in_slow_mc;
        unsigned int in_no_route;
        unsigned int in_brd;
        unsigned int in_martian_dst;
        unsigned int in_martian_src;
        unsigned int out_hit;
        unsigned int out_slow_tot;
        unsigned int out_slow_mc;
        unsigned int gc_total;
        unsigned int gc_ignored;
        unsigned int gc_goal_miss;
        unsigned int gc_dst_overflow;
        unsigned int in_hlist_search;
        unsigned int out_hlist_search;
};

extern struct ip_rt_acct *ip_rt_acct;

struct in_device;
extern int		ip_rt_init(void);
extern void		ip_rt_redirect(__be32 old_gw, __be32 dst, __be32 new_gw,
				       __be32 src, struct net_device *dev);
extern void		ip_rt_advice(struct rtable **rp, int advice);
extern void		rt_cache_flush(int how);
extern int		__ip_route_output_key(struct rtable **, const struct flowi *flp);
extern int		ip_route_output_key(struct rtable **, struct flowi *flp);
extern int		ip_route_output_flow(struct rtable **rp, struct flowi *flp, struct sock *sk, int flags);
extern int		ip_route_input(struct sk_buff*, __be32 dst, __be32 src, u8 tos, struct net_device *devin);
extern unsigned short	ip_rt_frag_needed(struct iphdr *iph, unsigned short new_mtu);
extern void		ip_rt_send_redirect(struct sk_buff *skb);

extern unsigned		inet_addr_type(__be32 addr);
extern void		ip_rt_multicast_event(struct in_device *);
extern int		ip_rt_ioctl(unsigned int cmd, void __user *arg);
extern void		ip_rt_get_source(u8 *src, struct rtable *rt);
extern int		ip_rt_dump(struct sk_buff *skb,  struct netlink_callback *cb);

struct in_ifaddr;
extern void fib_add_ifaddr(struct in_ifaddr *);

static inline void ip_rt_put(struct rtable * rt)
{
	if (rt)
		dst_release(&rt->u.dst);
}

#define IPTOS_RT_MASK	(IPTOS_TOS_MASK & ~3)

extern __u8 ip_tos2prio[16];

static inline char rt_tos2priority(u8 tos)
{
	return ip_tos2prio[IPTOS_TOS(tos)>>1];
}

static inline int ip_route_connect(struct rtable **rp, __be32 dst,
				   __be32 src, u32 tos, int oif, u8 protocol,
				   __be16 sport, __be16 dport, struct sock *sk,
				   int flags)
{
	struct flowi fl = { .oif = oif,
			    .nl_u = { .ip4_u = { .daddr = dst,
						 .saddr = src,
						 .tos   = tos } },
			    .proto = protocol,
			    .uli_u = { .ports =
				       { .sport = sport,
					 .dport = dport } } };

	int err;
	if (!dst || !src) {
		err = __ip_route_output_key(rp, &fl);
		if (err)
			return err;
		fl.fl4_dst = (*rp)->rt_dst;
		fl.fl4_src = (*rp)->rt_src;
		ip_rt_put(*rp);
		*rp = NULL;
	}
	security_sk_classify_flow(sk, &fl);
	return ip_route_output_flow(rp, &fl, sk, flags);
}

static inline int ip_route_newports(struct rtable **rp, u8 protocol,
				    __be16 sport, __be16 dport, struct sock *sk)
{
	if (sport != (*rp)->fl.fl_ip_sport ||
	    dport != (*rp)->fl.fl_ip_dport) {
		struct flowi fl;

		memcpy(&fl, &(*rp)->fl, sizeof(fl));
		fl.fl_ip_sport = sport;
		fl.fl_ip_dport = dport;
		fl.proto = protocol;
		ip_rt_put(*rp);
		*rp = NULL;
		security_sk_classify_flow(sk, &fl);
		return ip_route_output_flow(rp, &fl, sk, 0);
	}
	return 0;
}

extern void rt_bind_peer(struct rtable *rt, int create);

static inline struct inet_peer *rt_get_peer(struct rtable *rt)
{
	if (rt->peer)
		return rt->peer;

	rt_bind_peer(rt, 0);
	return rt->peer;
}

extern ctl_table ipv4_route_table[];

#endif	/* _ROUTE_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 IP router.
	7	*
	8	* Version: @(#)route.h 1.0.4 05/27/93
	9	*
02c30a84	10	* Authors: Ross Biro
1da177e4 LT	11	* Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
	12	* Fixes:
	13	* Alan Cox : Reformatted. Added ip_rt_local()
	14	* Alan Cox : Support for TCP parameters.
	15	* Alexey Kuznetsov: Major changes for new routing code.
	16	* Mike McLagan : Routing by source
	17	* Robert Olsson : Added rt_cache statistics
	18	*
	19	* This program is free software; you can redistribute it and/or
	20	* modify it under the terms of the GNU General Public License
	21	* as published by the Free Software Foundation; either version
	22	* 2 of the License, or (at your option) any later version.
	23	*/
	24	#ifndef _ROUTE_H
	25	#define _ROUTE_H
	26
1da177e4 LT	27	#include <net/dst.h>
	28	#include <net/inetpeer.h>
	29	#include <net/flow.h>
	30	#include <linux/in_route.h>
	31	#include <linux/rtnetlink.h>
	32	#include <linux/route.h>
	33	#include <linux/ip.h>
	34	#include <linux/cache.h>
beb8d13b	35	#include <linux/security.h>
1da177e4 LT	36
	37	#ifndef __KERNEL__
	38	#warning This file is not supposed to be used outside of kernel.
	39	#endif
	40
	41	#define RTO_ONLINK 0x01
	42
	43	#define RTO_CONN 0
	44	/* RTO_CONN is not used (being alias for 0), but preserved not to break
	45	* some modules referring to it. */
	46
	47	#define RT_CONN_FLAGS(sk) (RT_TOS(inet_sk(sk)->tos) \| sock_flag(sk, SOCK_LOCALROUTE))
	48
	49	struct fib_nh;
	50	struct inet_peer;
	51	struct rtable
	52	{
	53	union
	54	{
	55	struct dst_entry dst;
1da177e4 LT	56	} u;
1da177e4 LT	57
093c2ca4 ED	58	/* Cache lookup keys */
	59	struct flowi fl;
	60
1da177e4 LT	61	struct in_device *idev;
	62
	63	unsigned rt_flags;
	64	__u16 rt_type;
	65	__u16 rt_multipath_alg;
	66
f2c3fe24 AV	67	__be32 rt_dst; /* Path destination */
f2c3fe24 AV	68	__be32 rt_src; /* Path source */
1da177e4 LT	69	int rt_iif;
	70
	71	/* Info on neighbour */
f2c3fe24	72	__be32 rt_gateway;
1da177e4	73
1da177e4	74	/* Miscellaneous cached information */
f2c3fe24	75	__be32 rt_spec_dst; /* RFC1122 specific destination */
1da177e4 LT	76	struct inet_peer peer; / long-living peer info */
	77	};
	78
	79	struct ip_rt_acct
	80	{
	81	__u32 o_bytes;
	82	__u32 o_packets;
	83	__u32 i_bytes;
	84	__u32 i_packets;
	85	};
	86
	87	struct rt_cache_stat
	88	{
	89	unsigned int in_hit;
	90	unsigned int in_slow_tot;
	91	unsigned int in_slow_mc;
	92	unsigned int in_no_route;
	93	unsigned int in_brd;
	94	unsigned int in_martian_dst;
	95	unsigned int in_martian_src;
	96	unsigned int out_hit;
	97	unsigned int out_slow_tot;
	98	unsigned int out_slow_mc;
	99	unsigned int gc_total;
	100	unsigned int gc_ignored;
	101	unsigned int gc_goal_miss;
	102	unsigned int gc_dst_overflow;
	103	unsigned int in_hlist_search;
	104	unsigned int out_hlist_search;
	105	};
	106
1da177e4 LT	107	extern struct ip_rt_acct *ip_rt_acct;
	108
	109	struct in_device;
	110	extern int ip_rt_init(void);
f7655229 AV	111	extern void ip_rt_redirect(__be32 old_gw, __be32 dst, __be32 new_gw,
f7655229 AV	112	__be32 src, struct net_device *dev);
1da177e4 LT	113	extern void ip_rt_advice(struct rtable **rp, int advice);
	114	extern void rt_cache_flush(int how);
	115	extern int __ip_route_output_key(struct rtable *, const struct flowi flp);
	116	extern int ip_route_output_key(struct rtable *, struct flowi flp);
	117	extern int ip_route_output_flow(struct rtable *rp, struct flowi flp, struct sock *sk, int flags);
9e12bb22	118	extern int ip_route_input(struct sk_buff, __be32 dst, __be32 src, u8 tos, struct net_device devin);
1da177e4 LT	119	extern unsigned short ip_rt_frag_needed(struct iphdr *iph, unsigned short new_mtu);
	120	extern void ip_rt_send_redirect(struct sk_buff *skb);
	121
fd683222	122	extern unsigned inet_addr_type(__be32 addr);
1da177e4 LT	123	extern void ip_rt_multicast_event(struct in_device *);
	124	extern int ip_rt_ioctl(unsigned int cmd, void __user *arg);
	125	extern void ip_rt_get_source(u8 src, struct rtable rt);
	126	extern int ip_rt_dump(struct sk_buff skb, struct netlink_callback cb);
	127
0ff60a45 JHS	128	struct in_ifaddr;
	129	extern void fib_add_ifaddr(struct in_ifaddr *);
	130
1da177e4 LT	131	static inline void ip_rt_put(struct rtable * rt)
	132	{
	133	if (rt)
	134	dst_release(&rt->u.dst);
	135	}
	136
	137	#define IPTOS_RT_MASK (IPTOS_TOS_MASK & ~3)
	138
	139	extern __u8 ip_tos2prio[16];
	140
	141	static inline char rt_tos2priority(u8 tos)
	142	{
	143	return ip_tos2prio[IPTOS_TOS(tos)>>1];
	144	}
	145
bada8adc AV	146	static inline int ip_route_connect(struct rtable **rp, __be32 dst,
bada8adc AV	147	__be32 src, u32 tos, int oif, u8 protocol,
8eb9086f DM	148	__be16 sport, __be16 dport, struct sock *sk,
8eb9086f DM	149	int flags)
1da177e4 LT	150	{
	151	struct flowi fl = { .oif = oif,
	152	.nl_u = { .ip4_u = { .daddr = dst,
	153	.saddr = src,
	154	.tos = tos } },
	155	.proto = protocol,
	156	.uli_u = { .ports =
	157	{ .sport = sport,
	158	.dport = dport } } };
	159
	160	int err;
	161	if (!dst \|\| !src) {
	162	err = __ip_route_output_key(rp, &fl);
	163	if (err)
	164	return err;
	165	fl.fl4_dst = (*rp)->rt_dst;
	166	fl.fl4_src = (*rp)->rt_src;
	167	ip_rt_put(*rp);
	168	*rp = NULL;
	169	}
beb8d13b	170	security_sk_classify_flow(sk, &fl);
8eb9086f	171	return ip_route_output_flow(rp, &fl, sk, flags);
1da177e4 LT	172	}
1da177e4 LT	173
5d39a795	174	static inline int ip_route_newports(struct rtable **rp, u8 protocol,
39dccd9d	175	__be16 sport, __be16 dport, struct sock *sk)
1da177e4 LT	176	{
	177	if (sport != (*rp)->fl.fl_ip_sport \|\|
	178	dport != (*rp)->fl.fl_ip_dport) {
	179	struct flowi fl;
	180
	181	memcpy(&fl, &(*rp)->fl, sizeof(fl));
	182	fl.fl_ip_sport = sport;
	183	fl.fl_ip_dport = dport;
5d39a795	184	fl.proto = protocol;
1da177e4 LT	185	ip_rt_put(*rp);
1da177e4 LT	186	*rp = NULL;
beb8d13b	187	security_sk_classify_flow(sk, &fl);
1da177e4 LT	188	return ip_route_output_flow(rp, &fl, sk, 0);
	189	}
	190	return 0;
	191	}
	192
	193	extern void rt_bind_peer(struct rtable *rt, int create);
	194
	195	static inline struct inet_peer rt_get_peer(struct rtable rt)
	196	{
	197	if (rt->peer)
	198	return rt->peer;
	199
	200	rt_bind_peer(rt, 0);
	201	return rt->peer;
	202	}
	203
20380731 ACM	204	extern ctl_table ipv4_route_table[];
20380731 ACM	205
1da177e4	206	#endif /* _ROUTE_H */