xref: /openbmc/linux/include/net/route.h (revision 6df59a84)
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  *
10  * Authors:	Ross Biro
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 
27 #include <net/dst.h>
28 #include <net/inetpeer.h>
29 #include <net/flow.h>
30 #include <net/inet_sock.h>
31 #include <linux/in_route.h>
32 #include <linux/rtnetlink.h>
33 #include <linux/route.h>
34 #include <linux/ip.h>
35 #include <linux/cache.h>
36 #include <linux/security.h>
37 
38 #ifndef __KERNEL__
39 #warning This file is not supposed to be used outside of kernel.
40 #endif
41 
42 #define RTO_ONLINK	0x01
43 
44 #define RTO_CONN	0
45 /* RTO_CONN is not used (being alias for 0), but preserved not to break
46  * some modules referring to it. */
47 
48 #define RT_CONN_FLAGS(sk)   (RT_TOS(inet_sk(sk)->tos) | sock_flag(sk, SOCK_LOCALROUTE))
49 
50 struct fib_nh;
51 struct inet_peer;
52 struct fib_info;
53 struct rtable {
54 	struct dst_entry	dst;
55 
56 	/* Lookup key. */
57 	__be32			rt_key_dst;
58 	__be32			rt_key_src;
59 
60 	int			rt_genid;
61 	unsigned		rt_flags;
62 	__u16			rt_type;
63 	__u8			rt_tos;
64 
65 	__be32			rt_dst;	/* Path destination	*/
66 	__be32			rt_src;	/* Path source		*/
67 	int			rt_iif;
68 	int			rt_oif;
69 	__u32			rt_mark;
70 
71 	/* Info on neighbour */
72 	__be32			rt_gateway;
73 
74 	/* Miscellaneous cached information */
75 	__be32			rt_spec_dst; /* RFC1122 specific destination */
76 	u32			rt_peer_genid;
77 	struct inet_peer	*peer; /* long-living peer info */
78 	struct fib_info		*fi; /* for client ref to shared metrics */
79 };
80 
81 static inline bool rt_is_input_route(struct rtable *rt)
82 {
83 	return rt->rt_iif != 0;
84 }
85 
86 static inline bool rt_is_output_route(struct rtable *rt)
87 {
88 	return rt->rt_iif == 0;
89 }
90 
91 struct ip_rt_acct {
92 	__u32 	o_bytes;
93 	__u32 	o_packets;
94 	__u32 	i_bytes;
95 	__u32 	i_packets;
96 };
97 
98 struct rt_cache_stat {
99         unsigned int in_hit;
100         unsigned int in_slow_tot;
101         unsigned int in_slow_mc;
102         unsigned int in_no_route;
103         unsigned int in_brd;
104         unsigned int in_martian_dst;
105         unsigned int in_martian_src;
106         unsigned int out_hit;
107         unsigned int out_slow_tot;
108         unsigned int out_slow_mc;
109         unsigned int gc_total;
110         unsigned int gc_ignored;
111         unsigned int gc_goal_miss;
112         unsigned int gc_dst_overflow;
113         unsigned int in_hlist_search;
114         unsigned int out_hlist_search;
115 };
116 
117 extern struct ip_rt_acct __percpu *ip_rt_acct;
118 
119 struct in_device;
120 extern int		ip_rt_init(void);
121 extern void		ip_rt_redirect(__be32 old_gw, __be32 dst, __be32 new_gw,
122 				       __be32 src, struct net_device *dev);
123 extern void		rt_cache_flush(struct net *net, int how);
124 extern void		rt_cache_flush_batch(struct net *net);
125 extern struct rtable *__ip_route_output_key(struct net *, const struct flowi4 *flp);
126 extern struct rtable *ip_route_output_flow(struct net *, struct flowi4 *flp,
127 					   struct sock *sk);
128 extern struct dst_entry *ipv4_blackhole_route(struct net *net, struct dst_entry *dst_orig);
129 
130 static inline struct rtable *ip_route_output_key(struct net *net, struct flowi4 *flp)
131 {
132 	return ip_route_output_flow(net, flp, NULL);
133 }
134 
135 static inline struct rtable *ip_route_output(struct net *net, __be32 daddr,
136 					     __be32 saddr, u8 tos, int oif)
137 {
138 	struct flowi4 fl4 = {
139 		.flowi4_oif = oif,
140 		.daddr = daddr,
141 		.saddr = saddr,
142 		.flowi4_tos = tos,
143 	};
144 	return ip_route_output_key(net, &fl4);
145 }
146 
147 static inline struct rtable *ip_route_output_ports(struct net *net, struct sock *sk,
148 						   __be32 daddr, __be32 saddr,
149 						   __be16 dport, __be16 sport,
150 						   __u8 proto, __u8 tos, int oif)
151 {
152 	struct flowi4 fl4 = {
153 		.flowi4_oif = oif,
154 		.flowi4_flags = sk ? inet_sk_flowi_flags(sk) : 0,
155 		.flowi4_mark = sk ? sk->sk_mark : 0,
156 		.daddr = daddr,
157 		.saddr = saddr,
158 		.flowi4_tos = tos,
159 		.flowi4_proto = proto,
160 		.fl4_dport = dport,
161 		.fl4_sport = sport,
162 	};
163 	if (sk)
164 		security_sk_classify_flow(sk, flowi4_to_flowi(&fl4));
165 	return ip_route_output_flow(net, &fl4, sk);
166 }
167 
168 static inline struct rtable *ip_route_output_gre(struct net *net,
169 						 __be32 daddr, __be32 saddr,
170 						 __be32 gre_key, __u8 tos, int oif)
171 {
172 	struct flowi4 fl4 = {
173 		.flowi4_oif = oif,
174 		.daddr = daddr,
175 		.saddr = saddr,
176 		.flowi4_tos = tos,
177 		.flowi4_proto = IPPROTO_GRE,
178 		.fl4_gre_key = gre_key,
179 	};
180 	return ip_route_output_key(net, &fl4);
181 }
182 
183 extern int ip_route_input_common(struct sk_buff *skb, __be32 dst, __be32 src,
184 				 u8 tos, struct net_device *devin, bool noref);
185 
186 static inline int ip_route_input(struct sk_buff *skb, __be32 dst, __be32 src,
187 				 u8 tos, struct net_device *devin)
188 {
189 	return ip_route_input_common(skb, dst, src, tos, devin, false);
190 }
191 
192 static inline int ip_route_input_noref(struct sk_buff *skb, __be32 dst, __be32 src,
193 				       u8 tos, struct net_device *devin)
194 {
195 	return ip_route_input_common(skb, dst, src, tos, devin, true);
196 }
197 
198 extern unsigned short	ip_rt_frag_needed(struct net *net, struct iphdr *iph, unsigned short new_mtu, struct net_device *dev);
199 extern void		ip_rt_send_redirect(struct sk_buff *skb);
200 
201 extern unsigned		inet_addr_type(struct net *net, __be32 addr);
202 extern unsigned		inet_dev_addr_type(struct net *net, const struct net_device *dev, __be32 addr);
203 extern void		ip_rt_multicast_event(struct in_device *);
204 extern int		ip_rt_ioctl(struct net *, unsigned int cmd, void __user *arg);
205 extern void		ip_rt_get_source(u8 *src, struct rtable *rt);
206 extern int		ip_rt_dump(struct sk_buff *skb,  struct netlink_callback *cb);
207 
208 struct in_ifaddr;
209 extern void fib_add_ifaddr(struct in_ifaddr *);
210 extern void fib_del_ifaddr(struct in_ifaddr *, struct in_ifaddr *);
211 
212 static inline void ip_rt_put(struct rtable * rt)
213 {
214 	if (rt)
215 		dst_release(&rt->dst);
216 }
217 
218 #define IPTOS_RT_MASK	(IPTOS_TOS_MASK & ~3)
219 
220 extern const __u8 ip_tos2prio[16];
221 
222 static inline char rt_tos2priority(u8 tos)
223 {
224 	return ip_tos2prio[IPTOS_TOS(tos)>>1];
225 }
226 
227 static inline struct rtable *ip_route_connect(__be32 dst, __be32 src, u32 tos,
228 					      int oif, u8 protocol,
229 					      __be16 sport, __be16 dport,
230 					      struct sock *sk, bool can_sleep)
231 {
232 	struct flowi4 fl4 = {
233 		.flowi4_oif = oif,
234 		.flowi4_mark = sk->sk_mark,
235 		.daddr = dst,
236 		.saddr = src,
237 		.flowi4_tos = tos,
238 		.flowi4_proto = protocol,
239 		.fl4_sport = sport,
240 		.fl4_dport = dport,
241 	};
242 	struct net *net = sock_net(sk);
243 	struct rtable *rt;
244 
245 	if (inet_sk(sk)->transparent)
246 		fl4.flowi4_flags |= FLOWI_FLAG_ANYSRC;
247 	if (protocol == IPPROTO_TCP)
248 		fl4.flowi4_flags |= FLOWI_FLAG_PRECOW_METRICS;
249 	if (can_sleep)
250 		fl4.flowi4_flags |= FLOWI_FLAG_CAN_SLEEP;
251 
252 	if (!dst || !src) {
253 		rt = __ip_route_output_key(net, &fl4);
254 		if (IS_ERR(rt))
255 			return rt;
256 		fl4.daddr = rt->rt_dst;
257 		fl4.saddr = rt->rt_src;
258 		ip_rt_put(rt);
259 	}
260 	security_sk_classify_flow(sk, flowi4_to_flowi(&fl4));
261 	return ip_route_output_flow(net, &fl4, sk);
262 }
263 
264 static inline struct rtable *ip_route_newports(struct rtable *rt,
265 					       u8 protocol, __be16 orig_sport,
266 					       __be16 orig_dport, __be16 sport,
267 					       __be16 dport, struct sock *sk)
268 {
269 	if (sport != orig_sport || dport != orig_dport) {
270 		struct flowi4 fl4 = {
271 			.flowi4_oif = rt->rt_oif,
272 			.flowi4_mark = rt->rt_mark,
273 			.daddr = rt->rt_dst,
274 			.saddr = rt->rt_src,
275 			.flowi4_tos = rt->rt_tos,
276 			.flowi4_proto = protocol,
277 			.fl4_sport = sport,
278 			.fl4_dport = dport
279 		};
280 		if (inet_sk(sk)->transparent)
281 			fl4.flowi4_flags |= FLOWI_FLAG_ANYSRC;
282 		if (protocol == IPPROTO_TCP)
283 			fl4.flowi4_flags |= FLOWI_FLAG_PRECOW_METRICS;
284 		ip_rt_put(rt);
285 		security_sk_classify_flow(sk, flowi4_to_flowi(&fl4));
286 		return ip_route_output_flow(sock_net(sk), &fl4, sk);
287 	}
288 	return rt;
289 }
290 
291 extern void rt_bind_peer(struct rtable *rt, int create);
292 
293 static inline struct inet_peer *rt_get_peer(struct rtable *rt)
294 {
295 	if (rt->peer)
296 		return rt->peer;
297 
298 	rt_bind_peer(rt, 0);
299 	return rt->peer;
300 }
301 
302 static inline int inet_iif(const struct sk_buff *skb)
303 {
304 	return skb_rtable(skb)->rt_iif;
305 }
306 
307 extern int sysctl_ip_default_ttl;
308 
309 static inline int ip4_dst_hoplimit(const struct dst_entry *dst)
310 {
311 	int hoplimit = dst_metric_raw(dst, RTAX_HOPLIMIT);
312 
313 	if (hoplimit == 0)
314 		hoplimit = sysctl_ip_default_ttl;
315 	return hoplimit;
316 }
317 
318 #endif	/* _ROUTE_H */
319