[IPV4]: inet_diag annotations
[deliverable/linux.git] / include / net / ipv6.h
CommitLineData
1da177e4
LT
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. */
2b741653 43#define NEXTHDR_MOBILITY 135 /* Mobility header. */
1da177e4
LT
44
45#define NEXTHDR_MAX 255
46
47
48
49#define IPV6_DEFAULT_HOPLIMIT 64
50#define IPV6_DEFAULT_MCASTHOPS 1
51
52/*
53 * Addr type
54 *
55 * type - unicast | multicast
56 * scope - local | site | global
57 * v4 - compat
58 * v4mapped
59 * any
60 * loopback
61 */
62
63#define IPV6_ADDR_ANY 0x0000U
64
65#define IPV6_ADDR_UNICAST 0x0001U
66#define IPV6_ADDR_MULTICAST 0x0002U
67
68#define IPV6_ADDR_LOOPBACK 0x0010U
69#define IPV6_ADDR_LINKLOCAL 0x0020U
70#define IPV6_ADDR_SITELOCAL 0x0040U
71
72#define IPV6_ADDR_COMPATv4 0x0080U
73
74#define IPV6_ADDR_SCOPE_MASK 0x00f0U
75
76#define IPV6_ADDR_MAPPED 0x1000U
77#define IPV6_ADDR_RESERVED 0x2000U /* reserved address space */
78
79/*
80 * Addr scopes
81 */
82#ifdef __KERNEL__
83#define IPV6_ADDR_MC_SCOPE(a) \
84 ((a)->s6_addr[1] & 0x0f) /* nonstandard */
85#define __IPV6_ADDR_SCOPE_INVALID -1
86#endif
87#define IPV6_ADDR_SCOPE_NODELOCAL 0x01
88#define IPV6_ADDR_SCOPE_LINKLOCAL 0x02
89#define IPV6_ADDR_SCOPE_SITELOCAL 0x05
90#define IPV6_ADDR_SCOPE_ORGLOCAL 0x08
91#define IPV6_ADDR_SCOPE_GLOBAL 0x0e
92
93/*
94 * fragmentation header
95 */
96
97struct frag_hdr {
98 unsigned char nexthdr;
99 unsigned char reserved;
100 unsigned short frag_off;
101 __u32 identification;
102};
103
104#define IP6_MF 0x0001
105
106#ifdef __KERNEL__
107
108#include <net/sock.h>
109
110/* sysctls */
111extern int sysctl_ipv6_bindv6only;
112extern int sysctl_mld_max_msf;
113
114/* MIBs */
115DECLARE_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)
119DECLARE_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})
145DECLARE_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)
1da177e4
LT
149
150int snmp6_register_dev(struct inet6_dev *idev);
151int snmp6_unregister_dev(struct inet6_dev *idev);
152int snmp6_alloc_dev(struct inet6_dev *idev);
153int snmp6_free_dev(struct inet6_dev *idev);
154int snmp6_mib_init(void *ptr[2], size_t mibsize, size_t mibalign);
155void snmp6_mib_free(void *ptr[2]);
156
157struct ip6_ra_chain
158{
159 struct ip6_ra_chain *next;
160 struct sock *sk;
161 int sel;
162 void (*destructor)(struct sock *);
163};
164
165extern struct ip6_ra_chain *ip6_ra_chain;
166extern 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
173struct 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 */
1da177e4
LT
186 struct ipv6_opt_hdr *dst1opt;
187
188 /* Option buffer, as read by IPV6_PKTOPTIONS, starts here. */
189};
190
191struct 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
208struct ipv6_fl_socklist
209{
210 struct ipv6_fl_socklist *next;
211 struct ip6_flowlabel *fl;
212};
213
214extern struct ip6_flowlabel *fl6_sock_lookup(struct sock *sk, u32 label);
215extern struct ipv6_txoptions *fl6_merge_options(struct ipv6_txoptions * opt_space,
216 struct ip6_flowlabel * fl,
217 struct ipv6_txoptions * fopt);
218extern void fl6_free_socklist(struct sock *sk);
219extern int ipv6_flowlabel_opt(struct sock *sk, char __user *optval, int optlen);
220extern void ip6_flowlabel_init(void);
221extern void ip6_flowlabel_cleanup(void);
222
223static inline void fl6_sock_release(struct ip6_flowlabel *fl)
224{
225 if (fl)
226 atomic_dec(&fl->users);
227}
228
229extern int ip6_ra_control(struct sock *sk, int sel,
230 void (*destructor)(struct sock *));
231
232
a80ff03e 233extern int ipv6_parse_hopopts(struct sk_buff **skbp);
1da177e4
LT
234
235extern struct ipv6_txoptions * ipv6_dup_options(struct sock *sk, struct ipv6_txoptions *opt);
333fad53
YH
236extern 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);
df9890c3
YH
240struct ipv6_txoptions *ipv6_fixup_options(struct ipv6_txoptions *opt_space,
241 struct ipv6_txoptions *opt);
1da177e4 242
399c07de
ACM
243extern int ipv6_opt_accepted(struct sock *sk, struct sk_buff *skb);
244
1da177e4
LT
245extern int ip6_frag_nqueues;
246extern atomic_t ip6_frag_mem;
247
248#define IPV6_FRAG_TIMEOUT (60*HZ) /* 60 seconds */
249
250/*
251 * Function prototype for build_xmit
252 */
253
254typedef int (*inet_getfrag_t) (const void *data,
255 struct in6_addr *addr,
256 char *,
257 unsigned int, unsigned int);
258
b1cacb68
YH
259extern int __ipv6_addr_type(const struct in6_addr *addr);
260static inline int ipv6_addr_type(const struct in6_addr *addr)
261{
262 return __ipv6_addr_type(addr) & 0xffff;
263}
1da177e4
LT
264
265static inline int ipv6_addr_scope(const struct in6_addr *addr)
266{
b1cacb68
YH
267 return __ipv6_addr_type(addr) & IPV6_ADDR_SCOPE_MASK;
268}
269
270static inline int __ipv6_addr_src_scope(int type)
271{
272 return (type == IPV6_ADDR_ANY ? __IPV6_ADDR_SCOPE_INVALID : (type >> 16));
273}
274
275static inline int ipv6_addr_src_scope(const struct in6_addr *addr)
276{
277 return __ipv6_addr_src_scope(__ipv6_addr_type(addr));
1da177e4
LT
278}
279
280static inline int ipv6_addr_cmp(const struct in6_addr *a1, const struct in6_addr *a2)
281{
282 return memcmp((const void *) a1, (const void *) a2, sizeof(struct in6_addr));
283}
284
f2ffd9ee
PM
285static inline int
286ipv6_masked_addr_cmp(const struct in6_addr *a1, const struct in6_addr *m,
287 const struct in6_addr *a2)
288{
289 unsigned int i;
290
291 for (i = 0; i < 4; i++)
292 if ((a1->s6_addr32[i] ^ a2->s6_addr32[i]) & m->s6_addr32[i])
293 return 1;
294 return 0;
295}
296
1da177e4
LT
297static inline void ipv6_addr_copy(struct in6_addr *a1, const struct in6_addr *a2)
298{
299 memcpy((void *) a1, (const void *) a2, sizeof(struct in6_addr));
300}
301
302static inline void ipv6_addr_prefix(struct in6_addr *pfx,
303 const struct in6_addr *addr,
304 int plen)
305{
306 /* caller must guarantee 0 <= plen <= 128 */
307 int o = plen >> 3,
308 b = plen & 0x7;
309
310 memcpy(pfx->s6_addr, addr, o);
311 if (b != 0) {
312 pfx->s6_addr[o] = addr->s6_addr[o] & (0xff00 >> b);
313 o++;
314 }
315 if (o < 16)
316 memset(pfx->s6_addr + o, 0, 16 - o);
317}
318
319#ifndef __HAVE_ARCH_ADDR_SET
320static inline void ipv6_addr_set(struct in6_addr *addr,
321 __u32 w1, __u32 w2,
322 __u32 w3, __u32 w4)
323{
324 addr->s6_addr32[0] = w1;
325 addr->s6_addr32[1] = w2;
326 addr->s6_addr32[2] = w3;
327 addr->s6_addr32[3] = w4;
328}
329#endif
330
331static inline int ipv6_addr_equal(const struct in6_addr *a1,
332 const struct in6_addr *a2)
333{
334 return (a1->s6_addr32[0] == a2->s6_addr32[0] &&
335 a1->s6_addr32[1] == a2->s6_addr32[1] &&
336 a1->s6_addr32[2] == a2->s6_addr32[2] &&
337 a1->s6_addr32[3] == a2->s6_addr32[3]);
338}
339
340static inline int __ipv6_prefix_equal(const u32 *a1, const u32 *a2,
341 unsigned int prefixlen)
342{
343 unsigned pdw, pbi;
344
345 /* check complete u32 in prefix */
346 pdw = prefixlen >> 5;
347 if (pdw && memcmp(a1, a2, pdw << 2))
348 return 0;
349
350 /* check incomplete u32 in prefix */
351 pbi = prefixlen & 0x1f;
352 if (pbi && ((a1[pdw] ^ a2[pdw]) & htonl((0xffffffff) << (32 - pbi))))
353 return 0;
354
355 return 1;
356}
357
358static inline int ipv6_prefix_equal(const struct in6_addr *a1,
359 const struct in6_addr *a2,
360 unsigned int prefixlen)
361{
362 return __ipv6_prefix_equal(a1->s6_addr32, a2->s6_addr32,
363 prefixlen);
364}
365
366static inline int ipv6_addr_any(const struct in6_addr *a)
367{
368 return ((a->s6_addr32[0] | a->s6_addr32[1] |
369 a->s6_addr32[2] | a->s6_addr32[3] ) == 0);
370}
371
971f359d
YH
372/*
373 * find the first different bit between two addresses
374 * length of address must be a multiple of 32bits
375 */
376static inline int __ipv6_addr_diff(const void *token1, const void *token2, int addrlen)
377{
378 const __u32 *a1 = token1, *a2 = token2;
379 int i;
380
381 addrlen >>= 2;
382
383 for (i = 0; i < addrlen; i++) {
384 __u32 xb = a1[i] ^ a2[i];
385 if (xb) {
386 int j = 31;
387
388 xb = ntohl(xb);
389 while ((xb & (1 << j)) == 0)
390 j--;
391
392 return (i * 32 + 31 - j);
393 }
394 }
395
396 /*
397 * we should *never* get to this point since that
398 * would mean the addrs are equal
399 *
400 * However, we do get to it 8) And exacly, when
401 * addresses are equal 8)
402 *
403 * ip route add 1111::/128 via ...
404 * ip route add 1111::/64 via ...
405 * and we are here.
406 *
407 * Ideally, this function should stop comparison
408 * at prefix length. It does not, but it is still OK,
409 * if returned value is greater than prefix length.
410 * --ANK (980803)
411 */
412 return (addrlen << 5);
413}
414
415static inline int ipv6_addr_diff(const struct in6_addr *a1, const struct in6_addr *a2)
416{
417 return __ipv6_addr_diff(a1, a2, sizeof(struct in6_addr));
418}
419
1da177e4
LT
420/*
421 * Prototypes exported by ipv6
422 */
423
424/*
425 * rcv function (called from netdevice level)
426 */
427
428extern int ipv6_rcv(struct sk_buff *skb,
429 struct net_device *dev,
f2ccd8fa
DM
430 struct packet_type *pt,
431 struct net_device *orig_dev);
1da177e4 432
b05e1066
PM
433extern int ip6_rcv_finish(struct sk_buff *skb);
434
1da177e4
LT
435/*
436 * upper-layer output functions
437 */
438extern int ip6_xmit(struct sock *sk,
439 struct sk_buff *skb,
440 struct flowi *fl,
441 struct ipv6_txoptions *opt,
442 int ipfragok);
443
444extern int ip6_nd_hdr(struct sock *sk,
445 struct sk_buff *skb,
446 struct net_device *dev,
447 struct in6_addr *saddr,
448 struct in6_addr *daddr,
449 int proto, int len);
450
451extern int ip6_find_1stfragopt(struct sk_buff *skb, u8 **nexthdr);
452
453extern int ip6_append_data(struct sock *sk,
454 int getfrag(void *from, char *to, int offset, int len, int odd, struct sk_buff *skb),
455 void *from,
456 int length,
457 int transhdrlen,
458 int hlimit,
41a1f8ea 459 int tclass,
1da177e4
LT
460 struct ipv6_txoptions *opt,
461 struct flowi *fl,
462 struct rt6_info *rt,
463 unsigned int flags);
464
465extern int ip6_push_pending_frames(struct sock *sk);
466
467extern void ip6_flush_pending_frames(struct sock *sk);
468
469extern int ip6_dst_lookup(struct sock *sk,
470 struct dst_entry **dst,
471 struct flowi *fl);
497c615a
HX
472extern int ip6_sk_dst_lookup(struct sock *sk,
473 struct dst_entry **dst,
474 struct flowi *fl);
1da177e4
LT
475
476/*
477 * skb processing functions
478 */
479
480extern int ip6_output(struct sk_buff *skb);
481extern int ip6_forward(struct sk_buff *skb);
482extern int ip6_input(struct sk_buff *skb);
483extern int ip6_mc_input(struct sk_buff *skb);
484
485/*
486 * Extension header (options) processing
487 */
488
489extern u8 * ipv6_build_nfrag_opts(struct sk_buff *skb,
490 u8 *prev_hdr,
491 struct ipv6_txoptions *opt,
492 struct in6_addr *daddr,
493 u32 jumbolen);
494extern u8 * ipv6_build_frag_opts(struct sk_buff *skb,
495 u8 *prev_hdr,
496 struct ipv6_txoptions *opt);
497extern void ipv6_push_nfrag_opts(struct sk_buff *skb,
498 struct ipv6_txoptions *opt,
499 u8 *proto,
500 struct in6_addr **daddr_p);
501extern void ipv6_push_frag_opts(struct sk_buff *skb,
502 struct ipv6_txoptions *opt,
503 u8 *proto);
504
505extern int ipv6_skip_exthdr(const struct sk_buff *, int start,
0d3d077c 506 u8 *nexthdrp);
1da177e4
LT
507
508extern int ipv6_ext_hdr(u8 nexthdr);
509
c61a4043
MN
510extern int ipv6_find_tlv(struct sk_buff *skb, int offset, int type);
511
1da177e4
LT
512extern struct ipv6_txoptions * ipv6_invert_rthdr(struct sock *sk,
513 struct ipv6_rt_hdr *hdr);
514
515
516/*
517 * socket options (ipv6_sockglue.c)
518 */
519
520extern int ipv6_setsockopt(struct sock *sk, int level,
521 int optname,
522 char __user *optval,
523 int optlen);
524extern int ipv6_getsockopt(struct sock *sk, int level,
525 int optname,
526 char __user *optval,
527 int __user *optlen);
3fdadf7d
DM
528extern int compat_ipv6_setsockopt(struct sock *sk,
529 int level,
530 int optname,
531 char __user *optval,
532 int optlen);
533extern int compat_ipv6_getsockopt(struct sock *sk,
534 int level,
535 int optname,
536 char __user *optval,
537 int __user *optlen);
1da177e4
LT
538
539extern void ipv6_packet_init(void);
540
541extern void ipv6_packet_cleanup(void);
542
543extern int ip6_datagram_connect(struct sock *sk,
544 struct sockaddr *addr, int addr_len);
545
546extern int ipv6_recv_error(struct sock *sk, struct msghdr *msg, int len);
547extern void ipv6_icmp_error(struct sock *sk, struct sk_buff *skb, int err, u16 port,
548 u32 info, u8 *payload);
549extern void ipv6_local_error(struct sock *sk, int err, struct flowi *fl, u32 info);
550
551extern int inet6_release(struct socket *sock);
552extern int inet6_bind(struct socket *sock, struct sockaddr *uaddr,
553 int addr_len);
554extern int inet6_getname(struct socket *sock, struct sockaddr *uaddr,
555 int *uaddr_len, int peer);
556extern int inet6_ioctl(struct socket *sock, unsigned int cmd,
557 unsigned long arg);
558
d8313f5c
ACM
559extern int inet6_hash_connect(struct inet_timewait_death_row *death_row,
560 struct sock *sk);
561
1da177e4
LT
562/*
563 * reassembly.c
564 */
565extern int sysctl_ip6frag_high_thresh;
566extern int sysctl_ip6frag_low_thresh;
567extern int sysctl_ip6frag_time;
568extern int sysctl_ip6frag_secret_interval;
569
90ddc4f0
ED
570extern const struct proto_ops inet6_stream_ops;
571extern const struct proto_ops inet6_dgram_ops;
20380731 572
14c85021
ACM
573struct group_source_req;
574struct group_filter;
575
20380731
ACM
576extern int ip6_mc_source(int add, int omode, struct sock *sk,
577 struct group_source_req *pgsr);
578extern int ip6_mc_msfilter(struct sock *sk, struct group_filter *gsf);
579extern int ip6_mc_msfget(struct sock *sk, struct group_filter *gsf,
580 struct group_filter __user *optval,
581 int __user *optlen);
582
583#ifdef CONFIG_PROC_FS
584extern int ac6_proc_init(void);
585extern void ac6_proc_exit(void);
586extern int raw6_proc_init(void);
587extern void raw6_proc_exit(void);
588extern int tcp6_proc_init(void);
589extern void tcp6_proc_exit(void);
590extern int udp6_proc_init(void);
591extern void udp6_proc_exit(void);
592extern int ipv6_misc_proc_init(void);
593extern void ipv6_misc_proc_exit(void);
594
595extern struct rt6_statistics rt6_stats;
596#endif
1da177e4 597
20380731
ACM
598#ifdef CONFIG_SYSCTL
599extern ctl_table ipv6_route_table[];
600extern ctl_table ipv6_icmp_table[];
1da177e4 601
20380731
ACM
602extern void ipv6_sysctl_register(void);
603extern void ipv6_sysctl_unregister(void);
604#endif
1da177e4 605
20380731
ACM
606#endif /* __KERNEL__ */
607#endif /* _NET_IPV6_H */
This page took 0.179154 seconds and 5 git commands to generate.