[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / net / ipv6.h
blob65ec86678a08e34280fdd23e7e10f2c2cbb1494f
1 /*
2 * Linux INET6 implementation
4 * Authors:
5 * Pedro Roque <roque@di.fc.ul.pt>
7 * $Id: ipv6.h,v 1.1 2002/05/20 15:13:07 jgrimm Exp $
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.
15 #ifndef _NET_IPV6_H
16 #define _NET_IPV6_H
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>
24 #define SIN6_LEN_RFC2133 24
26 #define IPV6_MAXPLEN 65535
29 * NextHeader field of IPv6 header
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. */
44 #define NEXTHDR_MAX 255
48 #define IPV6_DEFAULT_HOPLIMIT 64
49 #define IPV6_DEFAULT_MCASTHOPS 1
52 * Addr type
54 * type - unicast | multicast
55 * scope - local | site | global
56 * v4 - compat
57 * v4mapped
58 * any
59 * loopback
62 #define IPV6_ADDR_ANY 0x0000U
64 #define IPV6_ADDR_UNICAST 0x0001U
65 #define IPV6_ADDR_MULTICAST 0x0002U
67 #define IPV6_ADDR_LOOPBACK 0x0010U
68 #define IPV6_ADDR_LINKLOCAL 0x0020U
69 #define IPV6_ADDR_SITELOCAL 0x0040U
71 #define IPV6_ADDR_COMPATv4 0x0080U
73 #define IPV6_ADDR_SCOPE_MASK 0x00f0U
75 #define IPV6_ADDR_MAPPED 0x1000U
76 #define IPV6_ADDR_RESERVED 0x2000U /* reserved address space */
79 * Addr scopes
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
93 * fragmentation header
96 struct frag_hdr {
97 unsigned char nexthdr;
98 unsigned char reserved;
99 unsigned short frag_off;
100 __u32 identification;
103 #define IP6_MF 0x0001
105 #ifdef __KERNEL__
107 #include <linux/config.h>
108 #include <net/sock.h>
110 /* sysctls */
111 extern int sysctl_ipv6_bindv6only;
112 extern int sysctl_mld_max_msf;
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); \
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); \
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); \
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); \
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)
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]);
157 struct ip6_ra_chain
159 struct ip6_ra_chain *next;
160 struct sock *sk;
161 int sel;
162 void (*destructor)(struct sock *);
165 extern struct ip6_ra_chain *ip6_ra_chain;
166 extern rwlock_t ip6_ra_lock;
169 This structure is prepared by protocol, when parsing
170 ancillary data and passed to IPv6.
173 struct ipv6_txoptions
175 /* Length of this structure */
176 int tot_len;
178 /* length of extension headers */
180 __u16 opt_flen; /* after fragment hdr */
181 __u16 opt_nflen; /* before fragment hdr */
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;
188 /* Option buffer, as read by IPV6_PKTOPTIONS, starts here. */
191 struct ip6_flowlabel
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;
205 #define IPV6_FLOWINFO_MASK __constant_htonl(0x0FFFFFFF)
206 #define IPV6_FLOWLABEL_MASK __constant_htonl(0x000FFFFF)
208 struct ipv6_fl_socklist
210 struct ipv6_fl_socklist *next;
211 struct ip6_flowlabel *fl;
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);
223 static inline void fl6_sock_release(struct ip6_flowlabel *fl)
225 if (fl)
226 atomic_dec(&fl->users);
229 extern int ip6_ra_control(struct sock *sk, int sel,
230 void (*destructor)(struct sock *));
233 extern int ipv6_parse_hopopts(struct sk_buff *skb, int);
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);
241 extern int ip6_frag_nqueues;
242 extern atomic_t ip6_frag_mem;
244 #define IPV6_FRAG_TIMEOUT (60*HZ) /* 60 seconds */
247 * Function prototype for build_xmit
250 typedef int (*inet_getfrag_t) (const void *data,
251 struct in6_addr *addr,
252 char *,
253 unsigned int, unsigned int);
256 extern int ipv6_addr_type(const struct in6_addr *addr);
258 static inline int ipv6_addr_scope(const struct in6_addr *addr)
260 return ipv6_addr_type(addr) & IPV6_ADDR_SCOPE_MASK;
263 static inline int ipv6_addr_cmp(const struct in6_addr *a1, const struct in6_addr *a2)
265 return memcmp((const void *) a1, (const void *) a2, sizeof(struct in6_addr));
268 static inline void ipv6_addr_copy(struct in6_addr *a1, const struct in6_addr *a2)
270 memcpy((void *) a1, (const void *) a2, sizeof(struct in6_addr));
273 static inline void ipv6_addr_prefix(struct in6_addr *pfx,
274 const struct in6_addr *addr,
275 int plen)
277 /* caller must guarantee 0 <= plen <= 128 */
278 int o = plen >> 3,
279 b = plen & 0x7;
281 memcpy(pfx->s6_addr, addr, o);
282 if (b != 0) {
283 pfx->s6_addr[o] = addr->s6_addr[o] & (0xff00 >> b);
284 o++;
286 if (o < 16)
287 memset(pfx->s6_addr + o, 0, 16 - o);
290 #ifndef __HAVE_ARCH_ADDR_SET
291 static inline void ipv6_addr_set(struct in6_addr *addr,
292 __u32 w1, __u32 w2,
293 __u32 w3, __u32 w4)
295 addr->s6_addr32[0] = w1;
296 addr->s6_addr32[1] = w2;
297 addr->s6_addr32[2] = w3;
298 addr->s6_addr32[3] = w4;
300 #endif
302 static inline int ipv6_addr_equal(const struct in6_addr *a1,
303 const struct in6_addr *a2)
305 return (a1->s6_addr32[0] == a2->s6_addr32[0] &&
306 a1->s6_addr32[1] == a2->s6_addr32[1] &&
307 a1->s6_addr32[2] == a2->s6_addr32[2] &&
308 a1->s6_addr32[3] == a2->s6_addr32[3]);
311 static inline int __ipv6_prefix_equal(const u32 *a1, const u32 *a2,
312 unsigned int prefixlen)
314 unsigned pdw, pbi;
316 /* check complete u32 in prefix */
317 pdw = prefixlen >> 5;
318 if (pdw && memcmp(a1, a2, pdw << 2))
319 return 0;
321 /* check incomplete u32 in prefix */
322 pbi = prefixlen & 0x1f;
323 if (pbi && ((a1[pdw] ^ a2[pdw]) & htonl((0xffffffff) << (32 - pbi))))
324 return 0;
326 return 1;
329 static inline int ipv6_prefix_equal(const struct in6_addr *a1,
330 const struct in6_addr *a2,
331 unsigned int prefixlen)
333 return __ipv6_prefix_equal(a1->s6_addr32, a2->s6_addr32,
334 prefixlen);
337 static inline int ipv6_addr_any(const struct in6_addr *a)
339 return ((a->s6_addr32[0] | a->s6_addr32[1] |
340 a->s6_addr32[2] | a->s6_addr32[3] ) == 0);
344 * Prototypes exported by ipv6
348 * rcv function (called from netdevice level)
351 extern int ipv6_rcv(struct sk_buff *skb,
352 struct net_device *dev,
353 struct packet_type *pt,
354 struct net_device *orig_dev);
357 * upper-layer output functions
359 extern int ip6_xmit(struct sock *sk,
360 struct sk_buff *skb,
361 struct flowi *fl,
362 struct ipv6_txoptions *opt,
363 int ipfragok);
365 extern int ip6_nd_hdr(struct sock *sk,
366 struct sk_buff *skb,
367 struct net_device *dev,
368 struct in6_addr *saddr,
369 struct in6_addr *daddr,
370 int proto, int len);
372 extern int ip6_find_1stfragopt(struct sk_buff *skb, u8 **nexthdr);
374 extern int ip6_append_data(struct sock *sk,
375 int getfrag(void *from, char *to, int offset, int len, int odd, struct sk_buff *skb),
376 void *from,
377 int length,
378 int transhdrlen,
379 int hlimit,
380 int tclass,
381 struct ipv6_txoptions *opt,
382 struct flowi *fl,
383 struct rt6_info *rt,
384 unsigned int flags);
386 extern int ip6_push_pending_frames(struct sock *sk);
388 extern void ip6_flush_pending_frames(struct sock *sk);
390 extern int ip6_dst_lookup(struct sock *sk,
391 struct dst_entry **dst,
392 struct flowi *fl);
395 * skb processing functions
398 extern int ip6_output(struct sk_buff *skb);
399 extern int ip6_forward(struct sk_buff *skb);
400 extern int ip6_input(struct sk_buff *skb);
401 extern int ip6_mc_input(struct sk_buff *skb);
404 * Extension header (options) processing
407 extern u8 * ipv6_build_nfrag_opts(struct sk_buff *skb,
408 u8 *prev_hdr,
409 struct ipv6_txoptions *opt,
410 struct in6_addr *daddr,
411 u32 jumbolen);
412 extern u8 * ipv6_build_frag_opts(struct sk_buff *skb,
413 u8 *prev_hdr,
414 struct ipv6_txoptions *opt);
415 extern void ipv6_push_nfrag_opts(struct sk_buff *skb,
416 struct ipv6_txoptions *opt,
417 u8 *proto,
418 struct in6_addr **daddr_p);
419 extern void ipv6_push_frag_opts(struct sk_buff *skb,
420 struct ipv6_txoptions *opt,
421 u8 *proto);
423 extern int ipv6_skip_exthdr(const struct sk_buff *, int start,
424 u8 *nexthdrp);
426 extern int ipv6_ext_hdr(u8 nexthdr);
428 extern struct ipv6_txoptions * ipv6_invert_rthdr(struct sock *sk,
429 struct ipv6_rt_hdr *hdr);
433 * socket options (ipv6_sockglue.c)
436 extern int ipv6_setsockopt(struct sock *sk, int level,
437 int optname,
438 char __user *optval,
439 int optlen);
440 extern int ipv6_getsockopt(struct sock *sk, int level,
441 int optname,
442 char __user *optval,
443 int __user *optlen);
445 extern void ipv6_packet_init(void);
447 extern void ipv6_packet_cleanup(void);
449 extern int ip6_datagram_connect(struct sock *sk,
450 struct sockaddr *addr, int addr_len);
452 extern int ipv6_recv_error(struct sock *sk, struct msghdr *msg, int len);
453 extern void ipv6_icmp_error(struct sock *sk, struct sk_buff *skb, int err, u16 port,
454 u32 info, u8 *payload);
455 extern void ipv6_local_error(struct sock *sk, int err, struct flowi *fl, u32 info);
457 extern int inet6_release(struct socket *sock);
458 extern int inet6_bind(struct socket *sock, struct sockaddr *uaddr,
459 int addr_len);
460 extern int inet6_getname(struct socket *sock, struct sockaddr *uaddr,
461 int *uaddr_len, int peer);
462 extern int inet6_ioctl(struct socket *sock, unsigned int cmd,
463 unsigned long arg);
466 * reassembly.c
468 extern int sysctl_ip6frag_high_thresh;
469 extern int sysctl_ip6frag_low_thresh;
470 extern int sysctl_ip6frag_time;
471 extern int sysctl_ip6frag_secret_interval;
473 extern struct proto_ops inet6_stream_ops;
474 extern struct proto_ops inet6_dgram_ops;
476 extern int ip6_mc_source(int add, int omode, struct sock *sk,
477 struct group_source_req *pgsr);
478 extern int ip6_mc_msfilter(struct sock *sk, struct group_filter *gsf);
479 extern int ip6_mc_msfget(struct sock *sk, struct group_filter *gsf,
480 struct group_filter __user *optval,
481 int __user *optlen);
483 #ifdef CONFIG_PROC_FS
484 extern int ac6_proc_init(void);
485 extern void ac6_proc_exit(void);
486 extern int raw6_proc_init(void);
487 extern void raw6_proc_exit(void);
488 extern int tcp6_proc_init(void);
489 extern void tcp6_proc_exit(void);
490 extern int udp6_proc_init(void);
491 extern void udp6_proc_exit(void);
492 extern int ipv6_misc_proc_init(void);
493 extern void ipv6_misc_proc_exit(void);
495 extern struct rt6_statistics rt6_stats;
496 #endif
498 #ifdef CONFIG_SYSCTL
499 extern ctl_table ipv6_route_table[];
500 extern ctl_table ipv6_icmp_table[];
502 extern void ipv6_sysctl_register(void);
503 extern void ipv6_sysctl_unregister(void);
504 #endif
506 #endif /* __KERNEL__ */
507 #endif /* _NET_IPV6_H */