Home | History | Annotate | Download | only in inet
      1 /*
      2  * CDDL HEADER START
      3  *
      4  * The contents of this file are subject to the terms of the
      5  * Common Development and Distribution License (the "License").
      6  * You may not use this file except in compliance with the License.
      7  *
      8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9  * or http://www.opensolaris.org/os/licensing.
     10  * See the License for the specific language governing permissions
     11  * and limitations under the License.
     12  *
     13  * When distributing Covered Code, include this CDDL HEADER in each
     14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15  * If applicable, add the following below this CDDL HEADER, with the
     16  * fields enclosed by brackets "[]" replaced with your own identifying
     17  * information: Portions Copyright [yyyy] [name of copyright owner]
     18  *
     19  * CDDL HEADER END
     20  */
     21 /*
     22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     23  * Use is subject to license terms.
     24  */
     25 
     26 #ifndef	_INET_IP6_H
     27 #define	_INET_IP6_H
     28 
     29 #ifdef	__cplusplus
     30 extern "C" {
     31 #endif
     32 
     33 #include <sys/isa_defs.h>
     34 
     35 #ifdef	_KERNEL
     36 /* icmp6_t is used in the prototype of icmp_inbound_error_fanout_v6() */
     37 #include <netinet/icmp6.h>
     38 #endif	/* _KERNEL */
     39 
     40 /* version number for IPv6 - hard to get this one wrong! */
     41 #define	IPV6_VERSION		6
     42 
     43 #define	IPV6_HDR_LEN		40
     44 
     45 #define	IPV6_ADDR_LEN		16
     46 
     47 /*
     48  * IPv6 address scopes.  The values of these enums also match the scope
     49  * field of multicast addresses.
     50  */
     51 typedef enum {
     52 	IP6_SCOPE_INTFLOCAL = 1,	/* Multicast addresses only */
     53 	IP6_SCOPE_LINKLOCAL,
     54 	IP6_SCOPE_SUBNETLOCAL,		/* Multicast addresses only */
     55 	IP6_SCOPE_ADMINLOCAL,		/* Multicast addresses only */
     56 	IP6_SCOPE_SITELOCAL,
     57 	IP6_SCOPE_GLOBAL
     58 } in6addr_scope_t;
     59 
     60 /* From RFC 3542 - setting for IPV6_USE_MIN_MTU socket option */
     61 #define	IPV6_USE_MIN_MTU_MULTICAST	-1	/* Default */
     62 #define	IPV6_USE_MIN_MTU_NEVER		0
     63 #define	IPV6_USE_MIN_MTU_ALWAYS		1
     64 
     65 #ifdef	_KERNEL
     66 
     67 /* Extract the scope from a multicast address */
     68 #ifdef _BIG_ENDIAN
     69 #define	IN6_ADDR_MC_SCOPE(addr) \
     70 	(((addr)->s6_addr32[0] & 0x000f0000) >> 16)
     71 #else
     72 #define	IN6_ADDR_MC_SCOPE(addr) \
     73 	(((addr)->s6_addr32[0] & 0x00000f00) >> 8)
     74 #endif
     75 
     76 /* Default IPv4 TTL for IPv6-in-IPv4 encapsulated packets */
     77 #define	IPV6_DEFAULT_HOPS	60	/* XXX What should it be? */
     78 
     79 /* Max IPv6 TTL */
     80 #define	IPV6_MAX_HOPS	255
     81 
     82 /* Minimum IPv6 MTU from rfc2460 */
     83 #define	IPV6_MIN_MTU		1280
     84 
     85 /* EUI-64 based token length */
     86 #define	IPV6_TOKEN_LEN		64
     87 
     88 /* Length of an advertised IPv6 prefix */
     89 #define	IPV6_PREFIX_LEN		64
     90 
     91 /* Default and maximum tunnel encapsulation limits.  See RFC 2473. */
     92 #define	IPV6_DEFAULT_ENCAPLIMIT	4
     93 #define	IPV6_MAX_ENCAPLIMIT	255
     94 
     95 /*
     96  * Minimum and maximum extension header lengths for IPv6.  The 8-bit
     97  * length field of each extension header (see rfc2460) specifies the
     98  * number of 8 octet units of data in the header not including the
     99  * first 8 octets.  A value of 0 would indicate 8 bytes (0 * 8 + 8),
    100  * and 255 would indicate 2048 bytes (255 * 8 + 8).
    101  */
    102 #define	MIN_EHDR_LEN		8
    103 #define	MAX_EHDR_LEN		2048
    104 
    105 #ifdef _BIG_ENDIAN
    106 #define	IPV6_DEFAULT_VERS_AND_FLOW	0x60000000
    107 #define	IPV6_VERS_AND_FLOW_MASK		0xF0000000
    108 #define	V6_MCAST			0xFF000000
    109 #define	V6_LINKLOCAL			0xFE800000
    110 
    111 #define	IPV6_FLOW_TCLASS(x)		(((x) & IPV6_FLOWINFO_TCLASS) >> 20)
    112 #define	IPV6_TCLASS_FLOW(f, c)		(((f) & ~IPV6_FLOWINFO_TCLASS) |\
    113 					((c) << 20))
    114 #else
    115 #define	IPV6_DEFAULT_VERS_AND_FLOW	0x00000060
    116 #define	IPV6_VERS_AND_FLOW_MASK		0x000000F0
    117 #define	V6_MCAST			0x000000FF
    118 #define	V6_LINKLOCAL			0x000080FE
    119 
    120 #define	IPV6_FLOW_TCLASS(x)		((((x) & 0xf000U) >> 12) |\
    121 					(((x) & 0xf) << 4))
    122 #define	IPV6_TCLASS_FLOW(f, c)		(((f) & ~IPV6_FLOWINFO_TCLASS) |\
    123 					((((c) & 0xf) << 12) |\
    124 					(((c) & 0xf0) >> 4)))
    125 #endif
    126 
    127 /*
    128  * UTILITY MACROS FOR ADDRESSES.
    129  */
    130 
    131 /*
    132  * Convert an IPv4 address mask to an IPv6 mask.   Pad with 1-bits.
    133  */
    134 #define	V4MASK_TO_V6(v4, v6)	((v6).s6_addr32[0] = 0xffffffffUL,	\
    135 				(v6).s6_addr32[1] = 0xffffffffUL,	\
    136 				(v6).s6_addr32[2] = 0xffffffffUL,	\
    137 				(v6).s6_addr32[3] = (v4))
    138 
    139 /*
    140  * Convert aligned IPv4-mapped IPv6 address into an IPv4 address.
    141  * Note: We use "v6" here in definition of macro instead of "(v6)"
    142  * Not possible to use "(v6)" here since macro is used with struct
    143  * field names as arguments.
    144  */
    145 #define	V4_PART_OF_V6(v6)	v6.s6_addr32[3]
    146 
    147 #ifdef _BIG_ENDIAN
    148 #define	V6_OR_V4_INADDR_ANY(a)	((a).s6_addr32[3] == 0 &&		\
    149 				((a).s6_addr32[2] == 0xffffU ||	\
    150 				(a).s6_addr32[2] == 0) &&		\
    151 				(a).s6_addr32[1] == 0 &&		\
    152 				(a).s6_addr32[0] == 0)
    153 
    154 #else
    155 #define	V6_OR_V4_INADDR_ANY(a)	((a).s6_addr32[3] == 0 && 		\
    156 				((a).s6_addr32[2] == 0xffff0000U ||	\
    157 				(a).s6_addr32[2] == 0) &&		\
    158 				(a).s6_addr32[1] == 0 &&		\
    159 				(a).s6_addr32[0] == 0)
    160 #endif /* _BIG_ENDIAN */
    161 
    162 /* IPv4-mapped CLASSD addresses */
    163 #ifdef _BIG_ENDIAN
    164 #define	IN6_IS_ADDR_V4MAPPED_CLASSD(addr) \
    165 	(((addr)->_S6_un._S6_u32[2] == 0x0000ffff) && \
    166 	(CLASSD((addr)->_S6_un._S6_u32[3])) && \
    167 	((addr)->_S6_un._S6_u32[1] == 0) && \
    168 	((addr)->_S6_un._S6_u32[0] == 0))
    169 #else  /* _BIG_ENDIAN */
    170 #define	IN6_IS_ADDR_V4MAPPED_CLASSD(addr) \
    171 	(((addr)->_S6_un._S6_u32[2] == 0xffff0000U) && \
    172 	(CLASSD((addr)->_S6_un._S6_u32[3])) && \
    173 	((addr)->_S6_un._S6_u32[1] == 0) && \
    174 	((addr)->_S6_un._S6_u32[0] == 0))
    175 #endif /* _BIG_ENDIAN */
    176 
    177 /* Clear an IPv6 addr */
    178 #define	V6_SET_ZERO(a)		((a).s6_addr32[0] = 0,			\
    179 				(a).s6_addr32[1] = 0,			\
    180 				(a).s6_addr32[2] = 0,			\
    181 				(a).s6_addr32[3] = 0)
    182 
    183 /* Mask comparison: is IPv6 addr a, and'ed with mask m, equal to addr b? */
    184 #define	V6_MASK_EQ(a, m, b)						\
    185 	((((a).s6_addr32[0] & (m).s6_addr32[0]) == (b).s6_addr32[0]) &&	\
    186 	(((a).s6_addr32[1] & (m).s6_addr32[1]) == (b).s6_addr32[1]) &&	\
    187 	(((a).s6_addr32[2] & (m).s6_addr32[2]) == (b).s6_addr32[2]) &&	\
    188 	(((a).s6_addr32[3] & (m).s6_addr32[3]) == (b).s6_addr32[3]))
    189 
    190 #define	V6_MASK_EQ_2(a, m, b)						\
    191 	((((a).s6_addr32[0] & (m).s6_addr32[0]) ==			\
    192 	    ((b).s6_addr32[0]  & (m).s6_addr32[0])) &&			\
    193 	(((a).s6_addr32[1] & (m).s6_addr32[1]) ==			\
    194 	    ((b).s6_addr32[1]  & (m).s6_addr32[1])) &&			\
    195 	(((a).s6_addr32[2] & (m).s6_addr32[2]) ==			\
    196 	    ((b).s6_addr32[2]  & (m).s6_addr32[2])) &&			\
    197 	(((a).s6_addr32[3] & (m).s6_addr32[3]) ==			\
    198 	    ((b).s6_addr32[3]  & (m).s6_addr32[3])))
    199 
    200 /* Copy IPv6 address (s), logically and'ed with mask (m), into (d) */
    201 #define	V6_MASK_COPY(s, m, d)						\
    202 	((d).s6_addr32[0] = (s).s6_addr32[0] & (m).s6_addr32[0],	\
    203 	(d).s6_addr32[1] = (s).s6_addr32[1] & (m).s6_addr32[1],		\
    204 	(d).s6_addr32[2] = (s).s6_addr32[2] & (m).s6_addr32[2],		\
    205 	(d).s6_addr32[3] = (s).s6_addr32[3] & (m).s6_addr32[3])
    206 
    207 #define	ILL_FRAG_HASH_V6(v6addr, i)					\
    208 	((ntohl((v6addr).s6_addr32[3]) ^ (i ^ (i >> 8))) % 		\
    209 						ILL_FRAG_HASH_TBL_COUNT)
    210 
    211 
    212 /*
    213  * GLOBAL EXTERNALS
    214  */
    215 extern const in6_addr_t	ipv6_all_ones;
    216 extern const in6_addr_t	ipv6_all_zeros;
    217 extern const in6_addr_t	ipv6_loopback;
    218 extern const in6_addr_t	ipv6_all_hosts_mcast;
    219 extern const in6_addr_t	ipv6_all_rtrs_mcast;
    220 extern const in6_addr_t	ipv6_all_v2rtrs_mcast;
    221 extern const in6_addr_t	ipv6_solicited_node_mcast;
    222 extern const in6_addr_t	ipv6_unspecified_group;
    223 
    224 /*
    225  * FUNCTION PROTOTYPES
    226  */
    227 
    228 extern void	convert2ascii(char *buf, const in6_addr_t *addr);
    229 extern char	*inet_ntop(int, const void *, char *, int);
    230 extern int	inet_pton(int, char *, void *);
    231 extern void	icmp_param_problem_nexthdr_v6(mblk_t *, boolean_t,
    232     ip_recv_attr_t *);
    233 extern void	icmp_pkt2big_v6(mblk_t *, uint32_t, boolean_t,
    234     ip_recv_attr_t *);
    235 extern void	icmp_time_exceeded_v6(mblk_t *, uint8_t, boolean_t,
    236     ip_recv_attr_t *);
    237 extern void	icmp_unreachable_v6(mblk_t *, uint8_t, boolean_t,
    238     ip_recv_attr_t *);
    239 extern mblk_t	*icmp_inbound_v6(mblk_t *, ip_recv_attr_t *);
    240 extern void	icmp_inbound_error_fanout_v6(mblk_t *, icmp6_t *,
    241     ip_recv_attr_t *);
    242 extern void	icmp_update_out_mib_v6(ill_t *, icmp6_t *);
    243 
    244 extern boolean_t conn_wantpacket_v6(conn_t *, ip_recv_attr_t *, ip6_t *);
    245 
    246 extern in6addr_scope_t	ip_addr_scope_v6(const in6_addr_t *);
    247 extern void	ip_build_hdrs_v6(uchar_t *, uint_t, const ip_pkt_t *, uint8_t,
    248     uint32_t);
    249 extern void	ip_fanout_udp_multi_v6(mblk_t *, ip6_t *, uint16_t, uint16_t,
    250     ip_recv_attr_t *);
    251 extern void	ip_fanout_send_icmp_v6(mblk_t *, uint_t, uint8_t,
    252     ip_recv_attr_t *);
    253 extern void	ip_fanout_proto_v6(mblk_t *, ip6_t *, ip_recv_attr_t *);
    254 extern int	ip_find_hdr_v6(mblk_t *, ip6_t *, boolean_t, ip_pkt_t *,
    255     uint8_t *);
    256 extern in6_addr_t ip_get_dst_v6(ip6_t *, const mblk_t *, boolean_t *);
    257 extern ip6_rthdr_t	*ip_find_rthdr_v6(ip6_t *, uint8_t *);
    258 extern boolean_t	ip_hdr_length_nexthdr_v6(mblk_t *, ip6_t *,
    259     uint16_t *, uint8_t **);
    260 extern int	ip_hdr_length_v6(mblk_t *, ip6_t *);
    261 extern uint32_t	ip_massage_options_v6(ip6_t *, ip6_rthdr_t *, netstack_t *);
    262 extern void	ip_forward_xmit_v6(nce_t *, mblk_t *, ip6_t *, ip_recv_attr_t *,
    263     uint32_t, uint32_t);
    264 extern mblk_t	*ip_fraghdr_add_v6(mblk_t *, uint32_t, ip_xmit_attr_t *);
    265 extern int	ip_fragment_v6(mblk_t *, nce_t *, iaflags_t, uint_t, uint32_t,
    266     uint32_t, zoneid_t, zoneid_t, pfirepostfrag_t postfragfn,
    267     uintptr_t *ixa_cookie);
    268 extern int	ip_process_options_v6(mblk_t *, ip6_t *,
    269     uint8_t *, uint_t, uint8_t, ip_recv_attr_t *);
    270 extern void	ip_process_rthdr(mblk_t *, ip6_t *, ip6_rthdr_t *,
    271     ip_recv_attr_t *);
    272 extern int	ip_total_hdrs_len_v6(const ip_pkt_t *);
    273 extern mblk_t	*ipsec_early_ah_v6(mblk_t *, ip_recv_attr_t *);
    274 extern int	ipsec_ah_get_hdr_size_v6(mblk_t *, boolean_t);
    275 extern void	ip_send_potential_redirect_v6(mblk_t *, ip6_t *, ire_t *,
    276     ip_recv_attr_t *);
    277 extern void	ip_rput_v6(queue_t *, mblk_t *);
    278 extern mblk_t	*mld_input(mblk_t *, ip_recv_attr_t *);
    279 extern void	mld_joingroup(ilm_t *);
    280 extern void	mld_leavegroup(ilm_t *);
    281 extern void	mld_timeout_handler(void *);
    282 
    283 extern void	pr_addr_dbg(char *, int, const void *);
    284 extern void	*ip6_kstat_init(netstackid_t, ip6_stat_t *);
    285 extern void	ip6_kstat_fini(netstackid_t, kstat_t *);
    286 extern size_t	ip6_get_src_preferences(ip_xmit_attr_t *, uint32_t *);
    287 extern int	ip6_set_src_preferences(ip_xmit_attr_t *, uint32_t);
    288 
    289 #endif	/* _KERNEL */
    290 
    291 #ifdef	__cplusplus
    292 }
    293 #endif
    294 
    295 #endif	/* _INET_IP6_H */
    296