[mirror_ubuntu-zesty-kernel.git] / include / linux / in.h

/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions of the Internet Protocol.
 *
 * Version:	@(#)in.h	1.0.1	04/21/93
 *
 * Authors:	Original taken from the GNU Project <netinet/in.h> file.
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 *
 *		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_IN_H
#define _LINUX_IN_H

#include <linux/types.h>
#include <linux/socket.h>

/* Standard well-defined IP protocols.  */
enum {
  IPPROTO_IP = 0,		/* Dummy protocol for TCP		*/
  IPPROTO_ICMP = 1,		/* Internet Control Message Protocol	*/
  IPPROTO_IGMP = 2,		/* Internet Group Management Protocol	*/
  IPPROTO_IPIP = 4,		/* IPIP tunnels (older KA9Q tunnels use 94) */
  IPPROTO_TCP = 6,		/* Transmission Control Protocol	*/
  IPPROTO_EGP = 8,		/* Exterior Gateway Protocol		*/
  IPPROTO_PUP = 12,		/* PUP protocol				*/
  IPPROTO_UDP = 17,		/* User Datagram Protocol		*/
  IPPROTO_IDP = 22,		/* XNS IDP protocol			*/
  IPPROTO_DCCP = 33,		/* Datagram Congestion Control Protocol */
  IPPROTO_RSVP = 46,		/* RSVP protocol			*/
  IPPROTO_GRE = 47,		/* Cisco GRE tunnels (rfc 1701,1702)	*/

  IPPROTO_IPV6	 = 41,		/* IPv6-in-IPv4 tunnelling		*/

  IPPROTO_ESP = 50,            /* Encapsulation Security Payload protocol */
  IPPROTO_AH = 51,             /* Authentication Header protocol       */
  IPPROTO_BEETPH = 94,	       /* IP option pseudo header for BEET */
  IPPROTO_PIM    = 103,		/* Protocol Independent Multicast	*/

  IPPROTO_COMP   = 108,                /* Compression Header protocol */
  IPPROTO_SCTP   = 132,		/* Stream Control Transport Protocol	*/

  IPPROTO_RAW	 = 255,		/* Raw IP packets			*/
  IPPROTO_MAX
};


/* Internet address. */
struct in_addr {
	__be32	s_addr;
};

#define IP_TOS		1
#define IP_TTL		2
#define IP_HDRINCL	3
#define IP_OPTIONS	4
#define IP_ROUTER_ALERT	5
#define IP_RECVOPTS	6
#define IP_RETOPTS	7
#define IP_PKTINFO	8
#define IP_PKTOPTIONS	9
#define IP_MTU_DISCOVER	10
#define IP_RECVERR	11
#define IP_RECVTTL	12
#define	IP_RECVTOS	13
#define IP_MTU		14
#define IP_FREEBIND	15
#define IP_IPSEC_POLICY	16
#define IP_XFRM_POLICY	17
#define IP_PASSSEC	18

/* BSD compatibility */
#define IP_RECVRETOPTS	IP_RETOPTS

/* IP_MTU_DISCOVER values */
#define IP_PMTUDISC_DONT		0	/* Never send DF frames */
#define IP_PMTUDISC_WANT		1	/* Use per route hints	*/
#define IP_PMTUDISC_DO			2	/* Always DF		*/

#define IP_MULTICAST_IF			32
#define IP_MULTICAST_TTL 		33
#define IP_MULTICAST_LOOP 		34
#define IP_ADD_MEMBERSHIP		35
#define IP_DROP_MEMBERSHIP		36
#define IP_UNBLOCK_SOURCE		37
#define IP_BLOCK_SOURCE			38
#define IP_ADD_SOURCE_MEMBERSHIP	39
#define IP_DROP_SOURCE_MEMBERSHIP	40
#define IP_MSFILTER			41
#define MCAST_JOIN_GROUP		42
#define MCAST_BLOCK_SOURCE		43
#define MCAST_UNBLOCK_SOURCE		44
#define MCAST_LEAVE_GROUP		45
#define MCAST_JOIN_SOURCE_GROUP		46
#define MCAST_LEAVE_SOURCE_GROUP	47
#define MCAST_MSFILTER			48

#define MCAST_EXCLUDE	0
#define MCAST_INCLUDE	1

/* These need to appear somewhere around here */
#define IP_DEFAULT_MULTICAST_TTL        1
#define IP_DEFAULT_MULTICAST_LOOP       1

/* Request struct for multicast socket ops */

struct ip_mreq 
{
	struct in_addr imr_multiaddr;	/* IP multicast address of group */
	struct in_addr imr_interface;	/* local IP address of interface */
};

struct ip_mreqn
{
	struct in_addr	imr_multiaddr;		/* IP multicast address of group */
	struct in_addr	imr_address;		/* local IP address of interface */
	int		imr_ifindex;		/* Interface index */
};

struct ip_mreq_source {
	__be32		imr_multiaddr;
	__be32		imr_interface;
	__be32		imr_sourceaddr;
};

struct ip_msfilter {
	__be32		imsf_multiaddr;
	__be32		imsf_interface;
	__u32		imsf_fmode;
	__u32		imsf_numsrc;
	__be32		imsf_slist[1];
};

#define IP_MSFILTER_SIZE(numsrc) \
	(sizeof(struct ip_msfilter) - sizeof(__u32) \
	+ (numsrc) * sizeof(__u32))

struct group_req
{
	__u32				 gr_interface;	/* interface index */
	struct __kernel_sockaddr_storage gr_group;	/* group address */
};

struct group_source_req
{
	__u32				 gsr_interface;	/* interface index */
	struct __kernel_sockaddr_storage gsr_group;	/* group address */
	struct __kernel_sockaddr_storage gsr_source;	/* source address */
};

struct group_filter
{
	__u32				 gf_interface;	/* interface index */
	struct __kernel_sockaddr_storage gf_group;	/* multicast address */
	__u32				 gf_fmode;	/* filter mode */
	__u32				 gf_numsrc;	/* number of sources */
	struct __kernel_sockaddr_storage gf_slist[1];	/* interface index */
};

#define GROUP_FILTER_SIZE(numsrc) \
	(sizeof(struct group_filter) - sizeof(struct __kernel_sockaddr_storage) \
	+ (numsrc) * sizeof(struct __kernel_sockaddr_storage))

struct in_pktinfo
{
	int		ipi_ifindex;
	struct in_addr	ipi_spec_dst;
	struct in_addr	ipi_addr;
};

/* Structure describing an Internet (IP) socket address. */
#define __SOCK_SIZE__	16		/* sizeof(struct sockaddr)	*/
struct sockaddr_in {
  sa_family_t		sin_family;	/* Address family		*/
  __be16		sin_port;	/* Port number			*/
  struct in_addr	sin_addr;	/* Internet address		*/

  /* Pad to size of `struct sockaddr'. */
  unsigned char		__pad[__SOCK_SIZE__ - sizeof(short int) -
			sizeof(unsigned short int) - sizeof(struct in_addr)];
};
#define sin_zero	__pad		/* for BSD UNIX comp. -FvK	*/


/*
 * Definitions of the bits in an Internet address integer.
 * On subnets, host and network parts are found according
 * to the subnet mask, not these masks.
 */
#define	IN_CLASSA(a)		((((long int) (a)) & 0x80000000) == 0)
#define	IN_CLASSA_NET		0xff000000
#define	IN_CLASSA_NSHIFT	24
#define	IN_CLASSA_HOST		(0xffffffff & ~IN_CLASSA_NET)
#define	IN_CLASSA_MAX		128

#define	IN_CLASSB(a)		((((long int) (a)) & 0xc0000000) == 0x80000000)
#define	IN_CLASSB_NET		0xffff0000
#define	IN_CLASSB_NSHIFT	16
#define	IN_CLASSB_HOST		(0xffffffff & ~IN_CLASSB_NET)
#define	IN_CLASSB_MAX		65536

#define	IN_CLASSC(a)		((((long int) (a)) & 0xe0000000) == 0xc0000000)
#define	IN_CLASSC_NET		0xffffff00
#define	IN_CLASSC_NSHIFT	8
#define	IN_CLASSC_HOST		(0xffffffff & ~IN_CLASSC_NET)

#define	IN_CLASSD(a)		((((long int) (a)) & 0xf0000000) == 0xe0000000)
#define	IN_MULTICAST(a)		IN_CLASSD(a)
#define IN_MULTICAST_NET	0xF0000000

#define	IN_EXPERIMENTAL(a)	((((long int) (a)) & 0xf0000000) == 0xf0000000)
#define	IN_BADCLASS(a)		IN_EXPERIMENTAL((a))

/* Address to accept any incoming messages. */
#define	INADDR_ANY		((unsigned long int) 0x00000000)

/* Address to send to all hosts. */
#define	INADDR_BROADCAST	((unsigned long int) 0xffffffff)

/* Address indicating an error return. */
#define	INADDR_NONE		((unsigned long int) 0xffffffff)

/* Network number for local host loopback. */
#define	IN_LOOPBACKNET		127

/* Address to loopback in software to local host.  */
#define	INADDR_LOOPBACK		0x7f000001	/* 127.0.0.1   */
#define	IN_LOOPBACK(a)		((((long int) (a)) & 0xff000000) == 0x7f000000)

/* Defines for Multicast INADDR */
#define INADDR_UNSPEC_GROUP   	0xe0000000U	/* 224.0.0.0   */
#define INADDR_ALLHOSTS_GROUP 	0xe0000001U	/* 224.0.0.1   */
#define INADDR_ALLRTRS_GROUP    0xe0000002U	/* 224.0.0.2 */
#define INADDR_MAX_LOCAL_GROUP  0xe00000ffU	/* 224.0.0.255 */


/* <asm/byteorder.h> contains the htonl type stuff.. */
#include <asm/byteorder.h> 

#ifdef __KERNEL__
/* Some random defines to make it easier in the kernel.. */
#define LOOPBACK(x)	(((x) & htonl(0xff000000)) == htonl(0x7f000000))
#define MULTICAST(x)	(((x) & htonl(0xf0000000)) == htonl(0xe0000000))
#define BADCLASS(x)	(((x) & htonl(0xf0000000)) == htonl(0xf0000000))
#define ZERONET(x)	(((x) & htonl(0xff000000)) == htonl(0x00000000))
#define LOCAL_MCAST(x)	(((x) & htonl(0xFFFFFF00)) == htonl(0xE0000000))

#endif

#endif	/* _LINUX_IN_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* INET An implementation of the TCP/IP protocol suite for the LINUX
	3	* operating system. INET is implemented using the BSD Socket
	4	* interface as the means of communication with the user level.
	5	*
	6	* Definitions of the Internet Protocol.
	7	*
	8	* Version: @(#)in.h 1.0.1 04/21/93
	9	*
	10	* Authors: Original taken from the GNU Project <netinet/in.h> file.
	11	* Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
	12	*
	13	* This program is free software; you can redistribute it and/or
	14	* modify it under the terms of the GNU General Public License
	15	* as published by the Free Software Foundation; either version
	16	* 2 of the License, or (at your option) any later version.
	17	*/
	18	#ifndef _LINUX_IN_H
	19	#define _LINUX_IN_H
	20
	21	#include <linux/types.h>
	22	#include <linux/socket.h>
	23
	24	/* Standard well-defined IP protocols. */
	25	enum {
	26	IPPROTO_IP = 0, /* Dummy protocol for TCP */
	27	IPPROTO_ICMP = 1, /* Internet Control Message Protocol */
	28	IPPROTO_IGMP = 2, /* Internet Group Management Protocol */
	29	IPPROTO_IPIP = 4, /* IPIP tunnels (older KA9Q tunnels use 94) */
	30	IPPROTO_TCP = 6, /* Transmission Control Protocol */
	31	IPPROTO_EGP = 8, /* Exterior Gateway Protocol */
	32	IPPROTO_PUP = 12, /* PUP protocol */
	33	IPPROTO_UDP = 17, /* User Datagram Protocol */
	34	IPPROTO_IDP = 22, /* XNS IDP protocol */
7c657876	35	IPPROTO_DCCP = 33, /* Datagram Congestion Control Protocol */
1da177e4 LT	36	IPPROTO_RSVP = 46, /* RSVP protocol */
	37	IPPROTO_GRE = 47, /* Cisco GRE tunnels (rfc 1701,1702) */
	38
	39	IPPROTO_IPV6 = 41, /* IPv6-in-IPv4 tunnelling */
	40
	41	IPPROTO_ESP = 50, /* Encapsulation Security Payload protocol */
	42	IPPROTO_AH = 51, /* Authentication Header protocol */
0a69452c	43	IPPROTO_BEETPH = 94, /* IP option pseudo header for BEET */
1da177e4 LT	44	IPPROTO_PIM = 103, /* Protocol Independent Multicast */
	45
	46	IPPROTO_COMP = 108, /* Compression Header protocol */
	47	IPPROTO_SCTP = 132, /* Stream Control Transport Protocol */
	48
	49	IPPROTO_RAW = 255, /* Raw IP packets */
	50	IPPROTO_MAX
	51	};
	52
	53
	54	/* Internet address. */
	55	struct in_addr {
def42ff4	56	__be32 s_addr;
1da177e4 LT	57	};
	58
	59	#define IP_TOS 1
	60	#define IP_TTL 2
	61	#define IP_HDRINCL 3
	62	#define IP_OPTIONS 4
	63	#define IP_ROUTER_ALERT 5
	64	#define IP_RECVOPTS 6
	65	#define IP_RETOPTS 7
	66	#define IP_PKTINFO 8
	67	#define IP_PKTOPTIONS 9
	68	#define IP_MTU_DISCOVER 10
	69	#define IP_RECVERR 11
	70	#define IP_RECVTTL 12
	71	#define IP_RECVTOS 13
	72	#define IP_MTU 14
	73	#define IP_FREEBIND 15
	74	#define IP_IPSEC_POLICY 16
	75	#define IP_XFRM_POLICY 17
2c7946a7	76	#define IP_PASSSEC 18
1da177e4 LT	77
	78	/* BSD compatibility */
	79	#define IP_RECVRETOPTS IP_RETOPTS
	80
	81	/* IP_MTU_DISCOVER values */
	82	#define IP_PMTUDISC_DONT 0 /* Never send DF frames */
	83	#define IP_PMTUDISC_WANT 1 /* Use per route hints */
	84	#define IP_PMTUDISC_DO 2 /* Always DF */
	85
	86	#define IP_MULTICAST_IF 32
	87	#define IP_MULTICAST_TTL 33
	88	#define IP_MULTICAST_LOOP 34
	89	#define IP_ADD_MEMBERSHIP 35
	90	#define IP_DROP_MEMBERSHIP 36
	91	#define IP_UNBLOCK_SOURCE 37
	92	#define IP_BLOCK_SOURCE 38
	93	#define IP_ADD_SOURCE_MEMBERSHIP 39
	94	#define IP_DROP_SOURCE_MEMBERSHIP 40
	95	#define IP_MSFILTER 41
	96	#define MCAST_JOIN_GROUP 42
	97	#define MCAST_BLOCK_SOURCE 43
	98	#define MCAST_UNBLOCK_SOURCE 44
	99	#define MCAST_LEAVE_GROUP 45
	100	#define MCAST_JOIN_SOURCE_GROUP 46
	101	#define MCAST_LEAVE_SOURCE_GROUP 47
	102	#define MCAST_MSFILTER 48
	103
	104	#define MCAST_EXCLUDE 0
	105	#define MCAST_INCLUDE 1
	106
	107	/* These need to appear somewhere around here */
	108	#define IP_DEFAULT_MULTICAST_TTL 1
	109	#define IP_DEFAULT_MULTICAST_LOOP 1
	110
	111	/* Request struct for multicast socket ops */
	112
	113	struct ip_mreq
	114	{
	115	struct in_addr imr_multiaddr; /* IP multicast address of group */
	116	struct in_addr imr_interface; /* local IP address of interface */
	117	};
	118
	119	struct ip_mreqn
	120	{
	121	struct in_addr imr_multiaddr; /* IP multicast address of group */
	122	struct in_addr imr_address; /* local IP address of interface */
	123	int imr_ifindex; /* Interface index */
	124	};
	125
	126	struct ip_mreq_source {
00a5020c AV	127	__be32 imr_multiaddr;
	128	__be32 imr_interface;
	129	__be32 imr_sourceaddr;
1da177e4 LT	130	};
	131
	132	struct ip_msfilter {
00a5020c AV	133	__be32 imsf_multiaddr;
00a5020c AV	134	__be32 imsf_interface;
1da177e4 LT	135	__u32 imsf_fmode;
1da177e4 LT	136	__u32 imsf_numsrc;
00a5020c	137	__be32 imsf_slist[1];
1da177e4 LT	138	};
	139
	140	#define IP_MSFILTER_SIZE(numsrc) \
	141	(sizeof(struct ip_msfilter) - sizeof(__u32) \
	142	+ (numsrc) * sizeof(__u32))
	143
	144	struct group_req
	145	{
	146	__u32 gr_interface; /* interface index */
	147	struct __kernel_sockaddr_storage gr_group; /* group address */
	148	};
	149
	150	struct group_source_req
	151	{
	152	__u32 gsr_interface; /* interface index */
	153	struct __kernel_sockaddr_storage gsr_group; /* group address */
	154	struct __kernel_sockaddr_storage gsr_source; /* source address */
	155	};
	156
	157	struct group_filter
	158	{
	159	__u32 gf_interface; /* interface index */
	160	struct __kernel_sockaddr_storage gf_group; /* multicast address */
	161	__u32 gf_fmode; /* filter mode */
	162	__u32 gf_numsrc; /* number of sources */
	163	struct __kernel_sockaddr_storage gf_slist[1]; /* interface index */
	164	};
	165
	166	#define GROUP_FILTER_SIZE(numsrc) \
	167	(sizeof(struct group_filter) - sizeof(struct __kernel_sockaddr_storage) \
	168	+ (numsrc) * sizeof(struct __kernel_sockaddr_storage))
	169
	170	struct in_pktinfo
	171	{
	172	int ipi_ifindex;
	173	struct in_addr ipi_spec_dst;
	174	struct in_addr ipi_addr;
	175	};
	176
	177	/* Structure describing an Internet (IP) socket address. */
	178	#define __SOCK_SIZE__ 16 /* sizeof(struct sockaddr) */
	179	struct sockaddr_in {
	180	sa_family_t sin_family; /* Address family */
cd360007	181	__be16 sin_port; /* Port number */
1da177e4 LT	182	struct in_addr sin_addr; /* Internet address */
	183
	184	/* Pad to size of `struct sockaddr'. */
	185	unsigned char __pad[__SOCK_SIZE__ - sizeof(short int) -
	186	sizeof(unsigned short int) - sizeof(struct in_addr)];
	187	};
	188	#define sin_zero __pad /* for BSD UNIX comp. -FvK */
	189
	190
	191	/*
	192	* Definitions of the bits in an Internet address integer.
	193	* On subnets, host and network parts are found according
	194	* to the subnet mask, not these masks.
	195	*/
	196	#define IN_CLASSA(a) ((((long int) (a)) & 0x80000000) == 0)
	197	#define IN_CLASSA_NET 0xff000000
	198	#define IN_CLASSA_NSHIFT 24
	199	#define IN_CLASSA_HOST (0xffffffff & ~IN_CLASSA_NET)
	200	#define IN_CLASSA_MAX 128
	201
	202	#define IN_CLASSB(a) ((((long int) (a)) & 0xc0000000) == 0x80000000)
	203	#define IN_CLASSB_NET 0xffff0000
	204	#define IN_CLASSB_NSHIFT 16
	205	#define IN_CLASSB_HOST (0xffffffff & ~IN_CLASSB_NET)
	206	#define IN_CLASSB_MAX 65536
	207
	208	#define IN_CLASSC(a) ((((long int) (a)) & 0xe0000000) == 0xc0000000)
	209	#define IN_CLASSC_NET 0xffffff00
	210	#define IN_CLASSC_NSHIFT 8
	211	#define IN_CLASSC_HOST (0xffffffff & ~IN_CLASSC_NET)
	212
	213	#define IN_CLASSD(a) ((((long int) (a)) & 0xf0000000) == 0xe0000000)
	214	#define IN_MULTICAST(a) IN_CLASSD(a)
	215	#define IN_MULTICAST_NET 0xF0000000
	216
	217	#define IN_EXPERIMENTAL(a) ((((long int) (a)) & 0xf0000000) == 0xf0000000)
	218	#define IN_BADCLASS(a) IN_EXPERIMENTAL((a))
	219
	220	/* Address to accept any incoming messages. */
	221	#define INADDR_ANY ((unsigned long int) 0x00000000)
	222
	223	/* Address to send to all hosts. */
	224	#define INADDR_BROADCAST ((unsigned long int) 0xffffffff)
	225
	226	/* Address indicating an error return. */
	227	#define INADDR_NONE ((unsigned long int) 0xffffffff)
	228
	229	/* Network number for local host loopback. */
	230	#define IN_LOOPBACKNET 127
	231
	232	/* Address to loopback in software to local host. */
	233	#define INADDR_LOOPBACK 0x7f000001 /* 127.0.0.1 */
	234	#define IN_LOOPBACK(a) ((((long int) (a)) & 0xff000000) == 0x7f000000)
	235
	236	/* Defines for Multicast INADDR */
	237	#define INADDR_UNSPEC_GROUP 0xe0000000U /* 224.0.0.0 */
	238	#define INADDR_ALLHOSTS_GROUP 0xe0000001U /* 224.0.0.1 */
	239	#define INADDR_ALLRTRS_GROUP 0xe0000002U /* 224.0.0.2 */
	240	#define INADDR_MAX_LOCAL_GROUP 0xe00000ffU /* 224.0.0.255 */
	241
	242
	243	/* <asm/byteorder.h> contains the htonl type stuff.. */
	244	#include <asm/byteorder.h>
	245
246	#ifdef __KERNEL__
247	/* Some random defines to make it easier in the kernel.. */
248	#define LOOPBACK(x) (((x) & htonl(0xff000000)) == htonl(0x7f000000))
249	#define MULTICAST(x) (((x) & htonl(0xf0000000)) == htonl(0xe0000000))
250	#define BADCLASS(x) (((x) & htonl(0xf0000000)) == htonl(0xf0000000))
251	#define ZERONET(x) (((x) & htonl(0xff000000)) == htonl(0x00000000))
252	#define LOCAL_MCAST(x) (((x) & htonl(0xFFFFFF00)) == htonl(0xE0000000))
253
254	#endif
255
256	#endif /* _LINUX_IN_H */