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