xref: /openbmc/linux/include/net/ipv6.h (revision b1cacb6820e0afc4aeeea67bcb5296a316862cad)
1 /*
2  *	Linux INET6 implementation
3  *
4  *	Authors:
5  *	Pedro Roque		<roque@di.fc.ul.pt>
6  *
7  *	$Id: ipv6.h,v 1.1 2002/05/20 15:13:07 jgrimm Exp $
8  *
9  *	This program is free software; you can redistribute it and/or
10  *      modify it under the terms of the GNU General Public License
11  *      as published by the Free Software Foundation; either version
12  *      2 of the License, or (at your option) any later version.
13  */
14 
15 #ifndef _NET_IPV6_H
16 #define _NET_IPV6_H
17 
18 #include <linux/ipv6.h>
19 #include <linux/hardirq.h>
20 #include <net/ndisc.h>
21 #include <net/flow.h>
22 #include <net/snmp.h>
23 
24 #define SIN6_LEN_RFC2133	24
25 
26 #define IPV6_MAXPLEN		65535
27 
28 /*
29  *	NextHeader field of IPv6 header
30  */
31 
32 #define NEXTHDR_HOP		0	/* Hop-by-hop option header. */
33 #define NEXTHDR_TCP		6	/* TCP segment. */
34 #define NEXTHDR_UDP		17	/* UDP message. */
35 #define NEXTHDR_IPV6		41	/* IPv6 in IPv6 */
36 #define NEXTHDR_ROUTING		43	/* Routing header. */
37 #define NEXTHDR_FRAGMENT	44	/* Fragmentation/reassembly header. */
38 #define NEXTHDR_ESP		50	/* Encapsulating security payload. */
39 #define NEXTHDR_AUTH		51	/* Authentication header. */
40 #define NEXTHDR_ICMP		58	/* ICMP for IPv6. */
41 #define NEXTHDR_NONE		59	/* No next header */
42 #define NEXTHDR_DEST		60	/* Destination options header. */
43 
44 #define NEXTHDR_MAX		255
45 
46 
47 
48 #define IPV6_DEFAULT_HOPLIMIT   64
49 #define IPV6_DEFAULT_MCASTHOPS	1
50 
51 /*
52  *	Addr type
53  *
54  *	type	-	unicast | multicast
55  *	scope	-	local	| site	    | global
56  *	v4	-	compat
57  *	v4mapped
58  *	any
59  *	loopback
60  */
61 
62 #define IPV6_ADDR_ANY		0x0000U
63 
64 #define IPV6_ADDR_UNICAST      	0x0001U
65 #define IPV6_ADDR_MULTICAST    	0x0002U
66 
67 #define IPV6_ADDR_LOOPBACK	0x0010U
68 #define IPV6_ADDR_LINKLOCAL	0x0020U
69 #define IPV6_ADDR_SITELOCAL	0x0040U
70 
71 #define IPV6_ADDR_COMPATv4	0x0080U
72 
73 #define IPV6_ADDR_SCOPE_MASK	0x00f0U
74 
75 #define IPV6_ADDR_MAPPED	0x1000U
76 #define IPV6_ADDR_RESERVED	0x2000U	/* reserved address space */
77 
78 /*
79  *	Addr scopes
80  */
81 #ifdef __KERNEL__
82 #define IPV6_ADDR_MC_SCOPE(a)	\
83 	((a)->s6_addr[1] & 0x0f)	/* nonstandard */
84 #define __IPV6_ADDR_SCOPE_INVALID	-1
85 #endif
86 #define IPV6_ADDR_SCOPE_NODELOCAL	0x01
87 #define IPV6_ADDR_SCOPE_LINKLOCAL	0x02
88 #define IPV6_ADDR_SCOPE_SITELOCAL	0x05
89 #define IPV6_ADDR_SCOPE_ORGLOCAL	0x08
90 #define IPV6_ADDR_SCOPE_GLOBAL		0x0e
91 
92 /*
93  *	fragmentation header
94  */
95 
96 struct frag_hdr {
97 	unsigned char	nexthdr;
98 	unsigned char	reserved;
99 	unsigned short	frag_off;
100 	__u32		identification;
101 };
102 
103 #define	IP6_MF	0x0001
104 
105 #ifdef __KERNEL__
106 
107 #include <linux/config.h>
108 #include <net/sock.h>
109 
110 /* sysctls */
111 extern int sysctl_ipv6_bindv6only;
112 extern int sysctl_mld_max_msf;
113 
114 /* MIBs */
115 DECLARE_SNMP_STAT(struct ipstats_mib, ipv6_statistics);
116 #define IP6_INC_STATS(field)		SNMP_INC_STATS(ipv6_statistics, field)
117 #define IP6_INC_STATS_BH(field)		SNMP_INC_STATS_BH(ipv6_statistics, field)
118 #define IP6_INC_STATS_USER(field) 	SNMP_INC_STATS_USER(ipv6_statistics, field)
119 DECLARE_SNMP_STAT(struct icmpv6_mib, icmpv6_statistics);
120 #define ICMP6_INC_STATS(idev, field)		({			\
121 	struct inet6_dev *_idev = (idev);				\
122 	if (likely(_idev != NULL))					\
123 		SNMP_INC_STATS(idev->stats.icmpv6, field); 		\
124 	SNMP_INC_STATS(icmpv6_statistics, field);			\
125 })
126 #define ICMP6_INC_STATS_BH(idev, field)		({			\
127 	struct inet6_dev *_idev = (idev);				\
128 	if (likely(_idev != NULL))					\
129 		SNMP_INC_STATS_BH((_idev)->stats.icmpv6, field);	\
130 	SNMP_INC_STATS_BH(icmpv6_statistics, field);			\
131 })
132 #define ICMP6_INC_STATS_USER(idev, field) 	({			\
133 	struct inet6_dev *_idev = (idev);				\
134 	if (likely(_idev != NULL))					\
135 		SNMP_INC_STATS_USER(_idev->stats.icmpv6, field);	\
136 	SNMP_INC_STATS_USER(icmpv6_statistics, field);			\
137 })
138 #define ICMP6_INC_STATS_OFFSET_BH(idev, field, offset)	({			\
139 	struct inet6_dev *_idev = idev;						\
140 	__typeof__(offset) _offset = (offset);					\
141 	if (likely(_idev != NULL))						\
142 		SNMP_INC_STATS_OFFSET_BH(_idev->stats.icmpv6, field, _offset);	\
143 	SNMP_INC_STATS_OFFSET_BH(icmpv6_statistics, field, _offset);    	\
144 })
145 DECLARE_SNMP_STAT(struct udp_mib, udp_stats_in6);
146 #define UDP6_INC_STATS(field)		SNMP_INC_STATS(udp_stats_in6, field)
147 #define UDP6_INC_STATS_BH(field)	SNMP_INC_STATS_BH(udp_stats_in6, field)
148 #define UDP6_INC_STATS_USER(field) 	SNMP_INC_STATS_USER(udp_stats_in6, field)
149 
150 int snmp6_register_dev(struct inet6_dev *idev);
151 int snmp6_unregister_dev(struct inet6_dev *idev);
152 int snmp6_alloc_dev(struct inet6_dev *idev);
153 int snmp6_free_dev(struct inet6_dev *idev);
154 int snmp6_mib_init(void *ptr[2], size_t mibsize, size_t mibalign);
155 void snmp6_mib_free(void *ptr[2]);
156 
157 struct ip6_ra_chain
158 {
159 	struct ip6_ra_chain	*next;
160 	struct sock		*sk;
161 	int			sel;
162 	void			(*destructor)(struct sock *);
163 };
164 
165 extern struct ip6_ra_chain	*ip6_ra_chain;
166 extern rwlock_t ip6_ra_lock;
167 
168 /*
169    This structure is prepared by protocol, when parsing
170    ancillary data and passed to IPv6.
171  */
172 
173 struct ipv6_txoptions
174 {
175 	/* Length of this structure */
176 	int			tot_len;
177 
178 	/* length of extension headers   */
179 
180 	__u16			opt_flen;	/* after fragment hdr */
181 	__u16			opt_nflen;	/* before fragment hdr */
182 
183 	struct ipv6_opt_hdr	*hopopt;
184 	struct ipv6_opt_hdr	*dst0opt;
185 	struct ipv6_rt_hdr	*srcrt;	/* Routing Header */
186 	struct ipv6_opt_hdr	*dst1opt;
187 
188 	/* Option buffer, as read by IPV6_PKTOPTIONS, starts here. */
189 };
190 
191 struct ip6_flowlabel
192 {
193 	struct ip6_flowlabel	*next;
194 	u32			label;
195 	struct in6_addr		dst;
196 	struct ipv6_txoptions	*opt;
197 	atomic_t		users;
198 	unsigned long		linger;
199 	u8			share;
200 	u32			owner;
201 	unsigned long		lastuse;
202 	unsigned long		expires;
203 };
204 
205 #define IPV6_FLOWINFO_MASK	__constant_htonl(0x0FFFFFFF)
206 #define IPV6_FLOWLABEL_MASK	__constant_htonl(0x000FFFFF)
207 
208 struct ipv6_fl_socklist
209 {
210 	struct ipv6_fl_socklist	*next;
211 	struct ip6_flowlabel	*fl;
212 };
213 
214 extern struct ip6_flowlabel	*fl6_sock_lookup(struct sock *sk, u32 label);
215 extern struct ipv6_txoptions	*fl6_merge_options(struct ipv6_txoptions * opt_space,
216 						   struct ip6_flowlabel * fl,
217 						   struct ipv6_txoptions * fopt);
218 extern void			fl6_free_socklist(struct sock *sk);
219 extern int			ipv6_flowlabel_opt(struct sock *sk, char __user *optval, int optlen);
220 extern void			ip6_flowlabel_init(void);
221 extern void			ip6_flowlabel_cleanup(void);
222 
223 static inline void fl6_sock_release(struct ip6_flowlabel *fl)
224 {
225 	if (fl)
226 		atomic_dec(&fl->users);
227 }
228 
229 extern int 			ip6_ra_control(struct sock *sk, int sel,
230 					       void (*destructor)(struct sock *));
231 
232 
233 extern int			ipv6_parse_hopopts(struct sk_buff *skb, int);
234 
235 extern struct ipv6_txoptions *  ipv6_dup_options(struct sock *sk, struct ipv6_txoptions *opt);
236 extern struct ipv6_txoptions *	ipv6_renew_options(struct sock *sk, struct ipv6_txoptions *opt,
237 						   int newtype,
238 						   struct ipv6_opt_hdr __user *newopt,
239 						   int newoptlen);
240 
241 extern int ip6_frag_nqueues;
242 extern atomic_t ip6_frag_mem;
243 
244 #define IPV6_FRAG_TIMEOUT	(60*HZ)		/* 60 seconds */
245 
246 /*
247  *	Function prototype for build_xmit
248  */
249 
250 typedef int		(*inet_getfrag_t) (const void *data,
251 					   struct in6_addr *addr,
252 					   char *,
253 					   unsigned int, unsigned int);
254 
255 extern int __ipv6_addr_type(const struct in6_addr *addr);
256 static inline int ipv6_addr_type(const struct in6_addr *addr)
257 {
258 	return __ipv6_addr_type(addr) & 0xffff;
259 }
260 
261 static inline int ipv6_addr_scope(const struct in6_addr *addr)
262 {
263 	return __ipv6_addr_type(addr) & IPV6_ADDR_SCOPE_MASK;
264 }
265 
266 static inline int __ipv6_addr_src_scope(int type)
267 {
268 	return (type == IPV6_ADDR_ANY ? __IPV6_ADDR_SCOPE_INVALID : (type >> 16));
269 }
270 
271 static inline int ipv6_addr_src_scope(const struct in6_addr *addr)
272 {
273 	return __ipv6_addr_src_scope(__ipv6_addr_type(addr));
274 }
275 
276 static inline int ipv6_addr_cmp(const struct in6_addr *a1, const struct in6_addr *a2)
277 {
278 	return memcmp((const void *) a1, (const void *) a2, sizeof(struct in6_addr));
279 }
280 
281 static inline void ipv6_addr_copy(struct in6_addr *a1, const struct in6_addr *a2)
282 {
283 	memcpy((void *) a1, (const void *) a2, sizeof(struct in6_addr));
284 }
285 
286 static inline void ipv6_addr_prefix(struct in6_addr *pfx,
287 				    const struct in6_addr *addr,
288 				    int plen)
289 {
290 	/* caller must guarantee 0 <= plen <= 128 */
291 	int o = plen >> 3,
292 	    b = plen & 0x7;
293 
294 	memcpy(pfx->s6_addr, addr, o);
295 	if (b != 0) {
296 		pfx->s6_addr[o] = addr->s6_addr[o] & (0xff00 >> b);
297 		o++;
298 	}
299 	if (o < 16)
300 		memset(pfx->s6_addr + o, 0, 16 - o);
301 }
302 
303 #ifndef __HAVE_ARCH_ADDR_SET
304 static inline void ipv6_addr_set(struct in6_addr *addr,
305 				     __u32 w1, __u32 w2,
306 				     __u32 w3, __u32 w4)
307 {
308 	addr->s6_addr32[0] = w1;
309 	addr->s6_addr32[1] = w2;
310 	addr->s6_addr32[2] = w3;
311 	addr->s6_addr32[3] = w4;
312 }
313 #endif
314 
315 static inline int ipv6_addr_equal(const struct in6_addr *a1,
316 				  const struct in6_addr *a2)
317 {
318 	return (a1->s6_addr32[0] == a2->s6_addr32[0] &&
319 		a1->s6_addr32[1] == a2->s6_addr32[1] &&
320 		a1->s6_addr32[2] == a2->s6_addr32[2] &&
321 		a1->s6_addr32[3] == a2->s6_addr32[3]);
322 }
323 
324 static inline int __ipv6_prefix_equal(const u32 *a1, const u32 *a2,
325 				      unsigned int prefixlen)
326 {
327 	unsigned pdw, pbi;
328 
329 	/* check complete u32 in prefix */
330 	pdw = prefixlen >> 5;
331 	if (pdw && memcmp(a1, a2, pdw << 2))
332 		return 0;
333 
334 	/* check incomplete u32 in prefix */
335 	pbi = prefixlen & 0x1f;
336 	if (pbi && ((a1[pdw] ^ a2[pdw]) & htonl((0xffffffff) << (32 - pbi))))
337 		return 0;
338 
339 	return 1;
340 }
341 
342 static inline int ipv6_prefix_equal(const struct in6_addr *a1,
343 				    const struct in6_addr *a2,
344 				    unsigned int prefixlen)
345 {
346 	return __ipv6_prefix_equal(a1->s6_addr32, a2->s6_addr32,
347 				   prefixlen);
348 }
349 
350 static inline int ipv6_addr_any(const struct in6_addr *a)
351 {
352 	return ((a->s6_addr32[0] | a->s6_addr32[1] |
353 		 a->s6_addr32[2] | a->s6_addr32[3] ) == 0);
354 }
355 
356 /*
357  * find the first different bit between two addresses
358  * length of address must be a multiple of 32bits
359  */
360 static inline int __ipv6_addr_diff(const void *token1, const void *token2, int addrlen)
361 {
362 	const __u32 *a1 = token1, *a2 = token2;
363 	int i;
364 
365 	addrlen >>= 2;
366 
367 	for (i = 0; i < addrlen; i++) {
368 		__u32 xb = a1[i] ^ a2[i];
369 		if (xb) {
370 			int j = 31;
371 
372 			xb = ntohl(xb);
373 			while ((xb & (1 << j)) == 0)
374 				j--;
375 
376 			return (i * 32 + 31 - j);
377 		}
378 	}
379 
380 	/*
381 	 *	we should *never* get to this point since that
382 	 *	would mean the addrs are equal
383 	 *
384 	 *	However, we do get to it 8) And exacly, when
385 	 *	addresses are equal 8)
386 	 *
387 	 *	ip route add 1111::/128 via ...
388 	 *	ip route add 1111::/64 via ...
389 	 *	and we are here.
390 	 *
391 	 *	Ideally, this function should stop comparison
392 	 *	at prefix length. It does not, but it is still OK,
393 	 *	if returned value is greater than prefix length.
394 	 *					--ANK (980803)
395 	 */
396 	return (addrlen << 5);
397 }
398 
399 static inline int ipv6_addr_diff(const struct in6_addr *a1, const struct in6_addr *a2)
400 {
401 	return __ipv6_addr_diff(a1, a2, sizeof(struct in6_addr));
402 }
403 
404 /*
405  *	Prototypes exported by ipv6
406  */
407 
408 /*
409  *	rcv function (called from netdevice level)
410  */
411 
412 extern int			ipv6_rcv(struct sk_buff *skb,
413 					 struct net_device *dev,
414 					 struct packet_type *pt,
415 					 struct net_device *orig_dev);
416 
417 /*
418  *	upper-layer output functions
419  */
420 extern int			ip6_xmit(struct sock *sk,
421 					 struct sk_buff *skb,
422 					 struct flowi *fl,
423 					 struct ipv6_txoptions *opt,
424 					 int ipfragok);
425 
426 extern int			ip6_nd_hdr(struct sock *sk,
427 					   struct sk_buff *skb,
428 					   struct net_device *dev,
429 					   struct in6_addr *saddr,
430 					   struct in6_addr *daddr,
431 					   int proto, int len);
432 
433 extern int			ip6_find_1stfragopt(struct sk_buff *skb, u8 **nexthdr);
434 
435 extern int			ip6_append_data(struct sock *sk,
436 						int getfrag(void *from, char *to, int offset, int len, int odd, struct sk_buff *skb),
437 		    				void *from,
438 						int length,
439 						int transhdrlen,
440 		      				int hlimit,
441 		      				int tclass,
442 						struct ipv6_txoptions *opt,
443 						struct flowi *fl,
444 						struct rt6_info *rt,
445 						unsigned int flags);
446 
447 extern int			ip6_push_pending_frames(struct sock *sk);
448 
449 extern void			ip6_flush_pending_frames(struct sock *sk);
450 
451 extern int			ip6_dst_lookup(struct sock *sk,
452 					       struct dst_entry **dst,
453 					       struct flowi *fl);
454 
455 /*
456  *	skb processing functions
457  */
458 
459 extern int			ip6_output(struct sk_buff *skb);
460 extern int			ip6_forward(struct sk_buff *skb);
461 extern int			ip6_input(struct sk_buff *skb);
462 extern int			ip6_mc_input(struct sk_buff *skb);
463 
464 /*
465  *	Extension header (options) processing
466  */
467 
468 extern u8 *			ipv6_build_nfrag_opts(struct sk_buff *skb,
469 						      u8 *prev_hdr,
470 						      struct ipv6_txoptions *opt,
471 						      struct in6_addr *daddr,
472 						      u32 jumbolen);
473 extern u8 *			ipv6_build_frag_opts(struct sk_buff *skb,
474 						     u8 *prev_hdr,
475 						     struct ipv6_txoptions *opt);
476 extern void 			ipv6_push_nfrag_opts(struct sk_buff *skb,
477 						     struct ipv6_txoptions *opt,
478 						     u8 *proto,
479 						     struct in6_addr **daddr_p);
480 extern void			ipv6_push_frag_opts(struct sk_buff *skb,
481 						    struct ipv6_txoptions *opt,
482 						    u8 *proto);
483 
484 extern int			ipv6_skip_exthdr(const struct sk_buff *, int start,
485 					         u8 *nexthdrp);
486 
487 extern int 			ipv6_ext_hdr(u8 nexthdr);
488 
489 extern struct ipv6_txoptions *	ipv6_invert_rthdr(struct sock *sk,
490 						  struct ipv6_rt_hdr *hdr);
491 
492 
493 /*
494  *	socket options (ipv6_sockglue.c)
495  */
496 
497 extern int			ipv6_setsockopt(struct sock *sk, int level,
498 						int optname,
499 						char __user *optval,
500 						int optlen);
501 extern int			ipv6_getsockopt(struct sock *sk, int level,
502 						int optname,
503 						char __user *optval,
504 						int __user *optlen);
505 
506 extern void			ipv6_packet_init(void);
507 
508 extern void			ipv6_packet_cleanup(void);
509 
510 extern int			ip6_datagram_connect(struct sock *sk,
511 						     struct sockaddr *addr, int addr_len);
512 
513 extern int 			ipv6_recv_error(struct sock *sk, struct msghdr *msg, int len);
514 extern void			ipv6_icmp_error(struct sock *sk, struct sk_buff *skb, int err, u16 port,
515 						u32 info, u8 *payload);
516 extern void			ipv6_local_error(struct sock *sk, int err, struct flowi *fl, u32 info);
517 
518 extern int inet6_release(struct socket *sock);
519 extern int inet6_bind(struct socket *sock, struct sockaddr *uaddr,
520 		      int addr_len);
521 extern int inet6_getname(struct socket *sock, struct sockaddr *uaddr,
522 			 int *uaddr_len, int peer);
523 extern int inet6_ioctl(struct socket *sock, unsigned int cmd,
524 		       unsigned long arg);
525 
526 /*
527  * reassembly.c
528  */
529 extern int sysctl_ip6frag_high_thresh;
530 extern int sysctl_ip6frag_low_thresh;
531 extern int sysctl_ip6frag_time;
532 extern int sysctl_ip6frag_secret_interval;
533 
534 extern struct proto_ops inet6_stream_ops;
535 extern struct proto_ops inet6_dgram_ops;
536 
537 extern int ip6_mc_source(int add, int omode, struct sock *sk,
538 			 struct group_source_req *pgsr);
539 extern int ip6_mc_msfilter(struct sock *sk, struct group_filter *gsf);
540 extern int ip6_mc_msfget(struct sock *sk, struct group_filter *gsf,
541 			 struct group_filter __user *optval,
542 			 int __user *optlen);
543 
544 #ifdef CONFIG_PROC_FS
545 extern int  ac6_proc_init(void);
546 extern void ac6_proc_exit(void);
547 extern int  raw6_proc_init(void);
548 extern void raw6_proc_exit(void);
549 extern int  tcp6_proc_init(void);
550 extern void tcp6_proc_exit(void);
551 extern int  udp6_proc_init(void);
552 extern void udp6_proc_exit(void);
553 extern int  ipv6_misc_proc_init(void);
554 extern void ipv6_misc_proc_exit(void);
555 
556 extern struct rt6_statistics rt6_stats;
557 #endif
558 
559 #ifdef CONFIG_SYSCTL
560 extern ctl_table ipv6_route_table[];
561 extern ctl_table ipv6_icmp_table[];
562 
563 extern void ipv6_sysctl_register(void);
564 extern void ipv6_sysctl_unregister(void);
565 #endif
566 
567 #endif /* __KERNEL__ */
568 #endif /* _NET_IPV6_H */
569