xref: /linux/include/uapi/linux/in.h (revision 1ac731c529cd4d6adbce134754b51ff7d822b145)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  * INET		An implementation of the TCP/IP protocol suite for the LINUX
4  *		operating system.  INET is implemented using the  BSD Socket
5  *		interface as the means of communication with the user level.
6  *
7  *		Definitions of the Internet Protocol.
8  *
9  * Version:	@(#)in.h	1.0.1	04/21/93
10  *
11  * Authors:	Original taken from the GNU Project <netinet/in.h> file.
12  *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13  *
14  *		This program is free software; you can redistribute it and/or
15  *		modify it under the terms of the GNU General Public License
16  *		as published by the Free Software Foundation; either version
17  *		2 of the License, or (at your option) any later version.
18  */
19 #ifndef _UAPI_LINUX_IN_H
20 #define _UAPI_LINUX_IN_H
21 
22 #include <linux/types.h>
23 #include <linux/stddef.h>
24 #include <linux/libc-compat.h>
25 #include <linux/socket.h>
26 
27 #if __UAPI_DEF_IN_IPPROTO
28 /* Standard well-defined IP protocols.  */
29 enum {
30   IPPROTO_IP = 0,		/* Dummy protocol for TCP		*/
31 #define IPPROTO_IP		IPPROTO_IP
32   IPPROTO_ICMP = 1,		/* Internet Control Message Protocol	*/
33 #define IPPROTO_ICMP		IPPROTO_ICMP
34   IPPROTO_IGMP = 2,		/* Internet Group Management Protocol	*/
35 #define IPPROTO_IGMP		IPPROTO_IGMP
36   IPPROTO_IPIP = 4,		/* IPIP tunnels (older KA9Q tunnels use 94) */
37 #define IPPROTO_IPIP		IPPROTO_IPIP
38   IPPROTO_TCP = 6,		/* Transmission Control Protocol	*/
39 #define IPPROTO_TCP		IPPROTO_TCP
40   IPPROTO_EGP = 8,		/* Exterior Gateway Protocol		*/
41 #define IPPROTO_EGP		IPPROTO_EGP
42   IPPROTO_PUP = 12,		/* PUP protocol				*/
43 #define IPPROTO_PUP		IPPROTO_PUP
44   IPPROTO_UDP = 17,		/* User Datagram Protocol		*/
45 #define IPPROTO_UDP		IPPROTO_UDP
46   IPPROTO_IDP = 22,		/* XNS IDP protocol			*/
47 #define IPPROTO_IDP		IPPROTO_IDP
48   IPPROTO_TP = 29,		/* SO Transport Protocol Class 4	*/
49 #define IPPROTO_TP		IPPROTO_TP
50   IPPROTO_DCCP = 33,		/* Datagram Congestion Control Protocol */
51 #define IPPROTO_DCCP		IPPROTO_DCCP
52   IPPROTO_IPV6 = 41,		/* IPv6-in-IPv4 tunnelling		*/
53 #define IPPROTO_IPV6		IPPROTO_IPV6
54   IPPROTO_RSVP = 46,		/* RSVP Protocol			*/
55 #define IPPROTO_RSVP		IPPROTO_RSVP
56   IPPROTO_GRE = 47,		/* Cisco GRE tunnels (rfc 1701,1702)	*/
57 #define IPPROTO_GRE		IPPROTO_GRE
58   IPPROTO_ESP = 50,		/* Encapsulation Security Payload protocol */
59 #define IPPROTO_ESP		IPPROTO_ESP
60   IPPROTO_AH = 51,		/* Authentication Header protocol	*/
61 #define IPPROTO_AH		IPPROTO_AH
62   IPPROTO_MTP = 92,		/* Multicast Transport Protocol		*/
63 #define IPPROTO_MTP		IPPROTO_MTP
64   IPPROTO_BEETPH = 94,		/* IP option pseudo header for BEET	*/
65 #define IPPROTO_BEETPH		IPPROTO_BEETPH
66   IPPROTO_ENCAP = 98,		/* Encapsulation Header			*/
67 #define IPPROTO_ENCAP		IPPROTO_ENCAP
68   IPPROTO_PIM = 103,		/* Protocol Independent Multicast	*/
69 #define IPPROTO_PIM		IPPROTO_PIM
70   IPPROTO_COMP = 108,		/* Compression Header Protocol		*/
71 #define IPPROTO_COMP		IPPROTO_COMP
72   IPPROTO_L2TP = 115,		/* Layer 2 Tunnelling Protocol		*/
73 #define IPPROTO_L2TP		IPPROTO_L2TP
74   IPPROTO_SCTP = 132,		/* Stream Control Transport Protocol	*/
75 #define IPPROTO_SCTP		IPPROTO_SCTP
76   IPPROTO_UDPLITE = 136,	/* UDP-Lite (RFC 3828)			*/
77 #define IPPROTO_UDPLITE		IPPROTO_UDPLITE
78   IPPROTO_MPLS = 137,		/* MPLS in IP (RFC 4023)		*/
79 #define IPPROTO_MPLS		IPPROTO_MPLS
80   IPPROTO_ETHERNET = 143,	/* Ethernet-within-IPv6 Encapsulation	*/
81 #define IPPROTO_ETHERNET	IPPROTO_ETHERNET
82   IPPROTO_RAW = 255,		/* Raw IP packets			*/
83 #define IPPROTO_RAW		IPPROTO_RAW
84   IPPROTO_MPTCP = 262,		/* Multipath TCP connection		*/
85 #define IPPROTO_MPTCP		IPPROTO_MPTCP
86   IPPROTO_MAX
87 };
88 #endif
89 
90 #if __UAPI_DEF_IN_ADDR
91 /* Internet address. */
92 struct in_addr {
93 	__be32	s_addr;
94 };
95 #endif
96 
97 #define IP_TOS		1
98 #define IP_TTL		2
99 #define IP_HDRINCL	3
100 #define IP_OPTIONS	4
101 #define IP_ROUTER_ALERT	5
102 #define IP_RECVOPTS	6
103 #define IP_RETOPTS	7
104 #define IP_PKTINFO	8
105 #define IP_PKTOPTIONS	9
106 #define IP_MTU_DISCOVER	10
107 #define IP_RECVERR	11
108 #define IP_RECVTTL	12
109 #define	IP_RECVTOS	13
110 #define IP_MTU		14
111 #define IP_FREEBIND	15
112 #define IP_IPSEC_POLICY	16
113 #define IP_XFRM_POLICY	17
114 #define IP_PASSSEC	18
115 #define IP_TRANSPARENT	19
116 
117 /* BSD compatibility */
118 #define IP_RECVRETOPTS	IP_RETOPTS
119 
120 /* TProxy original addresses */
121 #define IP_ORIGDSTADDR       20
122 #define IP_RECVORIGDSTADDR   IP_ORIGDSTADDR
123 
124 #define IP_MINTTL       21
125 #define IP_NODEFRAG     22
126 #define IP_CHECKSUM	23
127 #define IP_BIND_ADDRESS_NO_PORT	24
128 #define IP_RECVFRAGSIZE	25
129 #define IP_RECVERR_RFC4884	26
130 
131 /* IP_MTU_DISCOVER values */
132 #define IP_PMTUDISC_DONT		0	/* Never send DF frames */
133 #define IP_PMTUDISC_WANT		1	/* Use per route hints	*/
134 #define IP_PMTUDISC_DO			2	/* Always DF		*/
135 #define IP_PMTUDISC_PROBE		3       /* Ignore dst pmtu      */
136 /* Always use interface mtu (ignores dst pmtu) but don't set DF flag.
137  * Also incoming ICMP frag_needed notifications will be ignored on
138  * this socket to prevent accepting spoofed ones.
139  */
140 #define IP_PMTUDISC_INTERFACE		4
141 /* weaker version of IP_PMTUDISC_INTERFACE, which allows packets to get
142  * fragmented if they exeed the interface mtu
143  */
144 #define IP_PMTUDISC_OMIT		5
145 
146 #define IP_MULTICAST_IF			32
147 #define IP_MULTICAST_TTL 		33
148 #define IP_MULTICAST_LOOP 		34
149 #define IP_ADD_MEMBERSHIP		35
150 #define IP_DROP_MEMBERSHIP		36
151 #define IP_UNBLOCK_SOURCE		37
152 #define IP_BLOCK_SOURCE			38
153 #define IP_ADD_SOURCE_MEMBERSHIP	39
154 #define IP_DROP_SOURCE_MEMBERSHIP	40
155 #define IP_MSFILTER			41
156 #define MCAST_JOIN_GROUP		42
157 #define MCAST_BLOCK_SOURCE		43
158 #define MCAST_UNBLOCK_SOURCE		44
159 #define MCAST_LEAVE_GROUP		45
160 #define MCAST_JOIN_SOURCE_GROUP		46
161 #define MCAST_LEAVE_SOURCE_GROUP	47
162 #define MCAST_MSFILTER			48
163 #define IP_MULTICAST_ALL		49
164 #define IP_UNICAST_IF			50
165 #define IP_LOCAL_PORT_RANGE		51
166 #define IP_PROTOCOL			52
167 
168 #define MCAST_EXCLUDE	0
169 #define MCAST_INCLUDE	1
170 
171 /* These need to appear somewhere around here */
172 #define IP_DEFAULT_MULTICAST_TTL        1
173 #define IP_DEFAULT_MULTICAST_LOOP       1
174 
175 /* Request struct for multicast socket ops */
176 
177 #if __UAPI_DEF_IP_MREQ
178 struct ip_mreq  {
179 	struct in_addr imr_multiaddr;	/* IP multicast address of group */
180 	struct in_addr imr_interface;	/* local IP address of interface */
181 };
182 
183 struct ip_mreqn {
184 	struct in_addr	imr_multiaddr;		/* IP multicast address of group */
185 	struct in_addr	imr_address;		/* local IP address of interface */
186 	int		imr_ifindex;		/* Interface index */
187 };
188 
189 struct ip_mreq_source {
190 	__be32		imr_multiaddr;
191 	__be32		imr_interface;
192 	__be32		imr_sourceaddr;
193 };
194 
195 struct ip_msfilter {
196 	__be32		imsf_multiaddr;
197 	__be32		imsf_interface;
198 	__u32		imsf_fmode;
199 	__u32		imsf_numsrc;
200 	union {
201 		__be32		imsf_slist[1];
202 		__DECLARE_FLEX_ARRAY(__be32, imsf_slist_flex);
203 	};
204 };
205 
206 #define IP_MSFILTER_SIZE(numsrc) \
207 	(sizeof(struct ip_msfilter) - sizeof(__u32) \
208 	+ (numsrc) * sizeof(__u32))
209 
210 struct group_req {
211 	__u32				 gr_interface;	/* interface index */
212 	struct __kernel_sockaddr_storage gr_group;	/* group address */
213 };
214 
215 struct group_source_req {
216 	__u32				 gsr_interface;	/* interface index */
217 	struct __kernel_sockaddr_storage gsr_group;	/* group address */
218 	struct __kernel_sockaddr_storage gsr_source;	/* source address */
219 };
220 
221 struct group_filter {
222 	union {
223 		struct {
224 			__u32				 gf_interface_aux; /* interface index */
225 			struct __kernel_sockaddr_storage gf_group_aux;	   /* multicast address */
226 			__u32				 gf_fmode_aux;	   /* filter mode */
227 			__u32				 gf_numsrc_aux;	   /* number of sources */
228 			struct __kernel_sockaddr_storage gf_slist[1];	   /* interface index */
229 		};
230 		struct {
231 			__u32				 gf_interface;	  /* interface index */
232 			struct __kernel_sockaddr_storage gf_group;	  /* multicast address */
233 			__u32				 gf_fmode;	  /* filter mode */
234 			__u32				 gf_numsrc;	  /* number of sources */
235 			struct __kernel_sockaddr_storage gf_slist_flex[]; /* interface index */
236 		};
237 	};
238 };
239 
240 #define GROUP_FILTER_SIZE(numsrc) \
241 	(sizeof(struct group_filter) - sizeof(struct __kernel_sockaddr_storage) \
242 	+ (numsrc) * sizeof(struct __kernel_sockaddr_storage))
243 #endif
244 
245 #if __UAPI_DEF_IN_PKTINFO
246 struct in_pktinfo {
247 	int		ipi_ifindex;
248 	struct in_addr	ipi_spec_dst;
249 	struct in_addr	ipi_addr;
250 };
251 #endif
252 
253 /* Structure describing an Internet (IP) socket address. */
254 #if  __UAPI_DEF_SOCKADDR_IN
255 #define __SOCK_SIZE__	16		/* sizeof(struct sockaddr)	*/
256 struct sockaddr_in {
257   __kernel_sa_family_t	sin_family;	/* Address family		*/
258   __be16		sin_port;	/* Port number			*/
259   struct in_addr	sin_addr;	/* Internet address		*/
260 
261   /* Pad to size of `struct sockaddr'. */
262   unsigned char		__pad[__SOCK_SIZE__ - sizeof(short int) -
263 			sizeof(unsigned short int) - sizeof(struct in_addr)];
264 };
265 #define sin_zero	__pad		/* for BSD UNIX comp. -FvK	*/
266 #endif
267 
268 #if __UAPI_DEF_IN_CLASS
269 /*
270  * Definitions of the bits in an Internet address integer.
271  * On subnets, host and network parts are found according
272  * to the subnet mask, not these masks.
273  */
274 #define	IN_CLASSA(a)		((((long int) (a)) & 0x80000000) == 0)
275 #define	IN_CLASSA_NET		0xff000000
276 #define	IN_CLASSA_NSHIFT	24
277 #define	IN_CLASSA_HOST		(0xffffffff & ~IN_CLASSA_NET)
278 #define	IN_CLASSA_MAX		128
279 
280 #define	IN_CLASSB(a)		((((long int) (a)) & 0xc0000000) == 0x80000000)
281 #define	IN_CLASSB_NET		0xffff0000
282 #define	IN_CLASSB_NSHIFT	16
283 #define	IN_CLASSB_HOST		(0xffffffff & ~IN_CLASSB_NET)
284 #define	IN_CLASSB_MAX		65536
285 
286 #define	IN_CLASSC(a)		((((long int) (a)) & 0xe0000000) == 0xc0000000)
287 #define	IN_CLASSC_NET		0xffffff00
288 #define	IN_CLASSC_NSHIFT	8
289 #define	IN_CLASSC_HOST		(0xffffffff & ~IN_CLASSC_NET)
290 
291 #define	IN_CLASSD(a)		((((long int) (a)) & 0xf0000000) == 0xe0000000)
292 #define	IN_MULTICAST(a)		IN_CLASSD(a)
293 #define	IN_MULTICAST_NET	0xe0000000
294 
295 #define	IN_BADCLASS(a)		(((long int) (a) ) == (long int)0xffffffff)
296 #define	IN_EXPERIMENTAL(a)	IN_BADCLASS((a))
297 
298 #define	IN_CLASSE(a)		((((long int) (a)) & 0xf0000000) == 0xf0000000)
299 #define	IN_CLASSE_NET		0xffffffff
300 #define	IN_CLASSE_NSHIFT	0
301 
302 /* Address to accept any incoming messages. */
303 #define	INADDR_ANY		((unsigned long int) 0x00000000)
304 
305 /* Address to send to all hosts. */
306 #define	INADDR_BROADCAST	((unsigned long int) 0xffffffff)
307 
308 /* Address indicating an error return. */
309 #define	INADDR_NONE		((unsigned long int) 0xffffffff)
310 
311 /* Dummy address for src of ICMP replies if no real address is set (RFC7600). */
312 #define	INADDR_DUMMY		((unsigned long int) 0xc0000008)
313 
314 /* Network number for local host loopback. */
315 #define	IN_LOOPBACKNET		127
316 
317 /* Address to loopback in software to local host.  */
318 #define	INADDR_LOOPBACK		0x7f000001	/* 127.0.0.1   */
319 #define	IN_LOOPBACK(a)		((((long int) (a)) & 0xff000000) == 0x7f000000)
320 
321 /* Defines for Multicast INADDR */
322 #define INADDR_UNSPEC_GROUP		0xe0000000U	/* 224.0.0.0   */
323 #define INADDR_ALLHOSTS_GROUP		0xe0000001U	/* 224.0.0.1   */
324 #define INADDR_ALLRTRS_GROUP		0xe0000002U	/* 224.0.0.2 */
325 #define INADDR_ALLSNOOPERS_GROUP	0xe000006aU	/* 224.0.0.106 */
326 #define INADDR_MAX_LOCAL_GROUP		0xe00000ffU	/* 224.0.0.255 */
327 #endif
328 
329 /* <asm/byteorder.h> contains the htonl type stuff.. */
330 #include <asm/byteorder.h>
331 
332 
333 #endif /* _UAPI_LINUX_IN_H */
334