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