route.h 10.4 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9
/*
 * 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
 *
10
 * Authors:	Ross Biro
Linus Torvalds's avatar
Linus Torvalds committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *		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>
30
#include <net/inet_sock.h>
Linus Torvalds's avatar
Linus Torvalds committed
31 32 33 34 35
#include <linux/in_route.h>
#include <linux/rtnetlink.h>
#include <linux/route.h>
#include <linux/ip.h>
#include <linux/cache.h>
36
#include <linux/security.h>
Linus Torvalds's avatar
Linus Torvalds committed
37 38 39 40 41 42 43

#define RTO_ONLINK	0x01

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

struct fib_nh;
struct inet_peer;
44
struct fib_info;
Eric Dumazet's avatar
Eric Dumazet committed
45
struct rtable {
46
	struct dst_entry	dst;
Linus Torvalds's avatar
Linus Torvalds committed
47

48 49 50
	/* Lookup key. */
	__be32			rt_key_dst;
	__be32			rt_key_src;
51

52
	int			rt_genid;
53
	unsigned int		rt_flags;
Linus Torvalds's avatar
Linus Torvalds committed
54
	__u16			rt_type;
55
	__u8			rt_key_tos;
Linus Torvalds's avatar
Linus Torvalds committed
56

57 58
	__be32			rt_dst;	/* Path destination	*/
	__be32			rt_src;	/* Path source		*/
59
	int			rt_route_iif;
Linus Torvalds's avatar
Linus Torvalds committed
60
	int			rt_iif;
61 62
	int			rt_oif;
	__u32			rt_mark;
Linus Torvalds's avatar
Linus Torvalds committed
63 64

	/* Info on neighbour */
65
	__be32			rt_gateway;
Linus Torvalds's avatar
Linus Torvalds committed
66 67

	/* Miscellaneous cached information */
68
	u32			rt_peer_genid;
69
	unsigned long		_peer; /* long-living peer info */
70
	struct fib_info		*fi; /* for client ref to shared metrics */
Linus Torvalds's avatar
Linus Torvalds committed
71 72
};

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
static inline struct inet_peer *rt_peer_ptr(struct rtable *rt)
{
	return inetpeer_ptr(rt->_peer);
}

static inline bool rt_has_peer(struct rtable *rt)
{
	return inetpeer_ptr_is_peer(rt->_peer);
}

static inline void __rt_set_peer(struct rtable *rt, struct inet_peer *peer)
{
	__inetpeer_ptr_set_peer(&rt->_peer, peer);
}

static inline bool rt_set_peer(struct rtable *rt, struct inet_peer *peer)
{
	return inetpeer_ptr_set_peer(&rt->_peer, peer);
}

static inline void rt_init_peer(struct rtable *rt, struct inet_peer_base *base)
{
	inetpeer_init_ptr(&rt->_peer, base);
}

static inline void rt_transfer_peer(struct rtable *rt, struct rtable *ort)
{
	rt->_peer = ort->_peer;
	if (rt_has_peer(ort)) {
		struct inet_peer *peer = rt_peer_ptr(ort);
		atomic_inc(&peer->refcnt);
	}
}

107
static inline bool rt_is_input_route(const struct rtable *rt)
108
{
109
	return rt->rt_route_iif != 0;
110 111
}

112
static inline bool rt_is_output_route(const struct rtable *rt)
113
{
114
	return rt->rt_route_iif == 0;
115 116
}

Eric Dumazet's avatar
Eric Dumazet committed
117
struct ip_rt_acct {
Linus Torvalds's avatar
Linus Torvalds committed
118 119 120 121 122 123
	__u32 	o_bytes;
	__u32 	o_packets;
	__u32 	i_bytes;
	__u32 	i_packets;
};

Eric Dumazet's avatar
Eric Dumazet committed
124
struct rt_cache_stat {
Linus Torvalds's avatar
Linus Torvalds committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
        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;
};

143
extern struct ip_rt_acct __percpu *ip_rt_acct;
Linus Torvalds's avatar
Linus Torvalds committed
144 145 146

struct in_device;
extern int		ip_rt_init(void);
Al Viro's avatar
Al Viro committed
147 148
extern void		ip_rt_redirect(__be32 old_gw, __be32 dst, __be32 new_gw,
				       __be32 src, struct net_device *dev);
149
extern void		rt_cache_flush(struct net *net, int how);
150
extern void		rt_cache_flush_batch(struct net *net);
151
extern struct rtable *__ip_route_output_key(struct net *, struct flowi4 *flp);
152
extern struct rtable *ip_route_output_flow(struct net *, struct flowi4 *flp,
153
					   struct sock *sk);
154
extern struct dst_entry *ipv4_blackhole_route(struct net *net, struct dst_entry *dst_orig);
155

156
static inline struct rtable *ip_route_output_key(struct net *net, struct flowi4 *flp)
157 158 159 160
{
	return ip_route_output_flow(net, flp, NULL);
}

161 162 163
static inline struct rtable *ip_route_output(struct net *net, __be32 daddr,
					     __be32 saddr, u8 tos, int oif)
{
164 165
	struct flowi4 fl4 = {
		.flowi4_oif = oif,
166
		.flowi4_tos = tos,
167 168
		.daddr = daddr,
		.saddr = saddr,
169
	};
170
	return ip_route_output_key(net, &fl4);
171 172
}

173 174
static inline struct rtable *ip_route_output_ports(struct net *net, struct flowi4 *fl4,
						   struct sock *sk,
175 176 177 178
						   __be32 daddr, __be32 saddr,
						   __be16 dport, __be16 sport,
						   __u8 proto, __u8 tos, int oif)
{
179
	flowi4_init_output(fl4, oif, sk ? sk->sk_mark : 0, tos,
180 181 182
			   RT_SCOPE_UNIVERSE, proto,
			   sk ? inet_sk_flowi_flags(sk) : 0,
			   daddr, saddr, dport, sport);
183
	if (sk)
184 185
		security_sk_classify_flow(sk, flowi4_to_flowi(fl4));
	return ip_route_output_flow(net, fl4, sk);
186 187
}

188
static inline struct rtable *ip_route_output_gre(struct net *net, struct flowi4 *fl4,
189 190 191
						 __be32 daddr, __be32 saddr,
						 __be32 gre_key, __u8 tos, int oif)
{
192 193 194 195 196 197 198 199
	memset(fl4, 0, sizeof(*fl4));
	fl4->flowi4_oif = oif;
	fl4->daddr = daddr;
	fl4->saddr = saddr;
	fl4->flowi4_tos = tos;
	fl4->flowi4_proto = IPPROTO_GRE;
	fl4->fl4_gre_key = gre_key;
	return ip_route_output_key(net, fl4);
200 201
}

202
extern int ip_route_input_common(struct sk_buff *skb, __be32 dst, __be32 src,
203
				 u8 tos, struct net_device *devin, bool noref);
204 205 206 207

static inline int ip_route_input(struct sk_buff *skb, __be32 dst, __be32 src,
				 u8 tos, struct net_device *devin)
{
208
	return ip_route_input_common(skb, dst, src, tos, devin, false);
209 210 211
}

static inline int ip_route_input_noref(struct sk_buff *skb, __be32 dst, __be32 src,
212
				       u8 tos, struct net_device *devin)
213
{
214
	return ip_route_input_common(skb, dst, src, tos, devin, true);
215 216
}

217 218 219 220
extern void ipv4_update_pmtu(struct sk_buff *skb, struct net *net, u32 mtu,
			     int oif, u32 mark, u8 protocol, int flow_flags);
extern void ipv4_sk_update_pmtu(struct sk_buff *skb, struct sock *sk, u32 mtu);
extern void ip_rt_send_redirect(struct sk_buff *skb);
Linus Torvalds's avatar
Linus Torvalds committed
221

222 223
extern unsigned int		inet_addr_type(struct net *net, __be32 addr);
extern unsigned int		inet_dev_addr_type(struct net *net, const struct net_device *dev, __be32 addr);
Linus Torvalds's avatar
Linus Torvalds committed
224
extern void		ip_rt_multicast_event(struct in_device *);
225
extern int		ip_rt_ioctl(struct net *, unsigned int cmd, void __user *arg);
226
extern void		ip_rt_get_source(u8 *src, struct sk_buff *skb, struct rtable *rt);
Linus Torvalds's avatar
Linus Torvalds committed
227 228
extern int		ip_rt_dump(struct sk_buff *skb,  struct netlink_callback *cb);

229 230
struct in_ifaddr;
extern void fib_add_ifaddr(struct in_ifaddr *);
231
extern void fib_del_ifaddr(struct in_ifaddr *, struct in_ifaddr *);
232

Linus Torvalds's avatar
Linus Torvalds committed
233 234 235
static inline void ip_rt_put(struct rtable * rt)
{
	if (rt)
236
		dst_release(&rt->dst);
Linus Torvalds's avatar
Linus Torvalds committed
237 238 239 240
}

#define IPTOS_RT_MASK	(IPTOS_TOS_MASK & ~3)

241
extern const __u8 ip_tos2prio[16];
Linus Torvalds's avatar
Linus Torvalds committed
242 243 244 245 246 247

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

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/* ip_route_connect() and ip_route_newports() work in tandem whilst
 * binding a socket for a new outgoing connection.
 *
 * In order to use IPSEC properly, we must, in the end, have a
 * route that was looked up using all available keys including source
 * and destination ports.
 *
 * However, if a source port needs to be allocated (the user specified
 * a wildcard source port) we need to obtain addressing information
 * in order to perform that allocation.
 *
 * So ip_route_connect() looks up a route using wildcarded source and
 * destination ports in the key, simply so that we can get a pair of
 * addresses to use for port allocation.
 *
 * Later, once the ports are allocated, ip_route_newports() will make
 * another route lookup if needed to make sure we catch any IPSEC
 * rules keyed on the port information.
 *
 * The callers allocate the flow key on their stack, and must pass in
 * the same flowi4 object to both the ip_route_connect() and the
 * ip_route_newports() calls.
 */

static inline void ip_route_connect_init(struct flowi4 *fl4, __be32 dst, __be32 src,
					 u32 tos, int oif, u8 protocol,
					 __be16 sport, __be16 dport,
					 struct sock *sk, bool can_sleep)
Linus Torvalds's avatar
Linus Torvalds committed
276
{
277
	__u8 flow_flags = 0;
278 279

	if (inet_sk(sk)->transparent)
280
		flow_flags |= FLOWI_FLAG_ANYSRC;
281
	if (can_sleep)
282 283
		flow_flags |= FLOWI_FLAG_CAN_SLEEP;

284
	flowi4_init_output(fl4, oif, sk->sk_mark, tos, RT_SCOPE_UNIVERSE,
285
			   protocol, flow_flags, dst, src, dport, sport);
286 287 288 289 290 291 292 293 294 295 296 297 298
}

static inline struct rtable *ip_route_connect(struct flowi4 *fl4,
					      __be32 dst, __be32 src, u32 tos,
					      int oif, u8 protocol,
					      __be16 sport, __be16 dport,
					      struct sock *sk, bool can_sleep)
{
	struct net *net = sock_net(sk);
	struct rtable *rt;

	ip_route_connect_init(fl4, dst, src, tos, oif, protocol,
			      sport, dport, sk, can_sleep);
299

Linus Torvalds's avatar
Linus Torvalds committed
300
	if (!dst || !src) {
301
		rt = __ip_route_output_key(net, fl4);
302 303 304
		if (IS_ERR(rt))
			return rt;
		ip_rt_put(rt);
305
		flowi4_update_output(fl4, oif, tos, fl4->daddr, fl4->saddr);
Linus Torvalds's avatar
Linus Torvalds committed
306
	}
307 308
	security_sk_classify_flow(sk, flowi4_to_flowi(fl4));
	return ip_route_output_flow(net, fl4, sk);
Linus Torvalds's avatar
Linus Torvalds committed
309 310
}

311 312 313 314
static inline struct rtable *ip_route_newports(struct flowi4 *fl4, struct rtable *rt,
					       __be16 orig_sport, __be16 orig_dport,
					       __be16 sport, __be16 dport,
					       struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
315
{
316
	if (sport != orig_sport || dport != orig_dport) {
317 318
		fl4->fl4_dport = dport;
		fl4->fl4_sport = sport;
319
		ip_rt_put(rt);
320 321 322
		flowi4_update_output(fl4, sk->sk_bound_dev_if,
				     RT_CONN_FLAGS(sk), fl4->daddr,
				     fl4->saddr);
323 324
		security_sk_classify_flow(sk, flowi4_to_flowi(fl4));
		return ip_route_output_flow(sock_net(sk), fl4, sk);
Linus Torvalds's avatar
Linus Torvalds committed
325
	}
326
	return rt;
Linus Torvalds's avatar
Linus Torvalds committed
327 328
}

329
extern void rt_bind_peer(struct rtable *rt, __be32 daddr, int create);
Linus Torvalds's avatar
Linus Torvalds committed
330

331
static inline struct inet_peer *__rt_get_peer(struct rtable *rt, __be32 daddr, int create)
Linus Torvalds's avatar
Linus Torvalds committed
332
{
333 334
	if (rt_has_peer(rt))
		return rt_peer_ptr(rt);
Linus Torvalds's avatar
Linus Torvalds committed
335

336
	rt_bind_peer(rt, daddr, create);
337
	return (rt_has_peer(rt) ? rt_peer_ptr(rt) : NULL);
Linus Torvalds's avatar
Linus Torvalds committed
338 339
}

340 341 342 343 344 345 346 347 348 349
static inline struct inet_peer *rt_get_peer(struct rtable *rt, __be32 daddr)
{
	return __rt_get_peer(rt, daddr, 0);
}

static inline struct inet_peer *rt_get_peer_create(struct rtable *rt, __be32 daddr)
{
	return __rt_get_peer(rt, daddr, 1);
}

350 351
static inline int inet_iif(const struct sk_buff *skb)
{
Eric Dumazet's avatar
Eric Dumazet committed
352
	return skb_rtable(skb)->rt_iif;
353 354
}

355 356 357 358 359 360 361 362 363 364 365
extern int sysctl_ip_default_ttl;

static inline int ip4_dst_hoplimit(const struct dst_entry *dst)
{
	int hoplimit = dst_metric_raw(dst, RTAX_HOPLIMIT);

	if (hoplimit == 0)
		hoplimit = sysctl_ip_default_ttl;
	return hoplimit;
}

Linus Torvalds's avatar
Linus Torvalds committed
366
#endif	/* _ROUTE_H */