[mirror_ubuntu-bionic-kernel.git] / include / linux / in6.h

/*
 *	Types and definitions for AF_INET6 
 *	Linux INET6 implementation 
 *
 *	Authors:
 *	Pedro Roque		<roque@di.fc.ul.pt>	
 *
 *	Sources:
 *	IPv6 Program Interfaces for BSD Systems
 *      <draft-ietf-ipngwg-bsd-api-05.txt>
 *
 *	Advanced Sockets API for IPv6
 *	<draft-stevens-advanced-api-00.txt>
 *
 *	This program is free software; you can redistribute it and/or
 *      modify it under the terms of the GNU General Public License
 *      as published by the Free Software Foundation; either version
 *      2 of the License, or (at your option) any later version.
 */

#ifndef _LINUX_IN6_H
#define _LINUX_IN6_H

#include <linux/types.h>

/*
 *	IPv6 address structure
 */

struct in6_addr
{
	union 
	{
		__u8		u6_addr8[16];
		__be16		u6_addr16[8];
		__be32		u6_addr32[4];
	} in6_u;
#define s6_addr			in6_u.u6_addr8
#define s6_addr16		in6_u.u6_addr16
#define s6_addr32		in6_u.u6_addr32
};

/* IPv6 Wildcard Address (::) and Loopback Address (::1) defined in RFC2553
 * NOTE: Be aware the IN6ADDR_* constants and in6addr_* externals are defined
 * in network byte order, not in host byte order as are the IPv4 equivalents
 */
extern const struct in6_addr in6addr_any;
#define IN6ADDR_ANY_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } }
extern const struct in6_addr in6addr_loopback;
#define IN6ADDR_LOOPBACK_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }
#ifdef __KERNEL__
extern const struct in6_addr in6addr_linklocal_allnodes;
#define IN6ADDR_LINKLOCAL_ALLNODES_INIT	\
		{ { { 0xff,2,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }
extern const struct in6_addr in6addr_linklocal_allrouters;
#define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
		{ { { 0xff,2,0,0,0,0,0,0,0,0,0,0,0,0,0,2 } } }
#endif

struct sockaddr_in6 {
	unsigned short int	sin6_family;    /* AF_INET6 */
	__be16			sin6_port;      /* Transport layer port # */
	__be32			sin6_flowinfo;  /* IPv6 flow information */
	struct in6_addr		sin6_addr;      /* IPv6 address */
	__u32			sin6_scope_id;  /* scope id (new in RFC2553) */
};

struct ipv6_mreq {
	/* IPv6 multicast address of group */
	struct in6_addr ipv6mr_multiaddr;

	/* local IPv6 address of interface */
	int		ipv6mr_ifindex;
};

#define ipv6mr_acaddr	ipv6mr_multiaddr

struct in6_flowlabel_req
{
	struct in6_addr	flr_dst;
	__be32	flr_label;
	__u8	flr_action;
	__u8	flr_share;
	__u16	flr_flags;
	__u16 	flr_expires;
	__u16	flr_linger;
	__u32	__flr_pad;
	/* Options in format of IPV6_PKTOPTIONS */
};

#define IPV6_FL_A_GET	0
#define IPV6_FL_A_PUT	1
#define IPV6_FL_A_RENEW	2

#define IPV6_FL_F_CREATE	1
#define IPV6_FL_F_EXCL		2

#define IPV6_FL_S_NONE		0
#define IPV6_FL_S_EXCL		1
#define IPV6_FL_S_PROCESS	2
#define IPV6_FL_S_USER		3
#define IPV6_FL_S_ANY		255


/*
 *	Bitmask constant declarations to help applications select out the 
 *	flow label and priority fields.
 *
 *	Note that this are in host byte order while the flowinfo field of
 *	sockaddr_in6 is in network byte order.
 */

#define IPV6_FLOWINFO_FLOWLABEL		0x000fffff
#define IPV6_FLOWINFO_PRIORITY		0x0ff00000

/* These defintions are obsolete */
#define IPV6_PRIORITY_UNCHARACTERIZED	0x0000
#define IPV6_PRIORITY_FILLER		0x0100
#define IPV6_PRIORITY_UNATTENDED	0x0200
#define IPV6_PRIORITY_RESERVED1		0x0300
#define IPV6_PRIORITY_BULK		0x0400
#define IPV6_PRIORITY_RESERVED2		0x0500
#define IPV6_PRIORITY_INTERACTIVE	0x0600
#define IPV6_PRIORITY_CONTROL		0x0700
#define IPV6_PRIORITY_8			0x0800
#define IPV6_PRIORITY_9			0x0900
#define IPV6_PRIORITY_10		0x0a00
#define IPV6_PRIORITY_11		0x0b00
#define IPV6_PRIORITY_12		0x0c00
#define IPV6_PRIORITY_13		0x0d00
#define IPV6_PRIORITY_14		0x0e00
#define IPV6_PRIORITY_15		0x0f00

/*
 *	IPV6 extension headers
 */
#define IPPROTO_HOPOPTS		0	/* IPv6 hop-by-hop options	*/
#define IPPROTO_ROUTING		43	/* IPv6 routing header		*/
#define IPPROTO_FRAGMENT	44	/* IPv6 fragmentation header	*/
#define IPPROTO_ICMPV6		58	/* ICMPv6			*/
#define IPPROTO_NONE		59	/* IPv6 no next header		*/
#define IPPROTO_DSTOPTS		60	/* IPv6 destination options	*/
#define IPPROTO_MH		135	/* IPv6 mobility header		*/

/*
 *	IPv6 TLV options.
 */
#define IPV6_TLV_PAD0		0
#define IPV6_TLV_PADN		1
#define IPV6_TLV_ROUTERALERT	5
#define IPV6_TLV_JUMBO		194
#define IPV6_TLV_HAO		201	/* home address option */

/*
 *	IPV6 socket options
 */

#define IPV6_ADDRFORM		1
#define IPV6_2292PKTINFO	2
#define IPV6_2292HOPOPTS	3
#define IPV6_2292DSTOPTS	4
#define IPV6_2292RTHDR		5
#define IPV6_2292PKTOPTIONS	6
#define IPV6_CHECKSUM		7
#define IPV6_2292HOPLIMIT	8
#define IPV6_NEXTHOP		9
#define IPV6_AUTHHDR		10	/* obsolete */
#define IPV6_FLOWINFO		11

#define IPV6_UNICAST_HOPS	16
#define IPV6_MULTICAST_IF	17
#define IPV6_MULTICAST_HOPS	18
#define IPV6_MULTICAST_LOOP	19
#define IPV6_ADD_MEMBERSHIP	20
#define IPV6_DROP_MEMBERSHIP	21
#define IPV6_ROUTER_ALERT	22
#define IPV6_MTU_DISCOVER	23
#define IPV6_MTU		24
#define IPV6_RECVERR		25
#define IPV6_V6ONLY		26
#define IPV6_JOIN_ANYCAST	27
#define IPV6_LEAVE_ANYCAST	28

/* IPV6_MTU_DISCOVER values */
#define IPV6_PMTUDISC_DONT		0
#define IPV6_PMTUDISC_WANT		1
#define IPV6_PMTUDISC_DO		2
#define IPV6_PMTUDISC_PROBE		3

/* Flowlabel */
#define IPV6_FLOWLABEL_MGR	32
#define IPV6_FLOWINFO_SEND	33

#define IPV6_IPSEC_POLICY	34
#define IPV6_XFRM_POLICY	35

/*
 * Multicast:
 * Following socket options are shared between IPv4 and IPv6.
 *
 * MCAST_JOIN_GROUP		42
 * MCAST_BLOCK_SOURCE		43
 * MCAST_UNBLOCK_SOURCE		44
 * MCAST_LEAVE_GROUP		45
 * MCAST_JOIN_SOURCE_GROUP	46
 * MCAST_LEAVE_SOURCE_GROUP	47
 * MCAST_MSFILTER		48
 */

/*
 * Advanced API (RFC3542) (1)
 *
 * Note: IPV6_RECVRTHDRDSTOPTS does not exist. see net/ipv6/datagram.c.
 */

#define IPV6_RECVPKTINFO	49
#define IPV6_PKTINFO		50
#define IPV6_RECVHOPLIMIT	51
#define IPV6_HOPLIMIT		52
#define IPV6_RECVHOPOPTS	53
#define IPV6_HOPOPTS		54
#define IPV6_RTHDRDSTOPTS	55
#define IPV6_RECVRTHDR		56
#define IPV6_RTHDR		57
#define IPV6_RECVDSTOPTS	58
#define IPV6_DSTOPTS		59
#if 0	/* not yet */
#define IPV6_RECVPATHMTU	60
#define IPV6_PATHMTU		61
#define IPV6_DONTFRAG		62
#define IPV6_USE_MIN_MTU	63
#endif

/*
 * Netfilter (1)
 *
 * Following socket options are used in ip6_tables;
 * see include/linux/netfilter_ipv6/ip6_tables.h.
 *
 * IP6T_SO_SET_REPLACE / IP6T_SO_GET_INFO		64
 * IP6T_SO_SET_ADD_COUNTERS / IP6T_SO_GET_ENTRIES	65
 */

/*
 * Advanced API (RFC3542) (2)
 */
#define IPV6_RECVTCLASS		66
#define IPV6_TCLASS		67

/*
 * Netfilter (2)
 *
 * Following socket options are used in ip6_tables;
 * see include/linux/netfilter_ipv6/ip6_tables.h.
 *
 * IP6T_SO_GET_REVISION_MATCH	68
 * IP6T_SO_GET_REVISION_TARGET	69
 */

/* RFC5014: Source address selection */
#define IPV6_ADDR_PREFERENCES	72

#define IPV6_PREFER_SRC_TMP		0x0001
#define IPV6_PREFER_SRC_PUBLIC		0x0002
#define IPV6_PREFER_SRC_PUBTMP_DEFAULT	0x0100
#define IPV6_PREFER_SRC_COA		0x0004
#define IPV6_PREFER_SRC_HOME		0x0400
#define IPV6_PREFER_SRC_CGA		0x0008
#define IPV6_PREFER_SRC_NONCGA		0x0800

/*
 * Multicast Routing:
 * see include/linux/mroute6.h.
 *
 * MRT6_INIT			200
 * MRT6_DONE			201
 * MRT6_ADD_MIF			202
 * MRT6_DEL_MIF			203
 * MRT6_ADD_MFC			204
 * MRT6_DEL_MFC			205
 * MRT6_VERSION			206
 * MRT6_ASSERT			207
 * MRT6_PIM			208
 * (reserved)			209
 */
#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Types and definitions for AF_INET6
	3	* Linux INET6 implementation
	4	*
	5	* Authors:
	6	* Pedro Roque <roque@di.fc.ul.pt>
	7	*
	8	* Sources:
	9	* IPv6 Program Interfaces for BSD Systems
	10	* <draft-ietf-ipngwg-bsd-api-05.txt>
	11	*
	12	* Advanced Sockets API for IPv6
	13	* <draft-stevens-advanced-api-00.txt>
	14	*
	15	* This program is free software; you can redistribute it and/or
	16	* modify it under the terms of the GNU General Public License
	17	* as published by the Free Software Foundation; either version
	18	* 2 of the License, or (at your option) any later version.
	19	*/
	20
	21	#ifndef _LINUX_IN6_H
	22	#define _LINUX_IN6_H
	23
	24	#include <linux/types.h>
	25
	26	/*
	27	* IPv6 address structure
	28	*/
	29
	30	struct in6_addr
	31	{
	32	union
	33	{
	34	__u8 u6_addr8[16];
48818f82 AV	35	__be16 u6_addr16[8];
48818f82 AV	36	__be32 u6_addr32[4];
1da177e4 LT	37	} in6_u;
	38	#define s6_addr in6_u.u6_addr8
	39	#define s6_addr16 in6_u.u6_addr16
	40	#define s6_addr32 in6_u.u6_addr32
	41	};
	42
	43	/* IPv6 Wildcard Address (::) and Loopback Address (::1) defined in RFC2553
	44	* NOTE: Be aware the IN6ADDR_* constants and in6addr_* externals are defined
	45	* in network byte order, not in host byte order as are the IPv4 equivalents
	46	*/
1da177e4 LT	47	extern const struct in6_addr in6addr_any;
1da177e4 LT	48	#define IN6ADDR_ANY_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } }
1da177e4 LT	49	extern const struct in6_addr in6addr_loopback;
1da177e4 LT	50	#define IN6ADDR_LOOPBACK_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }
f3ee4010 YH	51	#ifdef __KERNEL__
	52	extern const struct in6_addr in6addr_linklocal_allnodes;
	53	#define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
	54	{ { { 0xff,2,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }
	55	extern const struct in6_addr in6addr_linklocal_allrouters;
	56	#define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
	57	{ { { 0xff,2,0,0,0,0,0,0,0,0,0,0,0,0,0,2 } } }
	58	#endif
1da177e4 LT	59
	60	struct sockaddr_in6 {
	61	unsigned short int sin6_family; /* AF_INET6 */
e2e38e81	62	__be16 sin6_port; /* Transport layer port # */
90bcaf7b	63	__be32 sin6_flowinfo; /* IPv6 flow information */
1da177e4 LT	64	struct in6_addr sin6_addr; /* IPv6 address */
	65	__u32 sin6_scope_id; /* scope id (new in RFC2553) */
	66	};
	67
	68	struct ipv6_mreq {
	69	/* IPv6 multicast address of group */
	70	struct in6_addr ipv6mr_multiaddr;
	71
	72	/* local IPv6 address of interface */
	73	int ipv6mr_ifindex;
	74	};
	75
	76	#define ipv6mr_acaddr ipv6mr_multiaddr
	77
	78	struct in6_flowlabel_req
	79	{
	80	struct in6_addr flr_dst;
90bcaf7b	81	__be32 flr_label;
1da177e4 LT	82	__u8 flr_action;
	83	__u8 flr_share;
	84	__u16 flr_flags;
	85	__u16 flr_expires;
	86	__u16 flr_linger;
	87	__u32 __flr_pad;
	88	/* Options in format of IPV6_PKTOPTIONS */
	89	};
	90
	91	#define IPV6_FL_A_GET 0
	92	#define IPV6_FL_A_PUT 1
	93	#define IPV6_FL_A_RENEW 2
	94
	95	#define IPV6_FL_F_CREATE 1
	96	#define IPV6_FL_F_EXCL 2
	97
	98	#define IPV6_FL_S_NONE 0
	99	#define IPV6_FL_S_EXCL 1
	100	#define IPV6_FL_S_PROCESS 2
	101	#define IPV6_FL_S_USER 3
	102	#define IPV6_FL_S_ANY 255
	103
	104
	105	/*
	106	* Bitmask constant declarations to help applications select out the
	107	* flow label and priority fields.
	108	*
	109	* Note that this are in host byte order while the flowinfo field of
	110	* sockaddr_in6 is in network byte order.
	111	*/
	112
	113	#define IPV6_FLOWINFO_FLOWLABEL 0x000fffff
	114	#define IPV6_FLOWINFO_PRIORITY 0x0ff00000
	115
	116	/* These defintions are obsolete */
	117	#define IPV6_PRIORITY_UNCHARACTERIZED 0x0000
	118	#define IPV6_PRIORITY_FILLER 0x0100
	119	#define IPV6_PRIORITY_UNATTENDED 0x0200
	120	#define IPV6_PRIORITY_RESERVED1 0x0300
	121	#define IPV6_PRIORITY_BULK 0x0400
	122	#define IPV6_PRIORITY_RESERVED2 0x0500
	123	#define IPV6_PRIORITY_INTERACTIVE 0x0600
	124	#define IPV6_PRIORITY_CONTROL 0x0700
	125	#define IPV6_PRIORITY_8 0x0800
	126	#define IPV6_PRIORITY_9 0x0900
	127	#define IPV6_PRIORITY_10 0x0a00
	128	#define IPV6_PRIORITY_11 0x0b00
	129	#define IPV6_PRIORITY_12 0x0c00
	130	#define IPV6_PRIORITY_13 0x0d00
	131	#define IPV6_PRIORITY_14 0x0e00
	132	#define IPV6_PRIORITY_15 0x0f00
	133
	134	/*
	135	* IPV6 extension headers
	136	*/
	137	#define IPPROTO_HOPOPTS 0 /* IPv6 hop-by-hop options */
	138	#define IPPROTO_ROUTING 43 /* IPv6 routing header */
	139	#define IPPROTO_FRAGMENT 44 /* IPv6 fragmentation header */
	140	#define IPPROTO_ICMPV6 58 /* ICMPv6 */
	141	#define IPPROTO_NONE 59 /* IPv6 no next header */
	142	#define IPPROTO_DSTOPTS 60 /* IPv6 destination options */
2b741653	143	#define IPPROTO_MH 135 /* IPv6 mobility header */
1da177e4 LT	144
	145	/*
	146	* IPv6 TLV options.
	147	*/
	148	#define IPV6_TLV_PAD0 0
	149	#define IPV6_TLV_PADN 1
	150	#define IPV6_TLV_ROUTERALERT 5
	151	#define IPV6_TLV_JUMBO 194
842426e7	152	#define IPV6_TLV_HAO 201 /* home address option */
1da177e4 LT	153
	154	/*
	155	* IPV6 socket options
	156	*/
	157
	158	#define IPV6_ADDRFORM 1
333fad53 YH	159	#define IPV6_2292PKTINFO 2
	160	#define IPV6_2292HOPOPTS 3
	161	#define IPV6_2292DSTOPTS 4
	162	#define IPV6_2292RTHDR 5
	163	#define IPV6_2292PKTOPTIONS 6
1da177e4	164	#define IPV6_CHECKSUM 7
333fad53	165	#define IPV6_2292HOPLIMIT 8
1da177e4	166	#define IPV6_NEXTHOP 9
7fe40f73	167	#define IPV6_AUTHHDR 10 /* obsolete */
1da177e4 LT	168	#define IPV6_FLOWINFO 11
	169
	170	#define IPV6_UNICAST_HOPS 16
	171	#define IPV6_MULTICAST_IF 17
	172	#define IPV6_MULTICAST_HOPS 18
	173	#define IPV6_MULTICAST_LOOP 19
	174	#define IPV6_ADD_MEMBERSHIP 20
	175	#define IPV6_DROP_MEMBERSHIP 21
	176	#define IPV6_ROUTER_ALERT 22
	177	#define IPV6_MTU_DISCOVER 23
	178	#define IPV6_MTU 24
	179	#define IPV6_RECVERR 25
	180	#define IPV6_V6ONLY 26
	181	#define IPV6_JOIN_ANYCAST 27
	182	#define IPV6_LEAVE_ANYCAST 28
	183
	184	/* IPV6_MTU_DISCOVER values */
	185	#define IPV6_PMTUDISC_DONT 0
	186	#define IPV6_PMTUDISC_WANT 1
	187	#define IPV6_PMTUDISC_DO 2
628a5c56	188	#define IPV6_PMTUDISC_PROBE 3
1da177e4 LT	189
	190	/* Flowlabel */
	191	#define IPV6_FLOWLABEL_MGR 32
	192	#define IPV6_FLOWINFO_SEND 33
	193
	194	#define IPV6_IPSEC_POLICY 34
	195	#define IPV6_XFRM_POLICY 35
	196
	197	/*
	198	* Multicast:
	199	* Following socket options are shared between IPv4 and IPv6.
	200	*
	201	* MCAST_JOIN_GROUP 42
	202	* MCAST_BLOCK_SOURCE 43
	203	* MCAST_UNBLOCK_SOURCE 44
	204	* MCAST_LEAVE_GROUP 45
	205	* MCAST_JOIN_SOURCE_GROUP 46
	206	* MCAST_LEAVE_SOURCE_GROUP 47
	207	* MCAST_MSFILTER 48
	208	*/
	209
9928890c YH	210	/*
	211	* Advanced API (RFC3542) (1)
	212	*
	213	* Note: IPV6_RECVRTHDRDSTOPTS does not exist. see net/ipv6/datagram.c.
	214	*/
	215
	216	#define IPV6_RECVPKTINFO 49
	217	#define IPV6_PKTINFO 50
	218	#define IPV6_RECVHOPLIMIT 51
	219	#define IPV6_HOPLIMIT 52
	220	#define IPV6_RECVHOPOPTS 53
	221	#define IPV6_HOPOPTS 54
	222	#define IPV6_RTHDRDSTOPTS 55
	223	#define IPV6_RECVRTHDR 56
	224	#define IPV6_RTHDR 57
	225	#define IPV6_RECVDSTOPTS 58
	226	#define IPV6_DSTOPTS 59
	227	#if 0 /* not yet */
	228	#define IPV6_RECVPATHMTU 60
	229	#define IPV6_PATHMTU 61
	230	#define IPV6_DONTFRAG 62
	231	#define IPV6_USE_MIN_MTU 63
333fad53	232	#endif
dd27466d YH	233
dd27466d YH	234	/*
b96e7ecb	235	* Netfilter (1)
dd27466d YH	236	*
	237	* Following socket options are used in ip6_tables;
	238	* see include/linux/netfilter_ipv6/ip6_tables.h.
	239	*
	240	* IP6T_SO_SET_REPLACE / IP6T_SO_GET_INFO 64
	241	* IP6T_SO_SET_ADD_COUNTERS / IP6T_SO_GET_ENTRIES 65
	242	*/
	243
	244	/*
	245	* Advanced API (RFC3542) (2)
	246	*/
333fad53 YH	247	#define IPV6_RECVTCLASS 66
333fad53 YH	248	#define IPV6_TCLASS 67
333fad53	249
b96e7ecb YK	250	/*
	251	* Netfilter (2)
	252	*
	253	* Following socket options are used in ip6_tables;
	254	* see include/linux/netfilter_ipv6/ip6_tables.h.
	255	*
	256	* IP6T_SO_GET_REVISION_MATCH 68
	257	* IP6T_SO_GET_REVISION_TARGET 69
	258	*/
	259
7cbca67c YH	260	/* RFC5014: Source address selection */
	261	#define IPV6_ADDR_PREFERENCES 72
	262
	263	#define IPV6_PREFER_SRC_TMP 0x0001
	264	#define IPV6_PREFER_SRC_PUBLIC 0x0002
	265	#define IPV6_PREFER_SRC_PUBTMP_DEFAULT 0x0100
	266	#define IPV6_PREFER_SRC_COA 0x0004
	267	#define IPV6_PREFER_SRC_HOME 0x0400
	268	#define IPV6_PREFER_SRC_CGA 0x0008
	269	#define IPV6_PREFER_SRC_NONCGA 0x0800
	270
12802d05 YH	271	/*
	272	* Multicast Routing:
	273	* see include/linux/mroute6.h.
	274	*
	275	* MRT6_INIT 200
	276	* MRT6_DONE 201
	277	* MRT6_ADD_MIF 202
	278	* MRT6_DEL_MIF 203
	279	* MRT6_ADD_MFC 204
	280	* MRT6_DEL_MFC 205
	281	* MRT6_VERSION 206
	282	* MRT6_ASSERT 207
	283	* MRT6_PIM 208
	284	* (reserved) 209
	285	*/
1da177e4	286	#endif